Version history¶

Releases¶

Added StructureOptions.length
Added PseudoMemberEnumMixin
Added lazy and length support to SwitchField
Add support for caching the read/written raw bytes when using StructureOptions.capture_raw

This release adds more field types and further improves on existing code. It also extends the documentation significantly.

Added Destructify GUI, contributed by mvdnes.
Added StructureOptions.encoding
Added StructureOptions.alignment, Field.offset and Field.skip, implemented by Field.seek_start
Added Field.lazy
Added Field.decoder, Field.encoder and Structure.initialize()
Added BytesField.terminator_handler
Added ConditionalField.fallback
Added ArrayField.until
New field BytesField, merging the features of FixedLengthField and TerminatedField. These fields will remain as subclasses.
New field: ConstantField
New field: SwitchField
New field: VariableLengthIntegerField
Merged FixedLengthStringField and TerminatedStringField into StringField
Removed hook functions Field.from_bytes() and Field.to_bytes()
Removed all byte-order specific subclasses from StructField.
Add option to ParsingContext to capture the raw bytes, available in ParsingContext.fields
Add ParsingContext.fields for information about the parsing structure.
Added ParsingContext.f for raw attribute access; this is now passed to lambdas.
Added this for quick construction of lambdas
Substream is now a wrapper instead of a full-fetched BufferedReader
Numerous bugfixes for consistent building of fields.

This release features several new field types, and bugfixes from the previous release. Also some backwards-incompatible changes were made.

Added StructureOptions.byte_order
Added Structure.as_cstruct()
Added Structure.__len__()
Added Structure.full_name()
FieldContext is now ParsingContext
New field: ConditionalField
New field: EnumField
New field: BitField
New field: IntegerField, renamed struct-based field to IntField
New field: FixedLengthStringField
New field: TerminatedStringField
Support strict, negative lengths and padding in structify.fields.FixedLengthField
Support length in structify.fields.ArrayField, renamed ArrayField.size to ArrayField.count
Support step structify.fields.TerminatedField
Fixed structify.fields.StructureField to use structify.Substream
Fixed double-closing a structify.Substream

Initial release.