Merge pull request #43 from DevoInc/release-next

2.0.3 improvements in devo.commons logging and configuration objects

Author: Worvast

CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [2.0.3] - 2019-01-23
+#### Changed
+ * Devo.common get_log() has more flags for better customization
+ 
+#### Added
+ * Sender for_logging() creation now verify where is tag flag
+ * Functions for configuration (save, leng, etc)
+
 ## [2.0.2] - 2019-01-23
 #### Fixed
  * devo.common logging handler

README.md

@@ -1,7 +1,7 @@
 
 [![master Build Status](https://travis-ci.com/DevoInc/python-sdk.svg?branch=master)](https://travis-ci.com/DevoInc/python-sdk) [![LICENSE](https://img.shields.io/dub/l/vibe-d.svg)](https://github.com/DevoInc/python-sdk/blob/master/LICENSE)
 
-[![wheel](https://img.shields.io/badge/wheel-yes-brightgreen.svg)](https://pypi.org/project/devo-sdk/) [![version](https://img.shields.io/badge/version-2.0.2-blue.svg)](https://pypi.org/project/devo-sdk/) [![python](https://img.shields.io/badge/python-2.7%20%7C%203.3%20%7C%203.4%20%7C%203.5%20%7C%203.6%20%7C%203.7-blue.svg)](https://pypi.org/project/devo-sdk/)
+[![wheel](https://img.shields.io/badge/wheel-yes-brightgreen.svg)](https://pypi.org/project/devo-sdk/) [![version](https://img.shields.io/badge/version-2.0.3-blue.svg)](https://pypi.org/project/devo-sdk/) [![python](https://img.shields.io/badge/python-2.7%20%7C%203.3%20%7C%203.4%20%7C%203.5%20%7C%203.6%20%7C%203.7-blue.svg)](https://pypi.org/project/devo-sdk/)
 
 
 # Devo Python SDK

devo/__version__.py

@@ -1,6 +1,6 @@
 __description__ = 'Devo Python Library.'
 __url__ = 'http://www.devo.com'
-__version__ = "2.0.2"
+__version__ = "2.0.3"
 __author__ = 'Devo'
 __author_email__ = 'support@devo.com'
 __license__ = 'MIT'

devo/common/generic/configuration.py

@@ -13,8 +13,10 @@ class Configuration:
     """
     Main class for load config files, and extract config objects
     """
-    def __init__(self):
+    def __init__(self, path=None, section=None):
         self.cfg = dict()
+        if path is not None:
+            self.load_config(path=path, section=section)
 
     def __load_cfg(self, cfg, section=None):
         """Load Configuration
@@ -27,7 +29,7 @@ def __load_cfg(self, cfg, section=None):
                 self.mix(cfg[section])
         else:
             self.mix(cfg)
-        return self
+        return None
 
     def load_json(self, path, section=None):
         """Load Json Configuration
@@ -73,6 +75,39 @@ def load_config(self, path, section=None):
 
         raise ConfigurationException("Configuration file type unknown or not supportted: %s" %path)
 
+    def save(self, path=None, save_bak=False):
+        if path is None:
+            return False
+
+        if os.path.isfile(path):
+            os.rename(path, "{}.bak".format(path))
+        try:
+            with open(path, 'w') as file:
+                if path.endswith('.json'):
+                    json.dump(self.cfg, file)
+                if path.endswith('.yaml') or path.endswith('.yml'):
+                    try:
+                        import yaml
+                    except ImportError as import_error:
+                        print(str(import_error),
+                              "- Use 'pip install pyyaml' or install this "
+                              "package with [click] option")
+                    yaml.dump(self.cfg, file, default_flow_style=False)
+            if os.path.isfile("{}.bak".format(path)) and not save_bak:
+                self.delete_file("{}.bak".format(path))
+            return True
+        except Exception:
+            if os.path.isfile(path):
+                self.delete_file(path)
+            if os.path.isfile("{}.bak".format(path)):
+                os.rename("{}.bak".format(path), path)
+            return False
+
+    @staticmethod
+    def delete_file(file):
+        if os.path.isfile(file):
+            os.remove(file)
+
     @staticmethod
     def __search_default_config_file():
         return "json" if os.path.exists(os.path.expanduser("~/.devo.json")) \
@@ -132,11 +167,28 @@ def secure_mix(self, cfg):
             if key not in self.cfg.keys():
                 self.cfg[key] = cfg[key]
 
-    def get(self):
+    def get(self, *args, **kwargs):
         """Get the configuration as dict
 
         :return: Return the configuration dict
         """
+        key = kwargs.get("key", None)
+        aux_dict = kwargs.get("aux_dict", None)
+
+        if args:
+            if isinstance(args[0], list):
+                key = args[0]
+            else:
+                key = list(args)
+        if key:
+            if aux_dict is None:
+                aux_dict = self.cfg
+            if isinstance(key, list):
+                if len(key) > 1:
+                    return self.get(key=key[1:], aux_dict=aux_dict[key[0]])
+                return aux_dict[key[0]]
+            return self.cfg[key]
+
         return self.cfg
 
     def keys(self, prop):
@@ -148,15 +200,12 @@ def keys(self, prop):
             return False
         return True
 
-    #DEPRECATE THIS FOR 2.0
     def key_exist(self, prop):
         """Check if exist property and if not then set to None
 
         :param prop: Property to check
         """
-        if prop not in self.cfg:
-            return False
-        return True
+        return self.keys(prop)
 
     def set(self, key_list, value):
         """ Set value of dict
@@ -184,3 +233,13 @@ def set_key_chain(aux_dict, key_list, value):
                                                                 key_list[1:],
                                                                 value)
         return aux_dict
+
+    def __getitem__(self, key):
+        return self.cfg[key]
+
+    def __setitem__(self, key, value):
+        self.cfg[key] = value
+        return None
+
+    def __str__(self):
+        return str(self.cfg)

devo/common/logging/log.py

@@ -7,14 +7,23 @@
 
 def get_log(path_base="./",
             file_name="history.log",
-            msg_format="'%(asctime)s %(levelname)s %(message)s'"):
+            msg_format="'%(asctime)s %(levelname)s %(message)s'",
+            name="log",
+            max_size=2097152,
+            backup_count=5,
+            level=logging.DEBUG):
     """Initialize logger for self process log
 
     :return: Log object
     """
-    logger = logging.getLogger('log')
-    logger.addHandler(set_handler(os.path.join(path_base, file_name), msg_format))
-    logger.setLevel(logging.DEBUG)
+
+    full_path = os.path.join(path_base, file_name)
+    if not os.path.exists(os.path.dirname(full_path)):
+        os.makedirs(os.path.dirname(full_path), exist_ok=True)
+
+    logger = logging.getLogger(name)
+    logger.addHandler(set_handler(full_path, msg_format, max_size, backup_count))
+    logger.setLevel(level)
     return logger
 
 
@@ -26,11 +35,12 @@ def set_formatter(msg_format):
     return logging.Formatter(msg_format)
 
 
-def set_handler(path, msg_format):
+def set_handler(path, msg_format, max_size, backup_count):
     """Initialize handler for logger
 
     :return: RotatingFileHandler object
     """
-    handler = RotatingFileHandler(path, maxBytes=2097152, backupCount=5)
+    handler = RotatingFileHandler(path, maxBytes=max_size,
+                                  backupCount=backup_count)
     handler.setFormatter(set_formatter(msg_format))
     return handler

devo/sender/data.py

@@ -436,17 +436,25 @@ def set_logger_tag(self, tag):
         self._logger_tag = tag
 
     @staticmethod
-    def for_logging(config, con_type="SSL", tag="test.drop.free"):
+    def for_logging(config, con_type="SSL", tag=None, level=10):
         """ Function for create Sender object from config file to use in
         logging handler
         :param config: config Devo file
         :param con_type: type of connection
         :param tag: tag for the table
+        :param level: level of logger
+        :param formatter: log formatter
         :return: Sender object
         """
         con = Sender.from_config(config, con_type)
-        con.set_logger_tag(tag)
-        con.set_level = 7
+        if tag:
+            con.set_logger_tag(tag)
+        elif "tag" in config.keys():
+            con.set_logger_tag(config['tag'])
+        else:
+            con.set_logger_tag("test.keep.free")
+
+        con.set_level = level
         return con
 
     @staticmethod

docs/common.md

@@ -7,7 +7,6 @@ This library add utilities for other packages.
 - Unification in the way of treating date formats
 - Unification in the way of treating configuration files
 - Logging functions
-- Custom memoize def
 
 #### Date Formats
 - Fixed format: As described on [Official Python Docs](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-behavior). Accepted formats are:
@@ -28,13 +27,84 @@ This library add utilities for other packages.
         - month(): Return 30 * 24 * 60 * 60
 
 
+#### Standard Devo logging file
+
+Devo commons gives you a function, with enough parameters for your personalization, to get a rotatting log handler:
+
+```python
+def get_log(path_base="./",
+            file_name="history.log",
+            msg_format="'%(asctime)s %(levelname)s %(message)s'",
+            name="log",
+            max_size=2097152,
+            backup_count=5,
+            level=logging.DEBUG):
+```
+
+
+You can use this handler with sender object, you can see more info in ['Sender readme'](sender.md######Third example)
+
 #### Standard Devo configuration file
 
 Devo Common contains the [`Configuration`](common/generic/configuration.py) 
-class to read JSON configuration files 
+class to read JSON and YAML configuration files 
 and automix an array with the file.
 
 You can see in several Devo libraries that the CLI allows the reading of a 
 config.json file, they all use this class to load them, and in each of the 
 libraries you can find the format they use, in addition to examples of use in 
 this class tests.
+
+You can read json or yaml file and save to obj faster:
+
+```python
+from devo.common import Configuration
+
+config = Configuration("/path/o/my/file.yaml")
+```
+
+You can use all these options for access, modify or use this  object:
+
+```python
+from devo.common import Configuration
+
+#Create
+config = Configuration("/path/o/my/file.yaml")
+
+
+# Get key
+value = config['keyOne']
+# or
+value = config.get("keyOne")
+# ---
+
+# Get key chain
+value = config['keyOne']['subKey']['id']
+# or
+value = config.get("keyOne", "subKey", "id")
+# or
+value = config.get(["keyOne", "subKey", "id"])
+# ---
+
+
+# Set key
+config['keyTwo'] = "value"
+# or
+config.set('keyTwo', "value")
+# ---
+
+# Set key chain
+config['keyTwo'] = {}
+config['keyTwo']['subKey'] = {}
+config['keyTwo']['subKey']['id'] = "value"
+
+# or
+config['keyTwo'] = {'subkey': {'id': "value"}}
+
+# or
+config.set(["keyTwo", "subKey", "id"], "value")
+
+
+# Save to file
+config.save("file/path.ext")
+```