refs #30 renames filter_training_data_by_account to simply `account…

…` or sometimes to be be more specific to `known_account`.

smart_importer/machinelearning_helpers.py

@@ -15,15 +15,15 @@
 
 
 def load_training_data(training_data: Union[_FileMemo, List[Transaction], str],
-                       filter_training_data_by_account: str = None,
+                       known_account: str = None,
                        existing_entries: List[Tuple] = None) -> List[Transaction]:
     '''
     Loads training data
     :param training_data: The training data that shall be loaded.
         Can be provided as a string (the filename pointing to a beancount file),
         a _FileMemo instance,
         or a list of beancount entries
-    :param filter_training_data_by_account: Optional filter for the training data.
+    :param known_account: Optional filter for the training data.
         If provided, the training data is filtered to only include transactions that involve the specified account.
     :param existing_entries: Optional existing entries to use instead of explicit training_data
     :return: Returns a list of beancount entries.
@@ -42,11 +42,11 @@ def load_training_data(training_data: Union[_FileMemo, List[Transaction], str],
         assert not errors
         training_data = filter_txns(training_data)
     logger.debug(f"Finished reading training data.")
-    if filter_training_data_by_account:
+    if known_account:
         training_data = [t for t in training_data
-                         # ...filtered because the training data must involve the filter_training_data_by_account:
-                         if transaction_involves_account(t, filter_training_data_by_account)]
-        logger.debug(f"After filtering for account {filter_training_data_by_account}, "
+                         # ...filtered because the training data must involve the account:
+                         if transaction_involves_account(t, known_account)]
+        logger.debug(f"After filtering for account {known_account}, "
                      f"the training data consists of {len(training_data)} entries.")
     return training_data
 

smart_importer/predict_payees.py

@@ -44,12 +44,12 @@ def extract(file):
 
     def __init__(self, *,
                  training_data: Union[_FileMemo, List[Transaction], str] = None,
-                 filter_training_data_by_account: str = None,
+                 account: str = None,
                  predict_payees: bool = True,
                  overwrite_existing_payees=False,
                  suggest_payees: bool = True):
         self.training_data = training_data
-        self.filter_training_data_by_account = filter_training_data_by_account
+        self.account = account
         self.predict_payees = predict_payees
         self.overwrite_existing_payees = overwrite_existing_payees
         self.suggest_payees = suggest_payees
@@ -88,7 +88,7 @@ def wrapper(self, file, existing_entries=None):
     def enhance_transactions(self):# load training data
         self.training_data = ml.load_training_data(
             self.training_data,
-            filter_training_data_by_account=self.filter_training_data_by_account,
+            known_account=self.account,
             existing_entries=self.existing_entries)
 
         # train the machine learning model

smart_importer/predict_postings.py

@@ -32,7 +32,7 @@ class PredictPostings:
 
     @PredictPostings(
         training_data="trainingdata.beancount",
-        filter_training_data_by_account="The:Importers:Already:Known:Accountname"
+        account="The:Importers:Already:Known:Accountname"
     )
     class MyImporter(ImporterProtocol):
         def extract(file):
@@ -48,12 +48,12 @@ def __init__(
             self,
             *,
             training_data: Union[_FileMemo, List[Transaction], str] = None,
-            filter_training_data_by_account: str = None,
+            account: str = None,
             predict_second_posting: bool = True,
             suggest_accounts: bool = True
     ):
         self.training_data = training_data
-        self.filter_training_data_by_account = filter_training_data_by_account
+        self.account = account
         self.predict_second_posting = predict_second_posting
         self.suggest_accounts = suggest_accounts
 
@@ -92,7 +92,7 @@ def wrapper(self, file, existing_entries=None):
     def enhance_transactions(self):# load training data
         self.training_data = ml.load_training_data(
             self.training_data,
-            filter_training_data_by_account=self.filter_training_data_by_account,
+            known_account=self.account,
             existing_entries=self.existing_entries)
 
         # convert training data to a list of TxnPostingAccounts

smart_importer/tests/predict_payees_test.py

@@ -85,7 +85,7 @@ class Testdata:
         """)
     assert not errors
 
-    filter_training_data_by_account = "Assets:US:BofA:Checking"
+    known_account = "Assets:US:BofA:Checking"
 
     correct_predictions = [
         'Farmer Fresh',
@@ -115,7 +115,7 @@ def setUp(self):
         # define and decorate an importer:
         @PredictPayees(
             training_data=Testdata.training_data,
-            filter_training_data_by_account="Assets:US:BofA:Checking",
+            account="Assets:US:BofA:Checking",
             overwrite_existing_payees=False
         )
         class DecoratedImporter(BasicImporter):
@@ -190,7 +190,7 @@ def test_class_decoration_with_arguments(self):
 
         @PredictPayees(
             training_data=Testdata.training_data,
-            filter_training_data_by_account=Testdata.filter_training_data_by_account
+            account=Testdata.known_account
         )
         class SmartImporter(BasicImporter):
             pass
@@ -213,7 +213,7 @@ def test_method_decoration_with_arguments(self):
         class SmartImporter(BasicImporter):
             @PredictPayees(
                 training_data=Testdata.training_data,
-                filter_training_data_by_account=Testdata.filter_training_data_by_account
+                account=Testdata.known_account
             )
             def extract(self, file, existing_entries=None):
                 testcase.assertIsInstance(self, SmartImporter)

smart_importer/tests/predict_postings_test.py

@@ -81,7 +81,7 @@ class Testdata:
                 """)
     assert not errors
 
-    filter_training_data_by_account = "Assets:US:BofA:Checking"
+    known_account = "Assets:US:BofA:Checking"
 
     correct_predictions = [
         'Expenses:Food:Groceries',
@@ -111,7 +111,7 @@ def setUp(self):
         # define and decorate an importer:
         @PredictPostings(
             training_data=Testdata.training_data,
-            filter_training_data_by_account="Assets:US:BofA:Checking"
+            account="Assets:US:BofA:Checking"
         )
         class DecoratedImporter(BasicImporter):
             pass
@@ -176,7 +176,7 @@ def test_class_decoration_with_arguments(self):
 
         @PredictPostings(
             training_data=Testdata.training_data,
-            filter_training_data_by_account=Testdata.filter_training_data_by_account
+            account=Testdata.known_account
         )
         class SmartImporter(BasicImporter):
             pass
@@ -199,7 +199,7 @@ def test_method_decoration_with_arguments(self):
         class SmartImporter(BasicImporter):
             @PredictPostings(
                 training_data=Testdata.training_data,
-                filter_training_data_by_account=Testdata.filter_training_data_by_account
+                account=Testdata.known_account
             )
             def extract(self, file, existing_entries=None):
                 testcase.assertIsInstance(self, SmartImporter)