Merge pull request #89 from jdebacker/warnings

PR to reduce warnings/notifications

Author: jdebacker

examples/run_og_zaf.py

@@ -5,7 +5,7 @@
 import json
 import time
 import copy
-import importlib.resources
+from importlib.resources import files
 import matplotlib.pyplot as plt
 from ogzaf.calibrate import Calibration
 from ogcore.parameters import Specifications
@@ -44,9 +44,11 @@ def main():
         output_base=base_dir,
     )
     # Update parameters for baseline from default json file
-    with importlib.resources.open_text(
-        "ogzaf", "ogzaf_default_parameters.json"
-    ) as file:
+    with (
+        files("ogzaf")
+        .joinpath("ogzaf_default_parameters.json")
+        .open("r") as file
+    ):
         defaults = json.load(file)
     p.update_specifications(defaults)
     # Update parameters from calibrate.py Calibration class

examples/run_og_zaf_education.py

@@ -7,6 +7,7 @@
 import time
 import copy
 import numpy as np
+from importlib.resources import files
 import matplotlib.pyplot as plt
 from ogzaf.calibrate import Calibration
 from ogcore.parameters import Specifications
@@ -47,15 +48,13 @@ def main():
         output_base=base_dir,
     )
     # Update parameters for baseline from default json file
-    p.update_specifications(
-        json.load(
-            open(
-                os.path.join(
-                    CUR_DIR, "..", "ogzaf", "ogzaf_default_parameters.json"
-                )
-            )
-        )
-    )
+    with (
+        files("ogzaf")
+        .joinpath("ogzaf_default_parameters.json")
+        .open("r") as file
+    ):
+        defaults = json.load(file)
+    p.update_specifications(defaults)
     # move closure rule out to 50 years since educaation phases in over 20 years
     p.tG1 = 50
 

examples/run_og_zaf_multiple_industry.py

@@ -6,7 +6,7 @@
 import json
 import time
 import copy
-import importlib.resources
+from importlib.resources import files
 import matplotlib.pyplot as plt
 from ogcore.parameters import Specifications
 from ogcore import output_tables as ot
@@ -43,9 +43,11 @@ def main():
         output_base=base_dir,
     )
     # Update parameters for baseline from default json file
-    with importlib.resources.open_text(
-        "ogzaf", "ogzaf_default_parameters_multisector.json"
-    ) as file:
+    with (
+        files("ogzaf")
+        .joinpath("ogzaf_default_parameters.json")
+        .open("r") as file
+    ):
         defaults = json.load(file)
     p.update_specifications(defaults)
 

examples/run_og_zaf_multiple_industry_cit_cut.py

@@ -2,7 +2,7 @@
 # function call
 import multiprocessing
 from distributed import Client
-import importlib.resources
+from importlib.resources import files
 import os
 import json
 import time
@@ -42,9 +42,11 @@ def main():
         output_base=base_dir,
     )
     # Update parameters for baseline from default json file
-    with importlib.resources.open_text(
-        "ogzaf", "ogzaf_default_parameters.json"
-    ) as file:
+    with (
+        files("ogzaf")
+        .joinpath("ogzaf_default_parameters.json")
+        .open("r") as file
+    ):
         defaults = json.load(file)
     p.update_specifications(defaults)
     # Update parameters from calibrate.py Calibration class for multiple industries

examples/run_og_zaf_multiple_industry_energy_tax.py

@@ -2,7 +2,7 @@
 # function call
 import multiprocessing
 from distributed import Client
-import importlib.resources
+from importlib.resources import files
 import os
 import json
 import time
@@ -46,11 +46,14 @@ def main():
         output_base=base_dir,
     )
     # Update parameters for baseline from default json file
-    with importlib.resources.open_text(
-        "ogzaf", "ogzaf_default_parameters.json"
-    ) as file:
+    with (
+        files("ogzaf")
+        .joinpath("ogzaf_default_parameters.json")
+        .open("r") as file
+    ):
         defaults = json.load(file)
     p.update_specifications(defaults)
+    p.update_specifications(defaults)
     # Update parameters from calibrate.py Calibration class for multiple industries
     p.M = 4
     p.I = 5

ogzaf/input_output.py

@@ -11,40 +11,43 @@
 SAM_path = "https://www.wider.unu.edu/sites/default/files/Data/SASAM-2015-Data-Resource.xlsx"
 SAM_path_alt = "https://raw.githubusercontent.com/EAPD-DRB/SAM-files/main/Data/ZAF/SASAM-2015-Data-Resource.xlsx"
 
-if is_connected():
-    try:
-        SAM = pd.read_excel(
-            SAM_path,
-            sheet_name="Micro SAM 2015",
-            skiprows=6,
-            index_col=0,
-            storage_options=storage_options,
-        )
-        print("Successfully read SAM from WIDER.")
-    except Exception as e:
-        print(f"Failed to read from WIDER: {e}")
+
+def read_SAM():
+    if is_connected():
         try:
-            # Attempt to read from the GitHub repository
             SAM = pd.read_excel(
-                SAM_path_alt,
+                SAM_path,
                 sheet_name="Micro SAM 2015",
                 skiprows=6,
                 index_col=0,
                 storage_options=storage_options,
             )
