Merge pull request #65 from acul71/fix/typecheck

Fix/typecheck

- Great efforts by Arush (arcinston) and Luca (acul71)

Author: seetadev

.bumpversion.cfg

@@ -0,0 +1,12 @@
+[bumpversion]
+current_version = 0.0.9
+commit = True
+tag = True
+
+[bumpversion:file:pyproject.toml]
+search = version = "{current_version}"
+replace = version = "{new_version}"
+
+[bumpversion:file:multiaddr/__init__.py]
+search = __version__ = '{current_version}'
+replace = __version__ = '{new_version}'

.editorconfig

@@ -23,6 +23,8 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+poetry.lock
+uv.lock
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

.flake8

@@ -0,0 +1,25 @@
+exclude: '.project-template|docs/conf.py|.*pb2\..*'
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: check-toml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.15.0
+    hooks:
+      - id: pyupgrade
+        args: [--py39-plus]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.10
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+  - repo: https://github.com/northisup/pyright-pretty
+    rev: v0.1.0
+    hooks:
+      - id: pyright-pretty
+        args: [--show-summary]

.gitignore

@@ -16,7 +16,7 @@ help:
 	@echo "clean-build - remove build artifacts"
 	@echo "clean-pyc - remove Python file artifacts"
 	@echo "clean-test - remove test and coverage artifacts"
-	@echo "lint - check style with flake8"
+	@echo "lint - check style with ruff"
 	@echo "test - run tests quickly with the default Python"
 	@echo "test-all - run tests on every Python version with tox"
 	@echo "coverage - check code coverage quickly with the default Python"
@@ -49,13 +49,20 @@ setup:
 	pip install -r requirements_dev.txt
 
 lint:
-	flake8 multiaddr/* tests/*
+	python -m ruff check --fix
+
+fix:
+	python -m ruff check --fix
+
+typecheck:
+	pre-commit run pyright-pretty --all-files
 
 test:
-	TOXENV=py27 tox
+	python -m pytest tests
 
 test-all:
-	tox
+	python3.11 -m pytest tests
+	python3.13 -m pytest tests
 
 coverage:
 	coverage run --source multiaddr setup.py test

.pre-commit-config.yaml

@@ -40,7 +40,8 @@ Simple
     m1 = Multiaddr("/ip4/127.0.0.1/udp/1234")
 
     # construct from bytes
-    m2 = Multiaddr(bytes_addr=m1.to_bytes())
+    #m2 = Multiaddr(bytes_addr=m1.to_bytes()) # deprecated
+    m2 = Multiaddr(m1.to_bytes())
 
     assert str(m1) == "/ip4/127.0.0.1/udp/1234"
     assert str(m1) == str(m2)

Makefile

@@ -1,22 +1,43 @@
 import importlib
-
+from typing import Any, Dict, Union
 
 # These are special sizes
 LENGTH_PREFIXED_VAR_SIZE = -1
 
 
-class NoneCodec:
-    SIZE = 0
-    IS_PATH = False
+class CodecBase:
+    SIZE: int
+    IS_PATH: bool
+
+    def to_string(self, proto: Any, buf: bytes) -> str:
+        raise NotImplementedError
+
+    def to_bytes(self, proto: Any, string: str) -> bytes:
+        raise NotImplementedError
+
+
+class NoneCodec(CodecBase):
+    SIZE: int = 0
+    IS_PATH: bool = False
+
+    def to_string(self, proto: Any, buf: bytes) -> str:
+        return ""
+
+    def to_bytes(self, proto: Any, string: str) -> bytes:
+        return b""
 
 
-CODEC_CACHE = {}
+CODEC_CACHE: Dict[str, CodecBase] = {}
 
 
-def codec_by_name(name):
-    if name is None:  # Special “do nothing – expect nothing” pseudo-codec
-        return NoneCodec
+def codec_by_name(name: Union[str, None]) -> CodecBase:
+    if name is None:  # Special "do nothing - expect nothing" pseudo-codec
+        return NoneCodec()
     codec = CODEC_CACHE.get(name)
-    if not codec:
-        codec = CODEC_CACHE[name] = importlib.import_module(".{0}".format(name), __name__)
+    if codec is None:
+        module = importlib.import_module(f".{name}", __name__)
+        codec_class = getattr(module, "Codec")
+        assert codec_class is not None, f"Codec {name} not found"
+        codec = codec_class()
+        CODEC_CACHE[name] = codec
     return codec