firstclass 0.0.1__tar.gz

firstclass-0.0.1/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: firstclass
+Version: 0.0.1
+Summary: dataclass with bytes, ctypes, C struct, JSON and XML serialization
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# firstclass
+
+`@firstclass` works like `@dataclass` (same keyword args) and adds conversion to and from
+packed bytes, `ctypes`, a C struct header, JSON and XML. Pure Python 3.10+, no dependencies.
+
+```python
+from firstclass import firstclass, uint8_t, uint16_t, int32_t, float32_t, bool_t, char_array, bytes_t, array_t
+
+@firstclass
+class Point:
+    x: int32_t
+    y: int32_t
+
+@firstclass
+class Packet:
+    kind: uint8_t
+    ok: bool_t
+    temp: float32_t
+    name: char_array[8]        # NUL-padded UTF-8
+    mac: bytes_t[6]            # exactly 6 bytes
+    samples: array_t[uint16_t, 4]
+    origin: Point              # nested
+
+p = Packet(1, True, 21.5, "sensor", b"\x00\x11\x22\x33\x44\x55", [1, 2, 3, 4], Point(10, -20))
+
+raw = p.to_bytes()                 # packed, little-endian
+assert Packet.from_bytes(raw) == p
+Packet.sizeof()                    # 36
+```
+
+## Types
+
+| Marker | C | Bytes |
+|---|---|---|
+| `uint8_t` `uint16_t` `uint32_t` `uint64_t` | `uintN_t` | 1/2/4/8 |
+| `int8_t` `int16_t` `int32_t` `int64_t` | `intN_t` | 1/2/4/8 |
+| `float32_t` / `float64_t` | `float` / `double` | 4 / 8 |
+| `bool_t` | `bool` | 1 |
+| `char_t` | `char` | 1 |
+| `char_array[N]` | `char x[N]` | N (UTF-8, NUL-padded) |
+| `bytes_t[N]` | `uint8_t x[N]` | N |
+| `array_t[T, N]` | `T x[N]` | N * size(T) |
+| another `@firstclass` class | `struct Name` | its size |
+
+Values are checked: out of range ints, over-long strings and wrong lengths raise
+`ValueError`; wrong Python types raise `TypeError`. Nothing is truncated or coerced silently.
+
+Raw `ctypes` types work as annotations too (packed, same layout as a `_pack_ = 1` Structure):
+`ctypes.c_int`, `c_uint64`, `c_size_t`, `c_bool`, `c_float`, `c_double`, `c_char`, `c_uint16 * 4`,
+`c_char * 8`. Pointers (`c_void_p`, `POINTER(T)`, `c_char_p`) are stored as the address (an `int`,
+0 = NULL) at pointer size; `to_ctypes()` gives a real pointer field you can dereference. The
+address only means something inside the same process. Sizes follow the platform
+(`c_long` is 4 bytes on Windows, 8 on Linux).
+
+## Methods added to every class
+
+| Method | |
+|---|---|
+| `obj.to_bytes()` / `Cls.from_bytes(data)` | binary; `from_bytes` needs exactly `sizeof()` bytes |
+| `Cls.sizeof()` | size in bytes |
+| `obj.to_dict()` / `Cls.from_dict(d)` | JSON-compatible dict (bytes as hex) |
+| `obj.to_json(**kw)` / `Cls.from_json(s)` | `kw` goes to `json.dumps` |
+| `obj.to_xml(indent=None)` / `Cls.from_xml(s)` | `<Packet><kind>1</kind>...</Packet>`, arrays as `<item>` |
+| `obj.to_ctypes()` / `Cls.from_ctypes(c)` / `Cls.ctypes_type()` | `ctypes.Structure` with matching layout |
+| `Cls.c_header()` | C source for the struct(s), nested ones first |
+
+## Layout options
+
+```python
+@firstclass(byteorder="big")   # default "little"
+@firstclass(align=True)        # default False = packed, no padding (like __attribute__((packed)))
+@firstclass(frozen=True, slots=True)   # any dataclass option
+```
+
+`align=True` inserts natural-alignment padding like a normal C struct (assumes the x86-64 style
+rule: alignment equals size). Padding bytes are written as zero and ignored on read.
+C headers describe the struct only; C compilers use native byte order, so `byteorder` is noted
+in a comment.
+
+## Notes
+
+- Fields with plain types (`str`, `int`) work for JSON/XML only; `to_bytes()` raises
+  `TypeError` naming the field.
+- Use `from __future__ import annotations` freely; annotations are resolved lazily. Classes
+  defined inside functions that refer to local names are not resolvable.
+- Don't parse untrusted XML with `from_xml` without extra care (stdlib `xml.etree`).
+- Field names that collide with the generated methods (`to_bytes`, ...) raise `TypeError`.
+
+## Example
+
+`python examples/example.py` shows bytes, JSON, XML, ctypes and the C header from one class.
+
+## Develop
+
+```
+python -m unittest discover -s tests
+```

