Codacy linting updates

Author: morgangraphics

.pylintrc

@@ -1,18 +1,37 @@
+[MASTER]
+# Support both old pylint ([MASTER]) and new pylint ([MAIN]) section names.
+py-version = 3.12
+
 [MAIN]
 py-version = 3.12
 
 [BASIC]
 # h and s are intentional short names that map directly to API query parameters.
-good-names = h,s,e,i,j,k,_
+# bp_* are idiomatic FastAPI APIRouter instance names, not constants.
+good-names = h,s,e,i,j,k,_,bp_dc,bp_hc,bp_marvel
 
 [DESIGN]
 # _build_options and route handlers mirror the full set of API query parameters.
 max-args = 15
 max-positional-arguments = 15
 
 [MESSAGES CONTROL]
-# 'format' and 'help' shadow builtins intentionally — they are public API
-# query-parameter names whose spelling cannot be changed without breaking clients.
+# redefined-builtin: 'format' and 'help' shadow builtins intentionally — they
+#   are public API query-parameter names that cannot be renamed.
+# line-too-long: not enforced in this project.
+# missing-module-docstring: modules use file-level docstrings only where needed.
+# E0611 (no-name-in-module): false positive — Annotated/Literal exist in
+#   typing since Python 3.8/3.9; old pylint doesn't know this.
+# E1136 (unsubscriptable-object): false positive — list[x]/dict[x] are valid
+#   in Python 3.9+; old pylint doesn't know this.
+# C0326 (bad-whitespace): false positive — PEP 8 requires spaces around '='
+#   for annotated function parameters; old pylint flags these incorrectly.
+# C0330 (wrong-hanging-indentation): removed in pylint 2.6+ but triggers as a
+#   false positive in older Codacy pylint builds.
 disable = redefined-builtin,
           line-too-long,
-          missing-module-docstring
+          missing-module-docstring,
+          no-name-in-module,
+          unsubscriptable-object,
+          bad-whitespace,
+          wrong-hanging-indentation

service/routes/__init__.py

@@ -4,9 +4,7 @@
 from .healthcheck import bp_hc
 from .marvel import bp_marvel
 
-
 def init_app(app: FastAPI) -> None:
     app.include_router(bp_dc)
     app.include_router(bp_hc)
     app.include_router(bp_marvel)
-

service/routes/dc.py

@@ -214,6 +214,7 @@ def dc_get_by_character(
     prune: Annotated[Optional[str], Query(description=f"Remove keys with null values. {_TF_TEXT}")] = None,
     s: Annotated[Optional[str], Query(description="Columns to sort on.")] = None,
 ):
+    """GET handler for DC universe character search by name."""
     api = ApiUtils()
     safe_chars = _sanitize(characters)
     options = _build_options(
@@ -241,6 +242,7 @@ def dc_get_by_character(
     description=_POST_DESCRIPTION,
 )
 def dc_post(body: CharacterSearchBody):
+    """POST handler for DC universe character search."""
     api = ApiUtils()
     options = body.model_dump(exclude_none=True)
     options.setdefault("universe", "dc")

service/routes/healthcheck.py

@@ -8,9 +8,7 @@
 
 bp_hc = APIRouter()
 
-
 @bp_hc.get("/healthcheck", tags=["healthcheck"], summary="Test if the Service is up", response_model=HealthResponse)
 def healthcheck() -> HealthResponse:
     """Simple health check endpoint."""
     return HealthResponse(status="Ok")
-

service/routes/marvel.py

@@ -217,6 +217,7 @@ def marvel_get_by_character(
     prune: Annotated[Optional[str], Query(description=f"Remove keys with null values. {_TF_TEXT}")] = None,
     s: Annotated[Optional[str], Query(description="Columns to sort on.")] = None,
 ):
+    """GET handler for Marvel universe character search by name."""
     api = ApiUtils()
     safe_chars = _sanitize(characters)
     options = _build_options(
@@ -244,6 +245,7 @@ def marvel_get_by_character(
     description=_POST_DESCRIPTION,
 )
 def marvel_post(body: CharacterSearchBody):
+    """POST handler for Marvel universe character search."""
     api = ApiUtils()
     options = body.model_dump(exclude_none=True)
     options.setdefault("universe", "marvel")

service/utils/file.py

@@ -205,13 +205,10 @@ def sort_i18n_str(self, row: dict, sort_col: str, sort_dir: bool) -> tuple:
         if self.config.get("nulls") == "first" and not self.config.get("prune"):
             if not sort_dir:
                 return (itm is not None, itm != "", itm)
-            else:
-                return (itm is None, itm != "", itm)
-        else:
-            if not sort_dir:
-                return (itm is None, itm != "", itm)
-            else:
-                return (itm is not None, itm != "", itm)
+            return (itm is None, itm != "", itm)
+        if not sort_dir:
+            return (itm is None, itm != "", itm)
+        return (itm is not None, itm != "", itm)
 
     def sort_results(self, results: list, srt_ordr: list | None = None) -> list:
         """

unit/conftest.py

@@ -151,4 +151,3 @@ def common_config_options(request):
     if request is not None and data.get(request.param):
         val = data[request.param]
     return val
-