Refactor for minimal lib (v2.0.0)

.gitignore

@@ -49,4 +49,9 @@ genrst/
 .DS_Store
 
 *.egg-info
-.venv
+.venv
+
+# VSCode
+settings.json
+
+.coverage

.pylintrc

@@ -0,0 +1,21 @@
+[MESSAGES CONTROL]
+disable=
+    invalid-name,                   # C0103
+    missing-module-docstring,       # C0114
+    missing-class-docstring,        # C0115
+    missing-function-docstring,     # C0116
+    consider-using-f-string,        # C0209
+    line-too-long,                  # C0301
+    ; trailing-whitespace,            # C0303
+    import-outside-toplevel,        # C0415
+    ; unsubscriptable-object,         # E1136
+    too-many-instance-attributes,   # R0902
+    too-few-public-methods,         # R0903
+    too-many-return-statements,     # R0911
+    ; too-many-branches,              # R0912
+    ; too-many-arguments,             # R0913
+    too-many-locals,                # R0914
+    ; too-many-positional-arguments,  # R0917
+    unused-argument                 # W0613
+    ; bare-except,                    # W0702
+    ; broad-exception-raised,         # W0719

README.md

@@ -3,3 +3,22 @@
 # urtypes
 
 Python implementation of the [Blockchain Commons UR Types specification](https://github.com/BlockchainCommons/Research/blob/master/papers/bcr-2020-006-urtypes.md).
+
+## Development
+
+Execute **tests**:
+```
+poetry run pytest tests
+```
+
+See **coverage**:
+```
+poetry run pytest --cov=urtypes --cov-report=term-missing --cov-report=html
+```
+
+**Before commit, check pylint, vulture and format with black**:
+```
+poetry run pylint src
+poetry run vulture src
+poetry run black src
+```

pyproject.toml

@@ -44,4 +44,6 @@ python = "^3.10"
 pytest = "^6.2.5"
 pytest-mock = "^3.6.1"
 pytest-cov = "^3.0.0"
-black = "^22.1.0"
+black = "^22.1.0"
+vulture = "^2.14"
+pylint = "^4.0.2"

src/urtypes/__init__.py

@@ -19,7 +19,3 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
-
-from .registry import *
-from .bytes import *
-from .crypto import *

src/urtypes/bytes.py

@@ -20,19 +20,15 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-from urtypes import RegistryType, RegistryItem
+from .registry import RegistryType, RegistryItem
 
 BYTES = RegistryType("bytes", None)
 
 
 class Bytes(RegistryItem):
     def __init__(self, data):
-        super().__init__()
         self.data = data
 
-    def __eq__(self, o):
-        return self.data == o.data
-
     @classmethod
     def registry_type(cls):
         return BYTES

src/urtypes/cbor/__init__.py

@@ -21,7 +21,3 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
-
-from .data import *
-from .decoder import *
-from .encoder import *

src/urtypes/cbor/data.py

@@ -24,53 +24,47 @@
 # coding: utf-8
 
 
-class Tagging(object):
+class Tagging:
     __slots__ = ("tag", "obj")
 
     def __init__(self, tag, obj):
         self.tag = tag
         self.obj = obj
 
-    def __eq__(self, other):
-        return (
-            isinstance(other, Tagging)
-            and self.tag == other.tag
-            and self.obj == other.obj
-        )
 
+class Mapping:
+    __slots__ = ("map",)
 
-class Mapping(object):
-    __slots__ = "map"
-
-    def __init__(self, map):
-        self.map = map
+    def __init__(self, _map):
+        self.map = _map
 
+    @staticmethod
     def mapping(obj):
         return Mapping(obj)
 
 
 class DataItem(Tagging):
-    def __init__(self, tag, map):
-        super().__init__(tag, Mapping(map))
+    def __init__(self, tag, _map):
+        super().__init__(tag, Mapping(_map))
         self.tag = tag
-        self.map = map
+        self.map = _map
 
 
-class _Undefined(object):
-    _instance = None
+# class _Undefined:
+#     _instance = None
 
-    def __new__(cls, *args, **kwargs):
-        if not isinstance(cls._instance, cls):
-            cls._instance = object.__new__(cls, *args, **kwargs)
-        return cls._instance
+#     def __new__(cls, *args, **kwargs):
+#         if not isinstance(cls._instance, cls):
+#             cls._instance = object.__new__(cls, *args, **kwargs)
+#         return cls._instance
 
-    def __str__(self):
-        return "Undefined"
+#     def __str__(self):
+#         return "Undefined"
 
-    def __repr__(self):
-        return "Undefined"
+#     def __repr__(self):
+#         return "Undefined"
 
 
-Undefined = _Undefined()
+# Undefined = _Undefined()
 
-__all__ = ["Tagging", "Mapping", "DataItem"]
+__all__ = ("Tagging", "Mapping", "DataItem")