Addressing pycodestyle issues

Addressing styling issues in the learning_observer module

Author: bradley-erickson

learning_observer/docs/conf.py

@@ -10,9 +10,9 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-#import os
-#import sys
-#sys.path.insert(0, os.path.abspath('..'))
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('..'))
 
 
 # -- Project information -----------------------------------------------------

learning_observer/learning_observer/auth/__init__.py

@@ -75,34 +75,36 @@
 import learning_observer.prestartup
 import learning_observer.settings as settings
 
+
 @learning_observer.prestartup.register_startup_check
 def verify_auth_precheck():
-   '''
-   This is a pre-startup check to make sure that the auth system is configured
-   correctly.
-   '''
-   # We need some auth
-   if 'auth' not in settings.settings:
-      raise learning_observer.prestartup.StartupCheck("Please configure auth")
-
-   # If we have Google oauth, we need it properly configured.
-   # TODO: Confirm everything works with Google Oauth missing
-   if 'google_oauth' in settings.settings['auth']:
-      if 'web' not in settings.settings['auth']['google_oauth'] or \
-         'client_secret' not in settings.settings['auth']['google_oauth']['web'] or \
-         'project_id' not in settings.settings['auth']['google_oauth']['web'] or \
-         'client_id' not in settings.settings['auth']['google_oauth']['web'] or \
-         isinstance(settings.settings['auth']['google_oauth']['web']['client_secret'], dict) or \
-         isinstance(settings.settings['auth']['google_oauth']['web']['project_id'], dict) or \
-         isinstance(settings.settings['auth']['google_oauth']['web']['client_id'], dict):
-          error = \
-            "Please configure (or disable) Google oauth\n" + \
-            "\n" + \
-            "Go to:\n" + \
-            "  https://console.developers.google.com/ \n" + \
-            "And set up an OAuth client for a web application. Make sure that configuration\n" + \
-            "mirrors the one here.\n" + \
-            "\n" + \
-            "If you are not planning to use Google auth (which is the case for most dev\n" + \
-            "settings), please disable Google authentication in creds.yaml"
-          raise learning_observer.prestartup.StartupCheck(error)
+    '''
+    This is a pre-startup check to make sure that the auth system is configured
+    correctly.
+    '''
+    # We need some auth
+    if 'auth' not in settings.settings:
+        raise learning_observer.prestartup.StartupCheck(
+            "Please configure auth")
+
+    # If we have Google oauth, we need it properly configured.
+    # TODO: Confirm everything works with Google Oauth missing
+    if 'google_oauth' in settings.settings['auth']:
+        if 'web' not in settings.settings['auth']['google_oauth'] or \
+           'client_secret' not in settings.settings['auth']['google_oauth']['web'] or \
+           'project_id' not in settings.settings['auth']['google_oauth']['web'] or \
+           'client_id' not in settings.settings['auth']['google_oauth']['web'] or \
+           isinstance(settings.settings['auth']['google_oauth']['web']['client_secret'], dict) or \
+           isinstance(settings.settings['auth']['google_oauth']['web']['project_id'], dict) or \
+           isinstance(settings.settings['auth']['google_oauth']['web']['client_id'], dict):
+            error = \
+                "Please configure (or disable) Google oauth\n" + \
+                "\n" + \
+                "Go to:\n" + \
+                "  https://console.developers.google.com/ \n" + \
+                "And set up an OAuth client for a web application. Make sure that configuration\n" + \
+                "mirrors the one here.\n" + \
+                "\n" + \
+                "If you are not planning to use Google auth (which is the case for most dev\n" + \
+                "settings), please disable Google authentication in creds.yaml"
+            raise learning_observer.prestartup.StartupCheck(error)

learning_observer/learning_observer/auth/events.py

@@ -120,7 +120,7 @@ async def basic_auth(request, headers, first_event, source):
     '''
     Authenticate with HTTP Basic through nginx.
     '''
-    (username, password)  = learning_observer.auth.http_basic.http_basic_extract_username_password(request)
+    (username, password) = learning_observer.auth.http_basic.http_basic_extract_username_password(request)
     print(f"Authenticated as {username}")
     if username is None:
         # nginx shouldn't pass requests without

learning_observer/learning_observer/auth/handlers.py

@@ -121,12 +121,12 @@ def name_to_email(name):
         name = names.get_full_name()
 
     user_info = {
-            "name": name,
-            "picture": "/auth/default-avatar.svg",
-            "authorized": True,
-            "google_id": random.randint(10000, 99999),
-            "email": name_to_email(name)
-        }
+        "name": name,
+        "picture": "/auth/default-avatar.svg",
+        "authorized": True,
+        "google_id": random.randint(10000, 99999),
+        "email": name_to_email(name)
+    }
     await learning_observer.auth.utils.update_session_user_info(request, user_info)
     return user_info
 

