Merge pull request #105 from DavidGeorge528/uv-migration

UV Migration (UV, Ruff, Pandas v2)

Author: isaacharrisholt

.github/workflows/tests.yml

@@ -10,17 +10,23 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ['3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.9', '3.10', '3.11', '3.12']
 
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v3
       with:
         python-version: ${{ matrix.python-version }}
+    # see https://github.com/pre-commit/action/#using-this-action
+    - name: pre-commit checks
+      uses: pre-commit/action@v3.0.1
+      env:
+        # it's okay for github to commit to main/master
+        SKIP: no-commit-to-branch
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install tox tox-gh-actions poetry==1.4.1
+        pip install tox tox-gh-actions uv tox-uv
     - name: Test with tox
       run: tox

.pre-commit-config.yaml

@@ -1,13 +1,7 @@
 repos:
-- repo: https://github.com/psf/black
-  rev: 23.1.0
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.8.6
   hooks:
-    - id: black
-- repo: https://github.com/pycqa/isort
-  rev: 5.12.0
-  hooks:
-    - id: isort
-- repo: https://github.com/charliermarsh/ruff-pre-commit
-  rev: v0.0.254
-  hooks:
-    - id: ruff
+    - id: ruff
+      args: [ --fix, --exit-non-zero-on-fix ]
+    - id: ruff-format

makefile

@@ -1,25 +1,25 @@
 PKG_NAME = 	quiffen
 
-.PHONY:		test
+.PHONY:	test
 test:
-		( cd tests ; poetry run pytest )
+	( cd tests ; uv run pytest )
 
-.PHONY:     lint
+.PHONY:	lint
 lint:
-        ( poetry run pylint $(PKG_NAME); poetry run pylint tests )
+	( uv run ruff check $(PKG_NAME); uv run ruff check tests )
 
-.PHONY:		wheel
+.PHONY:	wheel
 wheel:
-		poetry build -f wheel
+	uv build --wheel
 
-.PHONY:		install
+.PHONY:	install
 install:	wheel
-		poetry install
+	uv sync
 
-.PHONY:		reinstall
+.PHONY:	reinstall
 reinstall:	clean install
 
-.PHONY:		clean
+.PHONY:	clean
 clean:
-		find . -type d -name __pycache__ -prune -exec rm -r {} \;
-		rm -fr build dist *.egg-info test2.qif
+	find . -type d -name __pycache__ -prune -exec rm -r {} \;
+	rm -fr build dist *.egg-info test2.qif

poetry.lock

@@ -1,56 +1,93 @@
-[tool.poetry]
+[project]
+authors = [
+    {name = "Isaac Harris-Holt", email = "isaac@harris-holt.com"},
+]
+license = {text = "GPL-3.0-or-later"}
+requires-python = ">=3.9,<3.13"
+dependencies = [
+    "pydantic>=1.10.2,<2.11.0",
+    "python-dateutil>=2.8.2,<3.0.0",
+]
 name = "quiffen"
 version = "2.0.13"
 description = "Quiffen"
-authors = ["Isaac Harris-Holt <isaac@harris-holt.com>"]
-license = "GPL-3.0-or-later"
 readme = "README.rst"
-homepage = "https://github.com/isaacharrisholt/quiffen"
-repository = "https://github.com/isaacharrisholt/quiffen"
-documentation = "https://quiffen.readthedocs.io/en/latest/"
-keywords = ['qif', 'finance', 'data processing']
+keywords = [
+    "qif",
+    "finance",
+    "data processing",
+]
 classifiers = [
-  "Development Status :: 5 - Production/Stable",
-  "Intended Audience :: Developers",
-  "Programming Language :: Python :: 3",
-  "Operating System :: MacOS :: MacOS X",
-  "Operating System :: Microsoft :: Windows",
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: Microsoft :: Windows",
 ]
 
+[project.urls]
+homepage = "https://github.com/isaacharrisholt/quiffen"
+repository = "https://github.com/isaacharrisholt/quiffen"
+documentation = "https://quiffen.readthedocs.io/en/latest/"
 
-[tool.poetry.dependencies]
-python = "^3.8"
-pydantic = "^1.10.2"
-pandas = "^1.5.1"
-python-dateutil = "^2.8.2"
-
+[project.optional-dependencies]
+pandas = [
+    "pandas>2.2.0,<3.0.0",
+]
 
