binobj package

A Python library for reading and writing structured binary data.

Subpackages

• binobj.fields package
  • Submodules
    • binobj.fields.base module
      • DEFAULT
      • Field
      • NOT_PRESENT
      • UNDEFINED
    • binobj.fields.containers module
      • Array
      • Nested
      • Union
    • binobj.fields.numeric module
      • Float
      • Float16
      • Float32
      • Float64
      • Int16
      • Int32
      • Int64
      • Int8
      • Integer
      • Timestamp
      • Timestamp32
      • Timestamp64
      • UInt16
      • UInt32
      • UInt64
      • UInt8
      • UnsignedInteger
      • VariableLengthInteger
    • binobj.fields.stringlike module
      • Bytes
      • String
      • StringZ
      • UUID4
      • UUIDFormat

Submodules

• binobj.decorators module
  • ValidatorMethodWrapper
  • validates()
  • validates_struct()
• binobj.errors module
  • ArraySizeError
  • ConfigurationError
  • DeserializationError
  • Error
  • ExtraneousDataError
  • FieldRedefinedError
  • FieldReferenceError
  • IllegalOperationError
  • ImmutableFieldError
  • MissingRequiredValueError
  • MultipleInheritanceError
  • SerializationError
  • UndefinedSizeError
  • UnexpectedEOFError
  • UnexpectedValueError
  • UnserializableValueError
  • ValidationError
  • ValueSizeError
• binobj.helpers module
  • iter_bytes()
  • peek_bytes()
  • read_int()
  • write_int()
• binobj.pep526 module
  • dataclass()
• binobj.structures module
  • Struct
    • Struct.from_bytes()
    • Struct.from_stream()
    • Struct.get_field()
    • Struct.get_size()
    • Struct.partial_dump()
    • Struct.partial_load()
    • Struct.to_bytes()
    • Struct.to_dict()
    • Struct.to_stream()
    • Struct.validate_contents()
• binobj.typedefs module
  • FieldOrName
  • FieldValidator
  • MethodFieldValidator
  • MutableStrDict
  • StrDict
  • StructOrName
  • StructValidator
• binobj.varints module
  • EncodingInfo
    • EncodingInfo.decode
    • EncodingInfo.encode
    • EncodingInfo.endian
    • EncodingInfo.signed
  • INTEGER_ENCODING_MAP
  • VarIntEncoding
    • VarIntEncoding.COMPACT_INDICES
    • VarIntEncoding.LEB128
    • VarIntEncoding.ULEB128
    • VarIntEncoding.VLQ
  • decode_integer_compact()
  • decode_integer_leb128()
  • decode_integer_uleb128()
  • decode_integer_vlq()
  • encode_integer_compact()
  • encode_integer_leb128()
  • encode_integer_uleb128()
  • encode_integer_vlq()