refactor: finish typing hints (#21)

* Add stubs for is_ipfs dependencies :  py-cid, py-multibase

* refactor: finish typing hints for py-is_ipfs:
  * add stubs to setup
  * add py.typed
  * update dev dependcies
  * add type testing to tox.ini
  * add basic mypy.ini

Author: Barabazs

cid-stubs/__init__.pyi

@@ -0,0 +1,8 @@
+from .cid import (
+    CIDv0 as CIDv0,
+    CIDv1 as CIDv1,
+    from_bytes as from_bytes,
+    from_string as from_string,
+    is_cid as is_cid,
+    make_cid as make_cid,
+)

cid-stubs/cid.pyi

@@ -0,0 +1,36 @@
+from _typeshed import Incomplete
+from typing import Union, Callable
+
+class BaseCID:
+    __hash__: Callable[[object], int]
+    def __init__(self, version: int, codec: str, multihash: str) -> None: ...
+    @property
+    def version(self) -> int: ...
+    @property
+    def codec(self) -> str: ...
+    @property
+    def multihash(self) -> bytes: ...
+    @property
+    def buffer(self) -> None: ...
+    def encode(self, *args, **kwargs) -> None: ...
+    def __eq__(self, other): ...
+
+class CIDv0(BaseCID):
+    CODEC: str
+    def __init__(self, multihash: bytes) -> None: ...
+    @property
+    def buffer(self): ...
+    def encode(self): ...
+    def to_v1(self) -> CIDv1: ...
+
+class CIDv1(BaseCID):
+    def __init__(self, codec: str, multihash: Union[str, bytes]) -> None: ...
+    @property
+    def buffer(self): ...
+    def encode(self, encoding=...): ...
+    def to_v0(self) -> CIDv0: ...
+
+def make_cid(*args) -> Union[CIDv0, CIDv1]: ...
+def is_cid(cidstr: Union[str, bytes]) -> bool: ...
+def from_string(cidstr: str) -> Union[CIDv0, CIDv1]: ...
+def from_bytes(cidbytes: bytes) -> Union[CIDv0, CIDv1]: ...

is_ipfs/is_ipfs.py

@@ -248,7 +248,7 @@ def _id_is_explicit_tld(self, input_string: str) -> bool:
             r"(?=^.{4,253}\.?$)(^((?!-)[a-zA-Z0-9-]{1,63}(?<!-)\.)+[a-zA-Z]{2,63}$)"
         )
         hostname = urlparse(f"http://{input_string}").hostname
-        return bool(re.search(fqdn_with_tld, hostname))
+        return bool(re.search(fqdn_with_tld, hostname)) if hostname else False
 
     def _is_native_ipfs_url(self) -> bool:
         """

is_ipfs/py.typed

@@ -0,0 +1,8 @@
+from .multibase import (
+    ENCODINGS as ENCODINGS,
+    Encoding as Encoding,
+    decode as decode,
+    encode as encode,
+    get_codec as get_codec,
+    is_encoded as is_encoded,
+)

multibase-stubs/__init__.pyi

@@ -0,0 +1,31 @@
+from _typeshed import Incomplete
+from baseconv import BaseConverter  # type: ignore
+
+class BaseStringConverter(BaseConverter):
+    def encode(self, bytes: bytes) -> bytes: ...
+    def bytes_to_int(self, bytes: bytes) -> int: ...
+    def decode(self, bytes: bytes) -> bytes: ...
+
+class Base16StringConverter(BaseStringConverter):
+    def encode(self, bytes: bytes) -> bytes: ...
+
+class BaseByteStringConverter:
+    ENCODE_GROUP_BYTES: int
+    ENCODING_BITS: int
+    DECODING_BITS: int
+    digits: Incomplete
+    def __init__(self, digits): ...
+    def encode(self, bytes): ...
+    def decode(self, bytes): ...
+
+class Base64StringConverter(BaseByteStringConverter):
+    def encode(self, bytes: bytes) -> bytes: ...
+    def decode(self, bytes: bytes) -> bytes: ...
+
+class Base32StringConverter(BaseByteStringConverter):
+    def encode(self, bytes: bytes) -> bytes: ...
+    def decode(self, bytes: bytes) -> bytes: ...
+
+class IdentityConverter:
+    def encode(self, x): ...
+    def decode(self, x): ...

multibase-stubs/converters.pyi

@@ -0,0 +1,28 @@
+from .converters import (
+    Base16StringConverter as Base16StringConverter,
+    Base32StringConverter as Base32StringConverter,
+    Base64StringConverter as Base64StringConverter,
+    BaseStringConverter as BaseStringConverter,
+    IdentityConverter as IdentityConverter,
+)
+from typing import List, NamedTuple, Union, Dict
+
+class Encoding(NamedTuple):
+    encoding: str
+    code: bytes
+    converter: Union[
+        IdentityConverter,
+        BaseStringConverter,
+        Base16StringConverter,
+        Base32StringConverter,
+        Base64StringConverter,
+    ]
+
+CODE_LENGTH: int
+ENCODINGS: List[Encoding]
+ENCODINGS_LOOKUP: Dict[Union[str, bytes], Encoding]
+
+def encode(encoding: str, data: Union[str, bytes]) -> bytes: ...
+def get_codec(data: Union[str, bytes]) -> Encoding: ...
+def is_encoded(data: Union[str, bytes]) -> bool: ...
+def decode(data: Union[str, bytes]) -> str: ...

multibase-stubs/multibase.pyi

@@ -0,0 +1,5 @@
+# Global options:
+
+[mypy]
+warn_return_any = True
+warn_unused_configs = True

mypy.ini

@@ -1,3 +1,5 @@
 pre-commit==2.17.0
 black==22.3.0
-tox
+tox
+coverage
+mypy

requirements-dev.txt

@@ -6,13 +6,17 @@
 
 setuptools.setup(
     name="py-is_ipfs",
-    version="0.4.0",
+    version="0.5.0",
     description="Python library to identify valid IPFS resources",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/Barabazs/py-is_ipfs",
     author="Barabazs",
     packages=setuptools.find_packages(exclude=["tests", "tests.*"]),
+    package_data={
+        "cid-stubs": ["__init__.pyi", "cid.pyi"],
+        "multibase-stubs": ["__init__.pyi", "converters.pyi", "multibase.pyi"],
+    },
     license="MIT",
     classifiers=[
         "Development Status :: 4 - Beta",