Add InvestStatmentLine as possible return from parse_record to fix typing check errors.

.github/workflows/test.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
     - uses: actions/checkout@v2

Pipfile

@@ -12,8 +12,10 @@ mypy = "*"
 types-mock = "*"
 exceptiongroup = {markers="python_version < '3.11'"}
 tomli = {markers="python_version < '3.11'"}
+types-appdirs = "*"
 
 [packages]
 ofxstatement = {editable = true,path = "."}
 exceptiongroup = "*"
-importlib_metadata = {version = ">=3.8", markers="python_version < '3.10'"}
+importlib_metadata = {version = ">=3.8", markers="python_version < '3.10'"}
+zipp = {version = ">=3.8", markers="python_version < '3.10'"}

pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ofxstatement"
+version = "0.9.2.dev0"
+authors = [
+  { name="Andrey Lebedev", email="[email protected]" },
+]
+description = "Tool to convert proprietary bank statement to OFX format, suitable for importing to GnuCash"
+readme = "README.rst"
+requires-python = ">=3.9"
+license = { file="LICENSE.txt" }
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "Natural Language :: English",
+    "Topic :: Office/Business :: Financial :: Accounting",
+    "Topic :: Utilities",
+    "Environment :: Console",
+    "Operating System :: OS Independent",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+]
+keywords = ["ofx", "banking", "statement"]
+dependencies = [
+    "appdirs>=1.3.0",
+    "importlib_metadata>=3.8;python_version<'3.10'",
+    "zipp;python_version<'3.10'"
+]
+
+[project.urls]
+Homepage = "https://github.com/kedder/ofxstatement"
+
+[project.scripts]
+ofxstatement = "ofxstatement.tool:run"
+
+[tool.setuptools.package-data]
+ofxstatement = ["tests/samples"]

setup.cfg

@@ -1,51 +1,10 @@
-[metadata]
-name = ofxstatement
-version = 0.9.2.dev0
-description = Tool to convert proprietary bank statement to OFX format, suitable for importing to GnuCash
-long_description = file: README.rst
-long_description_content_type = text/x-rst
-url = https://github.com/kedder/ofxstatement
-author = Andrey Lebedev
-author_email = [email protected]
-classifiers =
-    Development Status :: 3 - Alpha
-    Programming Language :: Python :: 3
-    Natural Language :: English
-    Topic :: Office/Business :: Financial :: Accounting
-    Topic :: Utilities
-    Environment :: Console
-    Operating System :: OS Independent
-    License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-keywords = ofx banking statement
-project_urls =
-
 [options]
 package_dir = =src
 packages = find:
-python_requires = >=3.8, <4
-install_requires =
-    appdirs>=1.3.0
-    importlib_metadata>=3.8;python_version<'3.10'
-data_files =
+namespace_packages =
+    ofxstatement
+    ofxstatement.plugins
+
 
 [options.packages.find]
 where = src
-
-[options.entry_points]
-console_scripts =
-    ofxstatement=ofxstatement.tool:run 
-
-[options.extras_require]
-dev =
-    black
-    mypy
-test =
-    mock
-    pytest
-    pytest-coverage
-
-[mypy]
-ignore_missing_imports = True
-
-[pycodestyle]
-max-line-length=88

src/ofxstatement/__init__.py

@@ -0,0 +1 @@
+__import__("pkg_resources").declare_namespace(__name__)

src/ofxstatement/ofx.py

@@ -155,6 +155,8 @@ def buildInvestTransactionList(self) -> None:
         for security_id in dict.fromkeys(
             map(lambda x: x.security_id, self.statement.invest_lines)
         ):
+            if security_id is None:
+                continue
             tb.start("STOCKINFO", {})
             tb.start("SECINFO", {})
             tb.start("SECID", {})
@@ -199,12 +201,21 @@ def buildInvestTransactionList(self) -> None:
         tb.end("INVSTMTMSGSRSV1")
 
     def buildInvestTransaction(self, line: InvestStatementLine) -> None:
-        # invest transactions must always have trntype and trntype_detailed
-        if line.trntype is None or line.trntype_detailed is None:
+        # invest transactions must always have trntype
+        if line.trntype is None:
             return
 
         tb = self.tb
 
+        if line.trntype == "INVBANKTRAN":
+            tb.start(line.trntype, {})
+            bankTran = StatementLine(line.id, line.date, line.memo, line.amount)
+            bankTran.trntype = line.trntype_detailed
+            self.buildBankTransaction(bankTran)
+            self.buildText("SUBACCTFUND", "OTHER")
+            tb.end(line.trntype)
+            return
+
         tran_type_detailed_tag_name = None
         inner_tran_type_tag_name = None
         if line.trntype.startswith("BUY"):
@@ -213,14 +224,19 @@ def buildInvestTransaction(self, line: InvestStatementLine) -> None:
         elif line.trntype.startswith("SELL"):
             tran_type_detailed_tag_name = "SELLTYPE"
             inner_tran_type_tag_name = "INVSELL"
+        elif line.trntype == "TRANSFER":
+            # Transfer transactions don't have details or an envelope
+            tran_type_detailed_tag_name = None
+            inner_tran_type_tag_name = None
         else:
             tran_type_detailed_tag_name = "INCOMETYPE"
             inner_tran_type_tag_name = (
                 None  # income transactions don't have an envelope element
             )
 
         tb.start(line.trntype, {})
-        self.buildText(tran_type_detailed_tag_name, line.trntype_detailed, False)
+        if tran_type_detailed_tag_name:
+            self.buildText(tran_type_detailed_tag_name, line.trntype_detailed, False)
 
         if inner_tran_type_tag_name:
             tb.start(inner_tran_type_tag_name, {})
