feat(refactor): starting a wholescale refactor for better maintainability

Author: Karl Wooster

ruff.toml

@@ -1,4 +1,4 @@
-target-version = "py311"
+target-version = "py39"
 
 [lint]
 extend-select = ["B", "C90", "D", "RUF", "UP"]

src/ynamazon/_version.py

@@ -0,0 +1,21 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.1.dev96+g1cb66e2'
+__version_tuple__ = version_tuple = (0, 1, 'dev96', 'g1cb66e2')

src/ynamazon/wrappers/ynab/__init__.py

@@ -0,0 +1,4 @@
+from .accounts import Account
+from .transactions import MemoField
+
+__all__ = ["Account", "MemoField"]

src/ynamazon/wrappers/ynab.py src/ynamazon/wrappers/ynab/accounts.pysrc/ynamazon/wrappers/ynab.py renamed to src/ynamazon/wrappers/ynab/accounts.py

@@ -1,36 +1,12 @@
-import abc
-from decimal import Decimal
-import enum
-from typing import Annotated, Any, Generic, TypeVar
-from pydantic import (
-    BaseModel,
-    ConfigDict,
-    StrictBool,
-    StrictInt,
-    StrictStr,
-    model_validator,
-)
 import datetime as dt
+import enum
+from decimal import Decimal
+from typing import Annotated, Union
 
+from pydantic import Field, StrictBool, StrictInt, StrictStr
 
-class YnabBase(BaseModel, abc.ABC):
-    """Base class for YNAB."""
-
-    model_config = ConfigDict(from_attributes=True)
-
-
-_F = TypeVar("_F")
-
-
-class Field(BaseModel, Generic[_F], abc.ABC):
-    value: _F
-
-    @model_validator(mode="before")
-    @classmethod
-    def from_value(cls, data: Any) -> Any:
-        if not isinstance(data, dict):
-            return {"value": data}
-        return data
+from ynamazon.wrappers.ynab.common import YnabBase
+from ynamazon.wrappers.ynab.payees import Payee
 
 
 class AccountType(enum.StrEnum):
@@ -62,7 +38,7 @@ class Account(YnabBase):
     balance: StrictInt
     cleared_balance: StrictInt
     uncleared_balance: StrictInt
-    transfer_payee: "Payee" | None = None
+    transfer_payee: Union[Payee, None] = None
     direct_import_linked: StrictBool | None = None
     direct_import_in_error: StrictBool | None = None
     last_reconciled_at: dt.datetime | None = None
@@ -86,42 +62,3 @@ def cleared_balance_decimal(self) -> Decimal:
     def uncleared_balance_decimal(self) -> Decimal:
         """Returns the uncleared balance in currency."""
         return self._milliunit_to_decimal("uncleared_balance")
-
-
-class Payee(YnabBase):
-    id: StrictStr
-    name: StrictStr
-
-
-class MemoField(Field[str]):
-    """Memo field for YNAB."""
-
-
-class TransactionClearedStatus(enum.StrEnum):
-    """The cleared status of the transaction."""
-
-    CLEARED = "cleared"
-    UNCLEARED = "uncleared"
-    RECONCILED = "reconciled"
-
-
-class TransactionFlagColor(enum.StrEnum):
-    """The flag color of the transaction."""
-
-    RED = "red"
-    ORANGE = "orange"
-    YELLOW = "yellow"
-    GREEN = "green"
-    BLUE = "blue"
-    PURPLE = "purple"
-
-
-class BaseTransaction(YnabBase):
-    var_date: dt.date | None = None
-    amount: StrictInt
-    memo: MemoField | None = None
-    cleared: TransactionClearedStatus | None = None
-    approved: StrictBool | None = None
-    flag_color: TransactionFlagColor | None = None
-    account_id: StrictStr | None = None
-    payee_id: StrictStr | None = None

src/ynamazon/wrappers/ynab/common.py

@@ -0,0 +1,24 @@
+import abc
+from typing import Any, Generic, TypeVar
+
+from pydantic import BaseModel, ConfigDict, model_validator
+
+
+class YnabBase(BaseModel, abc.ABC):
+    """Base class for YNAB."""
+
+    model_config = ConfigDict(from_attributes=True)
+
+
+_F = TypeVar("_F")
+
+
+class YnabField(BaseModel, Generic[_F], abc.ABC):
+    value: _F
+
+    @model_validator(mode="before")
+    @classmethod
+    def from_value(cls, data: Any) -> Any:
+        if not isinstance(data, dict):
+            return {"value": data}
+        return data

src/ynamazon/wrappers/ynab/payees.py

@@ -0,0 +1,8 @@
+from pydantic import StrictStr
+
+from ynamazon.wrappers.ynab.common import YnabBase
+
+
+class Payee(YnabBase):
+    id: StrictStr
+    name: StrictStr

src/ynamazon/wrappers/ynab/transactions.py

@@ -0,0 +1,40 @@
+import datetime as dt
+import enum
+
+from pydantic import StrictBool, StrictInt, StrictStr
+
+from ynamazon.wrappers.ynab.common import YnabBase, YnabField
+
+
+class MemoField(YnabField[str]):
+    """Memo field for YNAB."""
+
+
+class TransactionClearedStatus(enum.StrEnum):
+    """The cleared status of the transaction."""
+
+    CLEARED = "cleared"
+    UNCLEARED = "uncleared"
+    RECONCILED = "reconciled"
+
+
+class TransactionFlagColor(enum.StrEnum):
+    """The flag color of the transaction."""
+
+    RED = "red"
+    ORANGE = "orange"
+    YELLOW = "yellow"
+    GREEN = "green"
+    BLUE = "blue"
+    PURPLE = "purple"
+
+
+class BaseTransaction(YnabBase):
+    var_date: dt.date | None = None
+    amount: StrictInt
+    memo: MemoField | None = None
+    cleared: TransactionClearedStatus | None = None
+    approved: StrictBool | None = None
+    flag_color: TransactionFlagColor | None = None
+    account_id: StrictStr | None = None
+    payee_id: StrictStr | None = None

src/ynamazon/ynab/__init__.py

@@ -0,0 +1,9 @@
+from typing import Union
+
+from pydantic import BaseModel
+
+from ynamazon.wrappers.ynab import MemoField
+
+
+class TransactionMemo(BaseModel):
+    _value: Union[str, None] = None