# -*- coding: utf-8 -*- # mypy: no-warn-unused-ignores from .declarativeunittest import raises, common, commonhex, commondumpdeprecated, commondump, commonbytes, ident, devzero from construct.core import * from construct import * from construct.lib import * from construct.lib.containers import * import itertools import os import io import random import math import pytest import typing as t import hashlib def test_bytes() -> None: d = Bytes(4) common(d, b"1234", b"1234", 4) assert d.parse(b"1234567890") == b"1234" assert raises(d.parse, b"") == StreamError assert raises(d.build, b"looooooooooooooong") == StreamError assert d.build(1) == b"\x00\x00\x00\x01" assert d.build(0x01020304) == b"\x01\x02\x03\x04" d = Bytes(this.n) common(d, b"1234", b"1234", 4, n=4) assert d.parse(b"1234567890",n=4) == b"1234" assert d.build(1, n=4) == b"\x00\x00\x00\x01" assert raises(d.build, b"", n=4) == StreamError assert raises(d.build, b"toolong", n=4) == StreamError assert raises(d.sizeof) == SizeofError assert raises(d.sizeof, n=4) == 4 def test_greedybytes() -> None: common(GreedyBytes, b"1234", b"1234", SizeofError) def test_bytes_issue_827() -> None: d1 = Bytes(3) assert d1.build(bytearray(b'\x01\x02\x03')) == b'\x01\x02\x03' d2 = GreedyBytes assert d2.build(bytearray(b'\x01\x02\x03')) == b'\x01\x02\x03' def test_bitwise() -> None: common(Bitwise(Bytes(8)), b"\xff", b"\x01\x01\x01\x01\x01\x01\x01\x01", 1) common(Bitwise(Array(8,Bit)), b"\xff", [1,1,1,1,1,1,1,1], 1) common(Bitwise(Array(2,Nibble)), b"\xff", [15,15], 1) common(Bitwise(Array(1,Octet)), b"\xff", [255], 1) common(Bitwise(GreedyBytes), bytes(10), bytes(80), SizeofError) def test_bytewise() -> None: common(Bitwise(Bytewise(Bytes(1))), b"\xff", b"\xff", 1) common(BitStruct("p1"/Nibble, "num"/Bytewise(Int24ub), "p2"/Nibble), b"\xf0\x10\x20\x3f", Container(p1=15, num=0x010203, p2=15), 4) common(Bitwise(Sequence(Nibble, Bytewise(Int24ub), Nibble)), b"\xf0\x10\x20\x3f", [0x0f,0x010203,0x0f], 4) common(Bitwise(Bytewise(GreedyBytes)), bytes(10), bytes(10), SizeofError) def test_ints() -> None: common(Byte, b"\xff", 255, 1) common(Short, b"\x00\xff", 255, 2) common(Int, b"\x00\x00\x00\xff", 255, 4) common(Long, b"\x00\x00\x00\x00\x00\x00\x00\xff", 255, 8) common(Int8ub, b"\x01", 0x01, 1) common(Int16ub, b"\x01\x02", 0x0102, 2) common(Int32ub, b"\x01\x02\x03\x04", 0x01020304, 4) common(Int64ub, b"\x01\x02\x03\x04\x05\x06\x07\x08", 0x0102030405060708, 8) common(Int8sb, b"\x01", 0x01, 1) common(Int16sb, b"\x01\x02", 0x0102, 2) common(Int32sb, b"\x01\x02\x03\x04", 0x01020304, 4) common(Int64sb, b"\x01\x02\x03\x04\x05\x06\x07\x08", 0x0102030405060708, 8) common(Int8sb, b"\xff", -1, 1) common(Int16sb, b"\xff\xff", -1, 2) common(Int32sb, b"\xff\xff\xff\xff", -1, 4) common(Int64sb, b"\xff\xff\xff\xff\xff\xff\xff\xff", -1, 8) common(Int8ul, b"\x01", 0x01, 1) common(Int16ul, b"\x01\x02", 0x0201, 2) common(Int32ul, b"\x01\x02\x03\x04", 0x04030201, 4) common(Int64ul, b"\x01\x02\x03\x04\x05\x06\x07\x08", 0x0807060504030201, 8) common(Int8sl, b"\x01", 0x01, 1) common(Int16sl, b"\x01\x02", 0x0201, 2) common(Int32sl, b"\x01\x02\x03\x04", 0x04030201, 4) common(Int64sl, b"\x01\x02\x03\x04\x05\x06\x07\x08", 0x0807060504030201, 8) common(Int8sl, b"\xff", -1, 1) common(Int16sl, b"\xff\xff", -1, 2) common(Int32sl, b"\xff\xff\xff\xff", -1, 4) common(Int64sl, b"\xff\xff\xff\xff\xff\xff\xff\xff", -1, 8) def test_ints24() -> None: common(Int24ub, b"\x01\x02\x03", 0x010203, 3) common(Int24ul, b"\x01\x02\x03", 0x030201, 3) common(Int24sb, b"\xff\xff\xff", -1, 3) common(Int24sl, b"\xff\xff\xff", -1, 3) def test_floats() -> None: common(Half, b"\x00\x00", 0., 2) common(Half, b"\x35\x55", 0.333251953125, 2) common(Single, b"\x00\x00\x00\x00", 0., 4) common(Single, b"?\x99\x99\x9a", 1.2000000476837158, 4) common(Double, b"\x00\x00\x00\x00\x00\x00\x00\x00", 0., 8) common(Double, b"?\xf3333333", 1.2, 8) def test_formatfield() -> None: d = FormatField("<","L") common(d, b"\x01\x02\x03\x04", 0x04030201, 4) assert raises(d.parse, b"") == StreamError assert raises(d.parse, b"\x01\x02") == StreamError assert raises(d.build, 2**100) == FormatFieldError assert raises(d.build, 1e9999) == FormatFieldError assert raises(d.build, "string not int") == FormatFieldError def test_formatfield_ints_randomized() -> None: for endianess,dtype in itertools.product("<>=","bhlqBHLQ"): d = FormatField(endianess, dtype) for _ in range(100): obj = random.randrange(0, 256**d.sizeof()//2) assert d.parse(d.build(obj)) == obj data = os.urandom(d.sizeof()) assert d.build(d.parse(data)) == data def test_formatfield_floats_randomized() -> None: # there is a roundoff error because Python float is a C double # http://stackoverflow.com/questions/39619636/struct-unpackstruct-packfloat-has-roundoff-error # and analog although that was misplaced # http://stackoverflow.com/questions/39676482/struct-packstruct-unpackfloat-is-inconsistent-on-py3 for endianess,dtype in itertools.product("<>=","fd"): d = FormatField(endianess, dtype) for _ in range(100): x = random.random()*12345 if dtype == "d": assert d.parse(d.build(x)) == x else: assert abs(d.parse(d.build(x)) - x) < 1e-3 for _ in range(100): b = os.urandom(d.sizeof()) if not math.isnan(d.parse(b)): assert d.build(d.parse(b)) == b def test_formatfield_bool_issue_901() -> None: d = FormatField(">","?") assert d.parse(b"\x01") == True assert d.parse(b"\xff") == True assert d.parse(b"\x00") == False assert d.build(True) == b"\x01" assert d.build(False) == b"\x00" assert d.sizeof() == 1 def test_bytesinteger() -> None: d = BytesInteger(4, signed=True, swapped=False) common(d, b"\x01\x02\x03\x04", 0x01020304, 4) common(d, b"\xff\xff\xff\xff", -1, 4) d = BytesInteger(4, signed=False, swapped=this.swapped) common(d, b"\x01\x02\x03\x04", 0x01020304, 4, swapped=False) common(d, b"\x04\x03\x02\x01", 0x01020304, 4, swapped=True) assert raises(BytesInteger(this.missing).sizeof) == SizeofError assert raises(BytesInteger(4, signed=False).build, -1) == IntegerError common(BytesInteger(0), b"", 0, 0) def test_bitsinteger() -> None: d = BitsInteger(8) common(d, b"\x01\x01\x01\x01\x01\x01\x01\x01", 255, 8) d = BitsInteger(8, signed=True) common(d, b"\x01\x01\x01\x01\x01\x01\x01\x01", -1, 8) d = BitsInteger(16, swapped=True) common(d, b"\x00\x00\x00\x00\x00\x00\x00\x00\x01\x01\x01\x01\x01\x01\x01\x01", 0xff00, 16) d = BitsInteger(16, swapped=this.swapped) common(d, b"\x01\x01\x01\x01\x01\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00", 0xff00, 16, swapped=False) common(d, b"\x00\x00\x00\x00\x00\x00\x00\x00\x01\x01\x01\x01\x01\x01\x01\x01", 0xff00, 16, swapped=True) assert raises(BitsInteger(this.missing).sizeof) == SizeofError assert raises(BitsInteger(8, signed=False).build, -1) == IntegerError common(BitsInteger(0), b"", 0, 0) def test_varint() -> None: d = VarInt common(d, b"\x80\x80\x80\x80\x80\x80\x80\x80\x80\x80\x80\x80\x80\x80\x80\x80\x80\x10", 2**123, SizeofError) for n in [0,1,5,100,255,256,65535,65536,2**32,2**100]: assert d.parse(d.build(n)) == n for n in range(0, 127): common(d, int2byte(n), n, SizeofError) assert raises(d.parse, b"") == StreamError assert raises(d.build, -1) == IntegerError def test_varint_issue_705() -> None: d = Struct('namelen' / VarInt, 'name' / Bytes(this.namelen)) d.build(Container(namelen = 400, name = bytes(400))) def test_zigzag() -> None: d = ZigZag assert d.parse(b"\x00") == 0 assert d.parse(b"\x05") == -3 assert d.parse(b"\x06") == 3 assert d.build(0) == b"\x00" assert d.build(-3) == b"\x05" assert d.build(3) == b"\x06" assert raises(d.parse, b"") == StreamError assert raises(d.build, None) == IntegerError assert raises(d.sizeof) == SizeofError def test_zigzag_regression() -> None: d = ZigZag assert isinstance(d.parse(b"\x05"), integertypes) assert isinstance(d.parse(b"\x06"), integertypes) def test_paddedstring() -> None: common(PaddedString(10, "utf8"), b"hello\x00\x00\x00\x00\x00", u"hello", 10) d = PaddedString(100, "ascii") assert d.parse(b"X"*100) == u"X"*100 assert d.build(u"X"*100) == b"X"*100 assert raises(d.build, u"X"*200) == PaddingError for e,_ in [("utf8",1),("utf16",2),("utf_16_le",2),("utf32",4),("utf_32_le",4)]: s = u"Афон" data = (s.encode(e)+bytes(100))[:100] common(PaddedString(100, e), data, s, 100) s = u"" data = bytes(100) common(PaddedString(100, e), data, s, 100) for e in ["ascii","utf8","utf16","utf-16-le","utf32","utf-32-le"]: assert PaddedString(10, e).sizeof() == 10 assert PaddedString(this.n, e).sizeof(n=10) == 10 def test_pascalstring() -> None: for e,_ in [("utf8",1),("utf16",2),("utf_16_le",2),("utf32",4),("utf_32_le",4)]: for sc in [Byte, Int16ub, Int16ul, VarInt]: s = u"Афон" data = sc.build(len(s.encode(e))) + s.encode(e) common(PascalString(sc, e), data, s) common(PascalString(sc, e), sc.build(0), u"") for e in ["utf8","utf16","utf-16-le","utf32","utf-32-le","ascii"]: assert raises(PascalString(Byte, e).sizeof) == SizeofError assert raises(PascalString(VarInt, e).sizeof) == SizeofError def test_cstring() -> None: s = u"" for e,us in [("utf8",1),("utf16",2),("utf_16_le",2),("utf32",4),("utf_32_le",4)]: s = u"Афон" common(CString(e), s.encode(e)+bytes(us), s) common(CString(e), bytes(us), u"") assert CString("utf8").build(s) == b'\xd0\x90\xd1\x84\xd0\xbe\xd0\xbd'+b"\x00" assert CString("utf16").build(s) == b'\xff\xfe\x10\x04D\x04>\x04=\x04'+b"\x00\x00" assert CString("utf32").build(s) == b'\xff\xfe\x00\x00\x10\x04\x00\x00D\x04\x00\x00>\x04\x00\x00=\x04\x00\x00'+b"\x00\x00\x00\x00" for e in ["utf8","utf16","utf-16-le","utf32","utf-32-le","ascii"]: assert raises(CString(e).sizeof) == SizeofError def test_greedystring() -> None: for e,_ in [("utf8",1),("utf16",2),("utf_16_le",2),("utf32",4),("utf_32_le",4)]: s = u"Афон" common(GreedyString(e), s.encode(e), s) common(GreedyString(e), b"", u"") for e in ["utf8","utf16","utf-16-le","utf32","utf-32-le","ascii"]: assert raises(GreedyString(e).sizeof) == SizeofError def test_string_encodings() -> None: # checks that "-" is replaced with "_" common(GreedyString("utf-8"), b"", u"") common(GreedyString("utf-8"), b'\xd0\x90\xd1\x84\xd0\xbe\xd0\xbd', u"Афон") def test_flag() -> None: d = Flag common(d, b"\x00", False, 1) common(d, b"\x01", True, 1) assert d.parse(b"\xff") == True def test_enum() -> None: d = Enum(Byte, one=1, two=2, four=4, eight=8) common(d, b"\x01", "one", 1) common(d, b"\xff", 255, 1) assert d.parse(b"\x01") == d.one assert d.parse(b"\x01") == "one" assert int(d.parse(b"\x01")) == 1 assert d.parse(b"\xff") == 255 assert int(d.parse(b"\xff")) == 255 assert d.build(8) == b'\x08' assert d.build(255) == b"\xff" assert d.build(d.eight) == b'\x08' assert d.one == "one" assert int(d.one) == 1 assert raises(d.build, "unknown") == MappingError assert raises(lambda: d.missing) == AttributeError def test_enum_enum34() -> None: import enum class E(enum.IntEnum): a = 1 class F(enum.IntEnum): b = 2 d = Enum(Byte, E, F) common(d, b"\x01", "a", 1) common(d, b"\x02", "b", 1) def test_enum_enum36() -> None: import enum class E(enum.IntEnum): a = 1 class F(enum.IntFlag): b = 2 d = Enum(Byte, E, F) common(d, b"\x01", "a", 1) common(d, b"\x02", "b", 1) def test_enum_issue_298() -> None: d = Struct( "ctrl" / Enum(Byte, NAK = 0x15, STX = 0x02, ), Probe(), "optional" / If(this.ctrl == "NAK", Byte), ) common(d, b"\x15\xff", Container(ctrl='NAK', optional=255)) common(d, b"\x02", Container(ctrl='STX', optional=None)) # FlagsEnum is not affected by same bug d = Struct( "flags" / FlagsEnum(Byte, a=1), Check(lambda ctx: ctx.flags == Container(_flagsenum=True, a=1)), ) common(d, b"\x01", dict(flags=Container(_flagsenum=True, a=True)), 1) # Flag is not affected by same bug d = Struct( "flag" / Flag, Check(lambda ctx: ctx.flag == True), ) common(d, b"\x01", dict(flag=True), 1) def test_enum_issue_677() -> None: d1 = Enum(Byte, one=1) common(d1, b"\xff", 255, 1) common(d1, b"\x01", EnumIntegerString.new(1, "one"), 1) assert isinstance(d1.parse(b"\x01"), EnumIntegerString) d2 = Enum(Byte, one=1).compile() common(d2, b"\xff", 255, 1) common(d2, b"\x01", EnumIntegerString.new(1, "one"), 1) assert isinstance(d2.parse(b"\x01"), EnumIntegerString) d3 = Struct("e" / Enum(Byte, one=1)) assert str(d3.parse(b"\x01")) == 'Container: \n e = (enum) one 1' assert str(d3.parse(b"\xff")) == 'Container: \n e = (enum) (unknown) 255' d4 = Struct("e" / Enum(Byte, one=1)).compile() assert str(d4.parse(b"\x01")) == 'Container: \n e = (enum) one 1' assert str(d4.parse(b"\xff")) == 'Container: \n e = (enum) (unknown) 255' def test_flagsenum() -> None: d = FlagsEnum(Byte, one=1, two=2, four=4, eight=8) common(d, b"\x03", Container(_flagsenum=True, one=True, two=True, four=False, eight=False), 1) assert d.build({}) == b'\x00' assert d.build(dict(one=True,two=True)) == b'\x03' assert d.build(8) == b'\x08' assert d.build(1|2) == b'\x03' assert d.build(255) == b"\xff" assert d.build(d.eight) == b'\x08' assert d.build(d.one|d.two) == b'\x03' assert raises(d.build, dict(unknown=True)) == MappingError assert raises(d.build, "unknown") == MappingError assert d.one == "one" assert d.one|d.two == "one|two" assert raises(lambda: d.missing) == AttributeError def test_flagsenum_enum34() -> None: import enum class E(enum.IntEnum): a = 1 class F(enum.IntEnum): b = 2 d = FlagsEnum(Byte, E, F) common(d, b"\x01", Container(_flagsenum=True, a=True,b=False), 1) common(d, b"\x02", Container(_flagsenum=True, a=False,b=True), 1) common(d, b"\x03", Container(_flagsenum=True, a=True,b=True), 1) def test_flagsenum_enum36() -> None: import enum class E(enum.IntEnum): a = 1 class F(enum.IntFlag): b = 2 d = FlagsEnum(Byte, E, F) common(d, b"\x01", Container(_flagsenum=True, a=True,b=False), 1) common(d, b"\x02", Container(_flagsenum=True, a=False,b=True), 1) common(d, b"\x03", Container(_flagsenum=True, a=True,b=True), 1) def test_mapping() -> None: x = object d = Mapping(Byte, {x:0}) common(d, b"\x00", x, 1) def test_struct() -> None: common(Struct(), b"", Container(), 0) common(Struct("a"/Int16ub, "b"/Int8ub), b"\x00\x01\x02", Container(a=1,b=2), 3) common(Struct("a"/Struct("b"/Byte)), b"\x01", Container(a=Container(b=1)), 1) common(Struct(Const(b"\x00"), Padding(1), Pass, Terminated), bytes(2), {}, SizeofError) assert raises(Struct("missingkey"/Byte).build, {}) == KeyError assert raises(Struct(Bytes(this.missing)).sizeof) == SizeofError d = Struct(Computed(7), Const(b"JPEG"), Pass, Terminated) assert d.build(None) == d.build({}) def test_struct_nested() -> None: d = Struct("a"/Byte, "b"/Int16ub, "inner"/Struct("c"/Byte, "d"/Byte)) common(d, b"\x01\x00\x02\x03\x04", Container(a=1,b=2,inner=Container(c=3,d=4)), 5) def test_struct_kwctor() -> None: d = Struct(a=Byte, b=Byte, c=Byte, d=Byte) common(d, b"\x01\x02\x03\x04", Container(a=1,b=2,c=3,d=4), 4) def test_struct_proper_context() -> None: # adjusted to support new embedding semantics d = Struct( "x"/Byte, "inner"/Struct( "y"/Byte, "a"/Computed(this._.x+1), "b"/Computed(this.y+2), ), "c"/Computed(this.x+3), "d"/Computed(this.inner.y+4), ) assert d.parse(b"\x01\x0f") == Container(x=1, inner=Container(y=15, a=2, b=17), c=4, d=19) def test_struct_sizeof_context_nesting() -> None: d = Struct( "a" / Computed(1), "inner" / Struct( "b" / Computed(2), Check(this._.a == 1), Check(this.b == 2), ), Check(this.a == 1), Check(this.inner.b == 2), ) d.sizeof() def test_sequence() -> None: common(Sequence(), b"", [], 0) common(Sequence(Int8ub, Int16ub), b"\x01\x00\x02", [1,2], 3) common(Int8ub >> Int16ub, b"\x01\x00\x02", [1,2], 3) d = Sequence(Computed(7), Const(b"JPEG"), Pass, Terminated) assert d.build(None) == d.build([None,None,None,None]) def test_sequence_nested() -> None: common(Sequence(Int8ub, Int16ub, Sequence(Int8ub, Int8ub)), b"\x01\x00\x02\x03\x04", [1,2,[3,4]], 5) def test_array() -> None: empty_list: t.List[int] = [] common(Byte[0], b"", empty_list, 0) common(Byte[4], b"1234", [49,50,51,52], 4) d = Array(3, Byte) common(d, b"\x01\x02\x03", [1,2,3], 3) assert d.parse(b"\x01\x02\x03additionalgarbage") == [1,2,3] assert raises(d.parse, b"") == StreamError assert raises(d.build, [1,2]) == RangeError assert raises(d.build, [1,2,3,4,5,6,7,8]) == RangeError d = Array(this.n, Byte) common(d, b"\x01\x02\x03", [1,2,3], 3, n=3) assert d.parse(b"\x01\x02\x03", n=3) == [1,2,3] assert d.parse(b"\x01\x02\x03additionalgarbage", n=3) == [1,2,3] assert raises(d.parse, b"", n=3) == StreamError assert raises(d.build, [1,2], n=3) == RangeError assert raises(d.build, [1,2,3,4,5,6,7,8], n=3) == RangeError assert raises(d.sizeof) == SizeofError assert raises(d.sizeof, n=3) == 3 def test_array_nontellable() -> None: assert Array(5, Byte).parse_stream(devzero) == [0,0,0,0,0] def test_greedyrange() -> None: empty_list: t.List[int] = [] common(GreedyRange(Byte), b"", empty_list, SizeofError) common(GreedyRange(Byte), b"\x01\x02", [1,2], SizeofError) assert GreedyRange(Byte, discard=False).parse(b"\x01\x02") == [1,2] assert GreedyRange(Byte, discard=True).parse(b"\x01\x02") == [] def test_repeatuntil() -> None: d = RepeatUntil(obj_ == 9, Byte) common(d, b"\x02\x03\x09", [2,3,9], SizeofError) assert d.parse(b"\x02\x03\x09additionalgarbage") == [2,3,9] assert raises(d.parse, b"\x02\x03\x08") == StreamError assert raises(d.build, [2,3,8]) == RepeatError d = RepeatUntil(lambda x,lst,ctx: lst[-2:] == [0,0], Byte) # d = RepeatUntil(lst_[-2:] == [0,0], Byte) assert d.parse(b"\x01\x00\x00\xff") == [1,0,0] assert d.build([1,0,0,4]) == b"\x01\x00\x00" d = RepeatUntil(True, Byte) assert d.parse(b"\x00") == [0] assert d.build([0]) == b"\x00" def test_const() -> None: common(Const(b"MZ"), b"MZ", b"MZ", 2) common(Const(b"MZ", Bytes(2)), b"MZ", b"MZ", 2) common(Const(255, Int32ul), b"\xff\x00\x00\x00", 255, 4) assert raises(Const(b"MZ").parse, b"???") == ConstError assert raises(Const(b"MZ").build, b"???") == ConstError assert raises(Const(255, Int32ul).parse, b"\x00\x00\x00\x00") == ConstError assert Struct(Const(b"MZ")).build({}) == b"MZ" # non-prefixed string literals are unicode on Python 3 assert raises(lambda: Const("no prefix string")) == StringError # type: ignore def test_computed() -> None: common(Computed(255), b"", 255, 0) common(Computed(lambda ctx: 255), b"", 255, 0) assert Computed(255).build(None) == b"" assert Struct(Computed(255)).build({}) == b"" assert raises(Computed(this.missing).parse, b"") == KeyError assert raises(Computed(this["missing"]).parse, b"") == KeyError def test_index() -> None: d1 = Array(3, Bytes(this._index+1)) common(d1, b"abbccc", [b"a", b"bb", b"ccc"]) d2 = GreedyRange(Bytes(this._index+1)) common(d2, b"abbccc", [b"a", b"bb", b"ccc"]) d3 = RepeatUntil(lambda o,l,ctx: ctx._index == 2, Bytes(this._index+1)) common(d3, b"abbccc", [b"a", b"bb", b"ccc"]) d4 = Array(3, Struct("i" / Index)) common(d4, b"", [Container(i=0),Container(i=1),Container(i=2)], 0) d5 = GreedyRange(Struct("i" / Index, "d" / Bytes(this.i+1))) common(d5, b"abbccc", [Container(i=0,d=b"a"),Container(i=1,d=b"bb"),Container(i=2,d=b"ccc")]) d6 = RepeatUntil(lambda o,l,ctx: ctx._index == 2, Index) common(d6, b"", [0,1,2]) def test_rebuild() -> None: d = Struct( "count" / Rebuild(Byte, len_(this.items)), "items"/Byte[this.count], ) assert d.parse(b"\x02ab") == Container(count=2, items=[97,98]) assert d.build(dict(count=None,items=[255])) == b"\x01\xff" assert d.build(dict(count=-1,items=[255])) == b"\x01\xff" assert d.build(dict(items=[255])) == b"\x01\xff" def test_rebuild_issue_664() -> None: d = Struct( "bytes" / Bytes(1), Check(this.bytes == b"\x00"), "bytesinteger" / BytesInteger(4), Check(this.bytesinteger == 255), "pascalstring" / PascalString(Byte, "utf8"), Check(this.pascalstring == u"text"), "enum" / Enum(Byte, label=255), Check(this.enum == "label"), "flagsenum" / FlagsEnum(Byte, label=255), Check(lambda this: this.flagsenum == Container(label=True)), "upfield" / Computed(200), "nestedstruct" / Struct( "nestedfield" / Computed(255), Check(this._.upfield == 200), Check(this.nestedfield == 255), ), Check(this.upfield == 200), Check(this.nestedstruct.nestedfield == 255), "sequence" / Sequence(Computed(1), Computed(2), Computed(3), Computed(4)), Check(this.sequence == [1,2,3,4]), "array" / Array(4, Byte), Check(this.array == [1,2,3,4]), "greedyrange" / GreedyRange(Byte), Check(this.greedyrange == [1,2,3,4]), "repeatuntil" / RepeatUntil(obj_ == 4, Byte), Check(this.repeatuntil == [1,2,3,4]), # Timestamp # Union # IfThenElse ) obj = Container( bytes = 0, bytesinteger = 255, pascalstring = u"text", enum = "label", flagsenum = {"label": True}, # nestedstruct = dict(), # sequence = [1,2,3,4], array = [1,2,3,4], greedyrange = [1,2,3,4], repeatuntil = [1,2,3,4], ) d.build(obj) def test_default() -> None: d = Default(Byte, 0) common(d, b"\xff", 255, 1) assert d.build(None) == b"\x00" def test_check() -> None: common(Check(True), b"", None, 0) common(Check(this.x == 255), b"", None, 0, x=255) common(Check(len_(this.a) == 3), b"", None, 0, a=[1,2,3]) assert raises(Check(False).parse, b"") == CheckError assert raises(Check(this.x == 255).parse, b"", x=0) == CheckError assert raises(Check(len_(this.a) == 3).parse, b"", a=[]) == CheckError def test_error() -> None: assert raises(Error.parse, b"") == ExplicitError assert raises(Error.build, None) == ExplicitError assert ("x"/Int8sb >> IfThenElse(this.x > 0, Int8sb, Error)).parse(b"\x01\x05") == [1,5] assert raises(("x"/Int8sb >> IfThenElse(this.x > 0, Int8sb, Error)).parse, b"\xff\x05") == ExplicitError def test_focusedseq() -> None: common(FocusedSeq("num", Const(b"MZ"), "num"/Byte, Terminated), b"MZ\xff", 255, SizeofError) common(FocusedSeq(this._.s, Const(b"MZ"), "num"/Byte, Terminated), b"MZ\xff", 255, SizeofError, s="num") d = FocusedSeq("missing", Pass) assert raises(d.parse, b"") == UnboundLocalError assert raises(d.build, {}) == UnboundLocalError assert raises(d.sizeof) == 0 d = FocusedSeq(this.missing, Pass) assert raises(d.parse, b"") == KeyError assert raises(d.build, {}) == KeyError assert raises(d.sizeof) == 0 def test_pickled() -> None: import pickle obj: t.List[t.Any] = [(), 1, 2.3, {}, [], bytes(1), ""] data = pickle.dumps(obj) common(Pickled, data, obj) def test_numpy() -> None: import numpy obj = numpy.array([1,2,3], dtype=numpy.int64) assert numpy.array_equal(Numpy.parse(Numpy.build(obj)), obj) @pytest.mark.xfail(reason="docs stated that it throws StreamError, not true at all") def test_numpy_error() -> None: import numpy, io numpy.load(io.BytesIO(b"")) # type: ignore def test_namedtuple() -> None: import collections coord = collections.namedtuple("coord", "x y z") d1 = NamedTuple("coord", "x y z", Array(3, Byte)) common(d1, b"123", coord(49,50,51), 3) d2 = NamedTuple("coord", "x y z", GreedyRange(Byte)) common(d2, b"123", coord(49,50,51), SizeofError) d3 = NamedTuple("coord", "x y z", Struct("x"/Byte, "y"/Byte, "z"/Byte)) common(d3, b"123", coord(49,50,51), 3) d4 = NamedTuple("coord", "x y z", Sequence(Byte, Byte, Byte)) common(d4, b"123", coord(49,50,51), 3) assert raises(lambda: NamedTuple("coord", "x y z", BitStruct("x"/Byte, "y"/Byte, "z"/Byte))) == NamedTupleError def test_timestamp() -> None: import arrow d1 = Timestamp(Int64ub, 1, 1970) common(d1, b'\x00\x00\x00\x00ZIz\x00', arrow.Arrow(2018,1,1), 8) d2 = Timestamp(Int64ub, 1, 1904) common(d2, b'\x00\x00\x00\x00\xd6o*\x80', arrow.Arrow(2018,1,1), 8) d3 = Timestamp(Int64ub, 10**-7, 1600) common(d3, b'\x01\xd4\xa2.\x1a\xa8\x00\x00', arrow.Arrow(2018,1,1), 8) d4 = Timestamp(Int32ub, "msdos", "msdos") common(d4, b'H9\x8c"', arrow.Arrow(2016,1,25,17,33,4), 4) def test_hex() -> None: d1 = Hex(Int32ub) common(d1, b"\x00\x00\x01\x02", 0x0102, 4) obj1 = d1.parse(b"\x00\x00\x01\x02") assert str(obj1) == "0x00000102" assert str(obj1) == "0x00000102" d2 = Hex(GreedyBytes) common(d2, b"\x00\x00\x01\x02", b"\x00\x00\x01\x02") common(d2, b"", b"") obj2 = d2.parse(b"\x00\x00\x01\x02") assert str(obj2) == "unhexlify('00000102')" assert str(obj2) == "unhexlify('00000102')" d3 = Hex(RawCopy(Int32ub)) common(d3, b"\x00\x00\x01\x02", dict(data=b"\x00\x00\x01\x02", value=0x0102, offset1=0, offset2=4, length=4), 4) obj3 = d3.parse(b"\x00\x00\x01\x02") assert str(obj3) == "unhexlify('00000102')" assert str(obj3) == "unhexlify('00000102')" def test_hexdump() -> None: d1 = HexDump(GreedyBytes) common(d1, b"abcdef", b"abcdef") common(d1, b"", b"") obj1 = d1.parse(b"\x00\x00\x01\x02") repr = \ '''hexundump(""" 0000 00 00 01 02 .... """) ''' pass assert str(obj1) == repr assert str(obj1) == repr d2 = HexDump(RawCopy(Int32ub)) common(d2, b"\x00\x00\x01\x02", dict(data=b"\x00\x00\x01\x02", value=0x0102, offset1=0, offset2=4, length=4), 4) obj2 = d2.parse(b"\x00\x00\x01\x02") repr = \ '''hexundump(""" 0000 00 00 01 02 .... """) ''' assert str(obj2) == repr assert str(obj2) == repr def test_hexdump_regression_issue_188() -> None: # Hex HexDump were not inheriting subcon flags d = Struct(Hex(Const(b"MZ"))) assert d.parse(b"MZ") == Container() assert d.build(dict()) == b"MZ" d = Struct(HexDump(Const(b"MZ"))) assert d.parse(b"MZ") == Container() assert d.build(dict()) == b"MZ" def test_union() -> None: d = Union(None, "a"/Bytes(2), "b"/Int16ub) assert d.parse(b"\x01\x02") == Container(a=b"\x01\x02", b=0x0102) assert raises(Union(123, Pass).parse, b"") == KeyError assert raises(Union("missing", Pass).parse, b"") == KeyError assert d.build(dict(a=b"zz")) == b"zz" assert d.build(dict(b=0x0102)) == b"\x01\x02" assert raises(d.build, {}) == UnionError d = Union(None, "a"/Bytes(2), "b"/Int16ub, Pass) assert d.build({}) == b"" # build skips parsefrom, invalid or not assert raises(Union(123, Pass).build, {}) == b"" assert raises(Union("missing", Pass).build, {}) == b"" assert raises(Union(None, Byte).sizeof) == SizeofError assert raises(Union(None, VarInt).sizeof) == SizeofError assert raises(Union(0, Byte, VarInt).sizeof) == SizeofError assert raises(Union(1, Byte, VarInt).sizeof) == SizeofError assert raises(Union(123, Pass).sizeof) == SizeofError assert raises(Union("missing", Pass).sizeof) == SizeofError assert raises(Union(this.missing, Pass).sizeof) == SizeofError # regression check, so first subcon is not parsefrom by accident assert raises(Union, Byte, VarInt) == UnionError def test_union_kwctor() -> None: d = Union(None, a=Int8ub, b=Int16ub, c=Int32ub) assert d.parse(b"\x01\x02\x03\x04") == Container(a=0x01,b=0x0102,c=0x01020304) assert d.build(Container(c=0x01020304)) == b"\x01\x02\x03\x04" def test_union_issue_348() -> None: d = Union(None, Int8=Prefixed(Int16ub, GreedyRange(Int8ub)), Int16=Prefixed(Int16ub, GreedyRange(Int16ub)), Int32=Prefixed(Int16ub, GreedyRange(Int32ub)), ) assert d.parse(b'\x00\x04\x11\x22\x33\x44') == {'Int16': [4386, 13124], 'Int32': [287454020], 'Int8': [17, 34, 51, 68]} assert d.build(dict(Int16=[4386, 13124])) == b'\x00\x04\x11\x22\x33\x44' assert d.build(dict(Int32=[287454020])) == b'\x00\x04\x11\x22\x33\x44' def test_select() -> None: d = Select(Int32ub, Int16ub, Int8ub) common(d, b"\x00\x00\x00\x07", 7) assert raises(Select(Int32ub, Int16ub).parse, b"") == SelectError assert raises(Select(Byte).sizeof) == SizeofError def test_select_kwctor() -> None: d = Select(a=Int8ub, b=Int16ub, c=Int32ub) assert d.parse(b"\x01\x02\x03\x04") == 0x01 assert d.build(0x01020304) == b"\x01\x02\x03\x04" def test_optional() -> None: d = Optional(Int32ul) assert d.parse(b"\x01\x00\x00\x00") == 1 assert d.build(1) == b"\x01\x00\x00\x00" assert d.parse(b"???") == None assert d.parse(b"") == None assert d.build(None) == b"" assert raises(d.sizeof) == SizeofError def test_optional_in_struct_issue_747() -> None: d = Struct("field" / Optional(Int32ul)) assert d.parse(b"\x01\x00\x00\x00") == {"field": 1} assert d.build({"field": 1}) == b"\x01\x00\x00\x00" assert d.parse(b"???") == {"field": None} assert d.build({"field": None}) == b"" assert d.parse(b"") == {"field": None} assert raises(d.sizeof) == SizeofError def test_optional_in_bit_struct_issue_747() -> None: d = BitStruct("field" / Optional(Octet)) assert d.parse(b"\x01") == {"field": 1} assert d.build({"field": 1}) == b"\x01" assert d.parse(b"???") == {"field": ord("?")} assert d.build({"field": None}) == b"" assert d.parse(b"") == {"field": None} assert raises(d.sizeof) == SizeofError def test_select_buildfromnone_issue_747() -> None: d = Struct("select" / Select(Int32ub, Default(Bytes(3), b"abc"))) assert d.parse(b"def") == dict(select=b"def") assert d.parse(b"\x01\x02\x03\x04") == dict(select=0x01020304) assert d.build(dict(select=b"def")) == b"def" assert d.build(dict(select=0xbeefcace)) == b"\xbe\xef\xca\xce" assert d.build(dict()) == b"abc" d = Struct("opt" / Optional(Byte)) assert d.build(dict(opt=1)) == b"\x01" assert d.build(dict()) == b"" def test_if() -> None: common(If(True, Byte), b"\x01", 1, 1) common(If(False, Byte), b"", None, 0) def test_ifthenelse() -> None: common(IfThenElse(True, Int8ub, Int16ub), b"\x01", 1, 1) common(IfThenElse(False, Int8ub, Int16ub), b"\x00\x01", 1, 2) def test_switch() -> None: d = Switch(this.x, {1:Int8ub, 2:Int16ub, 4:Int32ub}) common(d, b"\x01", 0x01, 1, x=1) common(d, b"\x01\x02", 0x0102, 2, x=2) assert d.parse(b"", x=255) == None assert d.build(None, x=255) == b"" assert raises(d.sizeof) == SizeofError assert raises(d.sizeof, x=1) == 1 d = Switch(this.x, {}, default=Byte) common(d, b"\x01", 1, 1, x=255) def test_switch_issue_357() -> None: inner = Struct( "computed" / Computed(4), ) inner2 = Struct( "computed" / Computed(7), ) st1 = Struct( "a" / inner, "b" / Switch(5, {1: inner2}, inner), Probe(), ) st2 = Struct( "a" / inner, "b" / Switch(5, {}, inner), Probe(), ) assert st1.parse(b"") == st2.parse(b"") def test_stopif() -> None: d1 = Struct("x"/Byte, StopIf(this.x == 0), "y"/Byte) common(d1, b"\x00", Container(x=0)) common(d1, b"\x01\x02", Container(x=1,y=2)) d2 = Sequence("x"/Byte, StopIf(this.x == 0), "y"/Byte) common(d2, b"\x01\x02", [1,None,2]) d3 = GreedyRange(FocusedSeq("x", "x"/Byte, StopIf(this.x == 0))) assert d3.parse(b"\x01\x00?????") == [1] assert d3.build([]) == b"" assert d3.build([0]) == b"\x00" assert d3.build([1]) == b"\x01" assert d3.build([1,0,2]) == b"\x01\x00" def test_padding() -> None: common(Padding(4), b"\x00\x00\x00\x00", None, 4) assert raises(Padding, 4, pattern=b"?????") == PaddingError assert raises(Padding, 4, pattern=u"?") == PaddingError def test_padded() -> None: common(Padded(4, Byte), b"\x01\x00\x00\x00", 1, 4) assert raises(Padded, 4, Byte, pattern=b"?????") == PaddingError assert raises(Padded, 4, Byte, pattern=u"?") == PaddingError assert Padded(4, VarInt).sizeof() == 4 assert Padded(4, Byte[this.missing]).sizeof() == 4 def test_aligned() -> None: common(Aligned(4, Byte), b"\x01\x00\x00\x00", 1, 4) common(Struct("a"/Aligned(4, Byte), "b"/Byte), b"\x01\x00\x00\x00\x02", Container(a=1, b=2), 5) assert Aligned(4, Int8ub).build(1) == b"\x01\x00\x00\x00" assert Aligned(4, Int16ub).build(1) == b"\x00\x01\x00\x00" assert Aligned(4, Int32ub).build(1) == b"\x00\x00\x00\x01" assert Aligned(4, Int64ub).build(1) == b"\x00\x00\x00\x00\x00\x00\x00\x01" d = Aligned(this.m, Byte) common(d, b"\xff\x00", 255, 2, m=2) assert raises(d.sizeof) == SizeofError assert raises(d.sizeof, m=2) == 2 def test_alignedstruct() -> None: d = AlignedStruct(4, "a"/Int8ub, "b"/Int16ub) common(d, b"\x01\x00\x00\x00\x00\x05\x00\x00", Container(a=1, b=5), 8) def test_bitstruct() -> None: d = BitStruct("a"/BitsInteger(3), "b"/Flag, Padding(3), "c"/Nibble, "d"/BitsInteger(5)) common(d, b"\xe1\x1f", Container(a=7, b=False, c=8, d=31), 2) d = BitStruct("a"/BitsInteger(3), "b"/Flag, Padding(3), "c"/Nibble, "sub"/Struct("d"/Nibble, "e"/Bit)) common(d, b"\xe1\x1f", Container(a=7, b=False, c=8, sub=Container(d=15, e=1)), 2) def test_pointer() -> None: common(Pointer(2, Byte), b"\x00\x00\x07", 7, 0) common(Pointer(lambda ctx: 2, Byte), b"\x00\x00\x07", 7, 0) d = Struct( 'inner' / Struct(), 'x' / Pointer(0, Byte, stream=this.inner._io), ) assert d.parse(bytes(20)).x == 0 def test_peek() -> None: d1 = Peek(Int8ub) assert d1.parse(b"\x01") == 1 assert d1.parse(b"") == None assert d1.build(1) == b"" assert d1.build(None) == b"" assert d1.sizeof() == 0 d2 = Peek(VarInt) assert d2.sizeof() == 0 d3 = Struct("a"/Peek(Int8ub), "b"/Int16ub) common(d3, b"\x01\x02", Container(a=0x01, b=0x0102), 2) d4 = Struct(Peek("a"/Byte), Peek("b"/Int16ub)) assert d4.parse(b"\x01\x02") == Container() assert d4.build(Container(a=0x01, b=0x0102)) == b"" assert d4.sizeof() == 0 def test_seek() -> None: d = Seek(5) assert d.parse(b"") == 5 assert d.build(None) == b"" assert (d >> Byte).parse(b"01234x") == [5,120] assert (d >> Byte).build([5,255]) == b"\x00\x00\x00\x00\x00\xff" assert (Bytes(10) >> d >> Byte).parse(b"0123456789") == [b"0123456789",5,ord('5')] assert (Bytes(10) >> d >> Byte).build([b"0123456789",None,255]) == b"01234\xff6789" assert Struct("data"/Bytes(10), d, "addin"/Byte).parse(b"0123456789") == Container(data=b"0123456789", addin=53) assert Struct("data"/Bytes(10), d, "addin"/Byte).build(dict(data=b"0123456789",addin=53)) == b"01234\x356789" assert (Seek(10,1) >> Seek(-5,1) >> Bytes(1)).parse(b"0123456789") == [10,5,b"5"] assert (Seek(10,1) >> Seek(-5,1) >> Bytes(1)).build([None,None,255]) == b"\x00\x00\x00\x00\x00\xff" assert raises(d.sizeof) == SizeofError def test_tell() -> None: d1 = Tell assert d1.parse(b"") == 0 assert d1.build(None) == b"" assert d1.sizeof() == 0 d2 = Struct("a"/Tell, "b"/Byte, "c"/Tell) assert d2.parse(b"\xff") == Container(a=0, b=255, c=1) assert d2.build(Container(a=0, b=255, c=1)) == b"\xff" assert d2.build(dict(b=255)) == b"\xff" def test_pass() -> None: common(Pass, b"", None, 0) common(Struct("empty"/Pass), b"", Container(empty=None), 0) def test_terminated() -> None: common(Terminated, b"", None, SizeofError) common(Struct(Terminated), b"", Container(), SizeofError) common(BitStruct(Terminated), b"", Container(), SizeofError) assert raises(Terminated.parse, b"x") == TerminatedError assert raises(Struct(Terminated).parse, b"x") == TerminatedError assert raises(BitStruct(Terminated).parse, b"x") == TerminatedError def test_rawcopy() -> None: d1 = RawCopy(Byte) assert d1.parse(b"\xff") == dict(data=b"\xff", value=255, offset1=0, offset2=1, length=1) assert d1.build(dict(data=b"\xff")) == b"\xff" assert d1.build(dict(value=255)) == b"\xff" assert d1.sizeof() == 1 d2 = RawCopy(Padding(1)) assert d2.build(None) == b'\x00' def test_rawcopy_issue_289() -> None: # When you build from a full dict that has all the keys, the if data kicks in, and replaces the context entry with a subset of a dict it had to begin with. d = Struct( "raw" / RawCopy(Struct("x"/Byte, "len"/Byte)), "array" / Byte[this.raw.value.len], ) print(d.parse(b"\x01\x02\xff\x00")) print(d.build(dict(raw=dict(value=dict(x=1, len=2)), array=[0xff, 0x01]))) print(d.build(d.parse(b"\x01\x02\xff\x00"))) # this is not buildable, array is not passed and cannot be deduced from raw data # print(d.build(dict(raw=dict(data=b"\x01\x02\xff\x00")))) def test_rawcopy_issue_358() -> None: # RawCopy overwritten context value with subcon return obj regardless of None d = Struct("a"/RawCopy(Byte), "check"/Check(this.a.value == 255)) assert d.build(dict(a=dict(value=255))) == b"\xff" def test_rawcopy_issue_888() -> None: # If you use build_file() on a RawCopy that has only a value defined, then # RawCopy._build may also attempt to read from the file, which won't work # if build_file opened the file for writing only. d = RawCopy(Byte) d.build_file(dict(value=0), filename="example_888") def test_byteswapped() -> None: d1 = ByteSwapped(Bytes(5)) common(d1, b"12345", b"54321", 5) d2 = ByteSwapped(Struct("a"/Byte, "b"/Byte)) common(d2, b"\x01\x02", Container(a=2, b=1), 2) def test_byteswapped_from_issue_70() -> None: d1 = ByteSwapped(BitStruct("flag1"/Bit, "flag2"/Bit, Padding(2), "number"/BitsInteger(16), Padding(4))) assert d1.parse(b'\xd0\xbc\xfa') == Container(flag1=1, flag2=1, number=0xabcd) d2 = BitStruct("flag1"/Bit, "flag2"/Bit, Padding(2), "number"/BitsInteger(16), Padding(4)) assert d2.parse(b'\xfa\xbc\xd1') == Container(flag1=1, flag2=1, number=0xabcd) def test_bitsswapped() -> None: d1 = BitsSwapped(Bytes(2)) common(d1, b"\x0f\x01", b"\xf0\x80", 2) d2 = Bitwise(Bytes(8)) common(d2, b"\xf2", b'\x01\x01\x01\x01\x00\x00\x01\x00', 1) d3 = BitsSwapped(Bitwise(Bytes(8))) common(d3, b"\xf2", b'\x00\x01\x00\x00\x01\x01\x01\x01', 1) d4 = BitStruct("a"/Nibble, "b"/Nibble) common(d4, b"\xf1", Container(a=15, b=1), 1) d5 = BitsSwapped(BitStruct("a"/Nibble, "b"/Nibble)) common(d5, b"\xf1", Container(a=8, b=15), 1) def test_prefixed() -> None: d1 = Prefixed(Byte, Int16ul) assert d1.parse(b"\x02\xff\xff??????") == 65535 assert d1.build(65535) == b"\x02\xff\xff" assert d1.sizeof() == 3 d2 = Prefixed(VarInt, GreedyBytes) assert d2.parse(b"\x03abc??????") == b"abc" assert d2.build(b"abc") == b'\x03abc' assert raises(d2.sizeof) == SizeofError d3 = Prefixed(Byte, Sequence(Peek(Byte), Int16ub, GreedyBytes)) assert d3.parse(b"\x02\x00\xff????????") == [0,255,b''] d4 = Prefixed(Byte, GreedyBytes) common(d4, b"\x0a"+bytes(10), bytes(10), SizeofError) d5 = Prefixed(Byte, GreedyString("utf-8")) common(d5, b"\x0a"+bytes(10), u"\x00"*10, SizeofError) def test_prefixedarray() -> None: d = PrefixedArray(Byte, Byte) common(d, b"\x02\x0a\x0b", [10,11], SizeofError) assert d.parse(b"\x03\x01\x02\x03") == [1,2,3] assert d.parse(b"\x00") == [] assert d.build([1,2,3]) == b"\x03\x01\x02\x03" assert raises(d.parse, b"") == StreamError assert raises(d.parse, b"\x03\x01") == StreamError assert raises(d.sizeof) == SizeofError def test_fixedsized() -> None: d1 = FixedSized(10, Byte) common(d1, b'\xff\x00\x00\x00\x00\x00\x00\x00\x00\x00', 255, 10) d2 = FixedSized(-255, Byte) assert raises(d2.parse, bytes(10)) == PaddingError assert raises(d2.build, 0) == PaddingError assert raises(d2.sizeof) == PaddingError d3 = FixedSized(10, GreedyBytes) common(d3, bytes(10), bytes(10), 10) d4 = FixedSized(10, GreedyString("utf-8")) common(d4, bytes(10), u"\x00"*10, 10) def test_nullterminated() -> None: d1 = NullTerminated(Byte) common(d1, b'\xff\x00', 255, SizeofError) d2 = NullTerminated(GreedyBytes, include=True) assert d2.parse(b'\xff\x00') == b'\xff\x00' d3 = NullTerminated(GreedyBytes, include=False) assert d3.parse(b'\xff\x00') == b'\xff' d4 = NullTerminated(GreedyBytes, consume=True) >> GreedyBytes assert d4.parse(b'\xff\x00') == [b'\xff', b''] d5 = NullTerminated(GreedyBytes, consume=False) >> GreedyBytes assert d5.parse(b'\xff\x00') == [b'\xff', b'\x00'] d6 = NullTerminated(GreedyBytes, require=True) assert raises(d6.parse, b'\xff') == StreamError d7 = NullTerminated(GreedyBytes, require=False) assert d7.parse(b'\xff') == b'\xff' d8 = NullTerminated(GreedyBytes) common(d8, bytes(1), b"", SizeofError) d9 = NullTerminated(GreedyString("utf-8")) common(d9, bytes(1), u"", SizeofError) d10 = NullTerminated(GreedyBytes, term=bytes(2)) common(d10, b"\x01\x00\x00\x02\x00\x00", b"\x01\x00\x00\x02", SizeofError) def test_nullstripped() -> None: d1 = NullStripped(GreedyBytes) common(d1, b'\xff', b'\xff', SizeofError) assert d1.parse(b'\xff\x00\x00') == b'\xff' assert d1.build(b'\xff') == b'\xff' d2 = NullStripped(GreedyBytes, pad=b'\x05') common(d2, b'\xff', b'\xff', SizeofError) assert d2.parse(b'\xff\x05\x05') == b'\xff' assert d2.build(b'\xff') == b'\xff' d3 = NullStripped(GreedyString("utf-8")) assert d3.parse(bytes(10)) == u"" assert d3.build(u"") == b"" d4 = NullStripped(GreedyBytes, pad=bytes(2)) assert d4.parse(bytes(10)) == b"" assert d4.parse(bytes(11)) == b"" def test_restreamdata() -> None: d1 = RestreamData(b"\x01", Int8ub) common(d1, b"", 1, 0) d2 = RestreamData(b"", Padding(1)) assert d2.build(None) == b'' d3 = RestreamData(io.BytesIO(b"\x01\x02"), Int16ub) assert d3.parse(b"\x01\x02\x00") == 0x0102 assert d3.build(None) == b'' d4 = RestreamData(NullTerminated(GreedyBytes), Int16ub) assert d4.parse(b"\x01\x02\x00") == 0x0102 assert d4.build(None) == b'' d5 = RestreamData(FixedSized(2, GreedyBytes), Int16ub) assert d5.parse(b"\x01\x02\x00") == 0x0102 assert d5.build(None) == b'' @pytest.mark.xfail(reason="unknown, either StreamError or KeyError due to this.entire or this._.entire") def test_restreamdata_issue_701() -> None: d1 = Struct( 'entire' / GreedyBytes, 'ac' / RestreamData(this.entire, Struct( 'a' / Byte, Bytes(len_(this._.entire)-1), 'c' / Byte, )), ) # StreamError: stream read less then specified amount, expected 1, found 0 assert d1.parse(b'\x01GGGGGGGGGG\x02') == Container(entire=b'\x01GGGGGGGGGG\x02', ac=Container(a=1,b=2)) d2 = FocusedSeq('ac', 'entire' / GreedyBytes, 'ac' / RestreamData(this.entire, Struct( 'a' / Byte, Bytes(len_(this._.entire)-1), 'c' / Byte, )), ) # KeyError: 'entire' assert d2.parse(b'\x01GGGGGGGGGG\x02') == Container(a=1,b=2) def test_transformed() -> None: d1 = Transformed(Bytes(16), bytes2bits, 2, bits2bytes, 2) common(d1, bytes(2), bytes(16), 2) d2 = Transformed(GreedyBytes, bytes2bits, None, bits2bytes, None) common(d2, bytes(2), bytes(16), SizeofError) d3 = Transformed(GreedyString("utf-8"), bytes2bits, None, bits2bytes, None) common(d3, bytes(2), u"\x00"*16, SizeofError) def test_transformed_issue_676() -> None: d = Struct( 'inner1' / BitStruct( 'a' / Default(BitsInteger(8), 0), ), 'inner2' / BitStruct( 'a' / Default(BitsInteger(lambda this: 8), 0), ), Probe(), Check(this.inner1.a == 0), Check(this.inner2.a == 0), ) d.build({}) def test_restreamed() -> None: d1 = Restreamed(Int16ub, ident, 1, ident, 1, ident) common(d1, b"\x00\x01", 1, 2) d2 = Restreamed(VarInt, ident, 1, ident, 1, ident) assert raises(d2.sizeof) == SizeofError d3 = Restreamed(Bytes(2), lambda b: b*2, 1, lambda b: b[0:1], 1, lambda n: n*2) common(d3, b"aa", b"aa", 4) def test_restreamed_partial_read() -> None: d = Restreamed(Bytes(255), ident, 1, ident, 1, ident) assert raises(d.parse, b"") == StreamError def test_processxor() -> None: d1 = ProcessXor(0, Int16ub) common(d1, b"\xf0\x0f", 0xf00f, 2) d2 = ProcessXor(0xf0, Int16ub) common(d2, b"\x00\xff", 0xf00f, 2) d3 = ProcessXor(bytes(10), Int16ub) common(d3, b"\xf0\x0f", 0xf00f, 2) d4 = ProcessXor(b"\xf0\xf0\xf0\xf0\xf0", Int16ub) common(d4, b"\x00\xff", 0xf00f, 2) d5 = ProcessXor(0xf0, GreedyBytes) common(d5, b"\x00\xff", b"\xf0\x0f", SizeofError) d6 = ProcessXor(b"\xf0\xf0\xf0\xf0\xf0", GreedyBytes) common(d6, b"\x00\xff", b"\xf0\x0f", SizeofError) d7 = ProcessXor(b"X", GreedyString("utf-8")) common(d7, b"\x00", u"X", SizeofError) d8 = ProcessXor(b"XXXXX", GreedyString("utf-8")) common(d8, b"\x00", u"X", SizeofError) def test_processrotateleft() -> None: d = ProcessRotateLeft(0, 1, GreedyBytes) common(d, bytes(10), bytes(10)) d = ProcessRotateLeft(0, 2, GreedyBytes) common(d, bytes(10), bytes(10)) d = ProcessRotateLeft(4, 1, GreedyBytes) common(d, b'\x0f\xf0', b'\xf0\x0f') d = ProcessRotateLeft(4, 2, GreedyBytes) common(d, b'\x0f\xf0', b'\xff\x00') def test_checksum() -> None: d = Struct( "fields" / RawCopy(Struct( "a" / Byte, "b" / Byte, )), "checksum" / Checksum(Bytes(64), lambda data: hashlib.sha512(data).digest(), this.fields.data), ) c = hashlib.sha512(b"\x01\x02").digest() assert d.parse(b"\x01\x02"+c) == Container(fields={"data": b"\x01\x02", "value": Container(a=1, b=2), "offset1": 0, "offset2": 2, "length": 2}, checksum=c) assert d.build(dict(fields=dict(data=b"\x01\x02"))) == b"\x01\x02"+c assert d.build(dict(fields=dict(value=dict(a=1,b=2)))) == b"\x01\x02"+c def test_checksum_nonbytes_issue_323() -> None: d = Struct( "vals" / Byte[2], "checksum" / Checksum(Byte, lambda vals: int(sum(vals)) & 0xFF, this.vals), ) assert d.parse(b"\x00\x00\x00") == Container(vals=[0, 0], checksum=0) assert raises(d.parse, b"\x00\x00\x01") == ChecksumError def test_checksum_warnings_issue_841() -> None: class ChecksumWarning(Warning): pass if t.TYPE_CHECKING: class Checksum2(Construct[ParsedType, BuildTypes]): def __init__( self, checksumfield: Construct[ParsedType, BuildTypes], hashfunc: t.Callable[[bytes], BuildTypes], bytesfunc: t.Callable[[Context], bytes] ) -> None: ... else: class Checksum2(Construct): def __init__(self, checksumfield, hashfunc, bytesfunc): super().__init__() self.checksumfield = checksumfield self.hashfunc = hashfunc self.bytesfunc = bytesfunc self.flagbuildnone = True def _parse(self, stream, context, path): hash1 = self.checksumfield._parsereport(stream, context, path) hash2 = self.hashfunc(self.bytesfunc(context)) if hash1 != hash2: import warnings warnings.warn( "wrong checksum, read %r, computed %r, path %s" % ( hash1 if not isinstance(hash1,bytestringtype) else binascii.hexlify(hash1), hash2 if not isinstance(hash2,bytestringtype) else binascii.hexlify(hash2), path), ChecksumWarning ) return hash1 def _build(self, obj, stream, context, path): hash2 = self.hashfunc(self.bytesfunc(context)) self.checksumfield._build(hash2, stream, context, path) return hash2 def _sizeof(self, context, path): return self.checksumfield._sizeof(context, path) d = Struct( "fields" / RawCopy(Struct( "a" / Byte, "b" / Byte, )), "checksum" / Checksum2(Bytes(64), lambda data: hashlib.sha512(data).digest(), this.fields.data), ) d.parse(bytes(66)) def test_compressed_zlib() -> None: zeros = bytes(10000) d = Compressed(GreedyBytes, "zlib") assert d.parse(d.build(zeros)) == zeros assert len(d.build(zeros)) < 50 assert raises(d.sizeof) == SizeofError d = Compressed(GreedyBytes, "zlib", level=9) assert d.parse(d.build(zeros)) == zeros assert len(d.build(zeros)) < 50 assert raises(d.sizeof) == SizeofError def test_compressed_gzip() -> None: zeros = bytes(10000) d = Compressed(GreedyBytes, "gzip") assert d.parse(d.build(zeros)) == zeros assert len(d.build(zeros)) < 50 assert raises(d.sizeof) == SizeofError d = Compressed(GreedyBytes, "gzip", level=9) assert d.parse(d.build(zeros)) == zeros assert len(d.build(zeros)) < 50 assert raises(d.sizeof) == SizeofError def test_compressed_bzip2() -> None: zeros = bytes(10000) d = Compressed(GreedyBytes, "bzip2") assert d.parse(d.build(zeros)) == zeros assert len(d.build(zeros)) < 50 assert raises(d.sizeof) == SizeofError d = Compressed(GreedyBytes, "bzip2", level=9) assert d.parse(d.build(zeros)) == zeros assert len(d.build(zeros)) < 50 assert raises(d.sizeof) == SizeofError def test_compressed_lzma() -> None: zeros = bytes(10000) d = Compressed(GreedyBytes, "lzma") assert d.parse(d.build(zeros)) == zeros assert len(d.build(zeros)) < 200 assert raises(d.sizeof) == SizeofError d = Compressed(GreedyBytes, "lzma", level=9) assert d.parse(d.build(zeros)) == zeros assert len(d.build(zeros)) < 200 assert raises(d.sizeof) == SizeofError def test_compressedlz4() -> None: zeros = bytes(10000) d = CompressedLZ4(GreedyBytes) assert d.parse(d.build(zeros)) == zeros assert len(d.build(zeros)) < 100 assert raises(d.sizeof) == SizeofError def test_compressed_prefixed() -> None: zeros = bytes(10000) d = Prefixed(VarInt, Compressed(GreedyBytes, "zlib")) st = Struct("one"/d, "two"/d) assert st.parse(st.build(Container(one=zeros,two=zeros))) == Container(one=zeros,two=zeros) assert raises(d.sizeof) == SizeofError def test_rebuffered() -> None: data = b"0" * 1000 assert Rebuffered(Array(1000,Byte)).parse_stream(io.BytesIO(data)) == [48]*1000 assert Rebuffered(Array(1000,Byte), tailcutoff=50).parse_stream(io.BytesIO(data)) == [48]*1000 assert Rebuffered(Byte).sizeof() == 1 assert raises(Rebuffered(Byte).sizeof) == 1 assert raises(Rebuffered(VarInt).sizeof) == SizeofError def test_lazy() -> None: d1 = Struct( 'dup' / Lazy(Computed(this.exists)), 'exists' / Computed(1), ) obj = d1.parse(b'') assert obj.dup() == 1 d2 = Lazy(Byte) x = d2.parse(b'\x00') assert x() == 0 assert d2.build(0) == b'\x00' assert d2.build(x) == b'\x00' assert d2.sizeof() == 1 def test_lazystruct() -> None: d = LazyStruct( "num1" / Int8ub, "num2" / BytesInteger(1), "prefixed1" / Prefixed(Byte, Byte), "prefixed2" / Prefixed(Byte, Byte, includelength=True), "prefixedarray" / PrefixedArray(Byte, Byte), ) obj = d.parse(b"\x00\x00\x01\x00\x02\x00\x01\x00") assert obj.num1 == obj["num1"] == obj[0] == 0 assert obj.num2 == obj["num2"] == obj[1] == 0 assert obj.prefixed1 == obj["prefixed1"] == obj[2] == 0 assert obj.prefixed2 == obj["prefixed2"] == obj[3] == 0 assert obj.prefixedarray == obj["prefixedarray"] == obj[4] == [0] assert len(obj) == 5 assert list(obj.keys()) == ['num1', 'num2', 'prefixed1', 'prefixed2', 'prefixedarray'] assert list(obj.values()) == [0, 0, 0, 0, [0]] assert list(obj.items()) == [('num1', 0), ('num2', 0), ('prefixed1', 0), ('prefixed2', 0), ('prefixedarray', [0])] assert repr(obj) == "" assert str(obj) == "" assert d.build(obj) == b"\x00\x00\x01\x00\x02\x00\x01\x00" assert d.build(Container(obj)) == b"\x00\x00\x01\x00\x02\x00\x01\x00" assert raises(d.sizeof) == SizeofError def test_lazyarray() -> None: d = LazyArray(5, Int8ub) obj = d.parse(b"\x00\x01\x02\x03\x04") assert repr(obj) == "" for i in range(5): assert obj[i] == i assert obj[:] == [0,1,2,3,4] assert obj == [0,1,2,3,4] assert list(obj) == [0,1,2,3,4] assert len(obj) == 5 assert repr(obj) == "" assert str(obj) == "" assert d.build([0,1,2,3,4]) == b"\x00\x01\x02\x03\x04" assert d.build(ListContainer([0,1,2,3,4])) == b"\x00\x01\x02\x03\x04" assert d.build(obj) == b"\x00\x01\x02\x03\x04" assert d.build(obj[:]) == b"\x00\x01\x02\x03\x04" assert d.sizeof() == 5 d = LazyArray(5, VarInt) obj = d.parse(b"\x00\x01\x02\x03\x04") assert repr(obj) == "" for i in range(5): assert obj[i] == i assert obj[:] == [0,1,2,3,4] assert obj == [0,1,2,3,4] assert list(obj) == [0,1,2,3,4] assert len(obj) == 5 assert repr(obj) == "" assert str(obj) == "" assert d.build([0,1,2,3,4]) == b"\x00\x01\x02\x03\x04" assert d.build(ListContainer([0,1,2,3,4])) == b"\x00\x01\x02\x03\x04" assert d.build(obj) == b"\x00\x01\x02\x03\x04" assert d.build(obj[:]) == b"\x00\x01\x02\x03\x04" assert raises(d.sizeof) == SizeofError def test_lazybound() -> None: d1 = LazyBound(lambda: Byte) common(d1, b"\x01", 1) d2 = Struct( "value" / Byte, "next" / If(this.value > 0, LazyBound(lambda: d2)), ) common(d2, b"\x05\x09\x00", Container(value=5, next=Container(value=9, next=Container(value=0, next=None)))) d3 = Struct( "value" / Byte, "next" / GreedyBytes, ) data = b"\x05\x09\x00" while data: x = d3.parse(data) data = x.next print(x) def test_expradapter() -> None: MulDiv = ExprAdapter(Byte, obj_ * 7, obj_ // 7) assert MulDiv.parse(b"\x06") == 42 assert MulDiv.build(42) == b"\x06" assert MulDiv.sizeof() == 1 Ident = ExprAdapter(Byte, obj_-1, obj_+1) assert Ident.parse(b"\x02") == 1 assert Ident.build(1) == b"\x02" assert Ident.sizeof() == 1 def test_exprsymmetricadapter() -> None: pass def test_exprvalidator() -> None: One = ExprValidator(Byte, lambda obj,ctx: obj in [1,3,5]) assert One.parse(b"\x01") == 1 assert raises(One.parse, b"\xff") == ValidationError assert One.build(5) == b"\x05" assert raises(One.build, 255) == ValidationError assert One.sizeof() == 1 def test_ipaddress_adapter_issue_95() -> None: if t.TYPE_CHECKING: class IpAddressAdapter(Adapter[ListContainer[int], t.List[int], str, str]): ... else: class IpAddressAdapter(Adapter): def _encode(self, obj, context, path): return list(map(int, obj.split("."))) def _decode(self, obj, context, path): return "{0}.{1}.{2}.{3}".format(*obj) IpAddress2 = IpAddressAdapter(Byte[4]) assert IpAddress2.parse(b"\x7f\x80\x81\x82") == "127.128.129.130" assert IpAddress2.build("127.1.2.3") == b"\x7f\x01\x02\x03" assert IpAddress2.sizeof() == 4 def encoder(obj: str, ctx: "Context") -> t.List[int]: return list(map(int, str(obj).split("."))) IpAddress = ExprAdapter(Byte[4], encoder = encoder, decoder = lambda obj,ctx: "{0}.{1}.{2}.{3}".format(*obj), ) assert IpAddress.parse(b"\x7f\x80\x81\x82") == "127.128.129.130" assert IpAddress.build("127.1.2.3") == b"\x7f\x01\x02\x03" assert IpAddress.sizeof() == 4 def test_oneof() -> None: assert OneOf(Byte,[4,5,6,7]).parse(b"\x05") == 5 assert OneOf(Byte,[4,5,6,7]).build(5) == b"\x05" assert raises(OneOf(Byte,[4,5,6,7]).parse, b"\x08") == ValidationError assert raises(OneOf(Byte,[4,5,6,7]).build, 8) == ValidationError def test_noneof() -> None: assert NoneOf(Byte,[4,5,6,7]).parse(b"\x08") == 8 assert raises(NoneOf(Byte,[4,5,6,7]).parse, b"\x06") == ValidationError def test_filter() -> None: d = Filter(obj_ != 0, GreedyRange(Byte)) assert d.parse(b"\x00\x02\x00") == [2] assert d.build([0,1,0,2,0]) == b"\x01\x02" def test_slicing() -> None: d = Slicing(Array(4,Byte), 4, 1, 3, empty=0) assert d.parse(b"\x01\x02\x03\x04") == [2,3] assert d.build([2,3]) == b"\x00\x02\x03\x00" assert d.sizeof() == 4 def test_indexing() -> None: d = Indexing(Array(4,Byte), 4, 2, empty=0) assert d.parse(b"\x01\x02\x03\x04") == 3 assert d.build(3) == b"\x00\x00\x03\x00" assert d.sizeof() == 4 def test_probe() -> None: common(Probe(), b"", None, 0) common(Probe(lookahead=32), b"", None, 0) common(Struct(Probe()), b"", {}, 0) common(Struct(Probe(lookahead=32)), b"", {}, 0) common(Struct("value"/Computed(7), Probe(this.value)), b"", dict(value=7), 0) def test_debugger() -> None: common(Debugger(Byte), b"\xff", 255, 1) def test_repr() -> None: assert repr(Byte) == '' assert repr("num"/Byte) == '>' assert repr(Default(Byte, 0)) == '>' assert repr(Struct()) == '' def test_operators() -> None: common(Struct("new" / ("old" / Byte)), b"\x01", Container(new=1), 1) common(Struct(Renamed(Renamed(Byte, newname="old"), newname="new")), b"\x01", Container(new=1), 1) common(Array(4, Byte), b"\x01\x02\x03\x04", [1,2,3,4], 4) common(Byte[4], b"\x01\x02\x03\x04", [1,2,3,4], 4) common(Struct("nums" / Byte[4]), b"\x01\x02\x03\x04", Container(nums=[1,2,3,4]), 4) common(Int8ub >> Int16ub, b"\x01\x00\x02", [1,2], 3) common(Int8ub >> Int16ub >> Int32ub, b"\x01\x00\x02\x00\x00\x00\x03", [1,2,3], 7) common(Int8ub[2] >> Int16ub[2], b"\x01\x02\x00\x03\x00\x04", [[1,2],[3,4]], 6) common(Sequence(Int8ub) >> Sequence(Int16ub), b"\x01\x00\x02", [1,2], 3) common(Struct("count"/Byte, "items"/Byte[this.count], Pass, Terminated), b"\x03\x01\x02\x03", Container(count=3, items=[1,2,3]), SizeofError) common("count"/Byte + "items"/Byte[this.count] + Pass + Terminated, b"\x03\x01\x02\x03", Container(count=3, items=[1,2,3]), SizeofError) common(Struct(a=Byte) + Struct(b=Byte), b"\x01\x02", Container(a=1, b=2), 2) d = Byte * "description" assert d.docs == "description" d = "description" * Byte assert d.docs == "description" """ description """ * \ Byte assert d.docs == "description" d = Renamed(Renamed(Byte, newdocs="old"), newdocs="new") assert d.docs == "new" def test_operators_issue_87() -> None: assert ("string_name" / Byte).parse(b"\x01") == 1 assert (u"unicode_name" / Byte).parse(b"\x01") == 1 assert (b"bytes_name" / Byte).parse(b"\x01") == 1 assert (None / Byte).parse(b"\x01") == 1 def test_from_issue_76() -> None: d = Aligned(4, Struct("a"/Byte, "f"/Bytes(lambda ctx: ctx.a))) common(d, b"\x02\xab\xcd\x00", Container(a=2, f=b"\xab\xcd")) def test_from_issue_60() -> None: Header = Struct( "type" / Int8ub, "size" / Switch(lambda ctx: ctx.type, { 0: Int8ub, 1: Int16ub, 2: Int32ub, }), "length" / Tell, ) assert Header.parse(b"\x00\x05") == Container(type=0, size=5, length=2) assert Header.parse(b"\x01\x00\x05") == Container(type=1, size=5, length=3) assert Header.parse(b"\x02\x00\x00\x00\x05") == Container(type=2, size=5, length=5) assert Header.build(dict(type=0, size=5)) == b"\x00\x05" assert Header.build(dict(type=1, size=5)) == b"\x01\x00\x05" assert Header.build(dict(type=2, size=5)) == b"\x02\x00\x00\x00\x05" def test_from_issue_171() -> None: attributes = BitStruct( "attr" / Aligned(8, Array(3, Struct( "attrCode" / BitsInteger(16), "attrValue" / Switch(this.attrCode, { 34: BitsInteger(8), 205: BitsInteger(2), 512: BitsInteger(2), }), ))), ) blob = b"\x00\x22\x82\x00\xCD\x80\x80\x10" assert attributes.parse(blob) == Container(attr=[ Container(attrCode=34, attrValue=130), Container(attrCode=205, attrValue=2), Container(attrCode=512, attrValue=1), ]) def test_from_issue_175() -> None: @FuncPath def comp_(num_array: t.List[int]) -> int: return sum(x << ((len(num_array)-1-i)*8) for i,x in enumerate(num_array)) test = Struct( "numArray" / RepeatUntil(obj_ < 128, Byte), "value" / Computed(comp_(this.numArray)) ) assert test.parse(b'\x87\x0f').value == 34575 def test_from_issue_71() -> None: Inner = Struct( 'name' / PascalString(Byte, "utf8"), 'occupation' / PascalString(Byte, "utf8"), ) Outer = Struct( 'struct_type' / Int16ub, 'payload_len' / Int16ub, 'payload' / RawCopy(Inner), 'serial' / Int16ub, 'checksum' / Checksum(Bytes(64), lambda data: hashlib.sha512(data).digest(), this.payload.data), Check(len_(this.payload.data) == this.payload_len), Terminated, ) payload = Inner.build(Container( name=u"unknown", occupation=u"worker", )) Outer.build(Container( struct_type=9001, payload_len=len(payload), payload=Container(data=payload), serial=12345, )) def test_from_issue_231() -> None: u = Union(0, "raw"/Byte[8], "ints"/Int[2]) s = Struct("u"/u, "d"/Byte[4]) buildret = s.build(dict(u=dict(ints=[1,2]),d=[0,1,2,3])) assert buildret == b"\x00\x00\x00\x01\x00\x00\x00\x02\x00\x01\x02\x03" assert s.build(s.parse(buildret)) == buildret def test_from_issue_246() -> None: NumVertices1 = Bitwise(Aligned(8, Struct( 'numVx4' / BitsInteger(4), 'numVx8' / If(this.numVx4 == 0, BitsInteger(8)), 'numVx16' / If(this.numVx4 == 0 & this.numVx8 == 255, BitsInteger(16)), ))) common(NumVertices1, b'\x02\x30', Container(numVx4=0, numVx8=35, numVx16=None)) testBit = BitStruct( 'a' / BitsInteger(8), 'b' / If(this.a == 97, BitsInteger(8)) ) testByte = Struct( 'a' / Byte, 'b' / If(this.a == 97, Byte) ) common(testBit, b'ab', Container(a=97, b=98)) common(testByte, b'ab', Container(a=97, b=98)) NumVertices2 = Union(None, 'numVx4' / Bitwise(Aligned(8, Struct('num'/ BitsInteger(4) ))), 'numVx8' / Bitwise(Aligned(8, Struct('num'/ BitsInteger(12)))), 'numVx16'/ Bitwise(Aligned(8, Struct('num'/ BitsInteger(28)))), ) assert NumVertices2.parse(b'\x01\x34\x56\x70') == Container(numVx4=Container(num=0), numVx8=Container(num=19), numVx16=Container(num=1262951)) def test_from_issue_244() -> None: if t.TYPE_CHECKING: # class IpAddressAdapter(Adapter[ListContainer[int], t.List[int], str, str]): ... class AddIndexes(Adapter[ListContainer[t.Any], t.List[t.Any], ListContainer[t.Any], t.List[t.Any]]): ... else: class AddIndexes(Adapter): def _decode(self, obj, context, path): for i,con in enumerate(obj): con.index = i return obj d = AddIndexes(Struct("num"/Byte)[4]) assert d.parse(b"abcd") == [Container(num=97, index=0),Container(num=98, index=1),Container(num=99, index=2),Container(num=100, index=3),] def test_from_issue_269() -> None: d = Struct("enabled" / Byte, If(this.enabled, Padding(2))) assert d.build(dict(enabled=1)) == b"\x01\x00\x00" assert d.build(dict(enabled=0)) == b"\x00" d = Struct("enabled" / Byte, "pad" / If(this.enabled, Padding(2))) assert d.build(dict(enabled=1)) == b"\x01\x00\x00" assert d.build(dict(enabled=0)) == b"\x00" def test_hanging_issue_280() -> None: d = BitStruct('a'/BitsInteger(20), 'b'/BitsInteger(12)) assert raises(d.parse, b'\x00') == StreamError def test_from_issue_324() -> None: d = Struct( "vals" / Prefixed(Byte, RawCopy( Struct("a" / Byte[2]), )), "checksum" / Checksum( Byte, lambda data: int(sum(data)) & 0xFF, this.vals.data ), ) assert d.build(dict(vals=dict(value=dict(a=[0,1])))) == b"\x02\x00\x01\x01" assert d.build(dict(vals=dict(data=b"\x00\x01"))) == b"\x02\x00\x01\x01" def test_from_issue_357() -> None: inner = Struct( "computed" / Computed(4), ) st1 = Struct( "a" / inner, Check(this.a.computed == 4), ) st2 = Struct( "b" / Switch(0, {}, inner), Check(this.b.computed == 4), ) assert st1.build(dict(a={})) == b"" assert st2.build(dict(b={})) == b"" def test_context_is_container() -> None: d = Struct(Check(lambda ctx: type(ctx) is Container)) d.parse(b"") def test_from_issue_362() -> None: FORMAT = Struct( "my_tell" / Tell, "my_byte" / Byte, ) BIT_FORMAT = BitStruct( "my_tell" / Tell, "my_bits" / Bit[8], ) for _ in range(5): assert FORMAT.parse(b'\x00').my_tell == 0 for _ in range(5): assert BIT_FORMAT.parse(b'\x00').my_tell == 0 @pytest.mark.xfail(raises=AttributeError, reason="can't access Enums inside BitStruct") def test_from_issue_781() -> None: d1 = Struct( "animal" / Enum(Byte, giraffe=1), ) x = d1.parse(b"\x01") assert x.animal == "giraffe" # works assert x.animal == d1.animal.giraffe # works d2 = BitStruct( "animal" / Enum(BitsInteger(8), giraffe=1), ) x = d2.parse(b"\x01") assert x.animal == "giraffe" # works assert x.animal == d2.animal.giraffe # type: ignore # AttributeError: 'Transformed' object has no attribute 'animal' def test_this_expresion_compare_container() -> None: st = Struct( "flags" / FlagsEnum(Byte, a=1), Check(lambda this: this.flags == Container(_flagsenum=True, a=1)), ) common(st, b"\x01", dict(flags=Container(_flagsenum=True, a=True)), 1) def test_pickling_constructs() -> None: import cloudpickle # type: ignore d = Struct( "count" / Byte, "greedybytes" / Prefixed(Byte, GreedyBytes), "formatfield" / FormatField("=","Q"), "bytesinteger" / BytesInteger(1), "varint" / VarInt, "text1" / PascalString(Byte, "utf8"), "text2" / CString("utf8"), "enum" / Enum(Byte, zero=0), "flagsenum" / FlagsEnum(Byte, zero=0), "array1" / Byte[5], "array2" / Byte[this.count], "greedyrange" / Prefixed(Byte, GreedyRange(Byte)), "if1" / IfThenElse(True, Byte, Byte), "padding" / Padding(1), "peek" / Peek(Byte), "tell" / Tell, "this1" / Byte[this.count], "obj_1" / RepeatUntil(obj_ == 0, Byte), "len_1" / Computed(len_(this.array1)), ) data = bytes(100) du = cloudpickle.loads(cloudpickle.dumps(d, protocol=-1)) assert du.parse(data) == d.parse(data) def test_pickling_constructs_issue_894() -> None: import cloudpickle fundus_header = Struct( 'width' / Int32un, 'height' / Int32un, 'bits_per_pixel' / Int32un, 'number_slices' / Int32un, 'unknown' / PaddedString(4, 'ascii'), 'size' / Int32un, 'img' / Int8un, ) cloudpickle.dumps(fundus_header) def test_exposing_members_attributes() -> None: d1 = Struct( "animal" / Enum(Byte, giraffe=1), ) assert d1.animal.giraffe == "giraffe" assert isinstance(d1.animal.subcon, Enum) assert isinstance(d1.animal, Renamed) d2 = Sequence( "animal" / Enum(Byte, giraffe=1), ) assert d2.animal.giraffe == "giraffe" assert isinstance(d2.animal.subcon, Enum) assert isinstance(d2.animal, Renamed) d3 = FocusedSeq("", "animal" / Enum(Byte, giraffe=1), ) assert d3.animal.giraffe == "giraffe" assert isinstance(d3.animal.subcon, Enum) assert isinstance(d3.animal, Renamed) d4 = Union(None, "animal" / Enum(Byte, giraffe=1), ) assert d4.animal.giraffe == "giraffe" assert isinstance(d4.animal.subcon, Enum) assert isinstance(d4.animal, Renamed) def test_exposing_members_context() -> None: d1 = Struct( "count" / Byte, "data" / Bytes(lambda this: this.count - this._subcons.count.sizeof()), Check(lambda this: this._subcons.count.sizeof() == 1), ) common(d1, b"\x05four", Container(count=5, data=b"four")) d2 = Sequence( "count" / Byte, "data" / Bytes(lambda this: this.count - this._subcons.count.sizeof()), Check(lambda this: this._subcons.count.sizeof() == 1), ) common(d2, b"\x05four", [5,b"four",None]) d3 = FocusedSeq("count", "count" / Byte, "data" / Padding(lambda this: this.count - this._subcons.count.sizeof()), Check(lambda this: this._subcons.count.sizeof() == 1), ) common(d3, b'\x04\x00\x00\x00', 4, SizeofError) d4 = Union(None, "chars" / Byte[4], "data" / Bytes(lambda this: this._subcons.chars.sizeof()), Check(lambda this: this._subcons.chars.sizeof() == 4), ) assert d4.parse(b"\x01\x02\x03\x04") == dict(chars=[1,2,3,4],data=b"\x01\x02\x03\x04") def test_isparsingbuilding() -> None: d1 = Struct( Check(this._parsing & this._._parsing), Check(~this._building & ~this._._building), Check(~this._sizing & ~this._._sizing), ) d1.parse(b'') d2 = Struct( Check(~this._parsing & ~this._._parsing), Check(this._building & this._._building), Check(~this._sizing & ~this._._sizing), ) d2.build(None) d3 = Struct( Check(~this._parsing & ~this._._parsing), Check(~this._building & ~this._._building), Check(this._sizing & this._._sizing), ) d3.sizeof() # --------------------------------- d4 = Sequence( Check(this._parsing & this._._parsing), Check(~this._building & ~this._._building), Check(~this._sizing & ~this._._sizing), ) d4.parse(b'') d5 = Sequence( Check(~this._parsing & ~this._._parsing), Check(this._building & this._._building), Check(~this._sizing & ~this._._sizing), ) d5.build(None) d6 = Sequence( Check(~this._parsing & ~this._._parsing), Check(~this._building & ~this._._building), Check(this._sizing & this._._sizing), ) d6.sizeof() # --------------------------------- d7 = FocusedSeq("none", "none" / Pass, Check(this._parsing & this._._parsing), Check(~this._building & ~this._._building), Check(~this._sizing & ~this._._sizing), ) d7.parse(b'') d8 = FocusedSeq("none", "none" / Pass, Check(~this._parsing & ~this._._parsing), Check(this._building & this._._building), Check(~this._sizing & ~this._._sizing), ) d8.build(None) d9 = FocusedSeq("none", "none" / Pass, Check(~this._parsing & ~this._._parsing), Check(~this._building & ~this._._building), Check(this._sizing & this._._sizing), ) d9.sizeof() # --------------------------------- d10 = Union(None, "none" / Pass, Check(this._parsing & this._._parsing), Check(~this._building & ~this._._building), Check(~this._sizing & ~this._._sizing), ) d10.parse(b'') d11 = Union(None, "none" / Pass, Check(~this._parsing & ~this._._parsing), Check(this._building & this._._building), Check(~this._sizing & ~this._._sizing), ) d11.build(dict(none=None)) d12 = Union(None, "none" / Pass, Check(~this._parsing & ~this._._parsing), Check(~this._building & ~this._._building), Check(this._sizing & this._._sizing), ) # doesnt check context because _sizeof just raises the error assert raises(d12.sizeof) == SizeofError # --------------------------------- d13 = LazyStruct( Check(this._parsing & this._._parsing), Check(~this._building & ~this._._building), Check(~this._sizing & ~this._._sizing), ) d13.parse(b'') d14 = LazyStruct( Check(~this._parsing & ~this._._parsing), Check(this._building & this._._building), Check(~this._sizing & ~this._._sizing), ) d14.build({}) d15 = LazyStruct( Check(~this._parsing & ~this._._parsing), Check(~this._building & ~this._._building), Check(this._sizing & this._._sizing), ) d15.sizeof() def test_struct_stream() -> None: d = Struct( 'fixed' / FixedSized(10, Struct( 'data' / GreedyBytes, # check a substream Check(lambda this: stream_size(this._io) == 10), Check(lambda this: stream_iseof(this._io)), # checks parent original stream Check(lambda this: stream_size(this._._io) == 20), Check(lambda this: not stream_iseof(this._._io)), )), # checks mid-parsing Check(lambda this: stream_tell(this._io, None) == 10), Check(lambda this: stream_size(this._io) == 20), Check(lambda this: not stream_iseof(this._io)), 'rest' / GreedyBytes, # checks after parsed to EOF Check(lambda this: stream_tell(this._io, None) == 20), Check(lambda this: stream_size(this._io) == 20), Check(lambda this: stream_iseof(this._io)), Check(lambda this: stream_seek(this._io, 0, 2, None) == 20), # checks nested struct stream Check(lambda this: stream_tell(this.fixed._io, None) == 10), Check(lambda this: stream_size(this.fixed._io) == 10), ) d.parse(bytes(20)) d = Struct() d.parse(bytes(20)) d.parse_stream(devzero) def test_struct_root_topmost() -> None: d = Struct( 'x' / Computed(1), 'inner' / Struct( 'inner2' / Struct( 'x' / Computed(this._root.x), 'z' / Computed(this._params.z), 'zz' / Computed(this._root._.z), ), ), Probe(), ) # setGlobalPrintPrivateEntries(True) # d.parse(b'', z=2) assert d.parse(b"", z=2) == Container(x=1, inner=Container(inner2=Container(x=1,z=2,zz=2))) def test_parsedhook_repeatersdiscard() -> None: outputs = [] def printobj1(obj: int, ctx: "Context") -> None: outputs.append(obj) d1 = GreedyRange(Byte * printobj1, discard=True) assert d1.parse(b"\x01\x02\x03") == [] assert outputs == [1,2,3] outputs = [] def printobj2(obj: int, ctx: "Context") -> None: outputs.append(obj) d2 = Array(3, Byte * printobj2, discard=True) assert d2.parse(b"\x01\x02\x03") == [] assert outputs == [1,2,3] outputs = [] def printobj3(obj: int, ctx: "Context") -> None: outputs.append(obj) d3 = RepeatUntil(lambda obj,lst,ctx: ctx._index == 2, Byte * printobj3, discard=True) assert d3.parse(b"\x01\x02\x03") == [] assert outputs == [1,2,3] def test_exportksy() -> None: d = Struct( "nothing" / Pass * "field docstring", "data1" / Bytes(10), "data2" / GreedyBytes, "bitstruct" / BitStruct( "flag" / Flag, "padding" / Padding(7), "int32" / Int32ub, "int32le" / BytesInteger(4), "int4a" / Nibble, "int4b" / BitsInteger(4), ), "int32" / Int32ub, "float32" / Float32b, "int32le" / BytesInteger(4, swapped=True), "varint" / VarInt, "string1" / PaddedString(10, "utf8"), "string2" / PascalString(Byte, "utf8"), "string3" / CString("utf8"), "string4" / GreedyString("utf8"), "flag" / Flag, "enum" / Enum(Byte, one=1, two=2), "flagsenum" / FlagsEnum(Byte, one=1, two=2), "struct1" / Struct(Byte, "named"/Byte), "sequence1" / Sequence(Byte, "named"/Byte), "array2d" / Array(5, Array(5, Byte)), "greedyrange" / GreedyRange(Byte), "repeatuntil" / RepeatUntil(obj_ == 0, Byte), "const1" / Const(b"ABCD"), "const2" / Const(1, Int32ub), # Computed # Index "rebuild" / Rebuild(Byte, 0), "default" / Default(Byte, 0), "namedtuple1" / NamedTuple("coord", "x y z", "x"/Byte + "y"/Byte + "z"/Byte), "namedtuple2" / NamedTuple("coord", "x y z", Byte >> Byte >> Byte), "namedtuple3" / NamedTuple("coord", "x y z", Byte[3]), "namedtuple4" / NamedTuple("coord", "x y z", GreedyRange(Byte)), "timestamp1" / Timestamp(Int32ub, 1, 1970), "timestamp2" / Timestamp(Int32ub, "msdos", "msdos"), "hex" / Hex(Int32ub), "hexdump" / HexDump(Int32ub), # Union "if1" / If(this.num == 0, Byte), "ifthenelse1" / IfThenElse(this.num == 0, Byte, Byte), # Switch "padding" / Padding(5), "padded" / Padded(5, Byte), "pointer1" / Pointer(0x1000, Int32ub), "pointer2" / Pointer(this.pointer1, Int32ub), "pass1" / Pass, # Terminated "prefixed" / Prefixed(Byte, GreedyBytes), "prefixedarray" / PrefixedArray(Byte, Byte), # Compressed ) * \ "struct docstring" print(d.export_ksy(filename="example_ksy.ksy")) @pytest.mark.xfail(reason="both sizeof fail because length is 1 level up than when parsing") def test_from_issue_692() -> None: # https://stackoverflow.com/questions/44747202/pythons-construct-sizeof-for-construct-depending-on-its-parent AttributeHandleValuePair = Struct( "handle" / Int16ul, "value" / GreedyBytes, ) AttReadByTypeResponse = Struct( "length" / Int8ul, # The size in bytes of each handle/value pair "datalist" / Array(2, FixedSized(this.length, AttributeHandleValuePair)), ) assert AttReadByTypeResponse.parse(b"\x04\x01\x02\x03\x04\x01\x02\x03\x04") == Container(length=4,datalist=[{"handle":0x0201,"value":b'\x03\x04'},{"handle": 0x0201,"value": b'\x03\x04'}]) assert AttReadByTypeResponse.sizeof(length=4) == 1+2*4 AttributeHandleValuePair = Struct( "handle" / Int16ul, "value" / Bytes(this._.length - 2), ) AttReadByTypeResponse = Struct( "length" / Int8ul, # The size in bytes of each handle/value pair "datalist" / AttributeHandleValuePair[2], ) assert AttReadByTypeResponse.parse(b"\x04\x01\x02\x03\x04\x01\x02\x03\x04") == Container(length=4,datalist=[{"handle": 0x0201,"value": b'\x03\x04'},{"handle": 0x0201,"value": b'\x03\x04'}]) assert AttReadByTypeResponse.sizeof(length=4) == 1+2*(2+4-2) def test_greedyrange_issue_697() -> None: d = BitStruct( "rest" / Bytewise(GreedyRange(Byte)), ) d.parse(bytes(5)) def test_greedybytes_issue_697() -> None: d = BitStruct( "rest" / Bytewise(GreedyBytes), ) d.parse(bytes(5)) def test_hex_issue_709() -> None: # Make sure, the fix doesn't destroy already working code d1 = Hex(Bytes(1)) obj1 = d1.parse(b"\xff") assert "unhexlify('ff')" in str(obj1) d2 = Struct("x" / Hex(Byte)) obj2 = d2.parse(b"\xff") assert "x = 0xFF" in str(obj2) d3 = HexDump(Bytes(1)) obj3 = d3.parse(b"\xff") assert "hexundump" in str(obj3) # The following checks only succeed after fixing the issue d4 = Struct("x" / Hex(Bytes(1))) obj4 = d4.parse(b"\xff") assert "x = unhexlify('ff')" in str(obj4) d5 = Struct("x" / HexDump(Bytes(1))) obj5 = d5.parse(b"\xff") assert "x = hexundump" in str(obj5) d6 = Struct("x" / Struct("y" / Hex(Bytes(1)))) obj6 = d6.parse(b"\xff") assert "y = unhexlify('ff')" in str(obj6) @pytest.mark.xfail(reason="Enable to see path information in stream operations") def test_showpath() -> None: # trips stream_read d = Struct("inner"/Struct("x"/Byte)) d.parse(b"") @pytest.mark.xfail(reason="Enable to see path information in stream operations") def test_showpath2() -> None: x = Struct( 'foo' / Bytes(1), 'a' / Struct( 'foo' / Bytes(1), 'b' / Struct( 'foo' / Bytes(1), 'c' / Struct( 'foo' / Bytes(1), 'bar' / Bytes(1) ) ) ) ) x.parse(b'\xff' * 5) x.parse(b'\xff' * 3) # StreamError: Error in path (parsing) -> a -> b -> c -> foo # stream read less than specified amount, expected 1, found 0 def test_buildfile_issue_737() -> None: Byte.build_file(Byte.parse(b'\xff'), 'example_737') assert Byte.parse_file('example_737') == 255 @pytest.mark.xfail(reason="Context is not properly processed, see #771 and PR #784") def test_struct_issue_771() -> None: spec = Struct( 'a' / Int32ul, 'b' / Struct( 'count' / Int32ul, 'entries' / Byte[this.count] ) ) data = b'\x01\x00\x00\x00\x02\x00\x00\x00\x0a\x0b' info = spec.parse(data) assert info == {'a': 1, 'b': {'count': 2, 'entries': [0x0a, 0x0b]}} assert spec.build(info) == data assert spec.sizeof(**info) == 10 def test_buildtypes_contravariance() -> None: if t.TYPE_CHECKING: class HexString(Adapter[bytes, bytes, str, str]): ... else: class HexString(Adapter): def _decode(self, obj, context, path): return obj.hex() def _encode(self, obj, context, path): return bytes.fromhex(obj) HexStringBytes = HexString(Bytes(2)) assert HexStringBytes.build('1234') == b'\x12\x34' assert HexStringBytes.parse(b'\x56\x78') == '5678' # this fails if BuildTypes is not contravariant, # as GreedyBytes has a BuildType of Union[bytes, int] HexStringGreedyBytes = HexString(GreedyBytes) assert HexStringGreedyBytes.build('9abc') == b'\x9a\xbc' assert HexStringGreedyBytes.parse(b'\xcd\xef') == 'cdef' def test_parsetype_covariance() -> None: T = t.TypeVar('T') if t.TYPE_CHECKING: class ReversedList(SymmetricAdapter[t.List[T], t.List[T], t.List[T], t.List[T]]): ... else: class ReversedList(SymmetricAdapter): def _decode(self, obj, context, path): return list(reversed(obj)) assert ReversedList(Array(4, Byte)).build([1, 2, 3, 4]) == b'\x04\x03\x02\x01' assert ReversedList(Array(4, Byte)).parse(b'\x01\x02\x03\x04') == [4, 3, 2, 1]