Merge pull request #17 from IloBe/16-correction-of-linter-messages

Style: Correct linter messages #16

Author: IloBe

sanitycheck.py

@@ -1,20 +1,21 @@
 #!/usr/bin/env -S python3 -i
 
-from os import path
-
 import argparse
 import importlib
 import inspect
-import os
 import sys
+import os
+from os import path
 
 FAIL_COLOR = '\033[91m'
 OK_COLOR = '\033[92m'
 WARN_COLOR = '\033[93m'
 
+
 def run_sanity_check(test_dir):
+    ''' Udacity file to check students test cases '''
 
-    #assert path.isdir(test_dir), FAIL_COLOR+f"No direcotry named {test_dir} found in {os.getcwd()}"
+    assert path.isdir(test_dir), FAIL_COLOR+f"No directory named {test_dir} found in {os.getcwd()}"
     print('This script will perform a sanity test to ensure your code meets the criteria in the rubric.\n')
     print('Please enter the path to the file that contains your test cases for the GET() and POST() methods')
     print('The path should be something like abc/def/test_xyz.py')
@@ -26,98 +27,93 @@ def run_sanity_check(test_dir):
     module_name = path.splitext(path.basename(filepath))[0]
     module = importlib.import_module(module_name)
 
-
-    test_function_names = list(filter(lambda x: inspect.isfunction(getattr(module,x)) and not x.startswith('__'), dir(module)))
-
-    test_functions_for_get = list(filter(lambda x: inspect.getsource(getattr(module,x)).find('.get(') != -1 , test_function_names))
-    test_functions_for_post = list(filter(lambda x: inspect.getsource(getattr(module,x)).find('.post(') != -1, test_function_names))
-    
+    test_function_names = list(filter(
+        lambda x: inspect.isfunction(getattr(module, x)) and not x.startswith('__'), dir(module)))
+    test_functions_for_get = list(filter(
+        lambda x: inspect.getsource(getattr(module, x)).find('.get(') != -1, test_function_names))
+    test_functions_for_post = list(filter(
+        lambda x: inspect.getsource(getattr(module, x)).find('.post(') != -1, test_function_names))
 
     print("\n============= Sanity Check Report ===========")
     SANITY_TEST_PASSING = True
     WARNING_COUNT = 1
 
-    ## GET()
+    # GET()
     TEST_FOR_GET_METHOD_RESPONSE_CODE = False
     TEST_FOR_GET_METHOD_RESPONSE_BODY = False
     if not test_functions_for_get:
-        print(FAIL_COLOR+f"[{WARNING_COUNT}]")
+        print(FAIL_COLOR + f"[{WARNING_COUNT}]")
         WARNING_COUNT += 1
