gocept.recordserialize 1.0

Fixed-width format

Define the format by listing all fields, in order. Each field has the following settings:

name:

Name of the field (required)

width:

Width of the field in characters (required)

fill character:

default: Space

alignment:

default: align LEFT (that is, pad on the right side)

For example:

>>> from gocept.recordserialize import FixedWidthRecord
>>> class FixedExample(FixedWidthRecord):
...
...    encoding = 'utf-8'
...    lineterminator = '\r\n'
...
...    fields = [
...        ('one', 3, ' ', FixedWidthRecord.LEFT),
...        ('two', 7, '0', FixedWidthRecord.RIGHT),
...    ]

Character-separated format

Define the format by declaring attributes on the class. Each field has the following settings:

position:

position of the field

default:

default value to write if none is given

maximum length:

truncate field to this length

Note that you do not have to declare all fields, any positions not declared are filled with empty columns. For this reason, you always have to give the total number of fields in the fields attribute:

>>> from gocept.recordserialize import SeparatedRecord
>>> class PipeExample(SeparatedRecord):
...
...    fields = 5
...    encoding = 'utf-8'
...    separator = '|'
...    lineterminator = '\r\n'
...
...    first = 1
...    default = 2, 'qux'
...    maxlen = 3, 3
...    maxlen_default = 4, 5, 'asdfg'

>>> from gocept.recordserialize import CSVRecord
>>> class CSVExample(CSVRecord):
...
...     fields = 1
...     one = 1

>>> r = CSVExample()
>>> r['one'] = 'my "quoted" string'
>>> str(r)
'"my \'quoted\' string"\r\n'

1.0 (2017-12-06)

• Add support for setuptools >= 32.

• Drop support for Python 2.6.

0.3 (2016-02-29)

• Escape unicode characters on errors.

0.2 (2013-11-26)

• Fixed dependency on setuptools.

0.1 (2012-09-19)

initial release