Refactor for coding best practices

Author: timothyhull

namedtuple_maker/namedtuple_logger.py

@@ -32,7 +32,7 @@
 import logbook
 
 # Imports - Local
-from graceful_exit import graceful_exit
+from namedtuple_maker.namedtuple_utils import graceful_exit
 
 # Constants
 LOG_FILE_PATH = path.curdir
@@ -139,9 +139,9 @@ def initialize_logging(
             )
 
         # Display error and gracefully exit
-        except FileNotFoundError as e:
+        except FileNotFoundError as error:
             graceful_exit(
-                error_object=e,
+                error_object=error,
             )
 
     else:

namedtuple_maker/namedtuple_maker.py

@@ -31,24 +31,28 @@ def your_function() -> Iterable:
 
     Logging Target:
         The application automatically creates a log file in the current
-        working directory, and writes log message to that file. To write log
-        messages to the console (STDOUT), set the LOG_TO_CONSOLE environment
-        variable to 'True'.
+        working directory, and writes log message to that file. To
+        write log messages to the console (STDOUT), set the
+        LOG_TO_CONSOLE environment variable to 'True'.
 
         Example logging target usage:
             export LOG_TO_CONSOLE=True
 '''
 
-# Imports
+# Imports - Python Standard Library
 from collections import namedtuple
 from typing import Callable, Iterable, List, NamedTuple
 from functools import wraps
-from namedtuple_maker.namedtuple_logger import initialize_logging
 from re import compile, VERBOSE
-from os import _exit, getenv
-from sys import exit, stderr
+from os import getenv
+
+# Imports - Third-Party
 import logbook
 
+# Imports - Local
+from namedtuple_maker.namedtuple_logger import initialize_logging
+from namedtuple_maker.namedtuple_utils import graceful_exit
+
 # Check for LOG_LEVEL environment variable
 log_level = getenv('LOG_LEVEL')
 
@@ -260,16 +264,17 @@ def convert_to_namedtuple(*args, **kwargs) -> namedtuple:
 
                     attribute_names (Iterable[str]):
                         Optional kwarg, any iterable object class
-                        including, list, tuple, dict_keys, dict_values, etc.
-                        with str values.
+                        including, list, tuple, dict_keys, dict_values,
+                        etc. with str values.
 
                     auto_attribute_names (bool):
                         Optional kwarg, automatically name attributes
-                        without user input or use of the attribute_names
-                        parameter. Default: False
+                        without user input or use of the
+                        attribute_names parameter. Default: False
 
             Returns: named_tuple (namedtuple):
-                Class NamedTuple instantiated from collections.namedtuple
+                Class NamedTuple instantiated from
+                collections.namedtuple
         '''
 
         # Log entry
@@ -587,8 +592,8 @@ def make_named_tuple(
                 Any iterable object to convert to a namedtuple.
 
             attribute_names (Iterable[str]):
-                Any iterable object of strings to supply field names for
-                a namedtuple.
+                Any iterable object of strings to supply field names
+                for a namedtuple.
 
             auto_attribute_names (bool):
                     Optional kwarg, automatically name attributes
@@ -640,7 +645,7 @@ def make_named_tuple(
             f'\t{iterable_input}'
         )
 
-    except TypeError as e:
+    except TypeError as error:
 
         # Set error message value
         error_message = (
@@ -655,22 +660,13 @@ def make_named_tuple(
             f'\t"iterable_input" value: {iterable_input}'
             f'\t"iterable_input" type: {type(iterable_input)}'
         )
-        application_log.exception(e)
-
-        # Write error message to STDERR
-        print(f'\n{error_message}')
-        print(f'{e!r}\n', file=stderr)
+        application_log.exception(error)
 
-        # Graceful exit with status code
-        try:
-
-            # Standard sys.exit
-            exit(1)
-
-        except SystemExit:
-
-            # Exit from an interactive REPL shell with os._exit
-            _exit(1)
+        # Display the error message and gracefully exit
+        graceful_exit(
+            error_message=error_message,
+            error_object=error
+        )
 
     # Log Entry
     # Log return of make_named_tuple function to named_tuple_converter
@@ -696,8 +692,9 @@ def run_make_named_tuple() -> NamedTuple:
 
         Returns:
             named_tuple (NamedTuple):
-                NamedTuple class object resulting from the make_named_tuple
-                function decorated by the named_tuple_converter function.
+                NamedTuple class object resulting from the
+                make_named_tuple function decorated by the
+                named_tuple_converter function.
     '''
 
     # Log Entry

tests/test_namedtuple_logger.py

@@ -13,11 +13,13 @@
 
 '''
 
-# Imports
-from namedtuple_maker.namedtuple_logger import initialize_logging
+# Imports - Third-Party
 from logbook import Logger
 # from pytest import raises
 
+# Imports - Local
+from namedtuple_maker.namedtuple_logger import initialize_logging
+
 # Constants
 LOG_FILE_INVALID = './bad_log_test_dir/log_file.log'
 LOG_INFO_MESSAGE = 'This is a log entry.'
@@ -27,9 +29,9 @@
 
 
 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):
@@ -56,6 +58,8 @@ def test_initialize_logging_to_console(capfd) -> None:
     log_output = capfd.readouterr().out
     assert LOG_INFO_MESSAGE in log_output
 
+    return None
+
 
 # def test_initialize_logging_invalid_log_file() -> None:
 #     ''' Test initialize logging function's ability to handle an invalid
@@ -72,3 +76,4 @@ def test_initialize_logging_to_console(capfd) -> None:
 #         initialize_logging(
 #             log_file=LOG_FILE_INVALID
 #         )
+#     return None

tests/test_namedtuple_maker.py

@@ -5,14 +5,18 @@
         pytest tests/test_namedtuple_maker.py
 '''
 
-# Imports
-from namedtuple_maker.namedtuple_maker import named_tuple_converter, \
-                                              make_named_tuple, TEST_DATA
+# Imports - Python Standard Library
 from collections import namedtuple
-from pytest import mark, raises
 from typing import Iterable, Tuple
 from unittest.mock import patch
 
+# Imports - Third-Party
+from pytest import mark, raises
+
+# Imports - Local
+from namedtuple_maker.namedtuple_maker import named_tuple_converter, \
+                                              make_named_tuple, TEST_DATA
+
 # Constants
 # Create a namedtuple object for synthetic testing
 TEST_PERSON_INFO = namedtuple(
@@ -106,20 +110,23 @@ 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 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.
 
         Args:
             iter_input (Iterable):
-                Iterable input to be converted to namedtuple attribute values.
+                Iterable input to be converted to namedtuple attribute
+                values.
 
             att_names (Iterable):
                 Iterable input of namedtuple attribute names.
 
             iter_return (Iterable):
-                Iterable output of expected namedtuple attribute values.
+                Iterable output of expected namedtuple attribute
+                values.
 
             att_return (Iterable):
                 Iterable output of expected namedtuple attribute names.
@@ -151,14 +158,16 @@ 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 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.
 
         Args:
             side_effects (unittest.mock.patch):
-                namedtuple attribute name mock data for the input() function.
+                namedtuple attribute name mock data for the input()
+                function.
 
         Returns:
             None.
@@ -202,16 +211,18 @@ 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 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.
 
         Args:
             iter_input (Iterable):
-                Iterable input to be converted to namedtuple attribute values.
+                Iterable input to be converted to namedtuple attribute
+                values.
 
             att_names (Iterable):
                 Iterable input of namedtuple attribute names.
@@ -240,9 +251,9 @@ 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 for
+        exception handling, when the iterable_input argument contains
+        a non-iterable object/value.
 
         Args:
             None.