feat: added support for non standard http status codes

Author: Ykrej

openapi_python_client/__init__.py

@@ -31,6 +31,7 @@
     "kebabcase": utils.kebab_case,
     "pascalcase": utils.pascal_case,
     "any": any,
+    "all": all,
 }
 
 

openapi_python_client/parser/responses.py

@@ -1,6 +1,6 @@
 __all__ = ["HTTPStatusPattern", "Response", "Responses", "response_from_data"]
-
 from collections.abc import Iterator
+from http import HTTPStatus
 from typing import TypedDict
 
 from attrs import define
@@ -53,11 +53,15 @@ class HTTPStatusPattern:
 
     pattern: str
     range: tuple[int, int] | None
+    is_official: bool
 
     def __init__(self, *, pattern: str, code_range: tuple[int, int] | None):
         """Initialize with a range of status codes or None for the default case."""
         self.pattern = pattern
         self.range = code_range
+        self.is_official = self.range is None or all(
+            code in HTTPStatus for code in range(self.range[0], self.range[1] + 1)
+        )
 
     @staticmethod
     def parse(pattern: str) -> "HTTPStatusPattern | ParseError":

openapi_python_client/templates/endpoint_module.py.jinja

@@ -1,4 +1,3 @@
-from http import HTTPStatus
 from typing import Any, cast
 from urllib.parse import quote
 
@@ -12,6 +11,13 @@ from ... import errors
 {{ relative }}
 {% endfor %}
 
+{% if endpoint.responses|list|length == 0 or endpoint.responses|map(attribute="status_code")|map(attribute="is_official")|all %}
+import http
+HTTPStatus = http.HTTPStatus
+{% else %}
+HTTPStatus = int
+{% endif %}
+
 {% from "endpoint_macros.py.jinja" import header_params, cookie_params, query_params,
     arguments, client, kwargs, parse_response, docstring, body_to_kwarg %}
 
@@ -92,7 +98,7 @@ def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Res
     {% endif %}
 
 
-def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[{{ return_string }}]:
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[{{ return_string }}, HTTPStatus]:
     return Response(
         status_code=HTTPStatus(response.status_code),
         content=response.content,
@@ -103,7 +109,7 @@ def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Res
 
 def sync_detailed(
     {{ arguments(endpoint) | indent(4) }}
-) -> Response[{{ return_string }}]:
+) -> Response[{{ return_string }}, HTTPStatus]:
     {{ docstring(endpoint, return_string, is_detailed=true) | indent(4) }}
 
     kwargs = _get_kwargs(
@@ -129,7 +135,7 @@ def sync(
 
 async def asyncio_detailed(
     {{ arguments(endpoint) | indent(4) }}
-) -> Response[{{ return_string }}]:
+) -> Response[{{ return_string }}, HTTPStatus]:
     {{ docstring(endpoint, return_string, is_detailed=true) | indent(4) }}
 
     kwargs = _get_kwargs(

openapi_python_client/templates/types.py.jinja

@@ -38,13 +38,14 @@ class File:
 
 
 T = TypeVar("T")
+S = TypeVar("S", bound=HTTPStatus | int)
 
 
 @define
-class Response(Generic[T]):
+class Response(Generic[T, S]):
     """ A response from an endpoint """
 
-    status_code: HTTPStatus
+    status_code: S
     content: bytes
     headers: MutableMapping[str, str]
     parsed: T | None