-            print("Successfully read SAM from GitHub repository.")
+            print("Successfully read SAM from WIDER.")
         except Exception as e:
-            print(f"Failed to read from the GitHub repository: {e}")
-            SAM = None
-    # If both attempts fail, SAM will be None
-    if SAM is None:
-        print("Failed to read SAM from both sources.")
-else:
-    SAM = None
-    print("No internet connection. SAM cannot be read.")
+            print(f"Failed to read from WIDER: {e}")
+            try:
+                # Attempt to read from the GitHub repository
+                SAM = pd.read_excel(
+                    SAM_path_alt,
+                    sheet_name="Micro SAM 2015",
+                    skiprows=6,
+                    index_col=0,
+                    storage_options=storage_options,
+                )
+                print("Successfully read SAM from GitHub repository.")
+            except Exception as e:
+                print(f"Failed to read from the GitHub repository: {e}")
+                SAM = None
+        # If both attempts fail, SAM will be None
+        if SAM is None:
+            print("Failed to read SAM from both sources.")
+    else:  # pragma: no cover
+        SAM = None
+        print("No internet connection. SAM cannot be read.")
+    return SAM
 
 
-def get_alpha_c(sam=SAM, cons_dict=CONS_DICT):
+def get_alpha_c(sam=None, cons_dict=CONS_DICT):
     """
     Calibrate the alpha_c vector, showing the shares of household
     expenditures for each consumption category
@@ -56,6 +59,8 @@ def get_alpha_c(sam=SAM, cons_dict=CONS_DICT):
     Returns:
         alpha_c (dict): Dictionary of shares of household expenditures
     """
+    if sam is None:
+        sam = read_SAM()
     alpha_c = {}
     overall_sum = 0
     for key, value in cons_dict.items():
@@ -72,7 +77,7 @@ def get_alpha_c(sam=SAM, cons_dict=CONS_DICT):
     return alpha_c
 
 
-def get_io_matrix(sam=SAM, cons_dict=CONS_DICT, prod_dict=PROD_DICT):
+def get_io_matrix(sam=None, cons_dict=CONS_DICT, prod_dict=PROD_DICT):
     """
     Calibrate the io_matrix array.  This array relates the share of each
     production category in each consumption category
@@ -85,6 +90,8 @@ def get_io_matrix(sam=SAM, cons_dict=CONS_DICT, prod_dict=PROD_DICT):
     Returns:
         io_df (pd.DataFrame): Dataframe of io_matrix
     """
+    if sam is None:
+        sam = read_SAM()
     # Create initial matrix as dataframe of 0's to fill in
     io_dict = {}
     for key in prod_dict.keys():

setup.py

@@ -18,7 +18,13 @@
         "Issue Tracker": "https://github.com/EAPD-DRB/OG-ZAF/issues",
     },
     packages=["ogzaf"],
-    package_data={"ogzaf": ["ogzaf_default_parameters.json", "data/*"]},
+    package_data={
+        "ogzaf": [
+            "ogzaf_default_parameters.json",
+            "ogzaf_default_parameters_multisector.json",
+            "data/*",
+        ]
+    },
     include_packages=True,
     python_requires=">=3.7.7, <3.13",
     install_requires=[

tests/test_input_output.py

@@ -25,6 +25,15 @@
 }
 
 
+def test_read_sam():
+    """
+    Test of read_SAM() function
+    """
+    test_df = io.read_SAM()
+
+    assert isinstance(test_df, pd.DataFrame)
+
+
 @pytest.mark.parametrize(
     "sam_df, cons_dict",
     [

tests/test_macro_params.py

@@ -2,24 +2,36 @@
 Tests of macro_params.py module
 """
 
+import pytest
 from ogzaf import macro_params
 
 
-def test_get_macro_params():
-    test_dict = macro_params.get_macro_params()
+@pytest.mark.parametrize(
+    "update_from_api",
+    [True, False],
+    ids=["update_from_api=True", "update_from_api=False"],
+)
+def test_get_macro_params(update_from_api):
+    test_dict = macro_params.get_macro_params(update_from_api=update_from_api)
 
     assert isinstance(test_dict, dict)
-    assert (
-        list(test_dict.keys()).sort()
-        == [
-            "r_gov_shift",
-            "r_gov_scale",
-            "alpha_T",
-            "alpha_G",
-            "initial_debt_ratio",
-            "g_y_annual",
-            "gamma",
-            "zeta_D",
-            "initial_foreign_debt_ratio",
-        ].sort()
-    )
+    if update_from_api:
+        assert (
+            list(test_dict.keys()).sort()
+            == [
+                "r_gov_shift",
+                "r_gov_scale",
+                "alpha_T",
+                "alpha_G",
+                "initial_debt_ratio",
+                "g_y_annual",
+                "gamma",
+                "zeta_D",
+                "initial_foreign_debt_ratio",
+            ].sort()
+        )
+    else:
+        assert (
+            list(test_dict.keys()).sort()
+            == ["r_gov_shift", "r_gov_scale"].sort()
+        )