pyopenapi-gen 0.15.0__py3-none-any.whl → 0.17.0__py3-none-any.whl

pyopenapi_gen/__init__.py

@@ -8,6 +8,8 @@ code‑generation pipeline can rely on.
 
 from __future__ import annotations
 
+from pathlib import Path
+
 # Removed dataclasses, field, Enum, unique from here, they are in ir.py and http_types.py
 from typing import (
     TYPE_CHECKING,
@@ -30,6 +32,11 @@ from .ir import (
 )
 
 __all__ = [
+    # Main API
+    "generate_client",
+    "ClientGenerator",
+    "GenerationError",
+    # IR classes
     "HTTPMethod",
     "IRParameter",
     "IRResponse",
@@ -37,52 +44,13 @@ __all__ = [
     "IRSchema",
     "IRSpec",
     "IRRequestBody",
-    # Keep existing __all__ entries for lazy loaded items
+    # Utilities
     "load_ir_from_spec",
     "WarningCollector",
 ]
 
 # Semantic version of the generator core – automatically managed by semantic-release.
-__version__: str = "0.14.3"
-
-
-# ---------------------------------------------------------------------------
-# HTTP Method Enum - REMOVED FROM HERE
-# ---------------------------------------------------------------------------
-
-# @unique
-# class HTTPMethod(str, Enum):
-#     ...
-
-
-# ---------------------------------------------------------------------------
-# IR Dataclasses - REMOVED FROM HERE
-# ---------------------------------------------------------------------------
-
-# @dataclass(slots=True)
-# class IRParameter:
-#     ...
-
-# @dataclass(slots=True)
-# class IRResponse:
-#     ...
-
-# @dataclass(slots=True)
-# class IRRequestBody:
-#     ...
-
-# @dataclass(slots=True)
-# class IROperation:
-#     ...
-
-# @dataclass(slots=True)
-# class IRSchema:
-#     ...
-
-# @dataclass(slots=True)
-# class IRSpec:
-#     ...
-
+__version__: str = "0.17.0"
 
 # ---------------------------------------------------------------------------
 # Lazy-loading and autocompletion support (This part remains)
@@ -91,6 +59,7 @@ if TYPE_CHECKING:
     # Imports for static analysis
     from .core.loader.loader import load_ir_from_spec  # noqa: F401
     from .core.warning_collector import WarningCollector  # noqa: F401
+    from .generator.client_generator import ClientGenerator, GenerationError  # noqa: F401
 
 # Expose loader and collector at package level
 # __all__ is already updated above
@@ -103,12 +72,152 @@ def __getattr__(name: str) -> Any:
 
         return _func
     if name == "WarningCollector":
-        from .core.warning_collector import WarningCollector as _cls
+        from .core.warning_collector import WarningCollector as _warning_cls
+
+        return _warning_cls
+    if name == "ClientGenerator":
+        from .generator.client_generator import ClientGenerator as _gen_cls
+
+        return _gen_cls
+    if name == "GenerationError":
+        from .generator.client_generator import GenerationError as _exc
 
-        return _cls
+        return _exc
     raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
 
 
 def __dir__() -> List[str]:
     # Ensure dir() and completion shows all exports
     return __all__.copy()
+
+
+# ---------------------------------------------------------------------------
+# Main Programmatic API
+# ---------------------------------------------------------------------------
+
+
+def generate_client(
+    spec_path: str,
+    project_root: str,
+    output_package: str,
+    core_package: str | None = None,
+    force: bool = False,
+    no_postprocess: bool = False,
+    verbose: bool = False,
+) -> List[Path]:
+    """Generate a Python client from an OpenAPI specification.
+
+    This is the main entry point for programmatic usage of pyopenapi_gen.
+    It provides a simple function-based API for generating OpenAPI clients
+    without needing to instantiate classes or understand internal structure.
+
+    Args:
+        spec_path: Path to the OpenAPI specification file (YAML or JSON).
+                  Can be a relative or absolute file path.
+
+        project_root: Root directory of your Python project where the generated
+                     client will be placed. This is the directory that contains
+                     your top-level Python packages.
+
+        output_package: Python package name for the generated client.
+                       Uses dot notation (e.g., 'pyapis.my_client').
+                       The client will be generated at:
+                       {project_root}/{output_package_as_path}/
+
+        core_package: Optional Python package name for shared core runtime.
+                     If not specified, defaults to {output_package}.core.
+                     Use this when generating multiple clients that share
+                     common runtime code (auth, config, http transport, etc.).
+
+        force: If True, overwrites existing output without diff checking.
+              If False (default), compares with existing output and only
+              updates if changes are detected.
+
+        no_postprocess: If True, skips post-processing (Black formatting and
+                       mypy type checking). Useful for faster iteration during
+                       development.
+
+        verbose: If True, prints detailed progress information during generation.
+
+    Returns:
+        List of Path objects for all generated files.
+
+    Raises:
+        GenerationError: If generation fails due to invalid spec, file I/O
+                        errors, or other issues during code generation.
+
+    Examples:
+        Basic usage with default settings:
+
+        >>> from pyopenapi_gen import generate_client
+        >>>
+        >>> files = generate_client(
+        ...     spec_path="input/openapi.yaml",
+        ...     project_root=".",
+        ...     output_package="pyapis.my_client"
+        ... )
+        >>> print(f"Generated {len(files)} files")
+
+        Generate multiple clients sharing a common core package:
+
+        >>> from pyopenapi_gen import generate_client
+        >>>
+        >>> # Generate first client (creates shared core)
+        >>> generate_client(
+        ...     spec_path="api_v1.yaml",
+        ...     project_root=".",
+        ...     output_package="pyapis.client_v1",
+        ...     core_package="pyapis.core"
+        ... )
+        >>>
+        >>> # Generate second client (reuses core)
+        >>> generate_client(
+        ...     spec_path="api_v2.yaml",
+        ...     project_root=".",
+        ...     output_package="pyapis.client_v2",
+        ...     core_package="pyapis.core"
+        ... )
+
+        Handle generation errors:
+
+        >>> from pyopenapi_gen import generate_client, GenerationError
+        >>>
+        >>> try:
+        ...     generate_client(
+        ...         spec_path="openapi.yaml",
+        ...         project_root=".",
+        ...         output_package="pyapis.my_client",
+        ...         verbose=True
+        ...     )
+        ... except GenerationError as e:
+        ...     print(f"Generation failed: {e}")
+
+        Force regeneration with verbose output:
+
+        >>> generate_client(
+        ...     spec_path="openapi.yaml",
+        ...     project_root=".",
+        ...     output_package="pyapis.my_client",
+        ...     force=True,
+        ...     verbose=True
+        ... )
+
+    Notes:
+        - Generated clients are completely self-contained and require no
+          runtime dependency on pyopenapi_gen
+        - All generated code is automatically formatted with Black and
+          type-checked with mypy (unless no_postprocess=True)
+        - The generated client uses modern async/await patterns with httpx
+        - Type hints are included for all generated code
+    """
+    from .generator.client_generator import ClientGenerator
+
+    generator = ClientGenerator(verbose=verbose)
+    return generator.generate(
+        spec_path=spec_path,
+        project_root=Path(project_root),
+        output_package=output_package,
+        core_package=core_package,
+        force=force,
+        no_postprocess=no_postprocess,
+    )

pyopenapi_gen/core/loader/parameters/parser.py

@@ -103,9 +103,9 @@ def parse_parameter(
                             if not inline_is_specific:
                                 sch = comp_schema
                         break
-    except Exception:
-        # Be conservative on any unexpected structure
-        pass
+    except Exception as e:
+        # Log unexpected structure but continue with inline schema
+        logger.debug(f"Could not check component parameter for '{param_name}': {e}. Using inline schema.")
 
     # For parameters, we want to avoid creating complex schemas for simple enum arrays
     # Check if this is a simple enum array and handle it specially

pyopenapi_gen/core/postprocess_manager.py

@@ -1,4 +1,4 @@
-import subprocess
+import subprocess  # nosec B404 - Required for running code formatters (Black, Ruff) and mypy
 import sys
 from pathlib import Path
 from typing import List, Union
@@ -71,7 +71,7 @@ class PostprocessManager:
         """Remove unused imports from multiple targets using Ruff (bulk operation)."""
         if not targets:
             return
-        result = subprocess.run(
+        result = subprocess.run(  # nosec B603 - Controlled subprocess with hardcoded command
             [
                 sys.executable,
                 "-m",
@@ -95,7 +95,7 @@ class PostprocessManager:
         """Sort imports in multiple targets using Ruff (bulk operation)."""
         if not targets:
             return
-        result = subprocess.run(
+        result = subprocess.run(  # nosec B603 - Controlled subprocess with hardcoded command
             [
                 sys.executable,
                 "-m",
@@ -119,7 +119,7 @@ class PostprocessManager:
         """Format code in multiple targets using Ruff (bulk operation)."""
         if not targets:
             return
-        result = subprocess.run(
+        result = subprocess.run(  # nosec B603 - Controlled subprocess with hardcoded command
             [
                 sys.executable,
                 "-m",
@@ -139,7 +139,7 @@ class PostprocessManager:
 
     def remove_unused_imports(self, target: Union[str, Path]) -> None:
         """Remove unused imports from the target using Ruff."""
-        result = subprocess.run(
+        result = subprocess.run(  # nosec B603 - Controlled subprocess with hardcoded command
             [
                 sys.executable,
                 "-m",
@@ -161,7 +161,7 @@ class PostprocessManager:
 
     def sort_imports(self, target: Union[str, Path]) -> None:
         """Sort imports in the target using Ruff."""
-        result = subprocess.run(
+        result = subprocess.run(  # nosec B603 - Controlled subprocess with hardcoded command
             [
                 sys.executable,
                 "-m",
@@ -183,7 +183,7 @@ class PostprocessManager:
 
     def format_code(self, target: Union[str, Path]) -> None:
         """Format code in the target using Ruff."""
-        result = subprocess.run(
+        result = subprocess.run(  # nosec B603 - Controlled subprocess with hardcoded command
             [
                 sys.executable,
                 "-m",
@@ -223,7 +223,7 @@ class PostprocessManager:
                 cmd.append("--cache-dir=/tmp/mypy_cache_temp")
             cmd.extend([str(f) for f in python_files])
 
-            result = subprocess.run(
+            result = subprocess.run(  # nosec B603 - Controlled subprocess with hardcoded command
                 cmd,
                 stdout=subprocess.PIPE,
                 stderr=subprocess.PIPE,

pyopenapi_gen/core/telemetry.py

@@ -62,6 +62,8 @@ class TelemetryClient:
             # Using print as a stub for actual telemetry transport
             # In production, this would be replaced with a proper telemetry client
             print("TELEMETRY", json.dumps(data))
-        except Exception:
-            # Silently ignore any telemetry errors to avoid affecting main execution
-            pass
+        except Exception as e:
+            # Telemetry failures should not affect execution, but log for debugging
+            import logging
+
+            logging.getLogger(__name__).debug(f"Telemetry event failed: {e}")

pyopenapi_gen/types/resolvers/schema_resolver.py

@@ -289,6 +289,7 @@ class OpenAPISchemaResolver(SchemaTypeResolver):
                 "hostname": "str",
                 "ipv4": "str",
                 "ipv6": "str",
+                "binary": "bytes",
             }
 
             python_type = format_mapping.get(format_type, "str")

{pyopenapi_gen-0.15.0.dist-info → pyopenapi_gen-0.17.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyopenapi-gen
-Version: 0.15.0
+Version: 0.17.0
 Summary: Modern, async-first Python client generator for OpenAPI specifications with advanced cycle detection and unified type resolution
 Project-URL: Homepage, https://github.com/your-org/pyopenapi-gen
 Project-URL: Documentation, https://github.com/your-org/pyopenapi-gen/blob/main/README.md

{pyopenapi_gen-0.15.0.dist-info → pyopenapi_gen-0.17.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-pyopenapi_gen/__init__.py,sha256=AUYdbyW8dbrYxo2DvttZkFO79T5QHsS96P8z4TU8y6U,3017
+pyopenapi_gen/__init__.py,sha256=nLxgWZNVSv0wDYh4S5NlwKP7DrQGisi4J3IL7WCmLX8,7533
 pyopenapi_gen/__main__.py,sha256=4-SCaCNhBd7rtyRK58uoDbdl93J0KhUeajP_b0CPpLE,110
 pyopenapi_gen/cli.py,sha256=9T_XF3-ih_JlM_BOkmHft-HoMCGOqL5UrnAHBJ0fb5w,2320
 pyopenapi_gen/http_types.py,sha256=EMMYZBt8PNVZKPFu77TQija-JI-nOKyXvpiQP9-VSWE,467
@@ -14,10 +14,10 @@ pyopenapi_gen/core/exceptions.py,sha256=HYFiYdmzsZUl46vB8M3B6Vpp6m8iqjUcKDWdL4yE
 pyopenapi_gen/core/http_status_codes.py,sha256=nn8QdXmkv5BQA9C-HTn9wmAVWyEyB9bAHpHve6EZX4M,6249
 pyopenapi_gen/core/http_transport.py,sha256=Ssyh5a4wWWZlvxG1jhTmynZUTBe5rtVgyDK5FIUXyos,9617
 pyopenapi_gen/core/pagination.py,sha256=mXSOyfVblWF0jc8dnqXIi0Vgj2UxC_uO_WuvdRIBzs4,2295
-pyopenapi_gen/core/postprocess_manager.py,sha256=cia8FbDXbulk44ElT1CTlypu1oFjNM41y1gWy8-HSug,9362
+pyopenapi_gen/core/postprocess_manager.py,sha256=Ia4H47lInhVxkHnDB46t4U-6BLpLXzhrmFaLSRmc8Uw,9865
 pyopenapi_gen/core/schemas.py,sha256=Ngehd-Aj4Drs_5i7eL0L5Eu1B_kfT4qxL94TJ_H_I7w,5523
 pyopenapi_gen/core/streaming_helpers.py,sha256=5fkzH9xsgzZWOTKFrZpmje07S7n7CcOpjteb5dig7ds,2664
-pyopenapi_gen/core/telemetry.py,sha256=vZ8PqNctndrmII9I1EHCyvp2bVGofBuHjm7II0tIqps,2203
+pyopenapi_gen/core/telemetry.py,sha256=LNMrlrUNVcp591w9cX4uvzlFrPB6ZZoGRIuCOHlDCqA,2296
 pyopenapi_gen/core/utils.py,sha256=rgKNyoOXRleGueUFItM5fpxUxwNMJOGISC_XxSPCPLg,14141
 pyopenapi_gen/core/warning_collector.py,sha256=DYl9D7eZYs04mDU84KeonS-5-d0aM7hNqraXTex31ss,2799
 pyopenapi_gen/core/auth/base.py,sha256=E2KUerA_mYv9D7xulUm-lenIxqZHqanjA4oRKpof2ZE,792
@@ -29,7 +29,7 @@ pyopenapi_gen/core/loader/operations/parser.py,sha256=E53NCTdTp9a6VKxhSx_6r-jP3B
 pyopenapi_gen/core/loader/operations/post_processor.py,sha256=Rzb3GSiLyJk-0hTBZ6s6iWAj4KqE4Rfo3w-q2wm_R7w,2487
 pyopenapi_gen/core/loader/operations/request_body.py,sha256=A6kX2oyNh3Ag_h-Flk8gDzZjiUl3lq8F6jGb3o-UhFg,3205
 pyopenapi_gen/core/loader/parameters/__init__.py,sha256=p13oSibCRC5RCfsP6w7yD9MYs5TXcdI4WwPv7oGUYKk,284
-pyopenapi_gen/core/loader/parameters/parser.py,sha256=0qGFcbnyWXacrnbxDPicw59JVwl3B3f4NP4tXVJBS9E,8033
+pyopenapi_gen/core/loader/parameters/parser.py,sha256=TROPMq6iyL9Somh7K1ADjqyDGXL0s4Wcieg6hM5vdYE,8145
 pyopenapi_gen/core/loader/responses/__init__.py,sha256=6APWoH3IdNkgVmI0KsgZoZ6knDaG-S-pnUCa6gkzT8E,216
 pyopenapi_gen/core/loader/responses/parser.py,sha256=6dZ86WvyBxPq68UQjF_F8F2FtmGtMm5ZB8UjKXZTu9Y,4063
 pyopenapi_gen/core/loader/schemas/__init__.py,sha256=rlhujYfw_IzWgzhVhYMJ3eIhE6C5Vi1Ylba-BHEVqOg,296
@@ -98,7 +98,7 @@ pyopenapi_gen/types/contracts/types.py,sha256=k3tCjMu6M1zcVXF6jzr-Q9S6LXaMEMoKoO
 pyopenapi_gen/types/resolvers/__init__.py,sha256=_5kA49RvyOTyXgt0GbbOfHJcdQw2zHxvU9af8GGyNWc,295
 pyopenapi_gen/types/resolvers/reference_resolver.py,sha256=ue6gw665Wo07POuAg5820A6AXiCVyQY-unfIzGjxrSY,2034
 pyopenapi_gen/types/resolvers/response_resolver.py,sha256=_W6-Z_SBQ8tDMd_VqveO5AiFs7Od7eAuqevpUIDCT5o,6481
-pyopenapi_gen/types/resolvers/schema_resolver.py,sha256=PWw77fPh8SG4i1YD45-cOmjmrA1HQkIz1u75AILlvM0,23617
+pyopenapi_gen/types/resolvers/schema_resolver.py,sha256=GoL2z_uMrS3Jsp1eN0_eAfyXyRxPnryUt6o-9UXcO3I,23652
 pyopenapi_gen/types/services/__init__.py,sha256=inSUKmY_Vnuym6tC-AhvjCTj16GbkfxCGLESRr_uQPE,123
 pyopenapi_gen/types/services/type_service.py,sha256=3IH0GBLeC-ruokBmhvC8iR5GT5tmFg1n6tcLZYa5TSk,6998
 pyopenapi_gen/types/strategies/__init__.py,sha256=bju8_KEPNIow1-woMO-zJCgK_E0M6JnFq0NFsK1R4Ss,171
@@ -125,8 +125,8 @@ pyopenapi_gen/visit/model/alias_generator.py,sha256=wEMHipPA1_CFxvQ6CS9j4qgXK93s
 pyopenapi_gen/visit/model/dataclass_generator.py,sha256=L794s2yyYUO__akGd120NJMV7g2xqiPfQyZo8CduIVM,14426
 pyopenapi_gen/visit/model/enum_generator.py,sha256=AXqKUFuWUUjUF_6_HqBKY8vB5GYu35Pb2C2WPFrOw1k,10061
 pyopenapi_gen/visit/model/model_visitor.py,sha256=TC6pbxpQiy5FWhmQpfllLuXA3ImTYNMcrazkOFZCIyo,9470
-pyopenapi_gen-0.15.0.dist-info/METADATA,sha256=iRFEkYUsm_-6q06MRBl03b1y3J7Utw1xqiZ7NF6aFSQ,14025
-pyopenapi_gen-0.15.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pyopenapi_gen-0.15.0.dist-info/entry_points.txt,sha256=gxSlNiwom50T3OEZnlocA6qRjGdV0bn6hN_Xr-Ub5wA,56
-pyopenapi_gen-0.15.0.dist-info/licenses/LICENSE,sha256=UFAyTWKa4w10-QerlJaHJeep7G2gcwpf-JmvI2dS2Gc,1088
-pyopenapi_gen-0.15.0.dist-info/RECORD,,
+pyopenapi_gen-0.17.0.dist-info/METADATA,sha256=YkgkvtWTtSfD9_1lhlfVYRRwM9pzBYpR7HVKROSP0C0,14025
+pyopenapi_gen-0.17.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pyopenapi_gen-0.17.0.dist-info/entry_points.txt,sha256=gxSlNiwom50T3OEZnlocA6qRjGdV0bn6hN_Xr-Ub5wA,56
+pyopenapi_gen-0.17.0.dist-info/licenses/LICENSE,sha256=UFAyTWKa4w10-QerlJaHJeep7G2gcwpf-JmvI2dS2Gc,1088
+pyopenapi_gen-0.17.0.dist-info/RECORD,,