learning_observer/learning_observer/auth/http_basic.py

@@ -172,20 +172,21 @@ async def password_auth_handler(request):
 def http_basic_startup_check():
     if http_auth_page_enabled() and http_auth_middleware_enabled():
         raise learning_observer.prestartup.StartupCheck(
-            "Your HTTP Basic authentication is misconfigured.\n" +
-            "\n" +
-            "You want EITHER auth on every page, OR a login page,\n" +
-            "not both. Having both setting may be a security risk.\n" +
-            "Please fix this."
+            "Your HTTP Basic authentication is misconfigured.\n"
+            + "\n"
+            + "You want EITHER auth on every page, OR a login page,\n"
+            + "not both. Having both setting may be a security risk.\n"
+            + "Please fix this."
         )
 
-    if ('http_basic' in learning_observer.settings.settings['auth']
+    if (
+        'http_basic' in learning_observer.settings.settings['auth']
         and learning_observer.settings.settings['auth']['http_basic'].get("delegate_nginx_auth", False)
         and learning_observer.settings.settings['auth']['http_basic'].get("password_file", False)
-        ):
+    ):
         raise learning_observer.prestartup.StartupCheck(
-            "Your HTTP Basic authentication is misconfigured.\n" +
-            "\n" +
-            "You should EITHER rely on nginx for password authentication OR Learning Observer," +
-            "not both."
+            "Your HTTP Basic authentication is misconfigured.\n"
+            + "\n"
+            + "You should EITHER rely on nginx for password authentication OR Learning Observer,"
+            + "not both."
         )

learning_observer/learning_observer/auth/password.py

@@ -62,7 +62,7 @@ async def password_auth_handler(request):
                 data['password'].encode('utf-8'),
                 user_data['password'].encode('utf-8')
             )
-        except:
+        except:  # noqa: E722 TODO figure out which errors to catch
             debug_log("Error verifying password hash")
             debug_log("Hint: Try reinstalling / upgrading bcrypt")
             debug_log("For some reason, bcrypt tends to sometimes install incorrectly")

learning_observer/learning_observer/auth/social_sso.py

@@ -59,7 +59,6 @@
 ]
 
 
-
 async def social_handler(request):
     """Handles Google sign in.
 

learning_observer/learning_observer/google.py

@@ -231,7 +231,7 @@ async def cleaner_handler(request):
             else:
                 raise AttributeError(f"Invalid response type: {type(response)}")
         if name is not None:
-            setattr(cleaner_handler, "__qualname__", name+"_handler")
+            setattr(cleaner_handler, "__qualname__", name + "_handler")
 
         return cleaner_handler
 
@@ -365,7 +365,7 @@ def _force_text_length(text, length):
     >>> force_text_length("Hello", 13)
     >>> 'Hello        '
     '''
-    return text[:length] + " " * (length-len(text))
+    return text[:length] + " " * (length - len(text))
 
 
 @register_cleaner("document", "doctext")
@@ -394,7 +394,7 @@ def extract_text_from_google_doc_json(
     flat = sum(elements, [])
     text_chunks = [f['textRun']['content'] for f in flat]
     if align:
-        lengths = [f['endIndex']-f['startIndex'] for f in flat]
+        lengths = [f['endIndex'] - f['startIndex'] for f in flat]
         text_chunks = [_force_text_length(chunk, length) for chunk, length in zip(text_chunks, lengths)]
     text = ''.join(text_chunks)
 

learning_observer/learning_observer/kvs.py

@@ -231,7 +231,7 @@ def key_to_safe_filename(self, key):
         if self.subdirs:
             paths = key.split('/')
             # Add underscores to directories so they don't conflict with files
-            for i in range(len(paths)-1):
+            for i in range(len(paths) - 1):
                 paths[i] = '_' + paths[i]
             safename = (os.sep).join(map(learning_observer.util.to_safe_filename, paths))
         else:

learning_observer/learning_observer/offline.py

@@ -303,22 +303,28 @@ async def test_case():
 class StubApp():
     def __init__(self):
         self.loop = asyncio.get_event_loop()
+
     def add_routes(self, *args, **kwargs):
         pass
 
 
 app = StubApp()
 
+
 class StubRequest():
+
     def __init__(self):
         self.app = app
+
     def __contains__(self, item):
         if item == 'auth_headers':
             return True
         return False
+
     def __getitem__(self, item):
         return {}
 
+
 request = StubRequest()