laforge has submitted this change. ( https://gerrit.osmocom.org/c/pysim/+/35851?usp=email )
Change subject: pylint: construct.py ...................................................................... pylint: construct.py pySim/construct.py:47:0: W0311: Bad indentation. Found 16 spaces, expected 12 (bad-indentation) pySim/construct.py:59:0: W0311: Bad indentation. Found 16 spaces, expected 12 (bad-indentation) pySim/construct.py:82:0: W0311: Bad indentation. Found 16 spaces, expected 12 (bad-indentation) pySim/construct.py:1:0: C0114: Missing module docstring (missing-module-docstring) pySim/construct.py:14:0: W0105: String statement has no effect (pointless-string-statement) pySim/construct.py:178:29: W0613: Unused argument 'instr' (unused-argument) pySim/construct.py:199:15: C0121: Comparison 'codepoint_prefix == None' should be 'codepoint_prefix is None' (singleton-comparison) pySim/construct.py:269:15: C0121: Comparison 'v == False' should be 'v is False' if checking for the singleton value False, or 'not v' if testing for falsiness (singleton-comparison) pySim/construct.py:271:17: C0121: Comparison 'v == True' should be 'v is True' if checking for the singleton value True, or 'v' if testing for truthiness (singleton-comparison) pySim/construct.py:385:15: C0123: Use isinstance() rather than type() for a typecheck. (unidiomatic-typecheck) pySim/construct.py:392:15: C0123: Use isinstance() rather than type() for a typecheck. (unidiomatic-typecheck) pySim/construct.py:408:11: C0123: Use isinstance() rather than type() for a typecheck. (unidiomatic-typecheck) pySim/construct.py:421:7: R1701: Consider merging these isinstance calls to isinstance(c, (Container, dict)) (consider-merging-isinstance) pySim/construct.py:444:11: R1729: Use a generator instead 'all(v == 255 for v in raw_bin_data)' (use-a-generator) pySim/construct.py:434:81: W0613: Unused argument 'exclude_prefix' (unused-argument) pySim/construct.py:544:12: W0707: Consider explicitly re-raising using 'raise IntegerError(str(e), path=path) from e' (raise-missing-from) pySim/construct.py:561:8: R1731: Consider using 'nbytes = max(nbytes, minlen)' instead of unnecessary if block (consider-using-max-builtin) pySim/construct.py:573:12: W0707: Consider explicitly re-raising using 'raise IntegerError(str(e), path=path) from e' (raise-missing-from) pySim/construct.py:3:0: C0411: standard import "import typing" should be placed before "from construct.lib.containers import Container, ListContainer" (wrong-import-order) pySim/construct.py:10:0: C0411: third party import "import gsm0338" should be placed before "from pySim.utils import b2h, h2b, swap_nibbles" (wrong-import-order) pySim/construct.py:11:0: C0411: standard import "import codecs" should be placed before "from construct.lib.containers import Container, ListContainer" (wrong-import-order) pySim/construct.py:12:0: C0411: standard import "import ipaddress" should be placed before "from construct.lib.containers import Container, ListContainer" (wrong-import-order) pySim/construct.py:7:0: W0611: Unused BitwisableString imported from construct.core (unused-import) Change-Id: Ic8a06d65a7bcff9ef399fe4e7e5d82f271c946bb --- M pySim/construct.py 1 file changed, 63 insertions(+), 28 deletions(-) Approvals: Jenkins Builder: Verified laforge: Looks good to me, approved diff --git a/pySim/construct.py b/pySim/construct.py index 8ef7941..881f1f2 100644 --- a/pySim/construct.py +++ b/pySim/construct.py @@ -1,17 +1,20 @@ -from construct.lib.containers import Container, ListContainer -from construct.core import EnumIntegerString +"""Utility code related to the integration of the 'construct' declarative parser.""" + import typing -from construct import Adapter, Prefixed, Int8ub, GreedyBytes, Default, Flag, Byte, Construct, Enum -from construct import BitsInteger, BitStruct, Bytes, StreamError, stream_read_entire, stream_write -from construct import SizeofError, IntegerError, swapbytes -from construct.core import evaluate, BitwisableString -from construct.lib import integertypes -from pySim.utils import b2h, h2b, swap_nibbles -import gsm0338 import codecs import ipaddress -"""Utility code related to the integration of the 'construct' declarative parser.""" +import gsm0338 + +from construct.lib.containers import Container, ListContainer +from construct.core import EnumIntegerString +from construct import Adapter, Prefixed, Int8ub, GreedyBytes, Default, Flag, Byte, Construct, Enum +from construct import BitsInteger, BitStruct, Bytes, StreamError, stream_read_entire, stream_write +from construct import SizeofError, IntegerError, swapbytes +from construct.core import evaluate +from construct.lib import integertypes + +from pySim.utils import b2h, h2b, swap_nibbles # (C) 2021-2022 by Harald Welte <[email protected]> # @@ -44,7 +47,7 @@ def _decode(self, obj, context, path): # In case the string contains only 0xff bytes we interpret it as an empty string if obj == b'\xff' * len(obj): - return "" + return "" return codecs.decode(obj, "utf-8") def _encode(self, obj, context, path): @@ -56,7 +59,7 @@ def _decode(self, obj, context, path): # In case the string contains only 0xff bytes we interpret it as an empty string if obj == b'\xff' * len(obj): - return "" + return "" # one of the magic bytes of TS 102 221 Annex A if obj[0] in [0x80, 0x81, 0x82]: ad = Ucs2Adapter(GreedyBytes) @@ -79,7 +82,7 @@ def _decode(self, obj, context, path): # In case the string contains only 0xff bytes we interpret it as an empty string if obj == b'\xff' * len(obj): - return "" + return "" if obj[0] == 0x80: # TS 102 221 Annex A Variant 1 return codecs.decode(obj[1:], 'utf_16_be') @@ -177,7 +180,7 @@ def _encode_variant1(instr: str) -> bytes: """Encode according to TS 102 221 Annex A Variant 1""" - return b'\x80' + codecs.encode(obj, 'utf_16_be') + return b'\x80' + codecs.encode(instr, 'utf_16_be') def _encode_variant2(instr: str) -> bytes: """Encode according to TS 102 221 Annex A Variant 2""" @@ -196,7 +199,7 @@ assert codepoint_prefix == c_prefix enc = (0x80 + (c_codepoint & 0x7f)).to_bytes(1, byteorder='big') chars += enc - if codepoint_prefix == None: + if codepoint_prefix is None: codepoint_prefix = 0 return hdr + codepoint_prefix.to_bytes(1, byteorder='big') + chars @@ -266,9 +269,9 @@ # skip all private entries if k.startswith('_'): continue - if v == False: + if v is False: obj[k] = True - elif v == True: + elif v is True: obj[k] = False return obj @@ -382,14 +385,14 @@ self.min_len = min_len def _decode(self, obj, context, path): - assert type(obj) == bytes + assert isinstance(obj, bytes) # pad with suppressed/missing bytes if len(obj) < self.total_length: obj += self.default_value * (self.total_length - len(obj)) return int.from_bytes(obj, 'big') def _encode(self, obj, context, path): - assert type(obj) == int + assert isinstance(obj, int) obj = obj.to_bytes(self.total_length, 'big') # remove trailing bytes if they are zero while len(obj) > self.min_len and obj[-1] == self.default_value[0]: @@ -405,20 +408,20 @@ for (key, value) in d.items(): if key.startswith(exclude_prefix): continue - if type(value) is dict: + if isinstance(value, dict): res[key] = filter_dict(value) else: res[key] = value return res -def normalize_construct(c): +def normalize_construct(c, exclude_prefix: str = '_'): """Convert a construct specific type to a related base type, mostly useful so we can serialize it.""" # we need to include the filter_dict as we otherwise get elements like this # in the dict: '_io': <_io.BytesIO object at 0x7fdb64e05860> which we cannot json-serialize - c = filter_dict(c) - if isinstance(c, Container) or isinstance(c, dict): + c = filter_dict(c, exclude_prefix) + if isinstance(c, (Container, dict)): r = {k: normalize_construct(v) for (k, v) in c.items()} elif isinstance(c, ListContainer): r = [normalize_construct(x) for x in c] @@ -441,11 +444,11 @@ # if the input is all-ff, this means the content is undefined. Let's avoid passing StreamError # exceptions in those situations (which might occur if a length field 0xff is 255 but then there's # actually less bytes in the remainder of the file. - if all([v == 0xff for v in raw_bin_data]): + if all(v == 0xff for v in raw_bin_data): return None else: raise e - return normalize_construct(parsed) + return normalize_construct(parsed, exclude_prefix) def build_construct(c, decoded_data, context: dict = {}): """Helper function to handle total_len.""" @@ -558,8 +561,7 @@ # round up to the minimum number # of bytes we anticipate - if nbytes < minlen: - nbytes = minlen + nbytes = max(nbytes, minlen) return nbytes @@ -570,7 +572,7 @@ try: data = obj.to_bytes(length, byteorder='big', signed=self.signed) except ValueError as e: - raise IntegerError(str(e), path=path) + raise IntegerError(str(e), path=path) from e if evaluate(self.swapped, context): data = swapbytes(data) stream_write(stream, data, length, path) -- To view, visit https://gerrit.osmocom.org/c/pysim/+/35851?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: pysim Gerrit-Branch: master Gerrit-Change-Id: Ic8a06d65a7bcff9ef399fe4e7e5d82f271c946bb Gerrit-Change-Number: 35851 Gerrit-PatchSet: 4 Gerrit-Owner: laforge <[email protected]> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: laforge <[email protected]> Gerrit-MessageType: merged