@@ -266,12 +282,7 @@ def buildInvestTransaction(self, line: InvestStatementLine) -> None:
             precision=self.invest_transactions_float_precision,
         )
 
-        self.buildAmount(
-            "TOTAL",
-            line.amount,
-            False,
-            precision=self.invest_transactions_float_precision,
-        )
+        self.buildAmount("TOTAL", line.amount)
 
         if inner_tran_type_tag_name:
             tb.end(inner_tran_type_tag_name)

src/ofxstatement/parser.py

@@ -1,10 +1,10 @@
-from typing import Dict, Optional, Any, Iterable, List, TextIO, TypeVar, Generic
+from typing import Dict, Optional, Any, Iterable, List, TextIO, TypeVar, Generic, Union
 from abc import abstractmethod
 import csv
 from decimal import Decimal, Decimal as D
 from datetime import datetime
 
-from ofxstatement.statement import Statement, StatementLine
+from ofxstatement.statement import Statement, StatementLine, InvestStatementLine
 
 LT = TypeVar("LT")
 
@@ -46,7 +46,7 @@ def parse(self) -> Statement:
             stmt_line = self.parse_record(line)
             if stmt_line:
                 stmt_line.assert_valid()
-                self.statement.lines.append(stmt_line)
+                self.statement.lines.append(stmt_line)  # type: ignore
         return self.statement
 
     def split_records(self) -> Iterable[LT]:  # pragma: no cover
@@ -57,6 +57,12 @@ def parse_record(self, line: LT) -> Optional[StatementLine]:  # pragma: no cover
         """Parse given transaction line and return StatementLine object"""
         raise NotImplementedError
 
+    def parse_invest_record(
+        self, line: LT
+    ) -> Optional[InvestStatementLine]:  # pragma: no cover
+        """Parse given investement transaction line and return InvetStatementLine object"""
+        raise NotImplementedError
+
     def parse_value(self, value: Optional[str], field: str) -> Any:
         tp = StatementLine.__annotations__.get(field)
         if value is None:

src/ofxstatement/plugin.py

@@ -2,6 +2,7 @@
 
 Plugins are objects that configures and coordinates conversion machinery.
 """
+
 from typing import List, Tuple, Type
 from collections.abc import MutableMapping
 import sys
@@ -21,7 +22,7 @@ def get_plugin(name: str, ui: UI, settings: MutableMapping) -> "Plugin":
         raise PluginNotRegistered(name)
     if len(plugins) > 1:
         raise PluginNameConflict(plugins)
-    plugin = plugins[0].load()  # type: ignore[index] # index requires a int but class expects a string
+    plugin = plugins[name].load()
     return plugin(ui, settings)
 
 

src/ofxstatement/plugins/__init__.py

@@ -0,0 +1 @@
+__import__("pkg_resources").declare_namespace(__name__)

src/ofxstatement/statement.py

@@ -1,4 +1,5 @@
 """Statement model"""
+
 from typing import List, Optional
 from datetime import datetime
 from decimal import Decimal as D
@@ -31,9 +32,11 @@
 INVEST_TRANSACTION_TYPES = [
     "BUYSTOCK",
     "BUYDEBT",
+    "INCOME",
+    "INVBANKTRAN",
     "SELLSTOCK",
     "SELLDEBT",
-    "INCOME",
+    "TRANSFER",
 ]
 
 INVEST_TRANSACTION_TYPES_DETAILED = [
@@ -43,6 +46,17 @@
     "SELLSHORT",  # open short sale
     "DIV",  # only for INCOME
     "INTEREST",  # only for INCOME
+    "CGLONG",  # only for INCOME
+    "CGSHORT",  # only for INCOME
+]
+
+INVBANKTRAN_TYPES_DETAILED = [
+    "INT",
+    "XFER",
+    "DEBIT",
+    "CREDIT",
+    "SRVCHG",
+    "OTHER",
 ]
 
 ACCOUNT_TYPE = [
@@ -274,19 +288,39 @@ def assert_valid(self) -> None:
             INVEST_TRANSACTION_TYPES,
         )
 
-        assert (
-            self.trntype_detailed in INVEST_TRANSACTION_TYPES_DETAILED
-        ), "trntype_detailed %s is not valid, must be one of %s" % (
-            self.trntype_detailed,
-            INVEST_TRANSACTION_TYPES_DETAILED,
-        )
+        if self.trntype == "INVBANKTRAN":
+            assert self.trntype_detailed in INVBANKTRAN_TYPES_DETAILED, (
+                "trntype_detailed %s is not valid for INVBANKTRAN, must be one of %s"
+                % (
+                    self.trntype_detailed,
+                    INVBANKTRAN_TYPES_DETAILED,
+                )
+            )
+        elif self.trntype == "TRANSFER":
+            assert (
+                self.trntype_detailed is None
+            ), f"trntype_detailed '{self.trntype_detailed}' should be empty for TRANSFERS"
+        else:
+            assert (
+                self.trntype_detailed in INVEST_TRANSACTION_TYPES_DETAILED
+            ), "trntype_detailed %s is not valid, must be one of %s" % (
+                self.trntype_detailed,
+                INVEST_TRANSACTION_TYPES_DETAILED,
+            )
 
         assert self.id
-        assert self.security_id
-        assert self.amount
-
-        assert self.trntype == "INCOME" or self.units
-        assert self.trntype == "INCOME" or self.unit_price
+        assert self.date
+        assert self.trntype == "TRANSFER" or self.amount
+        assert self.trntype == "INVBANKTRAN" or self.security_id
+
+        if self.trntype == "INVBANKTRAN":
+            pass
+        elif self.trntype == "INCOME":
+            assert self.security_id
+        else:
+            assert self.security_id
+            assert self.units
+            assert self.trntype == "TRANSFER" or self.unit_price
 
 
 class BankAccount(Printable):