NPO-Accounting/conservancy_beancount Changeset - 747ef25da618

Changeset - 747ef25da618

Parent rev.

Child rev.

[Not reviewed]

0 5 0

Brett Smith - 4 years ago 2020-03-30 03:18:40
brettcsmith@brettcsmith.org

setup: Disallow untyped defs.

Mostly this meant giving annotations to low-value functions like
the error classes and __init_subclass__, but it's worth it for
the future strictness+documentation value.

5 files changed with 71 insertions and 14 deletions:

conservancy_beancount/errors.py

conservancy_beancount/plugin/core.py

conservancy_beancount/plugin/meta_project.py

conservancy_beancount/rtutil.py

setup.cfg

0 comments (0 inline, 0 general)

conservancy_beancount/errors.py

➞

Show inline comments

@@ ... / @@ -15,15 +15,40 @@ @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 import beancount.core.data as bc_data
 from typing import (
     Any,
     Iterable,
     Optional,
+)
 from .beancount_types import (
     Directive,
     MetaKey,
     MetaValue,
     Posting,
     Transaction,
     Type,
+)
 Meta = Optional[bc_data.Meta]
 class Error(Exception):
     def __init__(self, message, entry, source=None):
     def __init__(self,
                  message: str,
                  entry: Optional[Directive],
                  source: Meta=None,
     ) -> None:
         self.message = message
         self.entry = entry
         self.source = entry.meta if source is None else source
         if source:
             self.source = source
         elif entry is not None:
             self.source = entry.meta
         else:
             self.source = {}
             self._fill_source(self.source, '<unknown>')
     def __repr__(self):
+    def __repr__(self) -> str:
         return "{clsname}<{source[filename]}:{source[lineno]}: {message}>".format(
             clsname=type(self).__name__,
@@ ... / @@ -32,5 +57,9 @@ class Error(Exception): @@
+        )
     def _fill_source(self, source, filename='conservancy_beancount', lineno=0):
     def _fill_source(self,
                      source: bc_data.Meta,
                      filename: str='conservancy_beancount',
                      lineno: int=0,
     ) -> None:
         source.setdefault('filename', filename)
         source.setdefault('lineno', lineno)
@@ ... / @@ -40,5 +69,10 @@ Iter = Iterable[Error] @@
 class BrokenLinkError(Error):
     def __init__(self, txn, key, link, source=None):
     def __init__(self,
                  txn: Transaction,
                  key: MetaKey,
                  link: str,
                  source: Meta=None,
     ) -> None:
         super().__init__(
             "{} not found in repository: {}".format(key, link),
@@ ... / @@ -47,6 +81,13 @@ class BrokenLinkError(Error): @@
+        )
 class BrokenRTLinkError(Error):
     def __init__(self, txn, key, link, parsed=True, source=None):
     def __init__(self,
                  txn: Transaction,
                  key: MetaKey,
                  link: str,
                  parsed: Any=True,
                  source: Meta=None,
     ) -> None:
         if parsed:
             msg_fmt = "{} not found in RT: {}"
@@ ... / @@ -59,6 +100,11 @@ class BrokenRTLinkError(Error): @@
+        )
 class ConfigurationError(Error):
     def __init__(self, message, entry=None, source=None):
     def __init__(self,
                  message: str,
                  entry: Optional[Directive]=None,
                  source: Meta=None,
     ) -> None:
         if source is None:
             source = {}
@@ ... / @@ -68,5 +114,12 @@ class ConfigurationError(Error): @@
 class InvalidMetadataError(Error):
     def __init__(self, txn, key, value=None, post=None, need_type=str, source=None):
     def __init__(self,
                  txn: Transaction,
                  key: MetaKey,
                  value: Optional[MetaValue]=None,
                  post: Optional[bc_data.Posting]=None,
                  need_type: Type=str,
                  source: Meta=None,
     ) -> None:
         if post is None:
             srcname = 'transaction'

conservancy_beancount/plugin/core.py

➞

Show inline comments

@@ ... / @@ -70,6 +70,7 @@ class Hook(Generic[Entry], metaclass=abc.ABCMeta): @@
     def run(self, entry: Entry) -> errormod.Iter: ...
     def __init_subclass__(cls):
         cls.DIRECTIVE = cls.__orig_bases__[0].__args__[0]
     def __init_subclass__(cls) -> None:
         # cls.__orig_bases__ comes from the ABCMeta metaclass
         cls.DIRECTIVE = cls.__orig_bases__[0].__args__[0]  # type:ignore[attr-defined]

conservancy_beancount/plugin/meta_project.py

➞

Show inline comments

@@ ... / @@ -32,4 +32,5 @@ from typing import ( @@
     Any,
     Dict,
     NoReturn,
     Optional,
     Set,
@@ ... / @@ -44,5 +45,5 @@ class MetaProject(core._NormalizePostingMetadataHook): @@
         repo_path = config.repository_path()
         if repo_path is None:
-            raise self._config_error("no repository configured")
             self._config_error("no repository configured")
         project_data_path = repo_path / source_path
         source = {'filename': str(project_data_path)}
@@ ... / @@ -69,5 +70,5 @@ class MetaProject(core._NormalizePostingMetadataHook): @@
             self.VALUES_ENUM = core.MetadataEnum(self.METADATA_KEY, names, aliases)
     def _config_error(self, msg: str, filename: Optional[Path]=None):
+    def _config_error(self, msg: str, filename: Optional[Path]=None) -> NoReturn:
         source = {}
         if filename is not None:

conservancy_beancount/rtutil.py

➞

Show inline comments

@@ ... / @@ -197,9 +197,10 @@ class RT: @@
     def _cache_method(func: _URLLookup) -> _URLLookup:  # type:ignore[misc]
         @functools.wraps(func)
         def caching_wrapper(self,
+        def caching_wrapper(self: 'RT',
                             ticket_id: RTId,
                             attachment_id: Optional[RTId]=None,
         ) -> Optional[str]:
             cache_key = (str(ticket_id), attachment_id and str(attachment_id))
             cache_key = (str(ticket_id),
                          None if attachment_id is None else str(attachment_id))
             url: Optional[str]
             try:

setup.cfg

➞

Show inline comments

@@ ... / @@ -5,4 +5,5 @@ typecheck=pytest --addopts="--mypy conservancy_beancount" @@
 [mypy]
 disallow_any_unimported = True
 disallow_untyped_defs = True
 show_error_codes = True
 strict_equality = True

0 comments (0 inline, 0 general)