30881 - AUTH-API to use Ruff (bcgov#3527)

Author: seeker25

auth-api/__init__.py

@@ -0,0 +1 @@
+"""Root package for the auth-api application."""

auth-api/gunicorn_config.py

@@ -11,13 +11,13 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-"""The configuration for gunicorn, which picks up the
-   runtime options from environment variables.
+"""The configuration for gunicorn, which picks up the runtime options from environment variables.
 
-   The best practice so far is For environments with multiple CPU cores, increase the number of workers to be equal to
-   the cores available. Timeout is set to 0 to disable the timeouts of the workers to allow Cloud Run to handle instance
-   scaling. Adjust the number of workers and threads on a per-application basis.
+The best practice so far is For environments with multiple CPU cores, increase the number of workers to be equal to
+the cores available. Timeout is set to 0 to disable the timeouts of the workers to allow Cloud Run to handle instance
+scaling. Adjust the number of workers and threads on a per-application basis.
 """
+
 import os
 
 workers = int(os.environ.get("GUNICORN_PROCESSES", "1"))  # pylint: disable=invalid-name

auth-api/lint

@@ -1 +1 @@
-poetry run isort . && poetry run black . && poetry run pylint . && poetry run flake8 .
+poetry run ruff format . && poetry run ruff check --fix .

auth-api/poetry.lock

@@ -62,89 +62,121 @@ pytest-asyncio = "^0.23.8"
 lovely-pytest-docker = "^0.3.1"
 
 [tool.poetry.group.dev.dependencies]
-black = "^24.8.0"
-pylint = "^3.2.6"
 bandit = "^1.7.9"
-flake8-pyproject = "^1.2.3"
-isort = "^5.13.2"
+ruff = "^0.14.1"
 
 [tool.bandit]
 exclude_dirs = [".venv","tests"]
 skips = ["B104"]
 
-[tool.flake8]
-ignore = ["F401","E402", "Q000", "E203", "W503"]
+[tool.ruff]
+# Exclude a variety of commonly ignored directories.
 exclude = [
-    ".venv",
-    "./venv",
+    ".bzr",
+    ".direnv",
+    ".eggs",
     ".git",
-    ".history",
+    ".git-rewrite",
+    ".hg",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "venv",
+    "migrations",
     "devops",
-    "*migrations*",
+    ".history",
 ]
-per-file-ignores = [
-    "__init__.py:F401",
-    "*.py:B902"
+
+# Same as Black.
+line-length = 120
+indent-width = 4
+
+# Assume Python 3.12
+target-version = "py312"
+
+[tool.ruff.lint]
+# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`) codes by default.
+select = [
+    "E4",      # pycodestyle errors
+    "E7",      # pycodestyle errors  
+    "E9",      # pycodestyle errors
+    "F",       # pyflakes
+    "W",       # pycodestyle warnings
+    "B",       # flake8-bugbear
+    "C4",      # flake8-comprehensions
+    "UP",      # pyupgrade
+    "ARG",     # unused-function-argument
+    "D",       # pydocstyle
+    "I",       # isort
+    "N",       # pep8-naming
+    "Q",       # flake8-quotes
+    "S",       # flake8-bandit
+    "T",       # flake8-type-checking
+    "TCH",     # flake8-type-checking
+    "TID",     # flake8-tidy-imports
 ]
-max-line-length = 120
-docstring-min-length=10
-count = true
 
-[tool.zimports]
-black-line-length = 120
-keep-unused-type-checking = true
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
 
-[tool.black]
-target-version =  ["py310", "py311", "py312"]
-line-length = 120
-include = '\.pyi?$'
-extend-exclude = '''
-/(
-  # The following are specific to Black, you probably don't want those.
-  migrations
-  | devops
-  | .history
-)/
-'''
-
-[tool.isort]
-atomic = true
-profile = "black"
-line_length = 120
-skip_gitignore = true
-skip_glob = ["migrations", "devops"]
-
-[tool.pylint.main]
-fail-under = 10
-max-line-length = 120
-ignore = [ "migrations", "devops", "tests"]
-ignore-patterns = ["^\\.#"]
-ignored-modules= ["flask_sqlalchemy", "sqlalchemy", "SQLAlchemy" , "alembic", "scoped_session"]
-ignored-classes= "scoped_session"
-ignore-long-lines = "^\\s*(# )?<?https?://\\S+>?$"
-extension-pkg-whitelist = "pydantic"
-notes = ["FIXME","XXX","TODO"]
-overgeneral-exceptions = ["builtins.BaseException", "builtins.Exception"]
-confidence = ["HIGH", "CONTROL_FLOW", "INFERENCE", "INFERENCE_FAILURE", "UNDEFINED"]
-disable = "C0209,C0301,W0511,W0613,W0703,W1514,W1203,R0801,R0902,R0903,R0911,R0401,R1705,R1718,W3101"
-argument-naming-style = "snake_case"
-attr-naming-style = "snake_case"
-class-attribute-naming-style = "any"
-class-const-naming-style = "UPPER_CASE"
-class-naming-style = "PascalCase"
-const-naming-style = "UPPER_CASE"
-function-naming-style = "snake_case"
-inlinevar-naming-style = "any"
-method-naming-style = "snake_case"
-module-naming-style = "any"
-variable-naming-style = "snake_case"
-docstring-min-length = -1
-good-names = ["i", "j", "k", "ex", "Run", "_"]
-bad-names = ["foo", "bar", "baz", "toto", "tutu", "tata"]
-defining-attr-methods = ["__init__", "__new__", "setUp", "asyncSetUp", "__post_init__"]
-exclude-protected = ["_asdict", "_fields", "_replace", "_source", "_make", "os._exit"]
-valid-classmethod-first-arg = ["cls"]
-valid-metaclass-classmethod-first-arg = ["mcs"]
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.lint.per-file-ignores]
+# Tests can use magic values, assertions, and relative imports
+"tests/**/*.py" = ["PLR2004", "S101", "TID252", "ARG001", "B006", "B008", "S311", "T201"]
+# Allow magic values in tests
+"**/test_*.py" = ["PLR2004", "S101", "TID252", "ARG001", "B006", "B008", "S311", "T201"]
+# Allow magic values in conftest.py
+"conftest.py" = ["PLR2004", "S101", "TID252", "ARG001", "B006", "B008", "S311", "T201"]
+# Allow magic values in migrations
+"migrations/**/*.py" = ["PLR2004", "S101", "TID252"]
+# Allow magic values in devops
+"devops/**/*.py" = ["PLR2004", "S101", "TID252"]
+# Allow unused imports in __init__.py and ignore N999 (invalid module name)
+"__init__.py" = ["F401", "N999"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["pay_api"]
+
+[tool.ruff.lint.flake8-quotes]
+docstring-quotes = "double"
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+docstring-code-format = false
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+docstring-code-line-length = "dynamic"
 
 [tool.pytest.ini_options]
 asyncio_mode = "auto"

auth-api/pyproject.toml

@@ -0,0 +1 @@
+"""Source package for the auth-api application."""

auth-api/src/__init__.py

@@ -15,11 +15,12 @@
 
 This module is the API for the Authroization system.
 """
+
 import os
 import traceback
 
 from cloud_sql_connector import DBConfig, setup_search_path_event_listener
-from flask import Flask, request
+from flask import Flask, request  # noqa: TC002
 from flask_cors import CORS
 from flask_migrate import Migrate, upgrade
 from sbc_common_components.utils.camel_case_response import convert_to_camel
@@ -40,8 +41,10 @@
 setup_logging(os.path.join(_Config.PROJECT_ROOT, "logging.conf"))
 
 
-def create_app(run_mode=os.getenv("DEPLOYMENT_ENV", "production")):
+def create_app(run_mode=None):
     """Return a configured Flask App using the Factory method."""
+    if run_mode is None:
+        run_mode = os.getenv("DEPLOYMENT_ENV", "production")
     app = Flask(__name__)
     app.config["ENV"] = run_mode
     app.config.from_object(config.CONFIGURATION[run_mode])

auth-api/src/auth_api/__init__.py

@@ -21,7 +21,6 @@
 
 import os
 import sys
-from typing import List
 
 from dotenv import find_dotenv, load_dotenv
 
@@ -58,7 +57,7 @@ class _Config:  # pylint: disable=too-few-public-methods
 
     PROJECT_ROOT = os.path.abspath(os.path.dirname(__file__))
 
-    SECRET_KEY = "a secret"
+    SECRET_KEY = "a secret"  # noqa: S105
     TESTING = False
     DEBUG = False
 
@@ -182,7 +181,7 @@ class _Config:  # pylint: disable=too-few-public-methods
     API_GW_KC_CLIENT_ID_PATTERN = os.getenv("API_GW_KC_CLIENT_ID_PATTERN", "api-key-account-{account_id}")
 
     # NR Supported Request types.
-    NR_SUPPORTED_REQUEST_TYPES: List[str] = os.getenv("NR_SUPPORTED_REQUEST_TYPES", "BC").replace(" ", "").split(",")
+    NR_SUPPORTED_REQUEST_TYPES: list[str] = os.getenv("NR_SUPPORTED_REQUEST_TYPES", "BC").replace(" ", "").split(",")
     AUTH_WEB_SANDBOX_HOST = os.getenv("AUTH_WEB_SANDBOX_HOST", "localhost")
 
     # LaunchDarkly SDK key
@@ -322,7 +321,7 @@ class ProdConfig(_Config):  # pylint: disable=too-few-public-methods
 
     if not SECRET_KEY:
         SECRET_KEY = os.urandom(24)
-        print("WARNING: SECRET_KEY being set as a one-shot", file=sys.stderr)
+        print("WARNING: SECRET_KEY being set as a one-shot", file=sys.stderr)  # noqa: T201
 
     TESTING = False
     DEBUG = False

auth-api/src/auth_api/config.py

@@ -7,7 +7,7 @@
 status_code - where possible use HTTP Error Codes
 """
 
-from auth_api.exceptions.errors import Error  # noqa: I001, I003
+from auth_api.exceptions.errors import Error  # noqa: I001
 from auth_api.exceptions.exception_handler import ExceptionHandler
 from auth_api.exceptions.exceptions import (
     BCOLException,

auth-api/src/auth_api/exceptions/__init__.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """Function to handle all exceptions."""
+
 import logging
 import traceback
 
@@ -47,7 +48,7 @@ def db_handler(self, error):  # pylint: disable=useless-option-value
         logger.exception(error_message)
         error_text = error.__dict__["code"] if hasattr(error.__dict__, "code") else ""
         status_code = error.status_code if hasattr(error, "status_code") else 500
-        return {"error": "{}".format(error_text), "message": "{}".format(message_text)}, status_code, RESPONSE_HEADERS
+        return {"error": f"{error_text}", "message": f"{message_text}"}, status_code, RESPONSE_HEADERS
 
     def std_handler(self, error):  # pylint: disable=useless-option-value
         """Handle standard exception."""
@@ -96,6 +97,7 @@ def _get_exc_class_and_code(exc_class_or_code):
         else:
             exc_class = exc_class_or_code
 
-        assert issubclass(exc_class, Exception)
+        if not issubclass(exc_class, Exception):
+            raise ValueError("exc_class must be a subclass of Exception")
 
         return exc_class