feat: refactor OpenAPI parser functions and enhance CI workflow

Author: MarcoMuellner

.github/workflows/tests.yml

@@ -17,16 +17,37 @@ jobs:
       fail-fast: false
 
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v3
+      - name: 📥 Checkout code
+        uses: actions/checkout@v3
+      
+      - name: 🐍 Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
         with:
           python-version: ${{ matrix.python-version }}
           architecture: x64
-      - run: pip install poetry==1.3.1
-      - run: poetry install
-      - run: poetry run pytest
-      - run: poetry run pytest --cov=src/ --cov-report=xml --cov-fail-under 90 --cov-config=.coveragerc
-      - uses: codecov/codecov-action@v2
+      
+      - name: 📦 Install Poetry and dependencies
+        run: |
+          pip install poetry==1.3.1
+          poetry install
+      
+      - name: 🧪 Run tests
+        run: poetry run pytest
+      
+      - name: 📊 Run tests with coverage
+        run: poetry run pytest --cov=src/ --cov-report=xml --cov-fail-under 90 --cov-config=.coveragerc
+      
+      - name: 🔍 Type checking with mypy
+        run: poetry run mypy src/
+      
+      - name: 🎨 Code formatting with black
+        run: poetry run black --check .
+      
+      - name: 🔧 Linting
+        run: poetry run ruff check .
+      
+      - name: 📈 Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
         if: always()
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

OPENAPI_31_STATUS.md

@@ -53,10 +53,6 @@ fastapi = "^0.115.5"
 uvicorn = "^0.18.1"
 respx = "^0.22.0"
 aiohttp = "^3.8.3"
-responses = "^0.25.7"
-types-PyYAML = "^6.0.12.20240808"
-types-requests = "^2.32.0.20241016"
-types-urllib3 = "^1.26.25.14"
 
 [tool.poetry.scripts]
 openapi-python-generator = "openapi_python_generator.__main__:main"

poetry.lock

@@ -20,10 +20,10 @@
 from .models import ConversionResult
 from .version_detector import detect_openapi_version
 from .parsers import (
-    parse_openapi_30,
-    parse_openapi_31,
-    generate_code_30,
-    generate_code_31,
+    parse_openapi_3_0,
+    parse_openapi_3_1,
+    generate_code_3_0,
+    generate_code_3_1,
 )
 
 
@@ -109,9 +109,9 @@ def get_open_api(source: Union[str, Path]):
         version = detect_openapi_version(data)
 
         if version == "3.0":
-            openapi_obj = parse_openapi_30(data)  # type: ignore[assignment]
+            openapi_obj = parse_openapi_3_0(data)  # type: ignore[assignment]
         elif version == "3.1":
-            openapi_obj = parse_openapi_31(data)  # type: ignore[assignment]
+            openapi_obj = parse_openapi_3_1(data)  # type: ignore[assignment]
         else:
             # Unsupported version detected (version detection already limited to 3.0 / 3.1)
             raise ValueError(
@@ -216,7 +216,7 @@ def generate_data(
 
     # Use version-specific generator
     if version == "3.0":
-        result = generate_code_30(
+        result = generate_code_3_0(
             openapi_obj,  # type: ignore
             library,
             env_token_name,
@@ -225,7 +225,7 @@ def generate_data(
             pydantic_version,
         )
     elif version == "3.1":
-        result = generate_code_31(
+        result = generate_code_3_1(
             openapi_obj,  # type: ignore
             library,
             env_token_name,

pyproject.toml

@@ -2,12 +2,12 @@
 OpenAPI parsers for different specification versions.
 """
 
-from .openapi_30 import parse_openapi_30, generate_code_30
-from .openapi_31 import parse_openapi_31, generate_code_31
+from .openapi_30 import parse_openapi_3_0, generate_code_3_0
+from .openapi_31 import parse_openapi_3_1, generate_code_3_1
 
 __all__ = [
-    "parse_openapi_30",
-    "generate_code_30",
-    "parse_openapi_31",
-    "generate_code_31",
+    "parse_openapi_3_0",
+    "generate_code_3_0",
+    "parse_openapi_3_1",
+    "generate_code_3_1",
 ]

src/openapi_python_generator/generate_data.py

@@ -13,7 +13,7 @@
 from openapi_python_generator.models import ConversionResult
 
 
-def parse_openapi_30(spec_data: dict) -> OpenAPI:
+def parse_openapi_3_0(spec_data: dict) -> OpenAPI:
     """
     Parse OpenAPI 3.0 specification data.
 
@@ -29,7 +29,7 @@ def parse_openapi_30(spec_data: dict) -> OpenAPI:
     return OpenAPI(**spec_data)
 
 
-def generate_code_30(
+def generate_code_3_0(
     data: OpenAPI,
     library: HTTPLibrary = HTTPLibrary.httpx,
     env_token_name: Optional[str] = None,

src/openapi_python_generator/parsers/__init__.py

@@ -13,7 +13,7 @@
 from openapi_python_generator.models import ConversionResult
 
 
-def parse_openapi_31(spec_data: dict) -> OpenAPI:
+def parse_openapi_3_1(spec_data: dict) -> OpenAPI:
     """
     Parse OpenAPI 3.1 specification data.
 
@@ -29,7 +29,7 @@ def parse_openapi_31(spec_data: dict) -> OpenAPI:
     return OpenAPI(**spec_data)
 
 
-def generate_code_31(
+def generate_code_3_1(
     data: OpenAPI,
     library: HTTPLibrary = HTTPLibrary.httpx,
     env_token_name: Optional[str] = None,

src/openapi_python_generator/parsers/openapi_30.py

@@ -7,7 +7,7 @@
 import pytest
 
 from openapi_python_generator.version_detector import detect_openapi_version
-from openapi_python_generator.parsers import parse_openapi_30, parse_openapi_31
+from openapi_python_generator.parsers import parse_openapi_3_0, parse_openapi_3_1
 
 test_data_folder = Path(__file__).parent / "test_data"
 test_data_path = test_data_folder / "test_api.json"
@@ -25,9 +25,9 @@ def model_data_fixture(json_data):
     """Parse OpenAPI spec with version-aware parser."""
     version = detect_openapi_version(json_data)
     if version == "3.0":
-        yield parse_openapi_30(json_data)
+        yield parse_openapi_3_0(json_data)
     elif version == "3.1":
-        yield parse_openapi_31(json_data)
+        yield parse_openapi_3_1(json_data)
     else:
         raise ValueError(f"Unsupported OpenAPI version: {version}")