-        print(FAIL_COLOR+"No test cases were detected for the GET() method.")
-        print(FAIL_COLOR+"\nPlease make sure you have a test case for the GET method.\
+        print(FAIL_COLOR + "No test cases were detected for the GET() method.")
+        print(FAIL_COLOR + "\nPlease make sure you have a test case for the GET method.\
             This MUST test both the status code as well as the contents of the request object.\n")
         SANITY_TEST_PASSING = False
-
     else:
         for func in test_functions_for_get:
-            source = inspect.getsource(getattr(module,func))
+            source = inspect.getsource(getattr(module, func))
             if source.find('.status_code') != -1:
                 TEST_FOR_GET_METHOD_RESPONSE_CODE = True
             if (source.find('.json') != -1) or (source.find('json.loads') != -1):
-                TEST_FOR_GET_METHOD_RESPONSE_BODY =  True
-
+                TEST_FOR_GET_METHOD_RESPONSE_BODY = True
 
         if not TEST_FOR_GET_METHOD_RESPONSE_CODE:
-            print(FAIL_COLOR+f"[{WARNING_COUNT}]")
+            print(FAIL_COLOR + f"[{WARNING_COUNT}]")
             WARNING_COUNT += 1
-            print(FAIL_COLOR+\
+            print(FAIL_COLOR +
                   "Your test case for GET() does not seem to be testing the response code.\n")
-        
+
         if not TEST_FOR_GET_METHOD_RESPONSE_BODY:
-            print(FAIL_COLOR+f"[{WARNING_COUNT}]")
+            print(FAIL_COLOR + f"[{WARNING_COUNT}]")
             WARNING_COUNT += 1
-            print(FAIL_COLOR+\
+            print(FAIL_COLOR +
                   "Your test case for GET() does not seem to be testing the CONTENTS of the response.\n")
 
-
-
-    ## POST() 
+    # POST()
     TEST_FOR_POST_METHOD_RESPONSE_CODE = False
     TEST_FOR_POST_METHOD_RESPONSE_BODY = False
     COUNT_POST_METHOD_TEST_FOR_INFERENCE_RESULT = 0
 
     if not test_functions_for_post:
-        print(FAIL_COLOR+f"[{WARNING_COUNT}]")
+        print(FAIL_COLOR + f"[{WARNING_COUNT}]")
         WARNING_COUNT += 1
-        print(FAIL_COLOR+"No test cases were detected for the POST() method.")
-        print(FAIL_COLOR+"Please make sure you have TWO test cases for the POST() method."+
-        "\nOne test case for EACH of the possible inferences (results/outputs) of the ML model.\n")
+        print(FAIL_COLOR + "No test cases were detected for the POST() method.")
+        print(FAIL_COLOR + "Please make sure you have TWO test cases for the POST() method." +
+              "\nOne test case for EACH of the possible inferences (results/outputs) of the ML model.\n")
         SANITY_TEST_PASSING = False
     else:
         if len(test_functions_for_post) == 1:
             print(f"[{WARNING_COUNT}]")
             WARNING_COUNT += 1
-            print(FAIL_COLOR+"Only one test case was detected for the POST() method.")
-            print(FAIL_COLOR+"Please make sure you have two test cases for the POST() method."+
-            "\nOne test case for EACH of the possible inferences (results/outputs) of the ML model.\n")
+            print(FAIL_COLOR + "Only one test case was detected for the POST() method.")
+            print(FAIL_COLOR + "Please make sure you have two test cases for the POST() method." +
+                  "\nOne test case for EACH of the possible inferences (results/outputs) of the ML model.\n")
             SANITY_TEST_PASSING = False
 
         for func in test_functions_for_post:
-            source = inspect.getsource(getattr(module,func))
+            source = inspect.getsource(getattr(module, func))
             if source.find('.status_code') != -1:
                 TEST_FOR_POST_METHOD_RESPONSE_CODE = True
             if (source.find('.json') != -1) or (source.find('json.loads') != -1):
-                TEST_FOR_POST_METHOD_RESPONSE_BODY =  True
+                TEST_FOR_POST_METHOD_RESPONSE_BODY = True
                 COUNT_POST_METHOD_TEST_FOR_INFERENCE_RESULT += 1
 
         if not TEST_FOR_POST_METHOD_RESPONSE_CODE:
-            print(FAIL_COLOR+f"[{WARNING_COUNT}]")
+            print(FAIL_COLOR + f"[{WARNING_COUNT}]")
             WARNING_COUNT += 1
-            print(FAIL_COLOR+\
+            print(FAIL_COLOR +
                   "One or more of your test cases for POST() do not seem to be testing the response code.\n")
+
         if not TEST_FOR_POST_METHOD_RESPONSE_BODY:
-            print(FAIL_COLOR+f"[{WARNING_COUNT}]")
+            print(FAIL_COLOR + f"[{WARNING_COUNT}]")
             WARNING_COUNT += 1
-            print(FAIL_COLOR+\
+            print(FAIL_COLOR +
                   "One or more of your test cases for POST() do not seem to be testing the contents of the response.\n")
 
         if len(test_functions_for_post) >= 2 and COUNT_POST_METHOD_TEST_FOR_INFERENCE_RESULT < 2:
-            print(FAIL_COLOR+f"[{WARNING_COUNT}]")
+            print(FAIL_COLOR + f"[{WARNING_COUNT}]")
             WARNING_COUNT += 1
-            print(FAIL_COLOR+\
-                  "You do not seem to have TWO separate test cases, one for each possible prediction that your model can make.")
-
-
+            print(FAIL_COLOR + "You do not seem to have TWO separate test cases, "
+                  "one for each possible prediction that your model can make.")
 
     SANITY_TEST_PASSING = SANITY_TEST_PASSING and\
         TEST_FOR_GET_METHOD_RESPONSE_CODE and \
@@ -127,11 +123,10 @@ def run_sanity_check(test_dir):
         COUNT_POST_METHOD_TEST_FOR_INFERENCE_RESULT >= 2
 
     if SANITY_TEST_PASSING:
-        print(OK_COLOR+"Your test cases look good!")
-    
-    print(WARN_COLOR+"This is a heuristic based sanity testing and cannot guarantee the correctness of your code.")
-    print(WARN_COLOR+"You should still check your work against the rubric to ensure you meet the criteria.")
+        print(OK_COLOR + "Your test cases look good!")
 
+    print(WARN_COLOR + "This is a heuristic based sanity testing and cannot guarantee the correctness of your code.")
+    print(WARN_COLOR + "You should still check your work against the rubric to ensure you meet the criteria.")
 
 
 if __name__ == "__main__":
@@ -143,4 +138,3 @@ def run_sanity_check(test_dir):
                         help='Name of the directory that has test files.')
     args = parser.parse_args()
     run_sanity_check(args.test_dir)
-

src/__init__.py

@@ -1,30 +1,27 @@
-# a user can manipulate configuration from project libraries like any other Python object
-
-print(f'Invoking __init__.py for {__name__}')
-
+import logging
+from logging import Formatter, NullHandler
+from colorama import Fore, Style
 from pkgutil import extend_path
 __path__ = extend_path(__path__, __name__)
+print(f'Invoking __init__.py for {__name__}')
 print(f'src package: __path__ : {__path__}')
 
-from src import app, config, training
-
-import logging
-from logging import Formatter, NullHandler
-import colorama
-from colorama import Back, Fore, Style
 
 COLORS = {"DEBUG": Fore.BLUE,
           "INFO": Fore.BLACK,
           "WARNING": Fore.YELLOW,
           "ERROR": Fore.RED,
           "CRITICAL": Fore.MAGENTA}
 
+
 class CustomColoredFormatter(Formatter):
     def __init__(self, *, format, use_color):
+        ''' Initialise customized formatter class '''
         Formatter.__init__(self, fmt=format)
         self.use_color = use_color
 
     def format(self, record):
+        ''' Sets message colour according log level '''
         msg = super().format(record)
         if self.use_color:
             levelname = record.levelname
@@ -34,9 +31,9 @@ def format(self, record):
                 return f"{COLORS[levelname]}{msg}{Style.RESET_ALL}"
         return msg
 
+
 logging.getLogger(__name__).addHandler(NullHandler())
 
 __version__ = '0.1.0'
 __author__ = 'Ilona Brinkmeier'
 __license__ = 'MIT'
-

src/app/__init__.py

@@ -2,21 +2,23 @@
 
 import logging
 from logging import Formatter, NullHandler
-import colorama
-from colorama import Back, Fore, Style
+from colorama import Fore, Style
 
 COLORS = {"DEBUG": Fore.BLUE,
           "INFO": Fore.BLACK,
           "WARNING": Fore.YELLOW,
           "ERROR": Fore.RED,
           "CRITICAL": Fore.MAGENTA}
 
+
 class CustomColoredFormatter(Formatter):
     def __init__(self, *, format, use_color):
+        ''' Initialise customized formatter class '''
         Formatter.__init__(self, fmt=format)
         self.use_color = use_color
 
     def format(self, record):
+        ''' Sets message colour according log level '''
         msg = super().format(record)
         if self.use_color:
             levelname = record.levelname
@@ -26,5 +28,5 @@ def format(self, record):
                 return f"{COLORS[levelname]}{msg}{Style.RESET_ALL}"
         return msg
 
-    
+
 logging.getLogger(__name__).addHandler(NullHandler())

src/config/__init__.py

@@ -1,25 +1,27 @@
 # a user can manipulate configuration from project libraries like any other Python object
-print(f'Invoking __init__.py for {__name__}')
-
-from src.config.config import get_config, get_data_path, get_models_path, get_project_root_path
 
 import logging
 from logging import Formatter, NullHandler
-import colorama
-from colorama import Back, Fore, Style
+from colorama import Fore, Style
+
+
+print(f'Invoking __init__.py for {__name__}')
 
 COLORS = {"DEBUG": Fore.BLUE,
           "INFO": Fore.BLACK,
           "WARNING": Fore.YELLOW,
           "ERROR": Fore.RED,
           "CRITICAL": Fore.MAGENTA}
 
+
 class CustomColoredFormatter(Formatter):
     def __init__(self, *, format, use_color):
+        ''' Initialise customized formatter class '''
         Formatter.__init__(self, fmt=format)
         self.use_color = use_color
 
     def format(self, record):
+        ''' Sets message colour according log level '''
         msg = super().format(record)
         if self.use_color:
             levelname = record.levelname
@@ -29,5 +31,6 @@ def format(self, record):
                 return f"{COLORS[levelname]}{msg}{Style.RESET_ALL}"
         return msg
 
+
 logging.getLogger(__name__).addHandler(NullHandler())
-config_dict={}
+config_dict = {}

src/config/config.py

@@ -9,7 +9,6 @@
 ###################
 # Imports
 ###################
-import numpy as np
 import logging
 import yaml
 import os
@@ -23,6 +22,7 @@
 # info see: https://realpython.com/python-logging-source-code/
 logger = logging.getLogger(__name__)
 
+
 def get_project_root_path():
     '''  Returns the absolute path to projects root. '''
     return os.getcwd()
@@ -41,13 +41,13 @@ def create_config():
                 logger.info('Configuration yml file content is:\n %s', config_dict)
                 return config_dict
             except yaml.YAMLError:
-                logger.exception(f"Exit: Error parsing config.yml in config.__init__.py.")
+                logger.exception("Exit: Error parsing config.yml in config.__init__.py.")
                 sys.exit(1)
     else:
         logger.exception("Exit: Configuration file does not exist on path: %s", CONFIG_FILE)
         sys.exit(1)
 
-        
+
 def get_config():
     ''' Returns dictionary about project configuration. '''
     # future toDo: create config class with _init_ to have config file once
@@ -64,7 +64,7 @@ def get_data_path():
     logger.info("config data_path: %s", data_path)
     return data_path
 
-                
+
 def get_models_path():
     ''' Returns the models directory path. '''
     ROOT = get_project_root_path()

src/eda/__init__.py

@@ -2,21 +2,23 @@
 
 import logging
 from logging import Formatter, NullHandler
-import colorama
-from colorama import Back, Fore, Style
+from colorama import Fore, Style
 
 COLORS = {"DEBUG": Fore.BLUE,
           "INFO": Fore.BLACK,
           "WARNING": Fore.YELLOW,
           "ERROR": Fore.RED,
           "CRITICAL": Fore.MAGENTA}
 
+
 class CustomColoredFormatter(Formatter):
     def __init__(self, *, format, use_color):
+        ''' Initialise customized formatter class '''
         Formatter.__init__(self, fmt=format)
         self.use_color = use_color
 
     def format(self, record):
+        ''' Sets message colour according log level '''
         msg = super().format(record)
         if self.use_color:
             levelname = record.levelname
@@ -26,5 +28,5 @@ def format(self, record):
                 return f"{COLORS[levelname]}{msg}{Style.RESET_ALL}"
         return msg
 
-    
-logging.getLogger(__name__).addHandler(NullHandler())
+
+logging.getLogger(__name__).addHandler(NullHandler())

src/main.py

@@ -10,8 +10,6 @@
 # Imports
 ###################
 
-import os
-import numpy as np
 import logging
 import uvicorn
 
@@ -31,4 +29,4 @@
 
 
 if __name__ == "__main__":
-    uvicorn.run("main:app", host="0.0.0.0", port=8000, reload=True)
+    uvicorn.run("main:app", host="0.0.0.0", port=8000, reload=True)