Merge pull request #55 from nijel/pytyped

feat: ship py.typed to allow type checking

Author: honzajavorek

src/fiobank/__init__.py

@@ -0,0 +1,5 @@
+from .exceptions import ThrottlingError
+from .fiobank import FioBank
+
+
+__all__ = ("FioBank", "ThrottlingError")

src/fiobank/exceptions.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+
+class ThrottlingError(Exception):
+    """Throttling error raised when the API is being used too fast."""
+
+    def __str__(self) -> str:
+        return "Token can be used only once per 30s"

fiobank.py src/fiobank/fiobank.py

@@ -5,7 +5,6 @@
 from collections.abc import Generator
 from datetime import date, datetime
 from decimal import Decimal
-from typing import Any, Callable
 
 import requests
 from tenacity import (
@@ -15,39 +14,8 @@
     wait_random_exponential,
 )
 
-
-__all__ = ("FioBank", "ThrottlingError")
-
-
-def coerce_amount(value: int | float) -> Decimal:
-    if isinstance(value, int):
-        return Decimal(value)
-    if isinstance(value, float):
-        return Decimal(str(value))
-    raise ValueError(value)
-
-
-def coerce_date(value: datetime | date | str) -> date:
-    if isinstance(value, datetime):
-        return value.date()
-    if isinstance(value, date):
-        return value
-    return datetime.strptime(value[:10], "%Y-%m-%d").date()
-
-
-def sanitize_value(value: Any, convert: Callable | None = None) -> Any:
-    if isinstance(value, str):
-        value = value.strip() or None
-    if convert and value is not None:
-        return convert(value)
-    return value
-
-
-class ThrottlingError(Exception):
-    """Throttling error raised when the API is being used too fast."""
-
-    def __str__(self) -> str:
-        return "Token can be used only once per 30s"
+from .exceptions import ThrottlingError
+from .utils import coerce_date, sanitize_value
 
 
 class FioBank:

src/fiobank/py.typed

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+from datetime import date, datetime
+from decimal import Decimal
+from typing import Any, Callable
+
+
+def coerce_amount(value: int | float) -> Decimal:
+    if isinstance(value, int):
+        return Decimal(value)
+    if isinstance(value, float):
+        return Decimal(str(value))
+    raise ValueError(value)
+
+
+def coerce_date(value: datetime | date | str) -> date:
+    if isinstance(value, datetime):
+        return value.date()
+    if isinstance(value, date):
+        return value
+    return datetime.strptime(value[:10], "%Y-%m-%d").date()
+
+
+def sanitize_value(value: Any, convert: Callable | None = None) -> Any:
+    if isinstance(value, str):
+        value = value.strip() or None
+    if convert and value is not None:
+        return convert(value)
+    return value

src/fiobank/utils.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from fiobank import coerce_date
+from fiobank.utils import coerce_date
 
 
 @pytest.mark.parametrize(

tests/test_coerce_date.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from fiobank import sanitize_value
+from fiobank.utils import sanitize_value
 
 
 @pytest.mark.parametrize(