pybare 1.2.1__tar.gz → 1.2.3__tar.gz

{pybare-1.2.1 → pybare-1.2.3}/PKG-INFO

@@ -1,15 +1,16 @@
 Metadata-Version: 2.1
 Name: pybare
-Version: 1.2.1
+Version: 1.2.3
 Summary: A declarative implementation of BARE for Python
 Home-page: https://sr.ht/~chiefnoah/pybare/
 Author: Noah Pederson
 Author-email: noah@packetlost.dev
+Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.11
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
@@ -17,7 +18,7 @@ License-File: LICENSE
 [![builds.sr.ht status](https://builds.sr.ht/~chiefnoah/pybare.svg)](https://builds.sr.ht/~chiefnoah/pybare?)
 
 A declarative implementation of the [BARE](https://baremessages.org/) message
-format for Python 3.11+
+format for Python 3.10+
 
 ---
 
@@ -39,36 +40,43 @@ pip install pybare
 pybare fully implements all BARE types for both encoding and decoding. This
 includes reading multiple messages from the same `BinaryIO` stream.
 
-### TODO
+## Gotchas
 
-- [ ] Codegen based on `.schema` files
-- [ ] Better documentation
-- [ ] More tests
-- [ ] Fast C implementation for encoding
+We use "Array" / "array" instead of "List" / "list" to avoid conflicts with Python's
+common builtin type of the same name.
 
 ## Examples
 
+An example that defines the types used as an example in the RFC may be found in
+[`example.py`](./example.py)
+
 pybare currently requires you define your structures by hand. Examples can be
 found in the
 [tests](https://git.sr.ht/~chiefnoah/pybare/tree/master/bare/test_encoder.py).
 
 ### Quickstart
 
+The general convention is type identifiers start with a *capital* letter and anonymous
+generating functions begin with a lowercase. This follows general "pythonic" style for
+classes vs functions.
+
 ```python
-from bare import Struct, map, Str, UInt, optional, data, array, Void
+from bare import Struct, map, Str, UInt, optional, data, array, Void, struct, U8
 
 # Alternatively, class Data(size=64): ...
 PubKey = data(64) # 512 bits
 
 class User(Struct):
-    username = Filed(Str)
+    username = Field(Str)
     userid = Field(Int)
     email = Field(optional(Str))
     keys = Field(map(Str, PubKey))
     repos = Field(array(Str)) # variable length array
+    # anonymous array and struct
+    friends = Field(array(struct(name=Str, age=U8)))
 
 
-noah = User(username="chiefnoah", userid=1, email=Void(), keys={}, repos=[])
+noah = User(username="chiefnoah", userid=1, email=Void(), keys={}, repos=[], friends=[])
 noah.username == 'chiefnoah'
 noah.username = 'someoneelse'
 noah.username == 'someoneelse'

{pybare-1.2.1 → pybare-1.2.3}/README.md

@@ -2,7 +2,7 @@
 [![builds.sr.ht status](https://builds.sr.ht/~chiefnoah/pybare.svg)](https://builds.sr.ht/~chiefnoah/pybare?)
 
 A declarative implementation of the [BARE](https://baremessages.org/) message
-format for Python 3.11+
+format for Python 3.10+
 
 ---
 
@@ -24,36 +24,43 @@ pip install pybare
 pybare fully implements all BARE types for both encoding and decoding. This
 includes reading multiple messages from the same `BinaryIO` stream.
 
-### TODO
+## Gotchas
 
-- [ ] Codegen based on `.schema` files
-- [ ] Better documentation
-- [ ] More tests
-- [ ] Fast C implementation for encoding
+We use "Array" / "array" instead of "List" / "list" to avoid conflicts with Python's
+common builtin type of the same name.
 
 ## Examples
 
+An example that defines the types used as an example in the RFC may be found in
+[`example.py`](./example.py)
+
 pybare currently requires you define your structures by hand. Examples can be
 found in the
 [tests](https://git.sr.ht/~chiefnoah/pybare/tree/master/bare/test_encoder.py).
 
 ### Quickstart
 
+The general convention is type identifiers start with a *capital* letter and anonymous
+generating functions begin with a lowercase. This follows general "pythonic" style for
+classes vs functions.
+
 ```python
-from bare import Struct, map, Str, UInt, optional, data, array, Void
+from bare import Struct, map, Str, UInt, optional, data, array, Void, struct, U8
 
 # Alternatively, class Data(size=64): ...
 PubKey = data(64) # 512 bits
 
 class User(Struct):
-    username = Filed(Str)
+    username = Field(Str)
     userid = Field(Int)
     email = Field(optional(Str))
     keys = Field(map(Str, PubKey))
     repos = Field(array(Str)) # variable length array
+    # anonymous array and struct
+    friends = Field(array(struct(name=Str, age=U8)))
 
 
-noah = User(username="chiefnoah", userid=1, email=Void(), keys={}, repos=[])
+noah = User(username="chiefnoah", userid=1, email=Void(), keys={}, repos=[], friends=[])
 noah.username == 'chiefnoah'
 noah.username = 'someoneelse'
 noah.username == 'someoneelse'

{pybare-1.2.1 → pybare-1.2.3}/bare/__init__.py

@@ -7,7 +7,7 @@ BARE RFC.
 """
 
 from .barearray import Array, array
-from .barestruct import Field, Struct
+from .barestruct import Field, Struct, struct
 from .baretype import BAREType
 from .data import Data, data
 from .map import Map, map
@@ -43,6 +43,7 @@ __all__ = [
     "array",
     "Field",
     "Struct",
+    "struct",
     "Map",
     "map",
 ]

{pybare-1.2.1 → pybare-1.2.3}/bare/barearray.py

@@ -1,7 +1,8 @@
+from __future__ import annotations
 import io
-from typing import (Any, BinaryIO, ClassVar, Generic, Iterable, Optional,
-                    Self, Type, TypeVar, _ProtocolMeta)
 from collections import UserList
+from typing import (Any, BinaryIO, ClassVar, Generic, Iterable, Optional, Type,
+                    TypeVar, _ProtocolMeta)
 
 from .baretype import BAREType
 from .number import UInt
@@ -60,7 +61,9 @@ class ArrayValidator(Generic[T, A]):
             else:
                 _value.append(v)  # type: ignore
         if self.size and len(_value) != self.size:
-            raise ValueError(f"Array size mismatch. Expected {self.size}, got {len(_value)}")
+            raise ValueError(
+                f"Array size mismatch. Expected {self.size}, got {len(_value)}"
+            )
         inst.__dict__["_inner"] = _value
 
 
@@ -144,7 +147,7 @@ class Array(Generic[T, A], BAREType[T], metaclass=ArrayMeta):
         return fp.getbuffer()
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> Array:
         size = cls._size or UInt.unpack(fp).value
         out = []
         for _ in range(size):
@@ -166,7 +169,9 @@ class Array(Generic[T, A], BAREType[T], metaclass=ArrayMeta):
         return f"{self.__class__.__name__}({repr(self.value)})"
 
 
-def array(inner: Type[BAREType[Any]], size: Optional[int] = None) -> Type[Array[Any, A]]:
+def array(
+    inner: Type[BAREType[Any]], size: Optional[int] = None
+) -> Type[Array[Any, A]]:
     """
     A function that defines and returns anonymous BARE `Array` subclass with
     the provided `inner` type and (optional) `size` arguments.

{pybare-1.2.1 → pybare-1.2.3}/bare/barestruct.py

@@ -1,13 +1,15 @@
 from __future__ import annotations
 
-from typing import Any, BinaryIO, _ProtocolMeta
+from typing import Any, BinaryIO, _ProtocolMeta, Type, Dict, TypeVar
 
 from .util import Field
 from .baretype import BAREType
 
-__all__ = ["Struct"]
+__all__ = ["Struct", "struct"]
 
 
+T = TypeVar("T")
+
 class StructMeta(_ProtocolMeta, type):
     def __new__(cls, clsname, bases, clsdict):
         fields = {}
@@ -118,3 +120,24 @@ class Struct(BAREType, metaclass=StructMeta):
                     return False
             return True
         return NotImplemented
+
+def struct(**kwargs: Dict[str, BAREType[T]]) -> Type[Struct]:
+    """
+    A function that defines and returnes an anonymous BARE `Struct` subclass with the
+    provided `kwargs` as fields. The name of each kwarg becomes the field name, with the
+    value being the field type. The field type is implicitly wrapped in a `Field`.Field
+
+    Proper usage of this function is as follows:
+
+    ```
+    MyStruct = struct(a=UInt, b=Str)
+    ```
+
+    Note that the name of the class is unspecified, use at your own risk.
+    """
+    name = "Struct_{}_anonymous".format("_".join(kwargs.keys()))
+    namespace = StructMeta.__prepare__(name, (Struct,))
+    namespace.update({field: Field(ty) for field, ty in kwargs.items()})  # type: ignore
+    AnonymousStruct = StructMeta.__new__(StructMeta, name, (Struct,), namespace)
+    StructMeta.__init__(AnonymousStruct, name, (Struct,), namespace)
+    return AnonymousStruct

{pybare-1.2.1 → pybare-1.2.3}/bare/baretype.py

@@ -1,5 +1,6 @@
+from __future__ import annotations
 from abc import abstractmethod
-from typing import Any, BinaryIO, Generic, Protocol, TypeVar, Self
+from typing import Any, BinaryIO, Generic, Protocol, TypeVar
 
 T = TypeVar("T", covariant=True)
 
@@ -15,7 +16,7 @@ class BAREType(Protocol, Generic[T]):
 
     @classmethod
     @abstractmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> BAREType:
         ...
 
     @classmethod

{pybare-1.2.1 → pybare-1.2.3}/bare/data.py

@@ -1,5 +1,6 @@
+from __future__ import annotations
 import io
-from typing import Any, BinaryIO, Optional, Self, Type, TypeVar, _ProtocolMeta
+from typing import Any, BinaryIO, Optional, Type, TypeVar, _ProtocolMeta
 
 from .baretype import BAREType
 from .number import UInt
@@ -64,7 +65,7 @@ class Data(BAREType[bytes], metaclass=DataMeta):
         return self.value == other.value
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> Data:
         size = cls._size or UInt.unpack(fp).value
         buf = fp.read(size)
         return cls(buf)

{pybare-1.2.1 → pybare-1.2.3}/bare/map.py

@@ -1,5 +1,7 @@
+from __future__ import annotations
+
 import io
-from typing import Any, BinaryIO, Mapping, Self, Type, TypeVar, _ProtocolMeta
+from typing import Any, BinaryIO, Mapping, Type, TypeVar, _ProtocolMeta
 
 from .baretype import BAREType
 from .number import UInt
@@ -99,7 +101,7 @@ class Map(BAREType[dict[K, V]], metaclass=MapMeta):
         return fp.getbuffer()
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> Map:
         size = UInt.unpack(fp).value
         out = {}
         for _ in range(size):

{pybare-1.2.1 → pybare-1.2.3}/bare/misc.py

@@ -1,6 +1,8 @@
+from __future__ import annotations
+
 import io
-from enum import EnumType, IntEnum
-from typing import Any, BinaryIO, Self, _ProtocolMeta
+from enum import EnumMeta, IntEnum
+from typing import Any, BinaryIO
 
 from .baretype import BAREType
 from .number import UInt
@@ -8,7 +10,7 @@ from .number import UInt
 __all__ = ["Enum", "Void", "Str"]
 
 
-class Enum(IntEnum, metaclass=EnumType):
+class Enum(IntEnum, metaclass=EnumMeta):
     """
     A BARE enum type. It is a subclass of `IntEnum` and is used to represent
     a BARE enum type.
@@ -34,7 +36,7 @@ class Enum(IntEnum, metaclass=EnumType):
         return UInt(self.value).pack()
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> Enum:
         x = UInt.unpack(fp).value
         return cls(x)
 
@@ -70,7 +72,7 @@ class Void:
         return bytes()
 
     @classmethod
-    def unpack(cls, _: BinaryIO) -> Self:
+    def unpack(cls, _: BinaryIO) -> Void:
         return cls()
 
     def __eq__(self, other: Any) -> bool:
@@ -122,7 +124,7 @@ class Str(BAREType[str]):
         return isinstance(value, (str, cls))
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> Str:
         size = UInt.unpack(fp).value
         buf = fp.read(size)
         if len(buf) != size:

{pybare-1.2.1 → pybare-1.2.3}/bare/number.py

@@ -1,6 +1,8 @@
+from __future__ import annotations
+
 import io
 import struct
-from typing import Any, BinaryIO, Generic, Self, TypeVar
+from typing import Any, BinaryIO, Generic, TypeVar
 
 from .baretype import BAREType
 
@@ -64,7 +66,7 @@ class UInt(NumberMixin[int], BAREType[int]):
         return buf.getvalue()
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> UInt:
         return cls(_read_varint(fp, False))
 
     @classmethod
@@ -102,7 +104,7 @@ class Int(NumberMixin[int]):
         return buf.getvalue()
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> Int:
         return cls(_read_varint(fp, True))
 
     @classmethod
@@ -136,7 +138,7 @@ class F64(NumberMixin[float]):
         return struct.pack("<d", self.value)
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> F64:
         buf = fp.read(struct.calcsize("<d"))
         return cls(struct.unpack("<d", buf)[0])
 
@@ -169,7 +171,7 @@ class F32(NumberMixin[float]):
         return struct.pack("<f", self.value)
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> F32:
         buf = fp.read(struct.calcsize("<f"))
         return cls(struct.unpack("<f", buf)[0])  # type: ignore
 
@@ -193,7 +195,7 @@ class U8(NumberMixin[int]):
         return struct.pack("<B", self.value)
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> U8:
         buf = fp.read(struct.calcsize("<B"))
         return cls(struct.unpack("<B", buf)[0])  # type: ignore
 
@@ -217,7 +219,7 @@ class Bool(NumberMixin[bool]):
         return struct.pack("<?", self.value)
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> Bool:
         buf = fp.read(struct.calcsize("<?"))
         return cls(struct.unpack("<?", buf)[0])  # type: ignore
 
@@ -235,7 +237,7 @@ class I8(NumberMixin[int]):
         return struct.pack("<b", self.value)
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> I8:
         buf = fp.read(struct.calcsize("<b"))
         return cls(struct.unpack("<b", buf)[0])  # type: ignore
 
@@ -259,7 +261,7 @@ class U16(NumberMixin[int]):
         return struct.pack("<H", self.value)
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> U16:
         buf = fp.read(struct.calcsize("<H"))
         return cls(struct.unpack("<H", buf)[0])  # type: ignore
 
@@ -283,7 +285,7 @@ class I16(NumberMixin[int]):
         return struct.pack("<h", self.value)
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> I16:
         buf = fp.read(struct.calcsize("<h"))
         return cls(struct.unpack("<h", buf)[0])  # type: ignore
 
@@ -307,7 +309,7 @@ class U32(NumberMixin[int]):
         return struct.pack("<L", self.value)
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> U32:
         buf = fp.read(struct.calcsize("<L"))
         return cls(struct.unpack("<L", buf)[0])  # type: ignore
 
@@ -331,7 +333,7 @@ class I32(NumberMixin[int]):
         return struct.pack("<l", self.value)
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> I32:
         buf = fp.read(struct.calcsize("<l"))
         return cls(struct.unpack("<l", buf)[0])  # type: ignore
 
@@ -355,7 +357,7 @@ class U64(NumberMixin[int]):
         return struct.pack("<Q", self.value)
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> U64:
         buf = fp.read(struct.calcsize("<Q"))
         return cls(struct.unpack("<Q", buf)[0])  # type: ignore
 
@@ -382,7 +384,7 @@ class I64(NumberMixin[int]):
         return struct.pack("<q", self.value)
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> I64:
         buf = fp.read(struct.calcsize("<q"))
         return cls(struct.unpack("<q", buf)[0])  # type: ignore
 

{pybare-1.2.1 → pybare-1.2.3}/bare/test_barestruct.py

@@ -1,5 +1,5 @@
 import io
-from bare import Struct, UInt, Str, Field
+from bare import Struct, UInt, Str, Field, struct
 
 def test_struct_basic():
     class MyStruct(Struct):
@@ -22,3 +22,10 @@ def test_nested_struct():
     b = x.pack()
     x2 = MyStruct.unpack(io.BytesIO(b))
     assert x == x2
+
+def test_anonymous_struct():
+    MyStruct = struct(name=Str, age=UInt)
+    x = MyStruct(name="Noah", age=27)
+    b = x.pack()
+    x2 = MyStruct.unpack(io.BytesIO(b))
+    assert x == x2

{pybare-1.2.1 → pybare-1.2.3}/bare/union.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import io
-from typing import Any, BinaryIO, Generic, Iterable, Self, Type, TypeVar
+from typing import Any, BinaryIO, Generic, Iterable, Type, TypeVar
 
 from .misc import Void
 from .number import UInt
@@ -104,7 +104,7 @@ class Union(metaclass=UnionMeta, variants=()):
         return buf.getbuffer()
 
     @classmethod
-    def unpack(cls, fp: BinaryIO) -> Self:
+    def unpack(cls, fp: BinaryIO) -> Union:
         discriminant = UInt.unpack(fp).value
         if discriminant not in cls._variants:
             raise TypeError(

{pybare-1.2.1 → pybare-1.2.3}/pybare.egg-info/PKG-INFO

@@ -1,15 +1,16 @@
 Metadata-Version: 2.1
 Name: pybare
-Version: 1.2.1
+Version: 1.2.3
 Summary: A declarative implementation of BARE for Python
 Home-page: https://sr.ht/~chiefnoah/pybare/
 Author: Noah Pederson
 Author-email: noah@packetlost.dev
+Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.11
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
@@ -17,7 +18,7 @@ License-File: LICENSE
 [![builds.sr.ht status](https://builds.sr.ht/~chiefnoah/pybare.svg)](https://builds.sr.ht/~chiefnoah/pybare?)
 
 A declarative implementation of the [BARE](https://baremessages.org/) message
-format for Python 3.11+
+format for Python 3.10+
 
 ---
 
@@ -39,36 +40,43 @@ pip install pybare
 pybare fully implements all BARE types for both encoding and decoding. This
 includes reading multiple messages from the same `BinaryIO` stream.
 
-### TODO
+## Gotchas
 
-- [ ] Codegen based on `.schema` files
-- [ ] Better documentation
-- [ ] More tests
-- [ ] Fast C implementation for encoding
+We use "Array" / "array" instead of "List" / "list" to avoid conflicts with Python's
+common builtin type of the same name.
 
 ## Examples
 
+An example that defines the types used as an example in the RFC may be found in
+[`example.py`](./example.py)
+
 pybare currently requires you define your structures by hand. Examples can be
 found in the
 [tests](https://git.sr.ht/~chiefnoah/pybare/tree/master/bare/test_encoder.py).
 
 ### Quickstart
 
+The general convention is type identifiers start with a *capital* letter and anonymous
+generating functions begin with a lowercase. This follows general "pythonic" style for
+classes vs functions.
+
 ```python
-from bare import Struct, map, Str, UInt, optional, data, array, Void
+from bare import Struct, map, Str, UInt, optional, data, array, Void, struct, U8
 
 # Alternatively, class Data(size=64): ...
 PubKey = data(64) # 512 bits
 
 class User(Struct):
-    username = Filed(Str)
+    username = Field(Str)
     userid = Field(Int)
     email = Field(optional(Str))
     keys = Field(map(Str, PubKey))
     repos = Field(array(Str)) # variable length array
+    # anonymous array and struct
+    friends = Field(array(struct(name=Str, age=U8)))
 
 
-noah = User(username="chiefnoah", userid=1, email=Void(), keys={}, repos=[])
+noah = User(username="chiefnoah", userid=1, email=Void(), keys={}, repos=[], friends=[])
 noah.username == 'chiefnoah'
 noah.username = 'someoneelse'
 noah.username == 'someoneelse'

{pybare-1.2.1 → pybare-1.2.3}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="pybare",  # Replace with your own username
-    version="1.2.1",
+    version="1.2.3",
     author="Noah Pederson",
     author_email="noah@packetlost.dev",
     description="A declarative implementation of BARE for Python",
@@ -14,10 +14,11 @@ setuptools.setup(
     url="https://sr.ht/~chiefnoah/pybare/",
     packages=setuptools.find_packages(),
     classifiers=[
+        "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
     ],
-    python_requires=">=3.11",
+    python_requires=">=3.10",
 )