firstclass-0.0.1/README.md

@@ -0,0 +1,97 @@
+# firstclass
+
+`@firstclass` works like `@dataclass` (same keyword args) and adds conversion to and from
+packed bytes, `ctypes`, a C struct header, JSON and XML. Pure Python 3.10+, no dependencies.
+
+```python
+from firstclass import firstclass, uint8_t, uint16_t, int32_t, float32_t, bool_t, char_array, bytes_t, array_t
+
+@firstclass
+class Point:
+    x: int32_t
+    y: int32_t
+
+@firstclass
+class Packet:
+    kind: uint8_t
+    ok: bool_t
+    temp: float32_t
+    name: char_array[8]        # NUL-padded UTF-8
+    mac: bytes_t[6]            # exactly 6 bytes
+    samples: array_t[uint16_t, 4]
+    origin: Point              # nested
+
+p = Packet(1, True, 21.5, "sensor", b"\x00\x11\x22\x33\x44\x55", [1, 2, 3, 4], Point(10, -20))
+
+raw = p.to_bytes()                 # packed, little-endian
+assert Packet.from_bytes(raw) == p
+Packet.sizeof()                    # 36
+```
+
+## Types
+
+| Marker | C | Bytes |
+|---|---|---|
+| `uint8_t` `uint16_t` `uint32_t` `uint64_t` | `uintN_t` | 1/2/4/8 |
+| `int8_t` `int16_t` `int32_t` `int64_t` | `intN_t` | 1/2/4/8 |
+| `float32_t` / `float64_t` | `float` / `double` | 4 / 8 |
+| `bool_t` | `bool` | 1 |
+| `char_t` | `char` | 1 |
+| `char_array[N]` | `char x[N]` | N (UTF-8, NUL-padded) |
+| `bytes_t[N]` | `uint8_t x[N]` | N |
+| `array_t[T, N]` | `T x[N]` | N * size(T) |
+| another `@firstclass` class | `struct Name` | its size |
+
+Values are checked: out of range ints, over-long strings and wrong lengths raise
+`ValueError`; wrong Python types raise `TypeError`. Nothing is truncated or coerced silently.
+
+Raw `ctypes` types work as annotations too (packed, same layout as a `_pack_ = 1` Structure):
+`ctypes.c_int`, `c_uint64`, `c_size_t`, `c_bool`, `c_float`, `c_double`, `c_char`, `c_uint16 * 4`,
+`c_char * 8`. Pointers (`c_void_p`, `POINTER(T)`, `c_char_p`) are stored as the address (an `int`,
+0 = NULL) at pointer size; `to_ctypes()` gives a real pointer field you can dereference. The
+address only means something inside the same process. Sizes follow the platform
+(`c_long` is 4 bytes on Windows, 8 on Linux).
+
+## Methods added to every class
+
+| Method | |
+|---|---|
+| `obj.to_bytes()` / `Cls.from_bytes(data)` | binary; `from_bytes` needs exactly `sizeof()` bytes |
+| `Cls.sizeof()` | size in bytes |
+| `obj.to_dict()` / `Cls.from_dict(d)` | JSON-compatible dict (bytes as hex) |
+| `obj.to_json(**kw)` / `Cls.from_json(s)` | `kw` goes to `json.dumps` |
+| `obj.to_xml(indent=None)` / `Cls.from_xml(s)` | `<Packet><kind>1</kind>...</Packet>`, arrays as `<item>` |
+| `obj.to_ctypes()` / `Cls.from_ctypes(c)` / `Cls.ctypes_type()` | `ctypes.Structure` with matching layout |
+| `Cls.c_header()` | C source for the struct(s), nested ones first |
+
+## Layout options
+
+```python
+@firstclass(byteorder="big")   # default "little"
+@firstclass(align=True)        # default False = packed, no padding (like __attribute__((packed)))
+@firstclass(frozen=True, slots=True)   # any dataclass option
+```
+
+`align=True` inserts natural-alignment padding like a normal C struct (assumes the x86-64 style
+rule: alignment equals size). Padding bytes are written as zero and ignored on read.
+C headers describe the struct only; C compilers use native byte order, so `byteorder` is noted
+in a comment.
+
+## Notes
+
+- Fields with plain types (`str`, `int`) work for JSON/XML only; `to_bytes()` raises
+  `TypeError` naming the field.
+- Use `from __future__ import annotations` freely; annotations are resolved lazily. Classes
+  defined inside functions that refer to local names are not resolvable.
+- Don't parse untrusted XML with `from_xml` without extra care (stdlib `xml.etree`).
+- Field names that collide with the generated methods (`to_bytes`, ...) raise `TypeError`.
+
+## Example
+
+`python examples/example.py` shows bytes, JSON, XML, ctypes and the C header from one class.
+
+## Develop
+
+```
+python -m unittest discover -s tests
+```