-[tool.poetry.group.dev.dependencies]
-pytest = "^7.2.0"
-black = "^23.1.0"
-isort = "^5.12.0"
-ruff = "^0.0.254"
-tox = "^4.4.6"
-pyright = "^1.1.296"
-pre-commit = "^3.1.1"
+[dependency-groups]
+dev = [
+    "pytest<8.0.0,>=7.2.0",
+    "ruff>=0.0.254,<1.0.0",
+    "tox<5.0.0,>=4.4.6",
+    "pyright<2.0.0,>=1.1.296",
+    "pre-commit<4.0.0,>=3.1.1",
+    "tox-uv>=1.17.0",
+    "pandas-stubs>=2.2.2.240807",
+    "mypy>=1.14.1",
+    "types-python-dateutil>=2.9.0.20241206",
+]
 
+[tool.pdm.build]
+includes = []
 
 [build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.isort]
-profile = "black"
-include_trailing_comma = true
+requires = ["pdm-backend"]
+build-backend = "pdm.backend"
 
 [tool.ruff]
 line-length = 88
+target-version = "py39"
+
+[tool.ruff.lint]
+# see https://docs.astral.sh/ruff/configuration/#using-pyprojecttoml
+select = [
+  # default Ruff checkers: E4, E7, E9, F
+  "E4",
+  "E7",
+  "E9",
+  # "F" contains autoflake, see https://github.com/astral-sh/ruff/issues/1647
+  "F",  # pyflakes
 
-[tool.ruff.per-file-ignores]
+  "I",   # isort
+
+  # TODO: add more rules.  For example:
+  # "B",   # flake8-bugbear
+  # "C4",  # flake8-comprehensions
+  # "EXE", # flake8-executable
+  # "ICN", # flake8-import-conventions
+  # "ISC", # flake8-implicit-str-concat
+  # "PL",  # pylint
+  # "RUF",
+  # "UP",  # pyupgrade
+]
+
+[tool.ruff.lint.per-file-ignores]
 "__init__.py" = ["F401"] # Ignore unused imports in __init__.py
 
 [tool.pyright]
-pythonVersion = "3.8"
+pythonVersion = "3.9"
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
+

pyproject.toml

@@ -5,6 +5,7 @@
 and also to create a QIF structure and then output to either a QIF file, a CSV
 of transaction data or a pandas DataFrame.
 """
+
 from quiffen.core.account import Account, AccountType
 from quiffen.core.base import Field
 from quiffen.core.category import (

quiffen/__init__.py

@@ -2,7 +2,7 @@
 
 from decimal import Decimal
 from enum import Enum
-from typing import Any, Dict, Iterable, List, Optional, Union
+from typing import Any, Dict, Iterable, List, Optional, TypeVar, Union
 
 from pydantic import validator
 
@@ -125,9 +125,14 @@ def __str__(self) -> str:
                     )
         return "Category:" + properties
 
-    def __lt__(self, other) -> bool:
+    def __lt__(self, other: Category) -> bool:
         return self.name < other.name
 
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, Category):
+            return False
+        return self.dict() == other.dict()
+
     @validator("hierarchy", pre=True, always=True)
     def _set_hierarchy(cls, v: str, values) -> str:
         if not v:
@@ -200,7 +205,7 @@ def traverse_down(self) -> List[Category]:
         The list is ordered starting with the current category, then its
         children, then the children's children etc.
         """
-        nodes_to_visit = [self]
+        nodes_to_visit: List[Category] = [self]
         all_children = []
         while nodes_to_visit:
             current_node = nodes_to_visit.pop()
