add log file logging

Author: christopher-wild

causal_testing/json_front/json_class.py

@@ -19,7 +19,6 @@
 
 logger = logging.getLogger(__name__)
 
-
 class JsonUtility(ABC):
     """
     The JsonUtility Class provides the functionality to use structured JSON to setup and run causal tests on the
@@ -37,7 +36,7 @@ class JsonUtility(ABC):
     :attr {CausalSpecification} causal_specification:
     """
 
-    def __init__(self):
+    def __init__(self, log_path):
         self.json_path = None
         self.dag_path = None
         self.data_path = None
@@ -48,6 +47,7 @@ def __init__(self):
         self.test_plan = None
         self.modelling_scenario = None
         self.causal_specification = None
+        self.setup_logger(log_path)
 
     def set_path(self, json_path: str, dag_path: str, data_path: str):
         """
@@ -212,3 +212,9 @@ def add_modelling_assumptions(self, estimation_model: Estimator):
         :param estimation_model: estimator model instance for the current running test.
         """
         return
+
+    @staticmethod
+    def setup_logger(log_path: Path):
+        logger = logging.getLogger(__name__)
+        fh = logging.FileHandler(log_path + "logs.txt")
+        logger.addHandler(fh)

examples/poisson/run_causal_tests.py

@@ -10,7 +10,7 @@
 from causal_testing.testing.estimators import Estimator
 from causal_testing.specification.scenario import Scenario
 from causal_testing.specification.variable import Input, Output, Meta
-
+import logging
 data_path = "data.csv"
 dag_path = "dag.dot"
 json_path = "causal_tests.json"
@@ -105,11 +105,19 @@ def get_args() -> argparse.Namespace:
     """
     parser = argparse.ArgumentParser(
         description="A script for parsing json config files for the Causal Testing Framework")
-    parser.add_argument("-f", help="if included, the script will stop if a test fails",
-                        action="store_true")
+    parser.add_argument(
+        "-f", help="if included, the script will stop if a test fails", action="store_true")
+    parser.add_argument(
+        "--log_path", help="Specify a directory to change the location of the log file", default="./")
     return parser.parse_args()
 
 
+def logger_setup():
+    logger = logging.getLogger(__name__)
+    fh = logging.FileHandler()
+    logger.addHandler(fh)
+
+
 inputs = [
     {"name": "width", "type": float, "distribution": "uniform"},
     {"name": "height", "type": float, "distribution": "uniform"},
@@ -188,7 +196,7 @@ def add_modelling_assumptions(self, estimation_model: Estimator):
 if __name__ == "__main__":
     args = get_args()
 
-    json_utility = MyJsonUtility()  # Create an instance of the extended JsonUtility class
+    json_utility = MyJsonUtility(args.log_path)  # Create an instance of the extended JsonUtility class
     json_utility.set_path(json_path, dag_path, data_path)  # Set the path to the data.csv, dag.dot and causal_tests.json file
 
     # Load the Causal Variables into the JsonUtility class ready to be used in the tests