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

1 files changed, 16 insertions, 4 deletions

diff --git a/pylog/onaplogging/monkey.py b/pylog/onaplogging/monkey.py
index f8bf992..33c3ced 100644
--- a/pylog/onaplogging/monkey.py
+++ b/pylog/onaplogging/monkey.py
@@ -12,17 +12,29 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from .mdcContext import patch_loggingMDC
-from .logWatchDog import patch_loggingYaml
+from typing import Optional
+
+from .mdcContext import patch_logging_mdc
+from .logWatchDog import patch_logging_yaml
 
 
 __all__ = ["patch_all"]
 
 
 def patch_all(mdc=True, yaml=True):
+    # type: ( Optional[bool], Optional[bool] ) -> None
+    """
+    Patches both MDC contextual information and YAML configuration file to the
+    logger by default. To exclude any or both set `mdc` and/or `yaml`
+    parameters to False.
+
+    Args:
+        mdc (bool, optional): Defaults to True.
+        yaml (bool, optional): Defaults to True.
+    """
 
     if mdc is True:
-        patch_loggingMDC()
+        patch_logging_mdc()
 
     if yaml is True:
-        patch_loggingYaml()
+        patch_logging_yaml()