The ConstBitStream class

class bitstring.ConstBitStream([auto, length, offset, **kwargs])

The Bits class is the base class for ConstBitStream and so all of its methods are also available for ConstBitStream objects. The initialiser is also the same as for Bits and so won’t be repeated here.

A ConstBitStream is a Bits with added methods and properties that allow it to be parsed as a stream of bits.

bytealign()

Aligns to the start of the next byte (so that pos is a multiple of 8) and returns the number of bits skipped.

If the current position is already byte aligned then it is unchanged.

>>> s = ConstBitStream('0xabcdef')
>>> s.pos += 3
>>> s.bytealign()
5
>>> s.pos
8
peek(fmt)

Reads from the current bit position pos in the bitstring according to the fmt string or integer and returns the result.

The bit position is unchanged.

For information on the format string see the entry for the read method.

>>> s = ConstBitStream('0x123456')
>>> s.peek(16)
ConstBitStream('0x1234')
>>> s.peek('hex:8')
'12'
peeklist(fmt, **kwargs)

Reads from current bit position pos in the bitstring according to the fmt string or iterable and returns a list of results.

A dictionary or keyword arguments can also be provided. These will replace length identifiers in the format string. The position is not advanced to after the read items.

See the entries for read and readlist for more information.

read(fmt)

Reads from current bit position pos in the bitstring according the the format string and returns a single result. If not enough bits are available then a ReadError is raised.

fmt is either a token string that describes how to interpret the next bits in the bitstring or an integer. If it’s an integer then that number of bits will be read, and returned as a new bitstring. Otherwise the tokens are:

int:n n bits as a signed integer.
uint:n n bits as an unsigned integer.
float:n n bits as a floating point number.
intbe:n n bits as a big-endian signed integer.
uintbe:n n bits as a big-endian unsigned integer.
floatbe:n n bits as a big-endian float.
intle:n n bits as a little-endian signed int.
uintle:n n bits as a little-endian unsigned int.
floatle:n n bits as a little-endian float.
intne:n n bits as a native-endian signed int.
uintne:n n bits as a native-endian unsigned int.
floatne:n n bits as a native-endian float.
hex:n n bits as a hexadecimal string.
oct:n n bits as an octal string.
bin:n n bits as a binary string.
ue next bits as an unsigned exp-Golomb.
se next bits as a signed exp-Golomb.
uie next bits as an interleaved unsigned exp-Golomb.
sie next bits as an interleaved signed exp-Golomb.
bits:n n bits as a new bitstring.
bytes:n n bytes as bytes object.
bool next bit as a boolean (True or False).
pad:n next n bits will be skipped.

For example:

>>> s = ConstBitStream('0x23ef55302')
>>> s.read('hex:12')
'23e'
>>> s.read('bin:4')
'1111'
>>> s.read('uint:5')
10
>>> s.read('bits:4')
ConstBitStream('0xa')

The read method is useful for reading exponential-Golomb codes.

>>> s = ConstBitStream('se=-9, ue=4')
>>> s.read('se')
-9
>>> s.read('ue')
4

The pad token is not very useful when used in read as it just skips a number of bits and returns None. However when used within readlist or unpack it allows unimportant part of the bitstring to be simply ignored.

readlist(fmt, **kwargs)

Reads from current bit position pos in the bitstring according to the fmt string or iterable and returns a list of results. If not enough bits are available then a ReadError is raised.

A dictionary or keyword arguments can also be provided. These will replace length identifiers in the format string. The position is advanced to after the read items.

See the entry for read for information on the format strings.

For multiple items you can separate using commas or given multiple parameters:

>>> s = ConstBitStream('0x43fe01ff21')
>>> s.readlist('hex:8, uint:6')
['43', 63]
>>> s.readlist(['bin:3', 'intle:16'])
['100', -509]
>>> s.pos = 0
>>> s.readlist('hex:b, uint:d', b=8, d=6)
['43', 63]
readto(bs, bytealigned)

Reads up to and including the next occurrence of the bitstring bs and returns the results. If bytealigned is True it will look for the bitstring starting only at whole-byte positions.

Raises a ReadError if bs is not found, and ValueError if bs is empty.

>>> s = ConstBitStream('0x47000102034704050647')
>>> s.readto('0x47', bytealigned=True)
BitStream('0x47')
>>> s.readto('0x47', bytealigned=True)
BitStream('0x0001020347')
>>> s.readto('0x47', bytealigned=True)
BitStream('0x04050647')
bytepos

Property for setting and getting the current byte position in the bitstring.

When used as a getter will raise a ByteAlignError if the current position in not byte aligned.

pos
bitpos

Read and write property for setting and getting the current bit position in the bitstring. Can be set to any value from 0 to len.

The pos and bitpos properties are exactly equivalent - you can use whichever you prefer.

if s.pos < 100:
    s.pos += 10