Merge pull request #1 from NACLab/logger

Logger

Author: willgebhardt

ngcsimlib/__init__.py

@@ -1,12 +1,15 @@
+
 from . import utils
 from . import controller
 from . import commands
+from . import logger
 
-import argparse, os, warnings, json
+import argparse, os, warnings, json, logging
 from types import SimpleNamespace
 from pathlib import Path
 from sys import argv
 from importlib import import_module
+from ngcsimlib.configManager import GlobalConfig
 
 from pkg_resources import get_distribution
 
@@ -26,7 +29,11 @@ def preload():
         module_path = None
 
     if module_path is None:
-        module_path = "json_files/modules.json"
+        module_config = GlobalConfig.get_config("modules")
+        if module_config is None:
+            module_path = "json_files/modules.json"
+        else:
+            module_path = module_config.get("module_path", "json_files/modules.json")
 
     if not os.path.isfile(module_path):
         warnings.warn("\nMissing file to preload modules from. Attempted to locate file at \"" + str(module_path) +
@@ -51,6 +58,36 @@ def preload():
                     utils._Loaded_Attributes[keyword] = atr
 
 
+###### Initialize Config
+def configure():
+    parser = argparse.ArgumentParser(description='Build and run a model using ngclearn')
+    parser.add_argument("--config", type=str, help='location of config.json file')
+
+    ## ngc-sim-lib only cares about --config argument
+    args, unknown = parser.parse_known_args()  # args = parser.parse_args()
+    try:
+        config_path = args.modules
+    except:
+        config_path = None
+
+    if config_path is None:
+        config_path = "json_files/config.json"
+
+    if not os.path.isfile(config_path):
+        warnings.warn("\nMissing configuration file. Attempted to locate file at \"" + str(config_path) +
+                      "\". Default Config will be used. "
+                      "\nSee PUT LINK HERE for additional information")
+        return
+
+    GlobalConfig.init_config(config_path)
+
+
+
+
 if not Path(argv[0]).name == "sphinx-build" or Path(argv[0]).name == "build.py":
     if "readthedocs" not in argv[0]:  ## prevent readthedocs execution of preload
+        configure()
+        logger.init_logging()
+
         preload()
+

ngcsimlib/commands/clamp.py

@@ -1,9 +1,7 @@
-import warnings
-
 from ngcsimlib.commands.command import Command
 from ngcsimlib.utils import extract_args
-from ngcsimlib.component_utils import find_compartment
-
+from ngcsimlib.componentUtils import find_compartment
+from ngcsimlib.logger import warn, error
 
 class Clamp(Command):
     """
@@ -33,11 +31,9 @@ def __init__(self, components=None, compartment=None, clamp_name=None,
         super().__init__(components=components, command_name=command_name,
                          required_calls=['clamp'])
         if compartment is None:
-            raise RuntimeError(
-                self.name + " requires a \'compartment\' to clamp to for construction")
+            error(self.name, "requires a \'compartment\' to clamp to for construction")
         if clamp_name is None:
-            raise RuntimeError(
-                self.name + " requires a \'clamp_name\' to bind to for construction")
+            error(self.name, "requires a \'clamp_name\' to bind to for construction")
 
         self.clamp_name = clamp_name
         self.compartment = compartment
@@ -46,23 +42,20 @@ def __init__(self, components=None, compartment=None, clamp_name=None,
             _, mapped_name = find_compartment(component.compartments, component.__class__, self.compartment)
 
             if mapped_name is None:
-                raise RuntimeError(self.name +
-                                   " is attempting to initialize clamp to non-existent compartment \"" + self.compartment
-                                   + "\" on " + name)
+                error(self.name, " is attempting to initialize clamp to non-existent compartment \"",
+                      self.compartment, "\" on ", name, sep=" ")
 
             if mapped_name != self.compartment:
-                warnings.warn(self.name +
-                              " is attempting to initialize clamp to a property name, not a compartment of " +
-                              name + ". If using a verboseDict and autoMap this will work, otherwise this clamp will "
-                                       "have unknown behavior")
+                warn(self.name, " is attempting to initialize clamp to a property name, not a compartment of ", name,
+                     ". If using a verboseDict and autoMap this will work, otherwise this clamp will have unknown "
+                     "behavior", sep=" ")
 
     def __call__(self, *args, **kwargs):
         try:
             vals = extract_args([self.clamp_name], *args, **kwargs)
         except RuntimeError:
-            raise RuntimeError(self.name + ", " + str(
-                self.clamp_name) + " is missing from keyword arguments or a positional "
-                                   "arguments can be provided")
+            error(self.name, ",", self.clamp_name,
+                  "is missing from keyword arguments or a positional arguments can be provided")
 
         for component in self.components:
             self.components[component].clamp(self.compartment, vals[self.clamp_name])

ngcsimlib/commands/compound.py

@@ -1,6 +1,6 @@
 from ngcsimlib.commands import Command
 from ngcsimlib.utils import check_attributes
-import warnings
+from ngcsimlib.logger import warn, error
 
 class Compound(Command):
     """
@@ -25,9 +25,9 @@ def __init__(self, components=None, command_name=None, command_list=None,
         """
         super().__init__(components=components, command_name=command_name)
         if controller is None:
-            raise RuntimeError("The controller is needed to build a compound command (This should be passed in by default)")
+            error("The controller is needed to build a compound command (This should be passed in by default)")
         if command_list is None or len(command_list) == 0:
-            warnings.warn("The command list for command " + self.name + " is None or empty")
+            warn("The command list for command", self.name, "is None or empty")
 
         self.command_list = command_list
         self.controller = controller

ngcsimlib/commands/multiclamp.py

@@ -1,6 +1,6 @@
 from ngcsimlib.commands.command import Command
 from ngcsimlib.utils import extract_args, check_attributes
-
+from ngcsimlib.logger import error
 
 class Multiclamp(Command):
     """
@@ -25,16 +25,16 @@ def __init__(self, components=None, clamp_name=None, command_name=None,
         super().__init__(components=components, command_name=command_name,
                          required_calls=['clamp'])
         if clamp_name is None:
-            raise RuntimeError(self.name + " requires a \'clamp_name\' to bind to for construction")
+            error(self.name, "requires a \'clamp_name\' to bind to for construction")
 
         self.clamp_name = clamp_name
 
     def __call__(self, *args, **kwargs):
         try:
             vals = extract_args([self.clamp_name], *args, **kwargs)
         except RuntimeError:
-            raise RuntimeError(self.name + ", " + str(self.clamp_name) + " is missing from keyword arguments or a "
-                                                                       "positional arguments can be provided")
+            error(self.name, ",", self.clamp_name,
+                  "is missing from keyword arguments or a positional arguments can be provided")
 
         for compartment, value in vals[self.clamp_name].items():
             for component in self.components:

ngcsimlib/commands/reset.py

@@ -1,7 +1,6 @@
 from ngcsimlib.commands import Command
 from ngcsimlib.utils import extract_args
-import warnings
-
+from ngcsimlib.logger import warn, error
 class Reset(Command):
     """
     In every model/system, there is a need to reset components back to some
@@ -24,15 +23,15 @@ def __init__(self, components=None, reset_name=None, command_name=None,
         super().__init__(components=components, command_name=command_name,
                          required_calls=['reset'])
         if reset_name is None:
-            raise RuntimeError(self.name + " requires a \'reset_name\' to bind to for construction")
+            error(self.name, "requires a \'reset_name\' to bind to for construction")
         self.reset_name = reset_name
 
     def __call__(self, *args, **kwargs):
         try:
             vals = extract_args([self.reset_name], *args, **kwargs)
         except RuntimeError:
-            warnings.warn(self.name + ", " + str(self.reset_name) + " is missing from keyword arguments and no "
-                                                             "positional arguments were provided", stacklevel=6)
+            warn(self.name, ",", self.reset_name,
+                 "is missing from keyword arguments and no positional arguments were provided")
             return
 
         if vals[self.reset_name]:

ngcsimlib/commands/save.py

@@ -1,6 +1,7 @@
 from ngcsimlib.commands import Command
 from ngcsimlib.utils import extract_args
-import warnings
+from ngcsimlib.logger import warn, error
+
 
 class Save(Command):
     """
@@ -30,15 +31,16 @@ def __init__(self, components=None, directory_flag=None, command_name=None,
         super().__init__(components=components, command_name=command_name,
                          required_calls=['save'])
         if directory_flag is None:
-            raise RuntimeError(self.name + " requires a \'directory_flag\' to bind to for construction")
+            error(self.name, "requires a \'directory_flag\' to bind to for construction")
+
         self.directory_flag = directory_flag
 
     def __call__(self, *args, **kwargs):
         try:
             vals = extract_args([self.directory_flag], *args, **kwargs)
         except RuntimeError:
-            warnings.warn(self.name + ", " + str(self.directory_flag) + " is missing from keyword arguments and no "
-                                                                "positional arguments were provided", stacklevel=6)
+            warn(self.name + ",", self.directory_flag,
+                 "is missing from keyword arguments and no positional arguments were provided")
             return
 
         if vals[self.directory_flag]:

ngcsimlib/commands/seed.py

@@ -1,6 +1,6 @@
 from ngcsimlib.commands.command import Command
 from ngcsimlib.utils import extract_args
-
+from ngcsimlib.logger import error
 
 class Seed(Command):
     """
@@ -27,18 +27,16 @@ def __init__(self, components=None, seed_name=None,
         super().__init__(components=components, command_name=command_name,
                          required_calls=['seed'])
         if seed_name is None:
-            raise RuntimeError(
-                self.name + " requires a \'seed_name\' to bind to for construction")
+            error(self.name, "requires a \'seed_name\' to bind to for construction")
 
         self.seed_name = seed_name
 
     def __call__(self, *args, **kwargs):
         try:
             vals = extract_args([self.seed_name], *args, **kwargs)
         except RuntimeError:
-            raise RuntimeError(self.name + ", " + str(
-                self.seed_name) + " is missing from keyword arguments or a positional "
-                                   "arguments can be provided")
+            error(self.name, ",", self.seed_name,
+                  "is missing from keyword arguments or a positional arguments can be provided")
 
         for component in self.components:
             self.components[component].seed(vals[self.seed_name])

ngcsimlib/commands/track.py

@@ -1,6 +1,6 @@
 from ngcsimlib.commands import Command
 from ngcsimlib.utils import extract_args
-import warnings
+from ngcsimlib.logger import warn, error
 
 class Track(Command):
     """
@@ -28,9 +28,9 @@ def __init__(self, components=None, compartment=None, tracker=None,
         """
         super().__init__(components=components, command_name=command_name)
         if compartment is None:
-            raise RuntimeError(self.name + " requires a \'compartment\' to clamp to for construction")
+            error(self.name, "requires a \'compartment\' to clamp to for construction")
         if tracker is None:
-            raise RuntimeError(self.name + " requires a \'tracker\' to bind to for construction")
+            error(self.name,"requires a \'tracker\' to bind to for construction")
 
         self.tracker = tracker
         self.compartment = compartment
@@ -40,8 +40,8 @@ def __call__(self, *args, **kwargs):
         try:
             vals = extract_args([self.tracker], *args, **kwargs)
         except RuntimeError:
-            warnings.warn(self.name + ", " + str(self.tracker) + " is missing from keyword arguments and no "
-                                                                "positional arguments were provided", stacklevel=6)
+            warn(self.name, ",", self.tracker,
+                 "is missing from keyword arguments and no positional arguments were provided")
             return
 
         v = []

ngcsimlib/component.py

@@ -1,7 +1,6 @@
 from abc import ABC, abstractmethod
-import warnings
 import ngcsimlib.utils as utils
-from ngcsimlib.component_utils import VerboseDict, ComponentMetadata
+from ngcsimlib.componentUtils import VerboseDict, ComponentMetadata