onaplogging: Docstrings, refactor, type hinting

Identify and document functionalities. Describe parameters
and their types, exception descriptions and types, extensions,
return types and descriptions. Preserve Python 2.7 and 3.x
compatibility. Add Python 2.7 to Tox testing. Extract code to utility files.
Add properties for readability and maintainability, fix naming conventions.
Deprecate old methods and attributes.

Issue-ID: REQ-420
Signed-off-by: Eli Halych <illia.halych@t-mobile.pl>
Change-Id: I19297e40fad743ec68aa04612ecbb11f61f2abec

5 files changed, 28 insertions, 27 deletions

diff --git a/pylog/tests/test_color_formatter.py b/pylog/tests/test_color_formatter.py
index 9a9ae5a..56bf9c2 100644
--- a/pylog/tests/test_color_formatter.py
+++ b/pylog/tests/test_color_formatter.py
@@ -27,7 +27,7 @@ from onaplogging.colorFormatter import (
     FMT_STR,
     RESET,
 )
-from onaplogging.utils import is_above_python_3_2
+from onaplogging.utils.system import is_above_python_3_2
 
 
 class TestColorFormatter(unittest.TestCase):
diff --git a/pylog/tests/test_log_watchdog.py b/pylog/tests/test_log_watchdog.py
index 5f43138..e1b9fea 100644
--- a/pylog/tests/test_log_watchdog.py
+++ b/pylog/tests/test_log_watchdog.py
@@ -22,7 +22,8 @@ if sys.version_info[0] >= 3:
 import pytest
 import yaml
 
-from onaplogging.logWatchDog import FileEventHandlers, _yaml2Dict, _yamlConfig
+from onaplogging.logWatchDog import FileEventHandlers, _yamlConfig
+from onaplogging.utils.tools import yaml_to_dict, _yaml2Dict
 
 
 TestEvent = namedtuple("TestEvent", ["src_path"])
diff --git a/pylog/tests/test_marker_formatter.py b/pylog/tests/test_marker_formatter.py
index bda7f24..c7ae6b1 100644
--- a/pylog/tests/test_marker_formatter.py
+++ b/pylog/tests/test_marker_formatter.py
@@ -30,16 +30,16 @@ class TestMarkerFormatter(unittest.TestCase):
     def test_marker_formatter_init(self):
         marker_formatter = MarkerFormatter()
         self.assertEqual(marker_formatter.style, "%")
-        self.assertEqual(marker_formatter._marker_tag, "%(marker)s")
+        self.assertEqual(marker_formatter.marker_tag, "%(marker)s")
 
         if sys.version_info[0] >= 3:
             marker_formatter = MarkerFormatter(style="{")
             self.assertEqual(marker_formatter.style, "{")
-            self.assertEqual(marker_formatter._marker_tag, "{marker}")
+            self.assertEqual(marker_formatter.marker_tag, "{marker}")
 
             marker_formatter = MarkerFormatter(style="$")
             self.assertEqual(marker_formatter.style, "$")
-            self.assertEqual(marker_formatter._marker_tag, "${marker}")
+            self.assertEqual(marker_formatter.marker_tag, "${marker}")
 
             with pytest.raises(ValueError):
                 MarkerFormatter(style="*")
@@ -50,18 +50,18 @@ class TestMarkerFormatter(unittest.TestCase):
         with patch("onaplogging.markerFormatter.BaseColorFormatter.format") as mock_format:
             marker_formatter = MarkerFormatter()
             self.assertEqual(marker_formatter._fmt, "%(message)s")
-            self.assertEqual(marker_formatter._marker_tag, "%(marker)s")
+            self.assertEqual(marker_formatter.marker_tag, "%(marker)s")
             marker_formatter.format(record)
             mock_format.assert_called_once()
             self.assertEqual(marker_formatter._fmt, "%(message)s")
-            self.assertEqual(marker_formatter._marker_tag, "%(marker)s")
+            self.assertEqual(marker_formatter.marker_tag, "%(marker)s")
 
         with patch("onaplogging.markerFormatter.BaseColorFormatter.format") as mock_format:
             marker_formatter = MarkerFormatter(fmt="%(message)s %(marker)s")
             self.assertEqual(marker_formatter._fmt, "%(message)s %(marker)s")
-            self.assertEqual(marker_formatter._marker_tag, "%(marker)s")
+            self.assertEqual(marker_formatter.marker_tag, "%(marker)s")
             marker_formatter.format(record)
             mock_format.assert_called_once()
             self.assertEqual(marker_formatter._fmt, "%(message)s %(marker)s")
