-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path__init__.py
More file actions
337 lines (258 loc) · 13.6 KB
/
__init__.py
File metadata and controls
337 lines (258 loc) · 13.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
#!/usr/bin/env python
r"""
This package defines classes that simplify bit-wise creation, manipulation and
interpretation of data.
Classes:
Bits -- An immutable container for binary data.
BitArray -- A mutable container for binary data.
ConstBitStream -- An immutable container with streaming methods.
BitStream -- A mutable container with streaming methods.
Array -- An efficient list-like container where each item has a fixed-length binary format.
Dtype -- Encapsulate the data types used in the other classes.
Functions:
pack -- Create a BitStream from a format string.
Data:
options -- Module-wide options.
Exceptions:
Error -- Module exception base class.
CreationError -- Error during creation.
InterpretError -- Inappropriate interpretation of binary data.
ByteAlignError -- Whole byte position or length needed.
ReadError -- Reading or peeking past the end of a bitstring.
https://github.com/scott-griffiths/bitstring
"""
__licence__ = """
The MIT License
Copyright (c) 2006 Scott Griffiths ([email protected])
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
"""
__version__ = "4.2.3"
__author__ = "Scott Griffiths"
import sys
from .bits import Bits
from .bitstring_options import Options
from .bitarray_ import BitArray
from .bitstream import ConstBitStream, BitStream
from .methods import pack
from .array_ import Array
from .exceptions import Error, ReadError, InterpretError, ByteAlignError, CreationError
from .dtypes import DtypeDefinition, dtype_register, Dtype
import types
from typing import List, Tuple, Literal
from .mxfp import decompress_luts as mxfp_decompress_luts
from .fp8 import decompress_luts as binary8_decompress_luts
# Decompress the LUTs for the exotic floating point formats
mxfp_decompress_luts()
binary8_decompress_luts()
# The Options class returns a singleton.
options = Options()
# These get defined properly by the module magic below. This just stops mypy complaining about them.
bytealigned = lsb0 = None
# An opaque way of adding module level properties. Taken from https://peps.python.org/pep-0549/
# This is now deprecated. Use the options object directly instead.
class _MyModuleType(types.ModuleType):
@property
def bytealigned(self) -> bool:
"""Determines whether a number of methods default to working only on byte boundaries."""
return options.bytealigned
@bytealigned.setter
def bytealigned(self, value: bool) -> None:
"""Determines whether a number of methods default to working only on byte boundaries."""
options.bytealigned = value
@property
def lsb0(self) -> bool:
"""If True, the least significant bit (the final bit) is indexed as bit zero."""
return options.lsb0
@lsb0.setter
def lsb0(self, value: bool) -> None:
"""If True, the least significant bit (the final bit) is indexed as bit zero."""
options.lsb0 = value
sys.modules[__name__].__class__ = _MyModuleType
# These methods convert a bit length to the number of characters needed to print it for different interpretations.
def hex_bits2chars(bitlength: int):
# One character for every 4 bits
return bitlength // 4
def oct_bits2chars(bitlength: int):
# One character for every 3 bits
return bitlength // 3
def bin_bits2chars(bitlength: int):
# One character for each bit
return bitlength
def bytes_bits2chars(bitlength: int):
# One character for every 8 bits
return bitlength // 8
def uint_bits2chars(bitlength: int):
# How many characters is largest possible int of this length?
return len(str((1 << bitlength) - 1))
def int_bits2chars(bitlength: int):
# How many characters is largest negative int of this length? (To include minus sign).
return len(str((-1 << (bitlength - 1))))
def float_bits2chars(bitlength: Literal[16, 32, 64]):
# These bit lengths were found by looking at lots of possible values
if bitlength in [16, 32]:
return 23 # Empirical value
else:
return 24 # Empirical value
def p3binary_bits2chars(_: Literal[8]):
return 19 # Empirical value
def p4binary_bits2chars(_: Literal[8]):
# Found by looking at all the possible values
return 13 # Empirical value
def e4m3mxfp_bits2chars(_: Literal[8]):
return 13
def e5m2mxfp_bits2chars(_: Literal[8]):
return 19
def e3m2mxfp_bits2chars(_: Literal[6]):
# Not sure what the best value is here. It's 7 without considering the scale that could be applied.
return 7
def e2m3mxfp_bits2chars(_: Literal[6]):
# Not sure what the best value is here.
return 7
def e2m1mxfp_bits2chars(_: Literal[4]):
# Not sure what the best value is here.
return 7
def e8m0mxfp_bits2chars(_: Literal[8]):
# Has same range as float32
return 23
def mxint_bits2chars(_: Literal[8]):
# Not sure what the best value is here.
return 10
def bfloat_bits2chars(_: Literal[16]):
# Found by looking at all the possible values
return 23 # Empirical value
def bits_bits2chars(bitlength: int):
# For bits type we can see how long it needs to be printed by trying any value
temp = Bits(bitlength)
return len(str(temp))
def bool_bits2chars(_: Literal[1]):
# Bools are printed as 1 or 0, not True or False, so are one character each
return 1
dtype_definitions = [
# Integer types
DtypeDefinition('uint', Bits._setuint, Bits._getuint, int, False, uint_bits2chars,
description="a two's complement unsigned int"),
DtypeDefinition('uintle', Bits._setuintle, Bits._getuintle, int, False, uint_bits2chars,
allowed_lengths=(8, 16, 24, ...), description="a two's complement little-endian unsigned int"),
DtypeDefinition('uintbe', Bits._setuintbe, Bits._getuintbe, int, False, uint_bits2chars,
allowed_lengths=(8, 16, 24, ...), description="a two's complement big-endian unsigned int"),
DtypeDefinition('int', Bits._setint, Bits._getint, int, True, int_bits2chars,
description="a two's complement signed int"),
DtypeDefinition('intle', Bits._setintle, Bits._getintle, int, True, int_bits2chars,
allowed_lengths=(8, 16, 24, ...), description="a two's complement little-endian signed int"),
DtypeDefinition('intbe', Bits._setintbe, Bits._getintbe, int, True, int_bits2chars,
allowed_lengths=(8, 16, 24, ...), description="a two's complement big-endian signed int"),
# String types
DtypeDefinition('hex', Bits._sethex, Bits._gethex, str, False, hex_bits2chars,
allowed_lengths=(0, 4, 8, ...), description="a hexadecimal string"),
DtypeDefinition('bin', Bits._setbin_safe, Bits._getbin, str, False, bin_bits2chars,
description="a binary string"),
DtypeDefinition('oct', Bits._setoct, Bits._getoct, str, False, oct_bits2chars,
allowed_lengths=(0, 3, 6, ...), description="an octal string"),
# Float types
DtypeDefinition('float', Bits._setfloatbe, Bits._getfloatbe, float, True, float_bits2chars,
allowed_lengths=(16, 32, 64), description="a big-endian floating point number"),
DtypeDefinition('floatle', Bits._setfloatle, Bits._getfloatle, float, True, float_bits2chars,
allowed_lengths=(16, 32, 64), description="a little-endian floating point number"),
DtypeDefinition('bfloat', Bits._setbfloatbe, Bits._getbfloatbe, float, True, bfloat_bits2chars,
allowed_lengths=(16,), description="a 16 bit big-endian bfloat floating point number"),
DtypeDefinition('bfloatle', Bits._setbfloatle, Bits._getbfloatle, float, True, bfloat_bits2chars,
allowed_lengths=(16,), description="a 16 bit little-endian bfloat floating point number"),
# Other known length types
DtypeDefinition('bits', Bits._setbits, Bits._getbits, Bits, False, bits_bits2chars,
description="a bitstring object"),
DtypeDefinition('bool', Bits._setbool, Bits._getbool, bool, False, bool_bits2chars,
allowed_lengths=(1,), description="a bool (True or False)"),
DtypeDefinition('bytes', Bits._setbytes, Bits._getbytes, bytes, False, bytes_bits2chars,
multiplier=8, description="a bytes object"),
# Unknown length types
DtypeDefinition('se', Bits._setse, Bits._getse, int, True, None,
variable_length=True, description="a signed exponential-Golomb code"),
DtypeDefinition('ue', Bits._setue, Bits._getue, int, False, None,
variable_length=True, description="an unsigned exponential-Golomb code"),
DtypeDefinition('sie', Bits._setsie, Bits._getsie, int, True, None,
variable_length=True, description="a signed interleaved exponential-Golomb code"),
DtypeDefinition('uie', Bits._setuie, Bits._getuie, int, False, None,
variable_length=True, description="an unsigned interleaved exponential-Golomb code"),
# Special case pad type
DtypeDefinition('pad', Bits._setpad, Bits._getpad, None, False, None,
description="a skipped section of padding"),
# MXFP and IEEE 8-bit float types
DtypeDefinition('p3binary', Bits._setp3binary, Bits._getp3binary, float, True, p3binary_bits2chars,
allowed_lengths=(8,), description="an 8 bit float with binary8p3 format"),
DtypeDefinition('p4binary', Bits._setp4binary, Bits._getp4binary, float, True, p4binary_bits2chars,
allowed_lengths=(8,), description="an 8 bit float with binary8p4 format"),
DtypeDefinition('e4m3mxfp', Bits._sete4m3mxfp, Bits._gete4m3mxfp, float, True, e4m3mxfp_bits2chars,
allowed_lengths=(8,), description="an 8 bit float with MXFP E4M3 format"),
DtypeDefinition('e5m2mxfp', Bits._sete5m2mxfp, Bits._gete5m2mxfp, float, True, e5m2mxfp_bits2chars,
allowed_lengths=(8,), description="an 8 bit float with MXFP E5M2 format"),
DtypeDefinition('e3m2mxfp', Bits._sete3m2mxfp, Bits._gete3m2mxfp, float, True, e3m2mxfp_bits2chars,
allowed_lengths=(6,), description="a 6 bit float with MXFP E3M2 format"),
DtypeDefinition('e2m3mxfp', Bits._sete2m3mxfp, Bits._gete2m3mxfp, float, True, e2m3mxfp_bits2chars,
allowed_lengths=(6,), description="a 6 bit float with MXFP E2M3 format"),
DtypeDefinition('e2m1mxfp', Bits._sete2m1mxfp, Bits._gete2m1mxfp, float, True, e2m1mxfp_bits2chars,
allowed_lengths=(4,), description="a 4 bit float with MXFP E2M1 format"),
DtypeDefinition('e8m0mxfp', Bits._sete8m0mxfp, Bits._gete8m0mxfp, float, False, e8m0mxfp_bits2chars,
allowed_lengths=(8,), description="an 8 bit float with MXFP E8M0 format"),
DtypeDefinition('mxint', Bits._setmxint, Bits._getmxint, float, True, mxint_bits2chars,
allowed_lengths=(8,), description="an 8 bit float with MXFP INT8 format"),
]
aliases: List[Tuple[str, str]] = [
# Floats default to big endian
('float', 'floatbe'),
('bfloat', 'bfloatbe'),
# Some single letter aliases for popular types
('int', 'i'),
('uint', 'u'),
('hex', 'h'),
('oct', 'o'),
('bin', 'b'),
('float', 'f'),
]
# Create native-endian aliases depending on the byteorder of the system
byteorder: str = sys.byteorder
if byteorder == 'little':
aliases.extend([
('uintle', 'uintne'),
('intle', 'intne'),
('floatle', 'floatne'),
('bfloatle', 'bfloatne'),
])
else:
aliases.extend([
('uintbe', 'uintne'),
('intbe', 'intne'),
('floatbe', 'floatne'),
('bfloatbe', 'bfloatne'),
])
for dt in dtype_definitions:
dtype_register.add_dtype(dt)
for alias in aliases:
dtype_register.add_dtype_alias(alias[0], alias[1])
property_docstrings = [f'{name} -- Interpret as {dtype_register[name].description}.' for name in dtype_register.names]
property_docstring = '\n '.join(property_docstrings)
# We can't be sure the docstrings are present, as it might be compiled without docstrings.
if Bits.__doc__ is not None:
Bits.__doc__ = Bits.__doc__.replace('[GENERATED_PROPERTY_DESCRIPTIONS]', property_docstring)
if BitArray.__doc__ is not None:
BitArray.__doc__ = BitArray.__doc__.replace('[GENERATED_PROPERTY_DESCRIPTIONS]', property_docstring)
if ConstBitStream.__doc__ is not None:
ConstBitStream.__doc__ = ConstBitStream.__doc__.replace('[GENERATED_PROPERTY_DESCRIPTIONS]', property_docstring)
if BitStream.__doc__ is not None:
BitStream.__doc__ = BitStream.__doc__.replace('[GENERATED_PROPERTY_DESCRIPTIONS]', property_docstring)
__all__ = ['ConstBitStream', 'BitStream', 'BitArray', 'Array',
'Bits', 'pack', 'Error', 'ReadError', 'InterpretError',
'ByteAlignError', 'CreationError', 'bytealigned', 'lsb0', 'Dtype', 'options']