typehint code (and use absolute imports)

Author: mathiasertl

.github/workflows/quality.yml

@@ -26,4 +26,7 @@ jobs:
         run: uv run ruff format --diff .
 
       - name: ruff check
-        run: uv run ruff check --diff .
+        run: uv run ruff check --diff .
+
+      - name: mypy
+        run: uv run mypy .

pkcs11/__init__.py

@@ -2,17 +2,30 @@
 :mod:`pkcs11` defines a high-level, "Pythonic" interface to PKCS#11.
 """
 
+import typing
+
 from .constants import *  # noqa: F403
 from .exceptions import *  # noqa: F403
 from .mechanisms import *  # noqa: F403
-from .types import *  # noqa: F403
+from .types import (
+    Certificate,
+    DomainParameters,
+    Library,
+    MechanismInfo,
+    PrivateKey,
+    PublicKey,
+    SecretKey,
+    Session,
+    Slot,
+    Token,
+)
 from .util import dh, dsa, ec, rsa, x509  # noqa: F401
 
 _so = None
 _lib = None
 
 
-def lib(so):
+def lib(so: str) -> Library:
     """
     Wrap the main library call coming from Cython with a preemptive
     dynamic loading.
@@ -28,9 +41,24 @@ def lib(so):
         else:
             return _lib
 
-    from . import _pkcs11
+    from . import _pkcs11  # type: ignore[attr-defined]
 
-    _lib = _pkcs11.lib(so)
+    _lib = typing.cast(Library, _pkcs11.lib(so))
     _so = so
 
     return _lib
+
+
+__all__ = [
+    "Certificate",
+    "DomainParameters",
+    "Library",
+    "MechanismInfo",
+    "PrivateKey",
+    "PublicKey",
+    "SecretKey",
+    "Session",
+    "Slot",
+    "Token",
+    "lib",
+]

pkcs11/constants.py

@@ -5,11 +5,7 @@
 use these classes.
 """
 
-try:
-    from enum import IntEnum, IntFlag, unique
-except ImportError:
-    from aenum import IntEnum, IntFlag, unique
-
+from enum import IntEnum, IntFlag, unique
 
 DEFAULT = object()
 """Sentinel value used in templates.
@@ -58,7 +54,7 @@ class ObjectClass(IntEnum):
 
     _VENDOR_DEFINED = 0x80000000
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return "<ObjectClass.%s>" % self.name
 
 
@@ -344,7 +340,7 @@ class Attribute(IntEnum):
 
     _VENDOR_DEFINED = 0x80000000
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return "<Attribute.%s>" % self.name
 
 

pkcs11/defaults.py

@@ -7,6 +7,7 @@
 
 from datetime import datetime
 from struct import Struct
+from typing import Any, Callable
 
 from .constants import (
     Attribute,
@@ -35,17 +36,18 @@
 _SIGNING = MechanismFlag.SIGN | MechanismFlag.VERIFY
 _WRAPPING = MechanismFlag.WRAP | MechanismFlag.UNWRAP
 
-DEFAULT_KEY_CAPABILITIES = {
+DEFAULT_KEY_CAPABILITIES: dict[KeyType, MechanismFlag] = {
     KeyType.AES: _ENCRYPTION | _SIGNING | _WRAPPING,
     KeyType.DES2: _ENCRYPTION | _SIGNING | _WRAPPING,
     KeyType.DES3: _ENCRYPTION | _SIGNING | _WRAPPING,
     KeyType.DH: MechanismFlag.DERIVE,
     KeyType.DSA: _SIGNING,
     KeyType.EC: _SIGNING | MechanismFlag.DERIVE,
     KeyType.RSA: _ENCRYPTION | _SIGNING | _WRAPPING,
-    KeyType.GENERIC_SECRET: 0,
+    KeyType.GENERIC_SECRET: 0,  # type: ignore[dict-item]
     KeyType.EC_EDWARDS: _SIGNING,
 }
+
 """
 Default capabilities for generating keys.
 """
@@ -125,11 +127,11 @@
 _biginteger = _bytes
 
 
-def _enum(type_):
+def _enum(type_: type[Any]) -> tuple[Callable[[Any], bytes], Callable[[Any], Any]]:
     """Factory to pack/unpack intos into IntEnums."""
     pack, unpack = _ulong
 
-    return (lambda v: pack(int(v)), lambda v: type_(unpack(v)))
+    return (lambda v: pack(int(v)), lambda v: type_(unpack(v)))  # type: ignore[no-untyped-call]
 
 
 ATTRIBUTE_TYPES = {

pkcs11/mechanisms.py

@@ -101,7 +101,7 @@ class KeyType(IntEnum):
 
     _VENDOR_DEFINED = 0x80000000
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return "<KeyType.%s>" % self.name
 
 
@@ -709,7 +709,7 @@ class Mechanism(IntEnum):
 
     _VENDOR_DEFINED = 0x80000000
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return "<Mechanism.%s>" % self.name
 
 
@@ -729,7 +729,7 @@ class KDF(IntEnum):
     SHA512 = 0x00000008
     CPDIVERSIFY = 0x00000009
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return "<KDF.%s>" % self.name
 
 
@@ -744,5 +744,5 @@ class MGF(IntEnum):
     SHA512 = 0x00000004
     SHA224 = 0x00000005
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return "<MGF.%s>" % self.name