pybare 1.2.2__tar.gz → 1.2.3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pybare
-Version: 1.2.2
+Version: 1.2.3
 Summary: A declarative implementation of BARE for Python
 Home-page: https://sr.ht/~chiefnoah/pybare/
 Author: Noah Pederson
@@ -18,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+
 
 ---
 
@@ -40,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.2 → 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.2 → 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.2 → 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.2 → 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.2 → pybare-1.2.3}/pybare.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pybare
-Version: 1.2.2
+Version: 1.2.3
 Summary: A declarative implementation of BARE for Python
 Home-page: https://sr.ht/~chiefnoah/pybare/
 Author: Noah Pederson
@@ -18,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+
 
 ---
 
@@ -40,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.2 → 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.2",
+    version="1.2.3",
     author="Noah Pederson",
     author_email="noah@packetlost.dev",
     description="A declarative implementation of BARE for Python",