refactor(deps): improve optionnal dependencies check system/tests

Author: Athroniaeth

pyproject.toml

@@ -24,18 +24,20 @@ core = [
     "argon2-cffi>=25.1.0",
     "bcrypt>=5.0.0",
 ]
+
+typer = [
+    "typer>=0.12.5",
+]
 fastapi = [
     "fastapi>=0.118.0",
 ]
 all = [
+        "typer>=0.12.5",
     "fastapi>=0.118.0",
     "sqlalchemy>=2.0.43",
     "argon2-cffi>=25.1.0",
     "bcrypt>=5.0.0",
 ]
-cli = [
-    "typer>=0.12.5",
-]
 
 [build-system]
 requires = ["hatchling"]

src/fastapi_api_key/api.py

@@ -1,18 +1,14 @@
+try:
+    import fastapi  # noqa: F401
+except ModuleNotFoundError as e:
+    raise ImportError("API support requires 'fastapi'. Install it with: uv add fastapi-api-key[fastapi]") from e
+
 import warnings
 
 
 from fastapi_api_key.services.service import AbstractApiKeyService
 from fastapi_api_key.types import SecurityHTTPBearer, SecurityAPIKeyHeader
 
-try:
-    import fastapi  # noqa: F401
-    import sqlalchemy  # noqa: F401
-except ModuleNotFoundError as e:
-    raise ImportError(
-        "FastAPI and SQLAlchemy backend requires 'fastapi' and 'sqlalchemy'. "
-        "Install it with: uv add fastapi_api_key[fastapi]"
-    ) from e
-
 from datetime import datetime
 from typing import Annotated, Awaitable, Callable, List, Optional, TypeVar, Literal, Union
 

src/fastapi_api_key/cli.py

@@ -1,9 +1,16 @@
+try:
+    import typer  # noqa: F401
+except ModuleNotFoundError as e:
+    raise ImportError("CLI support requires 'typer'. Install it with: uv add fastapi-api-key[typer]") from e
+
 import asyncio
 import json
 from dataclasses import asdict, is_dataclass
 from datetime import datetime, timezone
 from typing import Any, Awaitable, Callable, Optional
 
