chore: Clean up flake8 settings

Author: sondrelg

openapi_tester/utils.py

@@ -1,4 +1,6 @@
-""" Utils Module - this file contains utility functions used in multiple places """
+"""
+Utils Module - this file contains utility functions used in multiple places.
+"""
 from __future__ import annotations
 
 from copy import deepcopy
@@ -10,7 +12,9 @@
 
 
 def merge_objects(dictionaries: Sequence[dict[str, Any]]) -> dict[str, Any]:
-    """helper function to deep merge objects"""
+    """
+    Deeply merge objects.
+    """
     output: dict[str, Any] = {}
     for dictionary in dictionaries:
         for key, value in dictionary.items():
@@ -27,8 +31,10 @@ def merge_objects(dictionaries: Sequence[dict[str, Any]]) -> dict[str, Any]:
     return output
 
 
-def normalize_schema_section(schema_section: dict) -> dict:
-    """helper method to remove allOf and handle edge uses of oneOf"""
+def normalize_schema_section(schema_section: dict[str, Any]) -> dict[str, Any]:
+    """
+    Remove allOf and handle edge uses of oneOf.
+    """
     output: dict[str, Any] = deepcopy(schema_section)
     if output.get("allOf"):
         all_of = output.pop("allOf")
@@ -46,7 +52,9 @@ def normalize_schema_section(schema_section: dict) -> dict:
 
 
 def lazy_combinations(options_list: Sequence[dict[str, Any]]) -> Iterator[dict]:
-    """helper to lazy evaluate possible permutations of possible combinations"""
+    """
+    Lazily evaluate possible combinations.
+    """
     for i in range(2, len(options_list) + 1):
         for combination in combinations(options_list, i):
             yield merge_objects(combination)

setup.cfg

@@ -1,43 +1,23 @@
 [flake8]
 ignore=
-    # E501: Line length
-    E501
     # Docstring at the top of a public module
     D100
     # Docstring at the top of a public class (method is enough)
     D101
     # Make docstrings one line if it can fit.
     D200
     D210
-    # Imperative docstring declarations
-    D401
-    # Type annotation for `self`
-    TYP101
-    TYP102  # for cls
-    ANN101
     # Missing docstring in __init__
     D107
     # Missing docstring in public package
     D104
-    # Missing type annotations for `**kwargs`
-    TYP003
     # Whitespace before ':'. Black formats code this way.
     E203
     # 1 blank line required between summary line and description
     D205
-    # First line should end with a period - here we have a few cases where the first line is too long, and
-    # this issue can't be fixed without using noqa notation
-    D400
     # Line break before binary operator. W504 will be hit when this is excluded.
     W503
-    # Missing type annotation for *args
-    TYP002
-    ANN002
-    # Missing type annotation for **kwargs
-    ANN003
-    # f-string missing prefix (too many false positives)
-    FS003
-    # Handle error-cases first
+    # Handle error cases first
     SIM106
 enable-extensions =
     enable-extensions = TC, TC1
@@ -49,6 +29,11 @@ exclude =
     manage.py,
     .venv
 max-complexity = 16
+max-line-length = 120
+per-file-ignores =
+    openapi_tester/constants.py:FS003
+    tests/*:FS003
+    test_project/*:FS003
 
 [mypy]
 python_version = 3.10

tests/test_schema_tester.py

@@ -201,7 +201,8 @@ def test_validate_response_failure_scenario_undocumented_content(client, monkeyp
     response = client.get(de_parameterized_path)
     with pytest.raises(
         UndocumentedSchemaSectionError,
-        match=f"Error: Unsuccessfully tried to index the OpenAPI schema by `content`. \n\nNo `content` defined for this response: {method}, path: {parameterized_path}",
+        match=f"Error: Unsuccessfully tried to index the OpenAPI schema by `content`. \n\n"
+        f"No `content` defined for this response: {method}, path: {parameterized_path}",
     ):
         tester.validate_response(response)