patch fn takes params as an arg, like run_module

Author: nmdefries

google_symptoms/delphi_google_symptoms/patch.py

@@ -31,17 +31,28 @@
 from .run import run_module
 
 
-def patch():
+def patch(params):
     """
     Run the google symptoms indicator for a range of issue dates.
 
-    The range of issue dates is specified in params.json using the following keys:
+    Parameters
+    ----------
+    params
+        Dictionary containing indicator configuration. Expected to have the following structure:
+    - "common":
+        - "export_dir": str, directory to write output
+        - "log_exceptions" (optional): bool, whether to log exceptions to file
+        - "log_filename" (optional): str, name of file to write logs
+    - "indicator":
+        - "export_start_date": str, YYYY-MM-DD format, date from which to export data
+        - "num_export_days": int, number of days before end date (today) to export
+        - "path_to_bigquery_credentials": str, path to BigQuery API key and service account
+            JSON file
     - "patch": Only used for patching data
         - "start_date": str, YYYY-MM-DD format, first issue date
         - "end_date": str, YYYY-MM-DD format, last issue date
         - "patch_dir": str, directory to write all issues output
     """
-    params = read_params()
     logger = get_structured_logger("delphi_google_symptom.patch", filename=params["common"]["log_filename"])
 
     issue_date = datetime.strptime(params["patch"]["start_issue"], "%Y-%m-%d")
@@ -71,4 +82,4 @@ def patch():
 
 
 if __name__ == "__main__":
-    patch()
+    patch(read_params())

google_symptoms/tests/test_patch.py

@@ -46,8 +46,8 @@ def generate_expected_dates(self, params_, smoother, issue_date):
         num_export_days = (export_end_date - export_start_date).days + 1
 
         return sorted([export_start_date + timedelta(days=x) for x in range(num_export_days)])
-    def mocked_patch(self, params_):
 
+    def mocked_patch(self, params_):
         with mock_patch("delphi_google_symptoms.patch.read_params", return_value=params_), \
              mock_patch("delphi_google_symptoms.pull.pandas_gbq.read_gbq") as mock_read_gbq, \
              mock_patch("delphi_google_symptoms.pull.initialize_credentials", return_value=None), \
@@ -67,7 +67,7 @@ def side_effect(*args, **kwargs):
             mock_read_gbq.side_effect = side_effect
             start_date = datetime.strptime(params_["patch"]["start_issue"], "%Y-%m-%d")
 
-            patch()
+            patch(params_)
 
             patch_path = Path(f"{TEST_DIR}/{params_['patch']['patch_dir']}")