titus.pfaast.BinaryFormatter

class titus.pfaast.BinaryFormatter[source]

Bases: object

Helper class for pack and unpack that checks format strings.

class Declare

Bases: object

Trait for binary format declaration.

class BinaryFormatter.DeclareBoolean(value)

Bases: titus.pfaast.Declare

Binary format declaration for a boolean byte.

__init__(value)
avroType = "boolean"
class BinaryFormatter.DeclareByte(value, unsigned)

Bases: titus.pfaast.Declare

Binary format declaration for an integer byte.

__init__(value, unsigned)
avroType = "int"
class BinaryFormatter.DeclareDouble(value, littleEndian)

Bases: titus.pfaast.Declare

Binary format declaration for a double-precision (64-bit) floating point number.

__init__(value, littleEndian)
avroType = "double"
class BinaryFormatter.DeclareFloat(value, littleEndian)

Bases: titus.pfaast.Declare

Binary format declaration for a single-precision (32-bit) floating point number.

__init__(value, littleEndian)
avroType = "float"
class BinaryFormatter.DeclareInt(value, littleEndian, unsigned)

Bases: titus.pfaast.Declare

Binary format declaration for a regular (32-bit) integer.

__init__(value, littleEndian, unsigned)
avroType
class BinaryFormatter.DeclareLong(value, littleEndian, unsigned)

Bases: titus.pfaast.Declare

Binary format declaration for a long (64-bit) integer.

__init__(value, littleEndian, unsigned)
avroType
class BinaryFormatter.DeclarePad(value)

Bases: titus.pfaast.Declare

Binary format declaration for a padded byte.

__init__(value)
avroType = "null"
class BinaryFormatter.DeclarePrefixed(value)

Bases: titus.pfaast.Declare

Binary format declaration for length-prefixed raw data.

__init__(value)
avroType = "bytes"
class BinaryFormatter.DeclareRaw(value)

Bases: titus.pfaast.Declare

Binary format declaration for arbitrary-width raw data.

__init__(value)
avroType = "bytes"
class BinaryFormatter.DeclareRawSize(value, size)

Bases: titus.pfaast.Declare

Binary format declaration for fixed-width raw data.

__init__(value, size)
avroType = "bytes"
class BinaryFormatter.DeclareShort(value, littleEndian, unsigned)

Bases: titus.pfaast.Declare

Binary format declaration for a short (16-bit) integer.

__init__(value, littleEndian, unsigned)
avroType = "int"
class BinaryFormatter.DeclareToNull(value)

Bases: titus.pfaast.Declare

Binary format declaration for null-terminated raw data.

__init__(value)
avroType = "bytes"
BinaryFormatter.formatBoolean = <_sre.SRE_Pattern object at 0x7faece6fba80>
BinaryFormatter.formatByte = <_sre.SRE_Pattern object at 0x7faece78e750>
BinaryFormatter.formatDouble = <_sre.SRE_Pattern object at 0x2c967c0>
BinaryFormatter.formatFloat = <_sre.SRE_Pattern object at 0x353c950>
BinaryFormatter.formatInt = <_sre.SRE_Pattern object at 0x2c7ea40>
BinaryFormatter.formatLong = <_sre.SRE_Pattern object at 0x3525b00>
BinaryFormatter.formatPad = <_sre.SRE_Pattern object at 0x7faece46f200>
BinaryFormatter.formatPrefixed = <_sre.SRE_Pattern object at 0x7faece45c030>
BinaryFormatter.formatRaw = <_sre.SRE_Pattern object at 0x7faece4d7618>
BinaryFormatter.formatRawSize = <_sre.SRE_Pattern object at 0x7faed15b2df0>
BinaryFormatter.formatShort = <_sre.SRE_Pattern object at 0x3482150>
static BinaryFormatter.formatToDeclare(value, f, pos, output)

Convert a format string to a titus.pfaast.BinaryFormatter.Declare object.

Parameters:
  • value (titus.pfaast.TaskResult) – task result, usually Python code in a string, passed to the format declarer
  • f (string) – format string
  • pos (string or None) – source file location from the locator mark for error messages
  • output (bool) – True for pack, False for unpack
Return type:

titus.pfaast.BinaryFormatter.Declare subclass

Returns:

format declarer

BinaryFormatter.formatToNull = <_sre.SRE_Pattern object at 0x7faece45c1b0>
BinaryFormatter.formatUnsignedByte = <_sre.SRE_Pattern object at 0x7faece5e6b58>
BinaryFormatter.formatUnsignedInt = <_sre.SRE_Pattern object at 0x340c390>
BinaryFormatter.formatUnsignedLong = <_sre.SRE_Pattern object at 0x2c2c070>
BinaryFormatter.formatUnsignedShort = <_sre.SRE_Pattern object at 0x35340e0>