@@ -232,7 +237,7 @@ def find_child(self, node_name: str) -> Union[Category, None]:
         KeyError
             If the category cannot be found.
         """
-        nodes_to_visit = [self]
+        nodes_to_visit: List[Category] = [self]
         while nodes_to_visit:
             current_node = nodes_to_visit.pop()
             if current_node.name == node_name:
@@ -470,7 +475,7 @@ def from_list(cls, lst: List[str]) -> Category:
         return new_cat
 
 
-ListOrDictOfCategories = Union[List[Category], Dict[str, Category]]
+CategoryContainer = TypeVar("CategoryContainer", List[Category], Dict[str, Category])
 
 
 def create_categories_from_hierarchy(hierarchy: str) -> Category:
@@ -489,8 +494,8 @@ def create_categories_from_hierarchy(hierarchy: str) -> Category:
 
 def add_categories_to_container(
     new_category: Category,
-    categories: ListOrDictOfCategories,
-) -> ListOrDictOfCategories:
+    categories: CategoryContainer,
+) -> CategoryContainer:
     """Add ``new_category`` to ``categories`` after first creating necessary
     hierarchy.
 
@@ -511,29 +516,21 @@ def add_categories_to_container(
         The new iterable, now containing ``new_category``
     """
     # Add categories in hierarchy
-    categories_is_dict = isinstance(categories, dict)
     if new_category.hierarchy != new_category.name or new_category.children:
         # Get the root category in the chain
-        root = new_category.traverse_up()[-1]
+        new_category = new_category.traverse_up()[-1]
 
-        iterator = categories.values() if categories_is_dict else categories
+        iterator = categories.values() if isinstance(categories, dict) else categories
 
         # Check if the root category already exists in the categories container
         for category in iterator:
-            category: Category  # Type hint
-            success = category.merge(root)
+            success = category.merge(new_category)
             if success:
-                break
-        else:
-            # If the category doesn't exist, add it to the categories container
-            if categories_is_dict:
-                categories[root.name] = root
-            else:
-                categories.append(root)
+                return categories
+
+    if isinstance(categories, dict):
+        categories[new_category.name] = new_category
     else:
-        if categories_is_dict:
-            categories[new_category.name] = new_category
-        else:
-            categories.append(new_category)
+        categories.append(new_category)
 
     return categories

quiffen/core/category.py

@@ -4,7 +4,7 @@
 import io
 from enum import Enum
 from pathlib import Path
-from typing import Any, Dict, List, Optional, Set, Union
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Union
 
 from pydantic.types import FilePath
 
@@ -17,13 +17,9 @@
 from quiffen.core.security import Security
 from quiffen.core.transaction import Transaction
 
-try:
+if TYPE_CHECKING:
     import pandas as pd
 
-    PANDAS_INSTALLED = True
-except ModuleNotFoundError:
-    PANDAS_INSTALLED = False
-
 VALID_TRANSACTION_ACCOUNT_TYPES = [
     "!type:cash",
     "!type:bank",
@@ -203,7 +199,7 @@ def parse(
             if "!Type:Cat" in header_line:
                 # Section contains category information
                 new_category = Category.from_list(sanitised_section_lines)
-                categories = add_categories_to_container(  # type: ignore
+                categories = add_categories_to_container(
                     new_category,
                     categories,
                 )
@@ -325,7 +321,7 @@ def remove_account(self, account_name: str) -> Account:
 
     def add_category(self, new_category: Category) -> None:
         """Add a new category to the Qif object"""
-        self.categories = add_categories_to_container(  # type: ignore
+        self.categories = add_categories_to_container(
             new_category,
             self.categories,
         )
@@ -576,10 +572,12 @@ def to_dataframe(
         pd.DataFrame
             The data as a Pandas DataFrame
         """
-        if not PANDAS_INSTALLED:
+        try:
+            import pandas as pd
+        except ModuleNotFoundError as e:
             raise ModuleNotFoundError(
-                "The pandas module must be installed to use this method"
-            )
+                "The pandas package is required to convert Qif objects to DataFrames. Please install it using `pip install quiffen[pandas]`."
+            ) from e
 
         if ignore is None:
             ignore = []

quiffen/core/qif.py

@@ -453,10 +453,14 @@ def from_list(
                     if class_name:
                         classes[class_name].add_category(category)
             elif line_code == "N":
+                try:
+                    check_number: Union[int, str] = int(field_info)
+                except ValueError:
+                    check_number = field_info
                 if not splits:
-                    kwargs["check_number"] = field_info
+                    kwargs["check_number"] = check_number
                 elif current_split:
-                    current_split.check_number = field_info
+                    current_split.check_number = check_number
             elif line_code == "F":
                 kwargs["reimbursable_expense"] = field_info or True
             elif line_code == "1":