use uv for tests, run mypy

Author: yagebu

.github/workflows/ci.yml

@@ -7,17 +7,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.9", "3.13"]
+        python-version: ["3.10", "3.13"]
     steps:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
     - uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install Dependencies
-      run: pip install tox wheel setuptools pre-commit
-    - name: Run lint
-      run: pre-commit run -a
-    - name: Run tests
-      run: tox -e py
+    - uses: astral-sh/setup-uv@v5
+    - run: make lint
+    - run: make test

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.9.2
+    rev: v0.11.11
     hooks:
-      - id: ruff
+      - id: ruff-check
         args: ["--fix"]
       - id: ruff-format

Makefile

@@ -1,12 +1,17 @@
+# Run tests and linters
+.PHONY: all
+all: lint test
+
 # Run tests
 .PHONY: test
 test:
-	tox -e py
+	uv run pytest
 
 # Run linters
 .PHONY: lint
 lint:
-	pre-commit run -a
+	uv run pre-commit run -a
+	uv run mypy
 
 # Build the distribution (sdist and wheel).
 .PHONY: dist
@@ -16,6 +21,12 @@ dist:
 	python -m build
 	twine check dist/*
 
+# Update the lock file.
+.PHONY: update
+update:
+	uv lock --upgrade
+	uv run pre-commit autoupdate
+
 # Upload the distribution
 .PHONY: upload
 upload: dist

fava_plugins/split_income.py

@@ -50,31 +50,41 @@
         Income:Net:Bonus               100.00 EUR
 """
 
+from __future__ import annotations
+
 import ast
 import collections
 import copy
 import re
+from decimal import Decimal
+from typing import Any
+from typing import TYPE_CHECKING
 
 from beancount.core import convert
 from beancount.core import data
 from beancount.core import getters
 from beancount.core.inventory import Inventory
-from beancount.core.number import Decimal
-from beancount.core.number import ZERO
+
+if TYPE_CHECKING:
+    from beancount.core.data import Directive
 
 __plugins__ = ("split_income",)
 
 SplitIncomeError = collections.namedtuple(
-    "SplitIncomeError", "source message entry"
+    "SplitIncomeError",
+    "source message entry",
 )
 
+ZERO = Decimal()
+
 
-def split_income(entries, options_map, config_str):
+def split_income(
+    entries: list[Directive], options_map: Any, config_str: str
+) -> tuple[list[Directive], list[SplitIncomeError]]:
     """Split income transactions."""
-    # pylint: disable=too-many-locals
 
     errors = []
-    new_entries = []
+    new_entries: list[Directive] = []
     new_accounts = set()
     config = {
         "income": options_map["name_income"],
@@ -93,7 +103,7 @@ def split_income(entries, options_map, config_str):
                     data.new_metadata(options_map["filename"], 0),
                     f"Syntax error in config: {config_str}",
                     None,
-                )
+                ),
             )
             return entries, errors
 
@@ -107,14 +117,15 @@ def split_income(entries, options_map, config_str):
         # The new entry containing the raw income and taxes.
         new_entry = copy.deepcopy(entry)
         new_entry = new_entry._replace(
-            postings=[], tags=frozenset({config["tag"]} | entry.tags)
+            postings=[],
+            tags=frozenset({config["tag"]} | entry.tags),
         )
         new_entries.append(new_entry)
 
-        income = collections.defaultdict(Inventory)
-        taxes = collections.defaultdict(Decimal)
+        income: dict[str, Inventory] = collections.defaultdict(Inventory)
+        taxes: dict[str, Decimal] = collections.defaultdict(Decimal)
         for posting in list(entry.postings):
-            weight = convert.get_weight(posting)
+            weight = convert.get_weight(posting)  # type: ignore[no-untyped-call]
             if posting.account.startswith(config["income"]):
                 new_entry.postings.append(posting)
                 entry.postings.remove(posting)
@@ -126,7 +137,8 @@ def split_income(entries, options_map, config_str):
 
         for account, inv in income.items():
             net_account = account.replace(
-                config["income"], config["net_income"]
+                config["income"],
+                config["net_income"],
             )
             if net_account not in new_accounts:
                 new_accounts.add(net_account)
@@ -135,19 +147,25 @@ def split_income(entries, options_map, config_str):
                         data.new_metadata("<split_income>", 0),
                         entry.date,
                         net_account,
+                        [],
                         None,
-                        None,
-                    )
+                    ),
                 )
 
             for pos in inv:
                 amount = pos.units
                 number = amount.number + taxes.pop(amount.currency, ZERO)
                 data.create_simple_posting(
-                    entry, net_account, number, amount.currency
+                    entry,
+                    net_account,
+                    number,
+                    amount.currency,
                 )
                 data.create_simple_posting(
-                    new_entry, net_account, -number, amount.currency
+                    new_entry,
+                    net_account,
+                    -number,
+                    amount.currency,
                 )
 
     return entries + new_entries, errors

fava_plugins/todo_as_error.py

@@ -12,20 +12,29 @@
       Assets:Cash
 """
 
+from __future__ import annotations
+
 import collections
+from typing import Any
+from typing import TYPE_CHECKING
 
 from beancount.core.data import Transaction
 
+if TYPE_CHECKING:
+    from beancount.core.data import Directive
+
 __plugins__ = [
     "todo_as_error",
 ]
 
 TodoError = collections.namedtuple("TodoError", "source message entry")
 
 
-def todo_as_error(entries, _):
+def todo_as_error(
+    entries: list[Directive],
+    _: Any,
+) -> tuple[list[Directive], list[TodoError]]:
     """Create errors for entries 'todo' metadata."""
-
     errors = []
 
     for entry in entries:

pyproject.toml

@@ -3,8 +3,8 @@ name = "fava-plugins"
 version = "1.0"
 description = "A collection of Beancount plugins."
 readme = "README.md"
-requires-python = ">=3.9"
-license = {text = "MIT License"}
+requires-python = ">=3.10"
+license = "MIT"
 authors = [
   {name = "Jakob Schnitzer", email = "mail@jakobschnitzer.de"}
 ]
@@ -15,10 +15,8 @@ classifiers = [
     "Intended Audience :: End Users/Desktop",
     "Intended Audience :: Financial and Insurance Industry",
     "Intended Audience :: Information Technology",
-    "License :: OSI Approved :: MIT License",
     "Natural Language :: English",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
@@ -39,6 +37,49 @@ Issues = "https://github.com/beancount/fava-plugins/issues"
 requires = ["setuptools>=45", "wheel"]
 build-backend = "setuptools.build_meta"
 
+[dependency-groups]
+# Type-checking with mypy.
+mypy = [
+    "mypy>=1.14",
+    "pytest>=8",
+]
+# Running pre-commit hooks.
+pre-commit = [
+    "pre-commit>=4",
+]
+# Dependencies for tests.
+test = [
+    "pytest>=8",
+]
+# Stuff for the dev environment.
+dev = [
+    { include-group = "mypy" },
+    { include-group = "pre-commit" },
+    { include-group = "test" },
+    "ruff>=0.11",
+]
+
+[tool.mypy]
+strict = true
+files = [
+    "fava_plugins",
+    "tests",
+]
+
 [tool.ruff]
-target-version = "py39"
 line-length = 79
+
+[tool.ruff.lint]
+extend-select = [
+    "I",
+    "TC",
+]
+
+[tool.ruff.lint.flake8-type-checking]
+strict = true
+
+[tool.ruff.lint.isort]
+force-single-line = true
+order-by-type = false
+known-first-party = ["fava_plugins"]
+required-imports = ["from __future__ import annotations"]

tests/conftest.py

@@ -1,7 +1,15 @@
+from __future__ import annotations
+
 import pytest
+from beancount.core import data
 from beancount.loader import load_string
+from beancount.loader import OptionsMap
+
+LoaderResult = tuple[data.Directives, list[data.BeancountError], OptionsMap]
 
 
 @pytest.fixture
-def load_doc(request):
+def load_doc(
+    request: pytest.FixtureRequest,
+) -> LoaderResult:
     return load_string(request.function.__doc__, dedent=True)

tests/test_split_income.py

@@ -1,16 +1,30 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
 from beancount.core import data
+from beancount.core.data import Transaction
 from beancount.loader import load_string
 
+if TYPE_CHECKING:
+    from beancount.core.data import Directive
+
+    from .conftest import LoaderResult
+
 
-def _compare_postings(entry1, entry2):
+def _compare_postings(entry1: Directive, entry2: Directive) -> None:
+    assert isinstance(entry1, Transaction)
+    assert isinstance(entry2, Transaction)
     amounts = {}
     for pos in entry1.postings:
+        assert pos.units
         amounts[pos.account] = pos.units.number
     for pos in entry2.postings:
+        assert pos.units
         assert amounts[pos.account] == pos.units.number
 
 
-def test_split_income(load_doc):
+def test_split_income(load_doc: LoaderResult) -> None:
     """
     plugin "fava_plugins.split_income" ""
     plugin "beancount.plugins.auto_accounts"
@@ -44,6 +58,7 @@ def test_split_income(load_doc):
     )
 
     assert not errors
+    assert isinstance(entries[8], Transaction)
     assert "pretax" in entries[8].tags
 
     _compare_postings(entries[8], entries_after[1])
@@ -53,7 +68,7 @@ def test_split_income(load_doc):
     assert len([e for e in entries if isinstance(e, data.Open)]) == 7
 
 
-def test_split_income_config(load_doc):
+def test_split_income_config(load_doc: LoaderResult) -> None:
     """
     plugin "fava_plugins.split_income" "{
         'income': 'Income:Work',
@@ -92,6 +107,7 @@ def test_split_income_config(load_doc):
     )
 
     assert not errors
+    assert isinstance(entries[8], Transaction)
     assert "brutto" in entries[8].tags
 
     _compare_postings(entries[8], entries_after[1])
@@ -101,7 +117,7 @@ def test_split_income_config(load_doc):
     assert len([e for e in entries if isinstance(e, data.Open)]) == 7
 
 
-def test_split_income_mixed_currency_income(load_doc):
+def test_split_income_mixed_currency_income(load_doc: LoaderResult) -> None:
     """
     plugin "fava_plugins.split_income" ""
     plugin "beancount.plugins.auto_accounts"
@@ -129,6 +145,7 @@ def test_split_income_mixed_currency_income(load_doc):
     )
 
     assert not errors
+    assert isinstance(entries[5], Transaction)
     assert "pretax" in entries[5].tags
 
     _compare_postings(entries[5], entries_after[1])
@@ -138,7 +155,7 @@ def test_split_income_mixed_currency_income(load_doc):
     assert len([e for e in entries if isinstance(e, data.Open)]) == 4
 
 
-def test_split_income_mixed_currency_others(load_doc):
+def test_split_income_mixed_currency_others(load_doc: LoaderResult) -> None:
     """
     plugin "fava_plugins.split_income" ""
     plugin "beancount.plugins.auto_accounts"
@@ -166,6 +183,7 @@ def test_split_income_mixed_currency_others(load_doc):
     )
 
     assert not errors
+    assert isinstance(entries[5], Transaction)
     assert "pretax" in entries[5].tags
 
     _compare_postings(entries[5], entries_after[1])