Initial docstrings and ruff formatting

Author: Will-Hellinger

.gitignore

@@ -106,6 +106,9 @@ ENV/
 # vscode
 .vscode
 
+# SonarQube
+.scannerwork
+
 # Configurations
 config.py
 
@@ -132,4 +135,4 @@ packet/static/site.webmanifest
 faviconData.json
 
 # csvs
-*.csv
+*.csv

packet/__init__.py

@@ -2,11 +2,9 @@
 The application setup and initialization code lives here
 """
 
-import json
 import logging
 import os
 
-import csh_ldap
 import onesignal
 from flask import Flask
 from flask_gzip import Gzip
@@ -26,76 +24,84 @@
 
 # Load default configuration and any environment variable overrides
 _root_dir = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
-app.config.from_pyfile(os.path.join(_root_dir, 'config.env.py'))
+app.config.from_pyfile(os.path.join(_root_dir, "config.env.py"))
 
 # Load file based configuration overrides if present
-_pyfile_config = os.path.join(_root_dir, 'config.py')
+_pyfile_config = os.path.join(_root_dir, "config.py")
 if os.path.exists(_pyfile_config):
     app.config.from_pyfile(_pyfile_config)
 
 # Fetch the version number
-app.config['VERSION'] = get_version()
+app.config["VERSION"] = get_version()
 
 # Logger configuration
-logging.getLogger().setLevel(app.config['LOG_LEVEL'])
-app.logger.info('Launching packet ' + app.config['VERSION'])
-app.logger.info('Using the {} realm'.format(app.config['REALM']))
+logging.getLogger().setLevel(app.config["LOG_LEVEL"])
+app.logger.info("Launching packet " + app.config["VERSION"])
+app.logger.info("Using the {} realm".format(app.config["REALM"]))
 
 # Initialize the extensions
 db = SQLAlchemy(app)
 migrate = Migrate(app, db)
-app.logger.info('SQLAlchemy pointed at ' + repr(db.engine.url))
+app.logger.info("SQLAlchemy pointed at " + repr(db.engine.url))
 
-APP_CONFIG = ProviderConfiguration(issuer=app.config['OIDC_ISSUER'],
-                          client_metadata=ClientMetadata(app.config['OIDC_CLIENT_ID'],
-                                                            app.config['OIDC_CLIENT_SECRET']))
+APP_CONFIG = ProviderConfiguration(
+    issuer=app.config["OIDC_ISSUER"],
+    client_metadata=ClientMetadata(
+        app.config["OIDC_CLIENT_ID"], app.config["OIDC_CLIENT_SECRET"]
+    ),
+)
 
 # Initialize Onesignal Notification apps
 csh_onesignal_client = None
-if app.config['ONESIGNAL_USER_AUTH_KEY'] and \
-   app.config['ONESIGNAL_CSH_APP_AUTH_KEY'] and \
-   app.config['ONESIGNAL_CSH_APP_ID']:
+if (
+    app.config["ONESIGNAL_USER_AUTH_KEY"]
+    and app.config["ONESIGNAL_CSH_APP_AUTH_KEY"]
+    and app.config["ONESIGNAL_CSH_APP_ID"]
+):
     csh_onesignal_client = onesignal.Client(
-        user_auth_key=app.config['ONESIGNAL_USER_AUTH_KEY'],
-        app_auth_key=app.config['ONESIGNAL_CSH_APP_AUTH_KEY'],
-        app_id=app.config['ONESIGNAL_CSH_APP_ID']
+        user_auth_key=app.config["ONESIGNAL_USER_AUTH_KEY"],
+        app_auth_key=app.config["ONESIGNAL_CSH_APP_AUTH_KEY"],
+        app_id=app.config["ONESIGNAL_CSH_APP_ID"],
     )
-    app.logger.info('CSH Onesignal configured and notifications enabled')
+    app.logger.info("CSH Onesignal configured and notifications enabled")
 
 intro_onesignal_client = None
-if app.config['ONESIGNAL_USER_AUTH_KEY'] and \
-   app.config['ONESIGNAL_INTRO_APP_AUTH_KEY'] and \
-   app.config['ONESIGNAL_INTRO_APP_ID']:
+if (
+    app.config["ONESIGNAL_USER_AUTH_KEY"]
+    and app.config["ONESIGNAL_INTRO_APP_AUTH_KEY"]
+    and app.config["ONESIGNAL_INTRO_APP_ID"]
+):
     intro_onesignal_client = onesignal.Client(
-        user_auth_key=app.config['ONESIGNAL_USER_AUTH_KEY'],
-        app_auth_key=app.config['ONESIGNAL_INTRO_APP_AUTH_KEY'],
-        app_id=app.config['ONESIGNAL_INTRO_APP_ID']
+        user_auth_key=app.config["ONESIGNAL_USER_AUTH_KEY"],
+        app_auth_key=app.config["ONESIGNAL_INTRO_APP_AUTH_KEY"],
+        app_id=app.config["ONESIGNAL_INTRO_APP_ID"],
     )
-    app.logger.info('Intro Onesignal configured and notifications enabled')
+    app.logger.info("Intro Onesignal configured and notifications enabled")
 
 # OIDC Auth
-auth = OIDCAuthentication({'app': APP_CONFIG}, app)
-app.logger.info('OIDCAuth configured')
+auth = OIDCAuthentication({"app": APP_CONFIG}, app)
+app.logger.info("OIDCAuth configured")
 
 # Sentry
 # pylint: disable=abstract-class-instantiated
 sentry_sdk.init(
-    dsn=app.config['SENTRY_DSN'],
-    integrations=[FlaskIntegration(), SqlalchemyIntegration()]
+    dsn=app.config["SENTRY_DSN"],
+    integrations=[FlaskIntegration(), SqlalchemyIntegration()],
 )
 
-
-# pylint: disable=wrong-import-position
-from .ldap import ldap
-from . import models
-from . import context_processors
-from . import commands
-from .routes import api, shared
-
-if app.config['REALM'] == 'csh':
-    from .routes import upperclassmen
-    from .routes import admin
+__all__: list = [
+    "ldap",
+    "models",
+    "context_processors",
+    "commands",
+    "api",
+    "shared",
+]
+
+if app.config["REALM"] == "csh":
+    from .routes import upperclassmen as upperclassmen
+    from .routes import admin as admin
 else:
-    from .routes import freshmen
+    from .routes import freshmen as freshmen
 
-app.logger.info('Routes registered')
+app.logger.info("Routes registered")