adopted mypy --strict (#87)

Author: fametrano

.github/workflows/lint.yml

@@ -29,6 +29,6 @@ jobs:
           python-version: "3.11"
       - name: Check isort and black
         run: |
-          python -m pip install -U pip isort black
+          python -m pip install --upgrade pip isort black
           isort -c .
           black --check .

.github/workflows/test-pydev.yml

@@ -27,5 +27,5 @@ jobs:
           python-version: 3.12-dev
       - name: Run pytest
         run: |
-          python -m pip install -U -rrequirements.txt -rrequirements-dev.txt
+          python -m pip install --upgrade -rrequirements.txt -rrequirements-dev.txt
           pytest

.pre-commit-config.yaml

@@ -38,6 +38,13 @@ repos:
     hooks:
       - id: copyright-notice
         args: [--notice=COPYRIGHT]
+        files: python
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.3.1
+    hooks:
+      - id: pyupgrade
+        args: [--py37-plus]
+        # exclude: *fixtures
   - repo: https://github.com/PyCQA/autoflake
     rev: v2.0.0
     hooks:
@@ -50,12 +57,6 @@ repos:
           - --remove-duplicate-keys
           - --remove-unused-variables
           - --remove-rhs-for-unused-variables
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.3.1
-    hooks:
-      - id: pyupgrade
-        args: [--py37-plus]
-        # exclude: *fixtures
   - repo: https://github.com/pycqa/isort
     rev: 5.11.4
     hooks:
@@ -97,16 +98,15 @@ repos:
     hooks:
       - id: bandit
         name: bandit (tests)
-        # disable B101 (Test for use of assert) on tests folder
-        args: ["-s", "B101"]
+        # disable B101 (Test for use of assert) for the tests folder
+        args: ["--skip", "B101"]
         exclude: btclib
   - repo: https://github.com/pycqa/pylint
     rev: v2.15.9
     hooks:
       - id: pylint
         args: [
-            "-rn", # Only display messages
-            "-sn", # Don't display the score
+            "--score=false",
             "--disable=E0401", # import-error
           ]
   - repo: https://github.com/pre-commit/mirrors-mypy

HISTORY.md

@@ -2,7 +2,7 @@
 
 Notable changes to the codebase are documented here.
 
-Release names follow [*calendar versioning*](https://calver.org/):
+Release names follow [_calendar versioning_](https://calver.org/):
 full year, short month, short day (YYYY-M-D)
 
 ## v2023.0.0 (unreleased yet)
@@ -13,6 +13,7 @@ Major changes include:
 - improved typing
 - added SECURITY, CONTRIBUTING, bug report and feature request templates
 - added pre-commit hooks
+- adopted _mypy --strict_ and _from \_\_future\_\_ import annotations_
 
 ## v2022.12.31
 

MANIFEST.in

@@ -22,6 +22,7 @@ recursive-include btclib *.md
 recursive-include btclib *.txt
 recursive-include btclib *.bin
 recursive-include btclib *.typed
+recursive-include tests *.typed
 
 recursive-include tests *.bin
 recursive-include tests *.csv

btclib/alias.py

@@ -12,12 +12,11 @@
 
 mypy aliases, documenting also coding input conventions.
 """
+from __future__ import annotations
 
 from io import BytesIO
 from typing import Any, Callable, Tuple, Union
 
-from typing_extensions import TypeAlias
-
 # Octets are a sequence of eight-bit bytes or a hex-string (not text string)
 #
 # hex-strings are strings that can be converted to bytes using bytes.fromhex,
@@ -35,7 +34,7 @@
 # dsa.Sig (DER serialization of ECDSA signature),
 # ssa.Sig (BIP340 serialization of Schnorr signature)
 # etc.
-Octets: TypeAlias = Union[bytes, str]
+Octets = Union[bytes, str]
 
 # bytes or text string (not hex-string)
 #
@@ -61,23 +60,23 @@
 #
 # In those cases often there is no need to encode() to bytes
 # as b58decode/b32decode/etc. will take care of that
-String: TypeAlias = Union[bytes, str]
+String = Union[bytes, str]
 
 # binary data, usually to be cosumed as byte stream,
 # but possibily provided as Octets too
-BinaryData: TypeAlias = Union[BytesIO, Octets]
+BinaryData = Union[BytesIO, Octets]
 
 # hex-string or bytes representation of an int
 # Integer = Union[Octets, int]
-Integer: TypeAlias = Union[bytes, str, int]
+Integer = Union[bytes, str, int]
 
 # Hash digest constructor: it may be any name suitable to hashlib.new()
-HashF: TypeAlias = Callable[[], Any]
+HashF = Callable[[], Any]
 # HashF = Callable[[Any], Any]
 
 # Elliptic curve point in affine coordinates.
 # Warning: to make Point a NamedTuple would slow down the code
-Point: TypeAlias = Tuple[int, int]
+Point = Tuple[int, int]
 
 # Note that the infinity point in affine coordinates is INF = (int, 0)
 # (no affine point has y=0 coordinate in a group of prime order).
@@ -88,7 +87,7 @@
 INF = 5, 0
 
 # Elliptic curve point in Jacobian coordinates.
-JacPoint: TypeAlias = Tuple[int, int, int]
+JacPoint = Tuple[int, int, int]
 
 # Infinity point in Jacobian coordinates is INF = (int, int, 0).
 # It can be checked with 'INF[2] == 0'

btclib/amount.py

@@ -27,6 +27,8 @@
 (in a backward compatible way) in the future if such a need arises.
 """
 
+from __future__ import annotations
+
 from decimal import Decimal, FloatOperation, getcontext
 from typing import Any
 

btclib/b32.py

@@ -42,8 +42,9 @@
   (as this is not enforced by bech32.b32decode anymore)
 """
 
+from __future__ import annotations
 
-from typing import Iterable, List, Optional, Tuple
+from typing import Iterable
 
 from btclib.alias import Octets, String
 from btclib.bech32 import decode, encode
@@ -65,7 +66,7 @@ def has_segwit_prefix(addr: String) -> bool:
 
 def power_of_2_base_conversion(
     data: Iterable[int], from_bits: int, to_bits: int, pad: bool = True
-) -> List[int]:
+) -> list[int]:
     """Convert a power-of-two digit sequence to another power-of-two base."""
     acc = 0
     bits = 0
@@ -130,7 +131,7 @@ def address_from_witness(
     return _address_from_witness(wit_ver, wit_prg, hrp)
 
 
-def witness_from_address(b32addr: String) -> Tuple[int, bytes, str]:
+def witness_from_address(b32addr: String) -> tuple[int, bytes, str]:
     """Return the witness from a bech32 native SegWit address.
 
     The returned data structure is: version, program, network.
@@ -161,7 +162,7 @@ def witness_from_address(b32addr: String) -> Tuple[int, bytes, str]:
 # 1.+2. = 3. bech32 address from pub_key/script_pub_key
 
 
-def p2wpkh(key: Key, network: Optional[str] = None) -> str:
+def p2wpkh(key: Key, network: str | None = None) -> str:
     """Return the p2wpkh bech32 address corresponding to a public key."""
     pub_key, network = pub_keyinfo_from_key(key, network, compressed=True)
     return address_from_witness(0, hash160(pub_key), network)
@@ -174,8 +175,8 @@ def p2wsh(script_pub_key: Octets, network: str = "mainnet") -> str:
 
 
 def p2tr(
-    internal_key: Optional[Key] = None,
-    script_path: Optional[TaprootScriptTree] = None,
+    internal_key: Key | None = None,
+    script_path: TaprootScriptTree | None = None,
     network: str = "mainnet",
 ) -> str:
     """Return the p2tr bech32 address corresponding to a taproot output key."""

btclib/b58.py

@@ -13,8 +13,7 @@
 Base58 encoding of public keys and scripts as addresses,
 private keys as WIFs
 """
-
-from typing import Optional, Tuple
+from __future__ import annotations
 
 from btclib import b32
 from btclib.alias import Octets, String
@@ -29,7 +28,7 @@
 
 
 def wif_from_prv_key(
-    prv_key: PrvKey, network: Optional[str] = None, compressed: Optional[bool] = None
+    prv_key: PrvKey, network: str | None = None, compressed: bool | None = None
 ) -> str:
     """Return the WIF encoding of a private key."""
 
@@ -71,7 +70,7 @@ def address_from_h160(script_type: str, h160: Octets, network: str = "mainnet")
     return b58encode(payload).decode("ascii")
 
 
-def h160_from_address(b58addr: String) -> Tuple[str, bytes, str]:
+def h160_from_address(b58addr: String) -> tuple[str, bytes, str]:
     """Return the payload from a base58 address."""
 
     if isinstance(b58addr, str):
@@ -93,9 +92,7 @@ def h160_from_address(b58addr: String) -> Tuple[str, bytes, str]:
 # 1.+2. = 3. base58 address from pub_key/script_pub_key
 
 
-def p2pkh(
-    key: Key, network: Optional[str] = None, compressed: Optional[bool] = None
-) -> str:
+def p2pkh(key: Key, network: str | None = None, compressed: bool | None = None) -> str:
     """Return the p2pkh base58 address corresponding to a public key."""
     pub_key, network = pub_keyinfo_from_key(key, network, compressed=compressed)
     return address_from_h160("p2pkh", hash160(pub_key), network)
@@ -123,7 +120,7 @@ def _address_from_v0_witness(wit_prg: Octets, network: str = "mainnet") -> str:
 # 1.+2b. = 3b. base58 (p2sh-wrapped) SegWit addresses from pub_key/script_pub_key
 
 
-def p2wpkh_p2sh(key: Key, network: Optional[str] = None) -> str:
+def p2wpkh_p2sh(key: Key, network: str | None = None) -> str:
     """Return the p2wpkh-p2sh base58 address corresponding to a public key."""
     pub_key, network = pub_keyinfo_from_key(key, network, compressed=True)
     witness_program = hash160(pub_key)

btclib/base58.py

@@ -35,8 +35,7 @@
   it supports encoding bytes-like objects to ASCII bytes,
   and decoding ASCII bytes-like objects or ASCII strings to bytes.
 """
-
-from typing import Optional
+from __future__ import annotations
 
 from btclib.alias import Octets, String
 from btclib.exceptions import BTClibValueError
@@ -74,7 +73,7 @@ def _b58encode(v: bytes) -> bytes:
     return result
 
 
-def b58encode(v: Octets, in_size: Optional[int] = None) -> bytes:
+def b58encode(v: Octets, in_size: int | None = None) -> bytes:
     """Encode a bytes-like object using Base58Check."""
 
     v = bytes_from_octets(v, in_size)
@@ -113,7 +112,7 @@ def _b58decode(v: bytes) -> bytes:
     return result
 
 
-def b58decode(v: String, out_size: Optional[int] = None) -> bytes:
+def b58decode(v: String, out_size: int | None = None) -> bytes:
     """Decode a Base58Check encoded bytes-like object or ASCII string.
 
     Optionally, it also ensures required output size.