construct-classes 0.1.2__tar.gz → 0.2.0__tar.gz

{construct-classes-0.1.2 → construct_classes-0.2.0}/CHANGELOG.rst

@@ -11,7 +11,24 @@ Unreleased
 
 Please see all `Unreleased Changes`_ for more information.
 
-.. _Unreleased Changes: https://github.com/matejcik/construct-classes/compare/v0.1.2...HEAD
+.. _Unreleased Changes: https://github.com/matejcik/construct-classes/compare/v0.2.0...HEAD
+
+
+0.2.0 - 2025-08-25
+--------------------
+
+Added
+~~~~~
+
+- Allow pass-through of dataclass arguments via class attributes.
+
+Incompatible changes
+~~~~~~~~~~~~~~~~~~~~
+
+- Subclasses of :code:`Struct` are now :code:`kw_only` by default. This will break
+  any constructor invocations using positional arguments. You can explicitly
+  set :code:`kw_only=False` on your :code:`Struct` subclass to restore the old
+  behavior.
 
 
 0.1.2 - 2022-10-07

{construct-classes-0.1.2 → construct_classes-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: construct-classes
-Version: 0.1.2
+Version: 0.2.0
 Summary: Parse your binary structs into dataclasses
 Home-page: https://github.com/matejcik/construct-classes
 License: MIT
@@ -12,13 +12,17 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.6
 Requires-Dist: construct (>=2.10,<3.0)
+Requires-Dist: dataclasses (>=0.8,<0.9) ; python_full_version >= "3.6.0" and python_full_version < "3.7.0"
 Project-URL: Repository, https://github.com/matejcik/construct-classes
 Description-Content-Type: text/x-rst
 
@@ -107,8 +111,21 @@ must match the names of the fields in the Construct struct.
 
 Use :code:`dataclasses.field()` to specify attributes on fields that are not subcons.
 
-There are currently no other features. In particular, the resulting class is a Python
-dataclass, but you cannot specify its parameters like :code:`frozen` etc.
+By default, subclasses of :code:`Struct` are :code:`kw_only`. This is specifically to
+allow setting default values on any fields regardless of order, so that your attributes
+can be listed in the subcon order.
+
+However, you can pass any valid dataclass parameters to the :code:`Struct` class via
+class attributes:
+
+.. code-block:: python
+
+    class MyStruct(Struct, kw_only=False, frozen=True):
+        a: int
+        b: int
+
+    my_struct = MyStruct(1, 2)  # ok
+    my_struct.a = 2  # FrozenInstanceError
 
 
 Installing

{construct-classes-0.1.2 → construct_classes-0.2.0}/README.rst

@@ -83,8 +83,21 @@ must match the names of the fields in the Construct struct.
 
 Use :code:`dataclasses.field()` to specify attributes on fields that are not subcons.
 
-There are currently no other features. In particular, the resulting class is a Python
-dataclass, but you cannot specify its parameters like :code:`frozen` etc.
+By default, subclasses of :code:`Struct` are :code:`kw_only`. This is specifically to
+allow setting default values on any fields regardless of order, so that your attributes
+can be listed in the subcon order.
+
+However, you can pass any valid dataclass parameters to the :code:`Struct` class via
+class attributes:
+
+.. code-block:: python
+
+    class MyStruct(Struct, kw_only=False, frozen=True):
+        a: int
+        b: int
+
+    my_struct = MyStruct(1, 2)  # ok
+    my_struct.a = 2  # FrozenInstanceError
 
 
 Installing

{construct-classes-0.1.2 → construct_classes-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "construct-classes"
-version = "0.1.2"
+version = "0.2.0"
 authors = ["matejcik <ja@matejcik.cz>"]
 classifiers = [
   "Development Status :: 2 - Pre-Alpha",
@@ -14,17 +14,25 @@ classifiers = [
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
 ]
 description = "Parse your binary structs into dataclasses"
 homepage = "https://github.com/matejcik/construct-classes"
 license = "MIT"
 repository = "https://github.com/matejcik/construct-classes"
 readme = "README.rst"
-include = ["CHANGELOG.rst", "LICENSE", "README.rst"]
+include = [
+  { path = "CHANGELOG.rst", format = "sdist" },
+  { path = "LICENSE", format = "sdist" },
+  { path = "README.rst", format = "sdist" }
+]
 
 [tool.poetry.dependencies]
 python = ">=3.6.2,<4.0"
 construct = "^2.10"
+dataclasses = { version = "^0.8", python = "~3.6.0" }
 
 [tool.poetry.dev-dependencies]
 pytest = ">5"

{construct-classes-0.1.2 → construct_classes-0.2.0}/src/construct_classes/__init__.py

@@ -6,11 +6,14 @@ import construct as c
 if t.TYPE_CHECKING:
     from typing_extensions import dataclass_transform
 else:
+
     def dataclass_transform(**kwargs: t.Any) -> t.Any:
         def inner(cls: t.Any) -> t.Any:
             return cls
+
         return inner
 
+
 # workaround for mypy self type bug
 Self = t.TypeVar("Self", bound="Struct")
 
@@ -27,13 +30,23 @@ def subcon(
     return dataclasses.field(metadata=metadata, **kwargs)
 
 
-@dataclass_transform(field_specifiers=(subcon,))
+@dataclass_transform(field_specifiers=(subcon,), kw_only_default=True)
 class _StructMeta(type):
     def __new__(
-        cls, name: str, bases: t.Tuple[type, ...], namespace: t.Dict[str, t.Any]
+        cls,
+        name: str,
+        bases: t.Tuple[type, ...],
+        namespace: t.Dict[str, t.Any],
+        *,
+        kw_only: bool = True,
+        **kwargs: t.Any,
     ) -> type:
         new_cls = super().__new__(cls, name, bases, namespace)
-        return dataclasses.dataclass()(new_cls)  # type: ignore # pyright is bad with metaclasses
+        if bases:
+            assert bases[0].__name__ == "Struct"
+            return dataclasses.dataclass(kw_only=kw_only, **kwargs)(new_cls)
+        else:
+            return new_cls
 
 
 class Struct(metaclass=_StructMeta):

construct-classes-0.1.2/setup.py

@@ -1,34 +0,0 @@
-# -*- coding: utf-8 -*-
-from setuptools import setup
-
-package_dir = \
-{'': 'src'}
-
-packages = \
-['construct_classes']
-
-package_data = \
-{'': ['*']}
-
-install_requires = \
-['construct>=2.10,<3.0']
-
-setup_kwargs = {
-    'name': 'construct-classes',
-    'version': '0.1.2',
-    'description': 'Parse your binary structs into dataclasses',
-    'long_description': '=================\nconstruct-classes\n=================\n\n.. image:: https://img.shields.io/pypi/v/construct-classes.svg\n        :target: https://pypi.python.org/pypi/construct-classes\n\n.. .. image:: https://readthedocs.org/projects/construct-classes/badge/?version=latest\n..         :target: https://construct-classes.readthedocs.io/en/latest/?badge=latest\n..         :alt: Documentation Status\n\n.. image:: https://pyup.io/repos/github/trezor/construct-classes/shield.svg\n     :target: https://pyup.io/repos/github/trezor/construct-classes/\n     :alt: Updates\n\n\nParse your binary data into dataclasses. Pack your dataclasses into binary data.\n\n:code:`construct-classes` rely on `construct`_ for parsing and packing. The\nprogrammer needs to manually write the Construct expressions. There is also no type\nverification, so it is the programmer\'s responsibility that the dataclass and the\nConstruct expression match.\n\nFor fully type annotated experience, install `construct-typing`_.\n\nThis package typechecks with `mypy`_ and `pyright`_.\n\n.. _construct: https://construct.readthedocs.io/en/latest/\n.. _construct-typing: https://github.com/timrid/construct-typing\n.. _mypy: https://mypy.readthedocs.io/en/stable/\n.. _pyright: https://github.com/microsoft/pyright\n\nUsage\n-----\n\nAny child of :code:`Struct` is a Python dataclass. It expects a Construct :code:`Struct`\nexpression in the :code:`SUBCON` attribute. The names of the attributes of the dataclass\nmust match the names of the fields in the Construct struct.\n\n.. code-block:: python\n\n    import construct as c\n    from construct_classes import Struct, subcon\n\n    class BasicStruct(Struct):\n        x: int\n        y: int\n        description: str\n\n        SUBCON = c.Struct(\n            "x" / c.Int32ul,\n            "y" / c.Int32ul,\n            "description" / c.PascalString(c.Int8ul, "utf8"),\n        )\n\n\n    data = b"\\x01\\x00\\x00\\x00\\x02\\x00\\x00\\x00\\x05hello"\n    parsed = BasicStruct.parse(data)\n    print(parsed)  # BasicStruct(x=1, y=2, description=\'hello\')\n\n    new_data = BasicStruct(x=100, y=200, description="world")\n    print(new_data.build())  # b\'\\x64\\x00\\x00\\x00\\xc8\\x00\\x00\\x00\\x05world\'\n\n\n:code:`construct-classes` support nested structs, but you need to declare them explicitly:\n\n.. code-block:: python\n\n    class LargerStruct(Struct):\n        # specify the subclass type:\n        basic: BasicStruct = subcon(BasicStruct)\n        # in case of a list, specify the item type:\n        basic_array: List[BasicStruct] = subcon(BasicStruct)\n        # the `subcon()` function supports all arguments of `dataclass.field`:\n        default_array: List[BasicStruct] = subcon(BasicStruct, default_factory=list)\n\n        # to refer to the subcon, use the `SUBCON` class attribute:\n        SUBCON = c.Struct(\n            "basic" / BasicStruct.SUBCON,\n            "basic_array" / c.Array(2, BasicStruct.SUBCON),\n            "default_array" / c.PrefixedArray(c.Int8ul, BasicStruct.SUBCON),\n        )\n\nUse :code:`dataclasses.field()` to specify attributes on fields that are not subcons.\n\nThere are currently no other features. In particular, the resulting class is a Python\ndataclass, but you cannot specify its parameters like :code:`frozen` etc.\n\n\nInstalling\n----------\n\nInstall using pip:\n\n    $ pip install construct-classes\n\n\nChangelog\n~~~~~~~~~\n\nSee `CHANGELOG.rst`_.\n\n.. _CHANGELOG.rst: https://github.com/matejcik/construct-classes/blob/master/CHANGELOG.rst\n\n\nFooter\n------\n\n* Free software: MIT License\n\n.. * Documentation: https://construct-classes.readthedocs.io.\n',
-    'author': 'matejcik',
-    'author_email': 'ja@matejcik.cz',
-    'maintainer': None,
-    'maintainer_email': None,
-    'url': 'https://github.com/matejcik/construct-classes',
-    'package_dir': package_dir,
-    'packages': packages,
-    'package_data': package_data,
-    'install_requires': install_requires,
-    'python_requires': '>=3.6.2,<4.0',
-}
-
-
-setup(**setup_kwargs)