-            self.assertEqual(marker_formatter._marker_tag, "%(marker)s")
-            self.assertEqual(marker_formatter._tmpFmt, "%(message)s %(marker)s")
+            self.assertEqual(marker_formatter.marker_tag, "%(marker)s")
+            self.assertEqual(marker_formatter.temp_fmt, "%(message)s %(marker)s")
diff --git a/pylog/tests/test_monkey.py b/pylog/tests/test_monkey.py
index 4f71fe2..9b64b62 100644
--- a/pylog/tests/test_monkey.py
+++ b/pylog/tests/test_monkey.py
@@ -16,32 +16,32 @@ if sys.version_info[0] < 3:
 if sys.version_info[0] >= 3:
     from unittest.mock import patch
 
-from onaplogging.monkey import patch_all, patch_loggingMDC, patch_loggingYaml
+from onaplogging.monkey import patch_all, patch_logging_yaml, patch_logging_mdc
 
 
 class TestMonkey(unittest.TestCase):
 
     def test_patch_all(self):
-        with patch("onaplogging.monkey.patch_loggingMDC") as mock_mdc:
-            with patch("onaplogging.monkey.patch_loggingYaml") as mock_yaml:
+        with patch("onaplogging.monkey.patch_logging_mdc") as mock_mdc:
+            with patch("onaplogging.monkey.patch_logging_yaml") as mock_yaml:
                 patch_all()
                 mock_mdc.assert_called_once()
                 mock_yaml.assert_called_once()
 
-        with patch("onaplogging.monkey.patch_loggingMDC") as mock_mdc:
-            with patch("onaplogging.monkey.patch_loggingYaml") as mock_yaml:
+        with patch("onaplogging.monkey.patch_logging_mdc") as mock_mdc:
+            with patch("onaplogging.monkey.patch_logging_yaml") as mock_yaml:
                 patch_all(mdc=False)
                 mock_mdc.assert_not_called()
                 mock_yaml.assert_called_once()
 
-        with patch("onaplogging.monkey.patch_loggingMDC") as mock_mdc:
-            with patch("onaplogging.monkey.patch_loggingYaml") as mock_yaml:
+        with patch("onaplogging.monkey.patch_logging_mdc") as mock_mdc:
+            with patch("onaplogging.monkey.patch_logging_yaml") as mock_yaml:
                 patch_all(yaml=False)
                 mock_mdc.assert_called_once()
                 mock_yaml.assert_not_called()
 
-        with patch("onaplogging.monkey.patch_loggingMDC") as mock_mdc:
-            with patch("onaplogging.monkey.patch_loggingYaml") as mock_yaml:
+        with patch("onaplogging.monkey.patch_logging_mdc") as mock_mdc:
+            with patch("onaplogging.monkey.patch_logging_yaml") as mock_yaml:
                 patch_all(mdc=False, yaml=False)
                 mock_mdc.assert_not_called()
                 mock_yaml.assert_not_called()
diff --git a/pylog/tests/test_utils.py b/pylog/tests/test_utils.py
index 5a64aab..a118361 100644
--- a/pylog/tests/test_utils.py
+++ b/pylog/tests/test_utils.py
@@ -16,30 +16,30 @@ if sys.version_info[0] < 3:
 if sys.version_info[0] >= 3:
     from unittest.mock import patch, MagicMock
 
-from onaplogging.utils import is_above_python_2_7, is_above_python_3_2
+from onaplogging.utils.system import is_above_python_2_7, is_above_python_3_2
 
 
 class TestUtils(unittest.TestCase):
 
     def test_is_above_python_3_2(self):
-        with patch("onaplogging.utils.sys.version_info", (3, 4, 7)):
+        with patch("onaplogging.utils.system.sys.version_info", (3, 4, 7)):
             assert is_above_python_3_2() is True
 
-        with patch("onaplogging.utils.sys.version_info", (2, 7, 5)):
+        with patch("onaplogging.utils.system.sys.version_info", (2, 7, 5)):
             assert is_above_python_3_2() is False
 
-        with patch("onaplogging.utils.sys.version_info", (3, 2, 0, "final", 0)):
+        with patch("onaplogging.utils.system.sys.version_info", (3, 2, 0, "final", 0)):
             assert is_above_python_3_2() is True
 
     def test_is_above_python_2_7(self):
-        with patch("onaplogging.utils.sys.version_info", (3, 4, 7)):
+        with patch("onaplogging.utils.system.sys.version_info", (3, 4, 7)):
             assert is_above_python_2_7() is True
 
-        with patch("onaplogging.utils.sys.version_info", (2, 7, 5)):
+        with patch("onaplogging.utils.system.sys.version_info", (2, 7, 5)):
             assert is_above_python_2_7() is True
 
-        with patch("onaplogging.utils.sys.version_info", (2, 5, 6)):
+        with patch("onaplogging.utils.system.sys.version_info", (2, 5, 6)):
             assert is_above_python_2_7() is False
 
-        with patch("onaplogging.utils.sys.version_info", (2, 7, 0, "final", 0)):
+        with patch("onaplogging.utils.system.sys.version_info", (2, 7, 0, "final", 0)):
             assert is_above_python_2_7() is True