moat-lib-codec 0.2.4__tar.gz

moat_lib_codec-0.2.4/.gitignore

@@ -0,0 +1,48 @@
+__pycache__/
+/debian/
+.#*
+\#*
+/build/
+.cache
+/*.cfg
+*,cover
+.coverage
+.coverage.*
+/.coverage
+/coverage.xml
+/dist/
+docs/_build/
+docs/build/
+/downloads/
+/*.egg
+/*.egg-info/
+/.eggs/
+/eggs/
+/.env
+/env/
+/ENV/
+/htmlcov/
+/.hypothesis/
+/.installed.cfg
+*.log
+*.manifest
+*.mo
+/obj/
+/parts/
+pip-delete-this-directory.txt
+pip-log.txt
+*.pot
+/.pybuild/
+*.py[cod]
+/.pytest_cache/
+/sdist/
+*.so
+/tests/plugins/test.db
+.tox/
+/var/
+/.venv
+/venv/
+/wheels/
+
+# Debian packaging
+/debian/

moat_lib_codec-0.2.4/Makefile

@@ -0,0 +1,15 @@
+#!/usr/bin/make -f
+
+PACKAGE = moat-lib-codec
+MAKEINCL ?= $(shell python3 -mmoat src path)/make/py
+
+ifneq ($(wildcard $(MAKEINCL)),)
+include $(MAKEINCL)
+# availabe via http://github.com/smurfix/sourcemgr
+
+else
+%:
+	@echo "Please fix 'python3 -mmoat src path'."
+	@exit 1
+endif
+

moat_lib_codec-0.2.4/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.1
+Name: moat-lib-codec
+Version: 0.2.4
+Summary: A simple command/stream multiplexer
+Author-email: Matthias Urlichs <matthias@urlichs.de>
+Maintainer-email: Matthias Urlichs <matthias@urlichs.de>
+Project-URL: homepage, https://m-o-a-t.org
+Project-URL: repository, https://github.com/M-o-a-T/moat-lib-codec
+Keywords: MoaT
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved
+Classifier: Framework :: AnyIO
+Classifier: Framework :: Trio
+Classifier: Framework :: AsyncIO
+Classifier: Programming Language :: Python :: 3
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+Requires-Dist: anyio~=3.0
+
+======================
+The MoaT-Codec library
+======================
+
+This library packages various codecs used for MoaT protocols
+in a way that's reason- and stream-able.
+
+Interface
++++++++++
+
+Codec
+-----
+
+* encode(obj)
+
+  Encode the object to a bytestream.
+
+* decode(bytes)
+
+  Decode the given bytes to a single object.
+
+* feed(bytes, final=False)
+
+  Data stream. Returns an array of objects.
+
+  This method only exists when a sequence of encoded objects can be streamed,
+  i.e. contains built-in message boundaries.
+
+  if @final is ``True``, raise an exception if there is an incomplete
+  object in the buffer after this call.
+
+* getstate(), setstate(\*args)
+
+  A streaming decoder may store partially-decoded state (unprocessed
+  buffer) here.
+
+The list of accepted objects is implementation dependent.
+
+Extension
+---------
+
+Extension types vary by whether they carry binary data as in (msgpack), or
+objects (as in cbor).
+
+* binary (classvar): True if msgpack-style, False if cbor-style
+
+* encoder(cls, key, fn)
+
+  Encode an object ``obj`` of type ``type``. ``fn(codec, obj)`` must return
+  a bytestring / an encodeable object. If the registration key is ``None``
+  the function must return a tuple with the key as first element.
+
+* decoder(key, fn)
+
+  Add a decoder (key, data) to an object. ``fn(codec, data)`` is called with a
+  bytestring / a decoded object, and returns whatever has been encoded.
+
+Extensions get the codec as their first argument. They can use it to store
+data, e.g. references. The extension object is available as ``codec.ext``.
+

moat_lib_codec-0.2.4/README.rst

@@ -0,0 +1,60 @@
+======================
+The MoaT-Codec library
+======================
+
+This library packages various codecs used for MoaT protocols
+in a way that's reason- and stream-able.
+
+Interface
++++++++++
+
+Codec
+-----
+
+* encode(obj)
+
+  Encode the object to a bytestream.
+
+* decode(bytes)
+
+  Decode the given bytes to a single object.
+
+* feed(bytes, final=False)
+
+  Data stream. Returns an array of objects.
+
+  This method only exists when a sequence of encoded objects can be streamed,
+  i.e. contains built-in message boundaries.
+
+  if @final is ``True``, raise an exception if there is an incomplete
+  object in the buffer after this call.
+
+* getstate(), setstate(\*args)
+
+  A streaming decoder may store partially-decoded state (unprocessed
+  buffer) here.
+
+The list of accepted objects is implementation dependent.
+
+Extension
+---------
+
+Extension types vary by whether they carry binary data as in (msgpack), or
+objects (as in cbor).
+
+* binary (classvar): True if msgpack-style, False if cbor-style
+
+* encoder(cls, key, fn)
+
+  Encode an object ``obj`` of type ``type``. ``fn(codec, obj)`` must return
+  a bytestring / an encodeable object. If the registration key is ``None``
+  the function must return a tuple with the key as first element.
+
+* decoder(key, fn)
+
+  Add a decoder (key, data) to an object. ``fn(codec, data)`` is called with a
+  bytestring / a decoded object, and returns whatever has been encoded.
+
+Extensions get the codec as their first argument. They can use it to store
+data, e.g. references. The extension object is available as ``codec.ext``.
+

moat_lib_codec-0.2.4/moat/__init__.py

@@ -0,0 +1,9 @@
+# noqa: D104
+
+from __future__ import annotations
+
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)
+
+from moat._dev_fix import _fix
+
+_fix()

moat_lib_codec-0.2.4/moat/lib/codec/__init__.py

@@ -0,0 +1,21 @@
+"""
+Codec library.
+"""
+
+from __future__ import annotations
+
+from ._base import Codec, Extension, NoCodecError
+
+
+__all__ = ["Codec", "Extension", "get_codec", "NoCodecError"]
+
+
+def get_codec(name, *a, **kw) -> Codec:
+    """
+    Loads and initializes the named codec.
+    """
+    from importlib import import_module
+
+    if "." not in name:
+        name = "moat.lib.codec." + name
+    return import_module(name).Codec(*a, **kw)

moat_lib_codec-0.2.4/moat/lib/codec/_base.py

@@ -0,0 +1,80 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from typing import Any, Callable
+
+
+class NoCodecError(ValueError):
+    "No codec found"
+
+
+class IncompleteData(ValueError):
+    "Stream chopped off"
+
+
+class Codec:
+    def __init__(self, ext=None):
+        if ext is None:
+            ext = Extension()  # empty
+        self.ext = ext
+        self.buf = b""
+
+    def encode(self, obj: Any) -> bytes:
+        raise NotImplementedError
+
+    def decode(self, data: Any) -> Any:
+        raise NotImplementedError
+
+    def feed(self, data, final: bool = False) -> list[Any]:
+        raise NotImplementedError
+
+
+class Extension:
+    binary: bool = None
+
+    def __init__(self):
+        self.enc: dict[type, tuple[int | None, Callable]] = {}
+        self.dec: dict(int, Callable) = {}
+
+    def encoder(self, key: int | None, cls: type, fn=None) -> None:
+        def _enc(fn):
+            self.enc[cls] = (key, fn)
+            return fn
+
+        if fn is None:
+            return _enc
+        else:
+            _enc(fn)
+
+    def decoder(self, key: int, fn=None) -> None:
+        def _dec(fn):
+            self.dec[key] = fn
+            return fn
+
+        if fn is None:
+            return _dec
+        else:
+            _dec(fn)
+
+    def encode(self, codec, obj) -> tuple[int, bytes]:
+        try:
+            key, fn = self.enc[type(obj)]
+        except KeyError:
+            try:
+                key, fn = self.enc[object]
+            except KeyError:
+                raise NoCodecError(codec, obj) from None
+
+        res = fn(codec, obj)
+        if key is None:
+            key, res = res
+        return key, res
+
+    def decode(self, codec, key, data):
+        try:
+            fn = self.dec[key]
+        except KeyError:
+            raise NoCodecError(codec, key) from None
+        return fn(codec, data)