firstclass-0.0.1/firstclass/__init__.py

@@ -0,0 +1,26 @@
+from ._core import firstclass
+from ._specs import (
+    array_t,
+    bool_t,
+    bytes_t,
+    char_array,
+    char_t,
+    float32_t,
+    float64_t,
+    int8_t,
+    int16_t,
+    int32_t,
+    int64_t,
+    uint8_t,
+    uint16_t,
+    uint32_t,
+    uint64_t,
+)
+
+__all__ = [
+    "firstclass",
+    "uint8_t", "uint16_t", "uint32_t", "uint64_t",
+    "int8_t", "int16_t", "int32_t", "int64_t",
+    "float32_t", "float64_t", "bool_t", "char_t",
+    "char_array", "bytes_t", "array_t",
+]

firstclass-0.0.1/firstclass/_core.py

@@ -0,0 +1,251 @@
+"""The @firstclass decorator and the per-class Schema it attaches."""
+from __future__ import annotations
+
+import ctypes
+import dataclasses
+import json
+import sys
+import typing
+import xml.etree.ElementTree as ET
+
+from ._specs import ArrayOf, Nested, Spec, resolve_spec
+
+_METHODS = (
+    "to_bytes", "from_bytes", "to_dict", "from_dict", "to_json", "from_json",
+    "to_xml", "from_xml", "to_ctypes", "from_ctypes", "ctypes_type", "c_header", "sizeof",
+)
+
+
+def _round_up(n: int, a: int) -> int:
+    return -(-n // a) * a
+
+
+class Schema:
+    def __init__(self, cls, byteorder: str, align: bool):
+        if byteorder not in ("little", "big"):
+            raise ValueError(f"byteorder must be 'little' or 'big', got {byteorder!r}")
+        self.cls = cls
+        self.bo = "<" if byteorder == "little" else ">"
+        self.byteorder = byteorder
+        self.aligned = align
+        self._fields: list[tuple[dataclasses.Field, Spec]] | None = None
+        self._layout = None
+        self._ctype = None
+
+    # -- structure -----------------------------------------------------------
+
+    @property
+    def fields(self):
+        if self._fields is None:
+            hints = typing.get_type_hints(self.cls, include_extras=True)
+            self._fields = [(f, resolve_spec(hints[f.name])) for f in dataclasses.fields(self.cls)]
+        return self._fields
+
+    def require_binary(self):
+        for f, spec in self.fields:
+            if not spec.binary:
+                raise TypeError(
+                    f"{self.cls.__name__}.{f.name}: type {spec.tp!r} has no binary form; "
+                    "annotate it with uint8_t, char_array[N], ... or a firstclass class"
+                )
+
+    def layout(self):
+        if self._layout is None:
+            self.require_binary()
+            off, widest, offsets = 0, 1, []
+            for _, spec in self.fields:
+                a = spec.align() if self.aligned else 1
+                off = _round_up(off, a)
+                offsets.append(off)
+                off += spec.size()
+                widest = max(widest, a)
+            self._layout = (offsets, _round_up(off, widest), widest)
+        return self._layout
+
+    def size(self) -> int:
+        return self.layout()[1]
+
+    def align(self) -> int:
+        return self.layout()[2]
+
+    def _build(self, kw: dict):
+        init = {k: v for k, v in kw.items() if self._by_name[k].init}
+        obj = self.cls(**init)
+        for k, v in kw.items():
+            if not self._by_name[k].init:
+                object.__setattr__(obj, k, v)
+        return obj
+
+    @property
+    def _by_name(self):
+        return {f.name: f for f, _ in self.fields}  # small; fields are cached
+
+    def _ctx(self, f, exc):
+        return type(exc)(f"{self.cls.__name__}.{f.name}: {exc}")
+
+    # -- bytes ---------------------------------------------------------------
+
+    def pack(self, obj) -> bytes:
+        offsets, total, _ = self.layout()
+        buf = bytearray(total)
+        for (f, spec), off in zip(self.fields, offsets):
+            try:
+                raw = spec.pack(getattr(obj, f.name), self.bo)
+            except (TypeError, ValueError) as e:
+                raise self._ctx(f, e) from e
+            buf[off:off + len(raw)] = raw
+        return bytes(buf)
+
+    def unpack(self, buf, off: int = 0):
+        offsets, total, _ = self.layout()
+        if len(buf) - off < total:
+            raise ValueError(f"{self.cls.__name__} needs {total} bytes, got {len(buf) - off}")
+        kw = {}
+        for (f, spec), o in zip(self.fields, offsets):
+            try:
+                kw[f.name] = spec.unpack(buf, off + o, self.bo)
+            except (TypeError, ValueError) as e:
+                raise self._ctx(f, e) from e
+        return self._build(kw)
+
+    def from_bytes(self, data):
+        data = memoryview(data).cast("B") if not isinstance(data, (bytes, bytearray)) else data
+        if len(data) != self.size():
+            raise ValueError(f"{self.cls.__name__} needs exactly {self.size()} bytes, got {len(data)}")
+        return self.unpack(data, 0)
+
+    # -- dict / json / xml ---------------------------------------------------
+
+    def to_dict(self, obj) -> dict:
+        return {f.name: spec.to_json(getattr(obj, f.name)) for f, spec in self.fields}
+
+    def from_dict(self, d):
+        if not isinstance(d, dict):
+            raise TypeError(f"{self.cls.__name__}.from_dict needs a dict, got {type(d).__name__}")
+        unknown = set(d) - set(self._by_name)
+        if unknown:
+            raise ValueError(f"{self.cls.__name__}: unknown keys {sorted(unknown)}")
+        kw = {}
+        for f, spec in self.fields:
+            if f.name in d:
+                try:
+                    kw[f.name] = spec.from_json(d[f.name])
+                except (TypeError, ValueError) as e:
+                    raise self._ctx(f, e) from e
+        return self._build(kw)
+
+    def fill_xml(self, obj, elem: ET.Element) -> None:
+        for f, spec in self.fields:
+            spec.to_xml(getattr(obj, f.name), ET.SubElement(elem, f.name))
+
+    def read_xml(self, elem: ET.Element):
+        known = self._by_name
+        specs = {f.name: s for f, s in self.fields}
+        kw = {}
+        for child in elem:
+            if child.tag not in known:
+                raise ValueError(f"{self.cls.__name__}: unknown element <{child.tag}>")
+            if child.tag in kw:
+                raise ValueError(f"{self.cls.__name__}: duplicate element <{child.tag}>")
+            spec = specs[child.tag]
+            try:
+                kw[child.tag] = spec.from_xml(child)
+            except (TypeError, ValueError) as e:
+                raise self._ctx(known[child.tag], e) from e
+        return self._build(kw)
+
+    # -- ctypes / C ----------------------------------------------------------
+
+    def ctypes_type(self):
+        if self._ctype is None:
+            self.require_binary()
+            base = ctypes.LittleEndianStructure if self.bo == "<" else ctypes.BigEndianStructure
+            ns = {"_fields_": [(f.name, spec.ctype(self.bo)) for f, spec in self.fields]}
+            if not self.aligned:
+                ns["_pack_"] = 1
+                if sys.version_info >= (3, 14):
+                    ns["_layout_"] = "ms"
+            self._ctype = type(self.cls.__name__ + "_c", (base,), ns)
+        return self._ctype
+
+    def to_ctypes(self, obj):
+        c = self.ctypes_type()()
+        for f, spec in self.fields:
+            try:
+                setattr(c, f.name, spec.to_c(getattr(obj, f.name)))
+            except (TypeError, ValueError) as e:
+                raise self._ctx(f, e) from e
+        return c
+
+    def from_ctypes(self, c):
+        return self._build({f.name: spec.from_c(getattr(c, f.name)) for f, spec in self.fields})
+
+    def _nested_schemas(self):
+        for _, spec in self.fields:
+            while isinstance(spec, ArrayOf):
+                spec = spec.elem
+            if isinstance(spec, Nested):
+                yield spec.schema
+
+    def c_header(self) -> str:
+        self.require_binary()
+        out, seen = [], set()
+
+        def emit(schema):
+            if schema.cls in seen:
+                return
+            seen.add(schema.cls)
+            for dep in schema._nested_schemas():
+                emit(dep)
+            lines = [f"/* byteorder: {schema.byteorder} */"]
+            if not schema.aligned:
+                lines.append("#pragma pack(push, 1)")
+            lines.append(f"struct {schema.cls.__name__} {{")
+            lines += [f"    {spec.c_decl(f.name)};" for f, spec in schema.fields]
+            lines.append("};")
+            if not schema.aligned:
+                lines.append("#pragma pack(pop)")
+            out.append("\n".join(lines))
+
+        emit(self)
+        return "#include <stdint.h>\n#include <stdbool.h>\n\n" + "\n\n".join(out) + "\n"
+
+
+def firstclass(cls=None, /, *, byteorder: str = "little", align: bool = False, **dataclass_kwargs):
+    """Like `@dataclass` (same keyword args), plus binary/JSON/XML/ctypes/C codecs.
+
+    byteorder: 'little' (default) or 'big'.
+    align: False (default) = packed layout, no padding; True = natural C alignment padding.
+    """
+
+    def wrap(cls):
+        dc = dataclasses.dataclass(cls, **dataclass_kwargs)
+        clash = [f.name for f in dataclasses.fields(dc) if f.name in _METHODS or f.name == "__firstclass__"]
+        if clash:
+            raise TypeError(f"{dc.__name__}: field names clash with firstclass methods: {clash}")
+        s = Schema(dc, byteorder, align)
+        dc.__firstclass__ = s
+        dc.to_bytes = lambda self: s.pack(self)
+        dc.from_bytes = staticmethod(s.from_bytes)
+        dc.to_dict = lambda self: s.to_dict(self)
+        dc.from_dict = staticmethod(s.from_dict)
+        dc.to_json = lambda self, **kw: json.dumps(s.to_dict(self), **kw)
+        dc.from_json = staticmethod(lambda text: s.from_dict(json.loads(text)))
+        dc.to_xml = lambda self, indent=None: _to_xml(s, self, indent)
+        dc.from_xml = staticmethod(lambda text: s.read_xml(ET.fromstring(text)))
+        dc.to_ctypes = lambda self: s.to_ctypes(self)
+        dc.from_ctypes = staticmethod(s.from_ctypes)
+        dc.ctypes_type = staticmethod(s.ctypes_type)
+        dc.c_header = staticmethod(s.c_header)
+        dc.sizeof = staticmethod(s.size)
+        return dc
+
+    return wrap if cls is None else wrap(cls)
+
+
+def _to_xml(schema: Schema, obj, indent) -> str:
+    root = ET.Element(schema.cls.__name__)
+    schema.fill_xml(obj, root)
+    if indent is not None:
+        ET.indent(root, space=" " * indent if isinstance(indent, int) else indent)
+    return ET.tostring(root, encoding="unicode")