Merge pull request #21 from timothyhull:timothyhull/refactor-namedtuple-maker

Refactor for PEP compliance

Author: timothyhull

namedtuple_maker/namedtuple_logger.py

@@ -42,17 +42,16 @@
 LOG_FILE_PATH = path.curdir
 LOG_FILE_NAME = 'namedtuple-log.log'
 LOG_FILE = path.join(LOG_FILE_PATH, LOG_FILE_NAME)
-LOG_LEVEL_DEFAULT = 'INFO'
+LOG_LEVEL_DEFAULT = 'CRITICAL'
 LOG_LEVELS = (
-    'FATAL',
-    'ERROR',
     'CRITICAL',
-    'WARN',
+    'ERROR',
     'WARNING',
-    'INFO',
     'NOTICE',
+    'INFO',
     'DEBUG',
-    'TRACE'
+    'TRACE',
+    'NOTSET'
 )
 
 
@@ -158,7 +157,6 @@ def initialize_logging(
             )
 
     else:
-
         # Initialize logging to console
         logbook.StreamHandler(
             stream=stdout,

namedtuple_maker/namedtuple_maker.py

@@ -99,19 +99,18 @@ def my_function(
 
         Logging Level:
             The application creates a log level with a default
-            logging level of 'INFO'.  To set a different logging level,
+            logging level of 'CRITICAL'.  To set a different logging level,
             set an environment variable named LOG_LEVEL to one of the
             following case insensitive logging levels:
 
-            - FATAL
-            - ERROR
             - CRITICAL
-            - WARN
+            - ERROR
             - WARNING
-            - INFO
             - NOTICE
+            - INFO
             - DEBUG
             - TRACE
+            - NOTSET
 
             Example custom logging usage:
                 export LOG_LEVEL=DEBUG
@@ -130,8 +129,8 @@ def my_function(
 from collections import namedtuple
 from typing import Callable, Iterable, List, NamedTuple
 from functools import wraps
-from re import compile, VERBOSE
 from os import getenv
+import re
 
 # Imports - Third-Party
 import logbook
@@ -159,13 +158,13 @@ def my_function(
 
 # Constants
 # Match pattern for allowed first characters in a namedtuple attribute
-ATTRIBUTE_INPUT_START_CHARACTER = compile(
+ATTRIBUTE_INPUT_START_CHARACTER = re.compile(
     r'''
     ^          # Start at the beginning of the line
     [^a-zA-Z]  # Any non-alphabet character
     +          # One or more repetitions
     ''',
-    VERBOSE
+    re.VERBOSE
 )
 
 # Log entry
@@ -176,11 +175,11 @@ def my_function(
 )
 
 # Match pattern for allowed non-first characters in a namedtuple attribute
-ATTRIBUTE_INPUT_INVALID_CHARACTERS = compile(
+ATTRIBUTE_INPUT_INVALID_CHARACTERS = re.compile(
     r'''
     [^\w\s_-]    # Only allow alphabet letters, integers, _, -, and spaces
     ''',
-    VERBOSE
+    re.VERBOSE
 )
 
 # Log entry
@@ -191,11 +190,11 @@ def my_function(
 )
 
 # Match pattern to replace space characters in a namedtuple attribute
-ATTRIBUTE_INPUT_SPACE_CHARACTERS = compile(
+ATTRIBUTE_INPUT_SPACE_CHARACTERS = re.compile(
     r'''
     \s            # Any space character
     ''',
-    VERBOSE
+    re.VERBOSE
 )
 
 # Log entry

namedtuple_maker/namedtuple_utils.py

@@ -8,18 +8,18 @@
 # Imports - Python Standard Library
 from os import _exit
 from sys import exit, stderr
-from typing import AnyStr
 
 
 def graceful_exit(
-    error_message: AnyStr = None,
+    error_message: str = None,
     error_object: Exception = None
 ):
-    """ Gracefully exit a program after catching an exception.  Call the
-    graceful_exit function from within a higher-level except block.
-    Instead of using the raise keyword to display a stack trace and
-    exit, graceful_exit will display a friendly message, and exit the
-    program without displaying full trace stack details.
+    """ Gracefully exit a program after catching an exception.
+
+    Call the graceful_exit function from within a higher-level except
+    block. Instead of using the raise keyword to display a stack trace
+    and exit, graceful_exit will display a friendly message, and exit
+    the program without displaying full trace stack details.
 
     The graceful_exit function first attempts to use the sys.exit
     function to exit the application.  If sys.exit raises a
@@ -28,7 +28,7 @@ def graceful_exit(
     will use the os._exit function.
 
     Args:
-        error_message (AnyStr, optional):
+        error_message (str, optional):
             String error message to display.
 
         error_object (Exception):

tests/test_namedtuple_logger.py

@@ -30,9 +30,10 @@
 
 
 def test_initialize_logging_to_console(capfd) -> None:
-    """ Test initialize_logging function for console output.  Writes
-        mock log messages to the console and verifies the log messages
-        display correctly.
+    """ Test initialize_logging function for console output.
+
+        Writes mock log messages to the console and verifies the log
+        messages display correctly.
 
         Args:
             capfd (pytest fixture):
@@ -63,8 +64,10 @@ def test_initialize_logging_to_console(capfd) -> None:
 
 
 # def test_initialize_logging_invalid_log_file() -> None:
-#     """ Test initialize logging function's ability to handle an invalid
-#         log file path level.
+#     """ Test logging initialization.
+
+#         Test the initialize_logging function's ability to handle an
+#         invalid log file path level.
 
 #         Args:
 #             None.

tests/test_namedtuple_maker.py

@@ -52,8 +52,10 @@ def custom_namedtuple_function(
     iterable_input: Iterable,
     auto_attribute_names: bool
 ) -> Tuple:
-    """ Test function that accepts an iterable object as input,
-        and returns the iterable as a tuple object.
+    """ Test function that accepts an iterable object as input.
+
+        Testing function to collect an iterable object and return the
+        iterable as a tuple object.
 
         Args:
             iterable_input (Iterable):
@@ -110,11 +112,12 @@ def test_named_tuple_converter(
     iter_return,
     att_return
 ) -> None:
-    """ Test of the named_tuple_converter decorator function to
-        determine if the function accepts an iterable argument and
-        returns a namedtuple with the original iterable data values.
-        Collect the namedtuple field names from an iterable of names
-        passed an argument.
+    """ Test of the named_tuple_converter decorator function.
+
+        Determine if the decorator function accepts an iterable
+        argument and returns a namedtuple with the original iterable
+        data values.  Collect the namedtuple field names from an
+        iterable of names passed an argument.
 
         Args:
             iter_input (Iterable):
@@ -158,11 +161,12 @@ def test_named_tuple_converter(
     side_effect=TEST_DATA.keys()
 )
 def test_named_tuple_converter_input(side_effects) -> None:
-    """ Test of the named_tuple_converter decorator function to
-        determine if the function accepts an iterable argument and
-        returns a namedtuple with the original iterable data values.
-        Collect the namedtuple attribute names with the input()
-        function.
+    """ Test of the named_tuple_converter decorator function.
+
+        Determine if the decorator function accepts an iterable
+        argument and returns a namedtuple with the original iterable
+        data values.  Collect the namedtuple attribute names with the
+        input() function.
 
         Args:
             side_effects (unittest.mock.patch):
@@ -211,13 +215,13 @@ def test_named_tuple_converter_custom_function_auto_name_attributes(
     iter_return,
     att_return
 ) -> None:
-    """ Test of the named_tuple_converter decorator function using a
-        custom function to determine if the function accepts an
-        iterable argument and returns a namedtuple with the original
-        iterable data, and if the decorator function automatically
-        names the namedtuple attributes with the auto_attribute_names
-        parameter set to True. Collect the namedtuple field names from
-        an iterable of names passed an argument.
+    """ Test of the named_tuple_converter decorator function.
+
+        Determine if the decorator function accepts an iterable
+        argument and returns a namedtuple with the original iterable
+        data values.  Collect the namedtuple field names from an
+        iterable of names passed an argument.  Collect the namedtuple
+        field names from an iterable of names passed an argument.
 
         Args:
             iter_input (Iterable):
@@ -251,9 +255,10 @@ def test_named_tuple_converter_custom_function_auto_name_attributes(
 
 
 def test_named_tuple_converter_invalid_iterable_exception() -> None:
-    """ Test of the named_tuple_converter decorator function for
-        exception handling, when the iterable_input argument contains
-        a non-iterable object/value.
+    """ Test of the named_tuple_converter decorator function.
+
+        Tests exception handling, when the iterable_input argument
+        contains a non-iterable object/value.
 
         Args:
             None.