+from typer import Typer
+
 from fastapi_api_key.domain.base import ApiKeyEntity
 from fastapi_api_key.domain.errors import (
     InvalidKey,
@@ -25,7 +32,7 @@
 
 def create_api_keys_cli(
     service_factory: ServiceFactory,
-    app: Optional[Any] = None,
+    app: Optional[Typer] = None,
 ) -> Any:
     """Build a Typer CLI bound to an :class:`AbstractApiKeyService`.
 
@@ -36,8 +43,6 @@ def create_api_keys_cli(
     Returns:
         A configured Typer application exposing CRUD helpers for API keys.
     """
-
-    typer = _import_typer()
     cli = app or typer.Typer(help="Manage API keys using fastapi-api-key services.", no_args_is_help=True)
 
     def run_async(coro: Awaitable[Any]) -> Any:
@@ -275,13 +280,3 @@ def _serialize_entity(entity: ApiKeyEntity) -> dict[str, Any]:
         if isinstance(value, datetime):
             data[key] = value.isoformat()
     return data
-
-
-def _import_typer() -> Any:
-    try:
-        import typer
-    except ImportError as exc:  # pragma: no cover - import guard
-        raise RuntimeError(
-            "Typer is required to build the CLI. Install it with 'pip install fastapi-api-key[cli]'"
-        ) from exc
-    return typer

src/fastapi_api_key/hasher/argon2.py

@@ -1,7 +1,7 @@
 try:
     import argon2  # noqa: F401
 except ModuleNotFoundError as e:
-    raise ImportError("SQLAlchemy backend requires 'argon2'. Install it with: uv add fastapi_api_key[argon2]") from e
+    raise ImportError("SQLAlchemy backend requires 'argon2'. Install it with: uv add fastapi-api-key[argon2]") from e
 
 from typing import Optional
 

src/fastapi_api_key/hasher/bcrypt.py

@@ -1,11 +1,12 @@
-from typing import Optional
-
 try:
     import bcrypt  # noqa: F401
 except ModuleNotFoundError as e:
-    raise ImportError("SQLAlchemy backend requires 'bcrypt'. Install it with: uv add fastapi_api_key[bcrypt]") from e
+    raise ImportError("SQLAlchemy backend requires 'bcrypt'. Install it with: uv add fastapi-api-key[bcrypt]") from e
 import bcrypt
 
+from typing import Optional
+
+
 from fastapi_api_key.hasher.base import BaseApiKeyHasher
 
 

src/fastapi_api_key/repositories/sql.py

@@ -1,12 +1,12 @@
-from fastapi_api_key.domain.base import D
-
 try:
     import sqlalchemy  # noqa: F401
 except ModuleNotFoundError as e:
     raise ImportError(
-        "SQLAlchemy backend requires 'sqlalchemy'. Install it with: uv add fastapi_api_key[sqlalchemy]"
+        "SQLAlchemy backend requires 'sqlalchemy'. Install it with: uv add fastapi-api-key[sqlalchemy]"
     ) from e
 
+from fastapi_api_key.domain.base import D
+
 
 from datetime import datetime
 from typing import Callable, Generic, Type, TypeVar, List

tests/test_regression.py

@@ -1,14 +1,13 @@
 import importlib
-import sys
-from typing import Optional, Type
-
-import pytest
-from fastapi_api_key.hasher.base import ApiKeyHasher
 import re
 import string
+import sys
 from datetime import datetime, timezone
+from typing import Optional, Type
 
+import pytest
 
+from fastapi_api_key.hasher.base import ApiKeyHasher
 from fastapi_api_key.utils import (
     uuid_factory,
     key_id_factory,
@@ -23,8 +22,7 @@ def test_version():
 
     assert hasattr(module, "__version__")
     assert isinstance(module.__version__, str)
-    assert module.__version__ == "0.3.0"    # Replace with the expected version
-
+    assert module.__version__ == "0.3.0"  # Replace with the expected version
 
 
 @pytest.mark.parametrize(
@@ -103,15 +101,34 @@ def test_warning_default_pepper(hasher_class: Type[ApiKeyHasher]):
         ["argon2", "fastapi_api_key.hasher.argon2"],
     ],
 )
-def test_sqlalchemy_backend_import_error(monkeypatch: pytest.MonkeyPatch, library: str, module_path: str):
+def test_import_backend_error(monkeypatch: pytest.MonkeyPatch, library: str, module_path: str):
+    """Simulate absence of SQLAlchemy and check for ImportError."""
+    monkeypatch.setitem(sys.modules, library, None)
+
+    with pytest.raises(ImportError) as exc_info:
+        module = importlib.import_module(module_path)
+        importlib.reload(module)
+
+    expected = f"backend requires '{library}'. Install it with: uv add fastapi-api-key[{library}]"
+    assert expected in f"{exc_info.value}"
+
+
+@pytest.mark.parametrize(
+    ["library", "module_path"],
+    [
+        ["typer", "fastapi_api_key.cli"],
+        ["fastapi", "fastapi_api_key.api"],
+    ],
+)
+def test_import_support_error(monkeypatch: pytest.MonkeyPatch, library: str, module_path: str):
     """Simulate absence of SQLAlchemy and check for ImportError."""
     monkeypatch.setitem(sys.modules, library, None)
 
     with pytest.raises(ImportError) as exc_info:
         module = importlib.import_module(module_path)
         importlib.reload(module)
 
-    expected = f"backend requires '{library}'. Install it with: uv add fastapi_api_key[{library}]"
+    expected = f"support requires '{library}'. Install it with: uv add fastapi-api-key[{library}]"
     assert expected in f"{exc_info.value}"