Skip to content

Update type hint in add method of StructDef #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pmbarrett314 wants to merge 2 commits into
base: master
Choose a base branch
from
+13 −13
Open

Update type hint in add method of StructDef #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b475ce
Update type hint in add method of StructDef
pmbarrett314 Jul 13, 2022
d17577e
run black
pmbarrett314 Jul 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions pycstruct/cparser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,15 +66,15 @@ def _run_castxml(


def _get_hash(list_of_strings):
""" Get a reproducible short name of a list of strings """
"""Get a reproducible short name of a list of strings"""
long_string = "".join(list_of_strings)
sha256 = hashlib.sha256(long_string.encode())
hexdigest = sha256.hexdigest()
return hexdigest[:10]


def _listify(list_or_str):
""" If list_or_str is a string it will be put in a list """
"""If list_or_str is a string it will be put in a list"""
if isinstance(list_or_str, str):
list_or_str = [list_or_str]
return list_or_str
Expand Down Expand Up @@ -241,7 +241,7 @@ def _parse_bitfield(self, xml_bitfield):
return bitfield

def _set_common_meta(self, xml_input, dict_output):
""" Set common metadata available for all types """
"""Set common metadata available for all types"""
typeid = xml_input.attrib["id"]
name = self._get_attrib(xml_input, "name", "")
if name == "":
Expand All @@ -253,7 +253,7 @@ def _set_common_meta(self, xml_input, dict_output):
dict_output["supported"] = True

def _set_struct_union_members(self, xml_input, dict_output):
""" Set members - common for struct and unions """
"""Set members - common for struct and unions"""
dict_output["members"] = []
fields = self._get_fields(xml_input)
while len(fields) > 0:
Expand Down Expand Up @@ -322,7 +322,7 @@ def _get_elem_with_attrib(self, tag, attrib, value):
return elem

def _get_typedef_name(self, type_id):
""" Find out the typedef name of a type which do not have a name """
"""Find out the typedef name of a type which do not have a name"""

# First check if there is a connected ElaboratedType element
try:
Expand All @@ -342,7 +342,7 @@ def _get_typedef_name(self, type_id):
return name

def _fundamental_type_to_pycstruct_type(self, elem, is_array):
""" Map the fundamental type to pycstruct type """
"""Map the fundamental type to pycstruct type"""
# pylint: disable=no-self-use
typename = elem.attrib["name"]
typesize = elem.attrib["size"]
Expand All @@ -367,7 +367,7 @@ def _fundamental_type_to_pycstruct_type(self, elem, is_array):
return "{0}{1}".format(pycstruct_type_name, typesize)

def _get_basic_type_element(self, type_id):
""" Finds the basic type element possible hidden behind TypeDef's or ElaboratedType's """
"""Finds the basic type element possible hidden behind TypeDef's or ElaboratedType's"""
elem = self._get_elem_with_id(type_id)
while elem.tag == "Typedef" or elem.tag == "ElaboratedType":
elem = self._get_elem_with_id(elem.attrib["type"])
Expand Down
12 changes: 6 additions & 6 deletions pycstruct/pycstruct.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ def __init__(self, datatype, byteorder):
self.format = _TYPE[datatype]["format"]

def serialize(self, data, buffer=None, offset=0):
""" Data needs to be an integer, floating point or boolean value """
"""Data needs to be an integer, floating point or boolean value"""
if buffer is None:
assert offset == 0, "When buffer is None, offset have to be unset"
buffer = bytearray(self.size())
Expand All @@ -167,7 +167,7 @@ def serialize(self, data, buffer=None, offset=0):
return buffer

def deserialize(self, buffer, offset=0):
""" Result is an integer, floating point or boolean value """
"""Result is an integer, floating point or boolean value"""
dataformat = _BYTEORDER[self.byteorder]["format"] + self.format
value = struct.unpack_from(dataformat, buffer, offset)[0]

Expand Down Expand Up @@ -209,7 +209,7 @@ def __init__(self, length):
self.length = length

def serialize(self, data, buffer=None, offset=0):
""" Data needs to be a string """
"""Data needs to be a string"""
if buffer is None:
assert offset == 0, "When buffer is None, offset have to be unset"
buffer = bytearray(self.size())
Expand All @@ -232,7 +232,7 @@ def serialize(self, data, buffer=None, offset=0):
return buffer

def deserialize(self, buffer, offset=0):
""" Result is a string """
"""Result is a string"""
size = self.size()
# Find null termination
index = buffer.find(0, offset, offset + size)
Expand Down Expand Up @@ -508,7 +508,7 @@ def add(self, datatype, name, length=1, byteorder="", same_level=False, shape=No
+------------+---------------+--------------------------------------+

:param datatype: Element data type. See above.
:type datatype: str
:type datatype: str | _BaseDef
:param name: Name of element. Needs to be unique.
:type name: str
:param length: Number of elements. If > 1 this is an array/list of
Expand Down Expand Up @@ -1209,7 +1209,7 @@ def _set_subvalue(self, value, subvalue, nbr_of_bits, start_bit, signed):
"""
# pylint: disable=too-many-arguments,no-self-use
# Validate size according to nbr_of_bits
max_value = 2 ** nbr_of_bits - 1
max_value = 2**nbr_of_bits - 1
min_value = 0
if signed:
max_value = 2 ** (nbr_of_bits - 1) - 1
Expand Down