NPO-Accounting/conservancy_beancount Changeset - 3fbc14d377ac

Changeset - 3fbc14d377ac

Parent rev.

Child rev.

[Not reviewed]

2 5 2

Brett Smith - 4 years ago 2020-03-15 20:03:57
brettcsmith@brettcsmith.org

Improve organization between modules.

* Rename _typing to beancount_types to better reflect what it is.
* LessComparable isn't a Beancount type, so move that to
plugin.core with its dependent helper classes.
* Errors are a core Beancount concept, so move that module to the
top level and have it include appropriate type definitions.

7 files changed with 35 insertions and 32 deletions:

conservancy_beancount/beancount_types.py

conservancy_beancount/errors.py

conservancy_beancount/plugin/__init__.py

conservancy_beancount/plugin/core.py

conservancy_beancount/plugin/meta_expense_allocation.py

conservancy_beancount/plugin/meta_tax_implication.py

tests/test_plugin_run.py

0 comments (0 inline, 0 general)

conservancy_beancount/beancount_types.py

➞

Show inline comments

 file renamed from conservancy_beancount/_typing.py to conservancy_beancount/beancount_types.py
-"""Type definitions for Conservancy Beancount code"""
+"""Type definitions for Beancount data structures"""
 # Copyright © 2020  Brett Smith
+#
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License as published by
@@ ... / @@ -17,9 +17,8 @@ @@
 import abc
 import datetime
 import beancount.core.data as bc_data
 from .plugin import errors
 from typing import (
     Any,
     FrozenSet,
@@ ... / @@ -32,23 +31,13 @@ from typing import ( @@
     Type,
+)
 Account = bc_data.Account
 Error = errors._BaseError
 ErrorIter = Iterable[Error]
 MetaKey = str
 MetaValue = Any
 MetaValueEnum = str
 Posting = bc_data.Posting
 class LessComparable(metaclass=abc.ABCMeta):
     @abc.abstractmethod
     def __le__(self, other: Any) -> bool: ...
     @abc.abstractmethod
     def __lt__(self, other: Any) -> bool: ...
 class Directive(NamedTuple):
     meta: bc_data.Meta
     date: datetime.date

conservancy_beancount/errors.py

➞

Show inline comments

 file renamed from conservancy_beancount/plugin/errors.py to conservancy_beancount/errors.py
@@ ... / @@ -13,9 +13,13 @@ @@
+#
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 class _BaseError(Exception):
 from typing import (
     Iterable,
+)
 class Error(Exception):
     def __init__(self, message, entry, source=None):
         self.message = message
         self.entry = entry
         self.source = entry.meta if source is None else source
@@ ... / @@ -27,9 +31,11 @@ class _BaseError(Exception): @@
             source=self.source,
+        )
 class InvalidMetadataError(_BaseError):
 Iter = Iterable[Error]
 class InvalidMetadataError(Error):
     def __init__(self, txn, post, key, value=None, source=None):
         if value is None:
             msg_fmt = "{post.account} missing {key}"
         else:

conservancy_beancount/plugin/__init__.py

➞

Show inline comments

