Merge pull request #109 from deep-compute/feature-env-file

Support for custom global env variables

Author: sundarrajan78

basescript/basescript.py

@@ -4,7 +4,7 @@
 import argparse
 import socket
 
-from .log import init_logger, pretty_print
+from .log import init_logger, pretty_print, ReadEnv
 from deeputil import Dummy
 
 
@@ -59,6 +59,9 @@ def __init__(self, args=None):
         self._flush_metrics_q = log._force_flush_q
         self.log = log.bind(name=self.args.name)
 
+        if self.args.env_file:
+            ReadEnv(self.args.env_file)
+
         self.stats = Dummy()
 
         args = {n: getattr(self.args, n) for n in vars(self.args)}
@@ -174,6 +177,11 @@ def define_baseargs(self, parser):
             action="store_true",
             help="Hide log keys such as id, host",
         )
+        parser.add_argument(
+            "--env-file",
+            default=None,
+            help="Writes logs to log file if specified, default: %(default)s",
+        )
 
     def define_args(self, parser):
         """

basescript/log.py

@@ -7,6 +7,7 @@
 import logging
 import numbers
 import signal
+import yaml
 from six.moves import queue
 from threading import Thread, Lock
 from datetime import datetime
@@ -69,6 +70,22 @@ def __sighandler__(self, signum, frame):
             self.f = open(self.fpath, "a")
 
 
+class ReadEnv:
+    def __init__(self, envfile):
+        self.envfile = envfile
+        self.env = self.read()
+        setattr(structlog.BoundLoggerBase, "env_context", self.env)
+        signal.signal(signal.SIGUSR1, self.__sighandler__)
+
+    def read(self):
+        with open(self.envfile) as f:
+            return yaml.full_load(f.read())
+
+    def __sighandler__(self, signum, frame):
+        self.env = self.read()
+        setattr(structlog.BoundLoggerBase, "env_context", self.env)
+
+
 class StderrConsoleRenderer(object):
     BACKUP_KEYS = ("timestamp", "level", "event", "logger", "stack", "exception")
 
@@ -163,6 +180,8 @@ def _add_base_info(self, event_dict):
         f = sys._getframe()
         level_method_frame = f.f_back
         caller_frame = level_method_frame.f_back
+        if hasattr(self, "env_context"):
+            event_dict.update(self.env_context)
         return event_dict
 
     def debug(self, event=None, *args, **kw):

setup.py

@@ -25,7 +25,7 @@ def get_long_description():
 
 long_description = get_long_description()
 
-version = "0.3.8"
+version = "0.3.9"
 setup(
     name="basescript",
     version=version,
@@ -43,6 +43,7 @@ def get_long_description():
         "structlog==18.1.0",
         "colorama==0.3.9",
         "deeputil>=0.2.7",
+        "PyYAML==5.1.1"
     ],
     package_dir={"basescript": "basescript"},
     packages=find_packages(".", exclude=["tests*"]),