@@ ... / @@ -27,17 +27,19 @@ from typing import ( @@
     Set,
     Tuple,
     Type,
+)
-from .._typing import (
+from ..beancount_types import (
     ALL_DIRECTIVES,
     Directive,
     Error,
+)
 from .core import (
     Hook,
     HookName,
+)
 from ..errors import (
     Error,
+)
 __plugins__ = ['run']
 class HookRegistry:

conservancy_beancount/plugin/core.py

➞

Show inline comments

@@ ... / @@ -17,25 +17,23 @@ @@
 import abc
 import datetime
 import re
 from . import errors as errormod
+from .. import errors as errormod
 from typing import (
     Any,
     FrozenSet,
     Generic,
     Iterable,
     Iterator,
     Mapping,
     Optional,
     TypeVar,
+)
-from .._typing import (
+from ..beancount_types import (
     Account,
     Directive,
     Error,
     ErrorIter,
     LessComparable,
     MetaKey,
     MetaValue,
     MetaValueEnum,
     Posting,
@@ ... / @@ -61,9 +59,9 @@ class Hook(Generic[Entry], metaclass=abc.ABCMeta): @@
     DIRECTIVE: Type[Directive]
     HOOK_GROUPS: FrozenSet[HookName] = frozenset()
     @abc.abstractmethod
-    def run(self, entry: Entry) -> ErrorIter: ...
+    def run(self, entry: Entry) -> errormod.Iter: ...
     def __init_subclass__(cls):
         cls.DIRECTIVE = cls.__orig_bases__[0].__args__[0]
@@ ... / @@ -71,8 +69,16 @@ class Hook(Generic[Entry], metaclass=abc.ABCMeta): @@
 TransactionHook = Hook[Transaction]
 ### HELPER CLASSES
 class LessComparable(metaclass=abc.ABCMeta):
     @abc.abstractmethod
     def __le__(self, other: Any) -> bool: ...
     @abc.abstractmethod
     def __lt__(self, other: Any) -> bool: ...
 CT = TypeVar('CT', bound=LessComparable)
 class _GenericRange(Generic[CT]):
     """Convenience class to check whether a value is within a range.
@@ ... @@
     def _run_on_post(self, txn: Transaction, post: Posting) -> bool:
         return True
-    def run(self, txn: Transaction) -> ErrorIter:
+    def run(self, txn: Transaction) -> errormod.Iter:
         if self._run_on_txn(txn):
             for index, post in enumerate(txn.postings):
                 if self._run_on_post(txn, post):
                     yield from self.post_run(txn, post, index)
     @abc.abstractmethod
-    def post_run(self, txn: Transaction, post: Posting, post_index: int) -> ErrorIter: ...
+    def post_run(self, txn: Transaction, post: Posting, post_index: int) -> errormod.Iter: ...
 class _NormalizePostingMetadataHook(_PostingHook):
     """Base class to normalize posting metadata from an enum."""
@@ ... / @@ -228,16 +234,16 @@ class _NormalizePostingMetadataHook(_PostingHook): @@
     # This base implementation does the latter.
     def _default_value(self, txn: Transaction, post: Posting) -> MetaValueEnum:
         raise errormod.InvalidMetadataError(txn, post, self.METADATA_KEY)
-    def post_run(self, txn: Transaction, post: Posting, post_index: int) -> ErrorIter:
+    def post_run(self, txn: Transaction, post: Posting, post_index: int) -> errormod.Iter:
         source_value = self._meta_get(txn, post, self.METADATA_KEY)
         set_value = source_value
         error: Optional[Error] = None
+        error: Optional[errormod.Error] = None
         if source_value is None:
             try:
                 set_value = self._default_value(txn, post)
-            except errormod._BaseError as error_:
+            except errormod.Error as error_:
                 error = error_
         else:
             try:
                 set_value = self.VALUES_ENUM[source_value]

conservancy_beancount/plugin/meta_expense_allocation.py

➞

Show inline comments

@@ ... / @@ -14,9 +14,9 @@ @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 from . import core
-from .._typing import (
+from ..beancount_types import (
     MetaValueEnum,
     Posting,
     Transaction,
+)

conservancy_beancount/plugin/meta_tax_implication.py

➞

Show inline comments

@@ ... / @@ -16,9 +16,9 @@ @@
 import decimal
 from . import core
-from .._typing import (
+from ..beancount_types import (
     Posting,
     Transaction,
+)

tests/test_plugin_run.py

➞

Show inline comments

@@ ... / @@ -17,25 +17,25 @@ @@
 import pytest
 from . import testutil
-from conservancy_beancount import plugin, _typing
+from conservancy_beancount import beancount_types, plugin
 CONFIG_MAP = {}
 HOOK_REGISTRY = plugin.HookRegistry()
 @HOOK_REGISTRY.add_hook
 class TransactionCounter:
-    DIRECTIVE = _typing.Transaction
+    DIRECTIVE = beancount_types.Transaction
     HOOK_GROUPS = frozenset()
     def run(self, txn):
         return ['txn:{}'.format(id(txn))]
 @HOOK_REGISTRY.add_hook
 class PostingCounter(TransactionCounter):
-    DIRECTIVE = _typing.Transaction
+    DIRECTIVE = beancount_types.Transaction
     HOOK_GROUPS = frozenset(['posting'])
     def run(self, txn):
         return ['post:{}'.format(id(post)) for post in txn.postings]

0 comments (0 inline, 0 general)