python-openapi 0.1.10__py3-none-any.whl → 0.3.0__py3-none-any.whl

pyopenapi/__init__.py

@@ -1,54 +1,14 @@
-from typing import Any, Callable, List, Optional, TypeVar
+"""
+Generate an OpenAPI specification from a Python class definition
 
-from .metadata import WebMethod
-from .options import *  # noqa: F403
-from .utility import Specification as Specification
+Copyright 2021-2026, Levente Hunyadi
 
-__version__ = "0.1.10"
+:see: https://github.com/hunyadi/pyopenapi
+"""
 
-T = TypeVar("T")
-
-
-def webmethod(
-    route: Optional[str] = None,
-    public: Optional[bool] = False,
-    request_example: Optional[Any] = None,
-    response_example: Optional[Any] = None,
-    request_examples: Optional[List[Any]] = None,
-    response_examples: Optional[List[Any]] = None,
-) -> Callable[[T], T]:
-    """
-    Decorator that supplies additional metadata to an endpoint operation function.
-
-    :param route: The URL path pattern associated with this operation which path parameters are substituted into.
-    :param public: True if the operation can be invoked without prior authentication.
-    :param request_example: A sample request that the operation might take.
-    :param response_example: A sample response that the operation might produce.
-    :param request_examples: Sample requests that the operation might take. Pass a list of objects, not JSON.
-    :param response_examples: Sample responses that the operation might produce. Pass a list of objects, not JSON.
-    """
-
-    if request_example is not None and request_examples is not None:
-        raise ValueError("arguments `request_example` and `request_examples` are exclusive")
-    if response_example is not None and response_examples is not None:
-        raise ValueError("arguments `response_example` and `response_examples` are exclusive")
-
-    if request_example:
-        request_examples = [request_example]
-    if response_example:
-        response_examples = [response_example]
-
-    def wrap(cls: T) -> T:
-        setattr(
-            cls,
-            "__webmethod__",
-            WebMethod(
-                route=route,
-                public=public or False,
-                request_examples=request_examples,
-                response_examples=response_examples,
-            ),
-        )
-        return cls
-
-    return wrap
+__version__ = "0.3.0"
+__author__ = "Levente Hunyadi"
+__copyright__ = "Copyright 2021-2026, Levente Hunyadi"
+__license__ = "MIT"
+__maintainer__ = "Levente Hunyadi"
+__status__ = "Production"

pyopenapi/decorators.py

@@ -0,0 +1,58 @@
+"""
+Generate an OpenAPI specification from a Python class definition
+
+Copyright 2021-2026, Levente Hunyadi
+
+:see: https://github.com/hunyadi/pyopenapi
+"""
+
+from typing import Any, Callable, TypeVar
+
+from .metadata import WebMethod
+from .options import *  # noqa: F403
+from .utility import Specification as Specification
+
+F = TypeVar("F", bound=Callable[..., Any])
+
+
+def webmethod(
+    route: str | None = None,
+    public: bool = False,
+    deprecated: bool = False,
+    request_example: Any | None = None,
+    response_example: Any | None = None,
+    request_examples: list[Any] | None = None,
+    response_examples: list[Any] | None = None,
+) -> Callable[[F], F]:
+    """
+    Decorator that supplies additional metadata to an endpoint operation function.
+
+    :param route: The URL path pattern associated with this operation which path parameters are substituted into.
+    :param public: True if the operation can be invoked without prior authentication.
+    :param request_example: A sample request that the operation might take.
+    :param response_example: A sample response that the operation might produce.
+    :param request_examples: Sample requests that the operation might take. Pass a list of objects, not JSON.
+    :param response_examples: Sample responses that the operation might produce. Pass a list of objects, not JSON.
+    """
+
+    if request_example is not None and request_examples is not None:
+        raise ValueError("arguments `request_example` and `request_examples` are exclusive")
+    if response_example is not None and response_examples is not None:
+        raise ValueError("arguments `response_example` and `response_examples` are exclusive")
+
+    if request_example:
+        request_examples = [request_example]
+    if response_example:
+        response_examples = [response_example]
+
+    def wrap(cls: F) -> F:
+        cls.__webmethod__ = WebMethod(  # type: ignore[attr-defined]
+            route=route,
+            public=public or False,
+            deprecated=deprecated or False,
+            request_examples=request_examples,
+            response_examples=response_examples,
+        )
+        return cls
+
+    return wrap

pyopenapi/generator.py

@@ -1,16 +1,26 @@
+"""
+Generate an OpenAPI specification from a Python class definition
+
+Copyright 2021-2026, Levente Hunyadi
+
+:see: https://github.com/hunyadi/pyopenapi
+"""
+
 import dataclasses
 import hashlib
 import ipaddress
+import operator
 import typing
 from dataclasses import dataclass
+from functools import reduce
 from http import HTTPStatus
-from typing import Any, Callable, Dict, List, Optional, Set, Tuple, Union
+from typing import Any, Callable
 
-from strong_typing.core import JsonType
+from strong_typing.core import JsonType, Schema
 from strong_typing.docstring import Docstring, parse_type
-from strong_typing.inspection import is_generic_list, is_type_optional, is_type_union, unwrap_generic_list, unwrap_optional_type, unwrap_union_types
+from strong_typing.inspection import is_type_optional, is_type_union, unwrap_optional_type, unwrap_union_types
 from strong_typing.name import python_type_to_name
-from strong_typing.schema import JsonSchemaGenerator, Schema, SchemaOptions, get_schema_identifier, register_schema
+from strong_typing.schema import JsonSchemaGenerator, SchemaOptions, get_schema_identifier, register_schema
 from strong_typing.serialization import json_dump_string, object_to_json
 
 from .operations import EndpointOperation, HTTPMethod, get_endpoint_events, get_endpoint_operations
@@ -28,7 +38,6 @@ from .specification import (
     RequestBody,
     Response,
     ResponseRef,
-    SchemaOrRef,
     SchemaRef,
     Tag,
     TagGroup,
@@ -66,25 +75,24 @@ register_schema(
 def http_status_to_string(status_code: HTTPStatusCode) -> str:
     "Converts an HTTP status code to a string."
 
-    if isinstance(status_code, HTTPStatus):
-        return str(status_code.value)
-    elif isinstance(status_code, int):
-        return str(status_code)
-    elif isinstance(status_code, str):
-        return status_code
-    else:
-        raise TypeError("expected: HTTP status code")
+    match status_code:
+        case HTTPStatus():
+            return str(status_code.value)
+        case int():
+            return str(status_code)
+        case str():
+            return status_code
 
 
 class SchemaBuilder:
     schema_generator: JsonSchemaGenerator
-    schemas: Dict[str, Schema]
+    schemas: dict[str, Schema]
 
     def __init__(self, schema_generator: JsonSchemaGenerator) -> None:
         self.schema_generator = schema_generator
         self.schemas = {}
 
-    def classdef_to_schema(self, typ: type) -> Schema:
+    def classdef_to_schema(self, typ: type[Any]) -> Schema:
         """
         Converts a type to a JSON schema.
         For nested types found in the type hierarchy, adds the type to the schema registry in the OpenAPI specification section `components`.
@@ -98,12 +106,12 @@ class SchemaBuilder:
 
         return type_schema
 
-    def classdef_to_named_schema(self, name: str, typ: type) -> Schema:
+    def classdef_to_named_schema(self, name: str, typ: type[Any]) -> Schema:
         schema = self.classdef_to_schema(typ)
         self._add_ref(name, schema)
         return schema
 
-    def classdef_to_ref(self, typ: type) -> SchemaOrRef:
+    def classdef_to_ref(self, typ: type[Any]) -> Schema | SchemaRef:
         """
         Converts a type to a JSON schema, and if possible, returns a schema reference.
         For composite types (such as classes), adds the type to the schema registry in the OpenAPI specification section `components`.
@@ -137,35 +145,35 @@ class SchemaBuilder:
 
 class ContentBuilder:
     schema_builder: SchemaBuilder
-    schema_transformer: Optional[Callable[[SchemaOrRef], SchemaOrRef]]
-    sample_transformer: Optional[Callable[[JsonType], JsonType]]
+    schema_transformer: Callable[[Schema | SchemaRef], Schema | SchemaRef] | None
+    sample_transformer: Callable[[JsonType], JsonType] | None
 
     def __init__(
         self,
         schema_builder: SchemaBuilder,
-        schema_transformer: Optional[Callable[[SchemaOrRef], SchemaOrRef]] = None,
-        sample_transformer: Optional[Callable[[JsonType], JsonType]] = None,
+        schema_transformer: Callable[[Schema | SchemaRef], Schema | SchemaRef] | None = None,
+        sample_transformer: Callable[[JsonType], JsonType] | None = None,
     ) -> None:
         self.schema_builder = schema_builder
         self.schema_transformer = schema_transformer
         self.sample_transformer = sample_transformer
 
-    def build_content(self, payload_type: type, examples: Optional[List[Any]] = None) -> Dict[str, MediaType]:
+    def build_content(self, payload_type: type[Any], examples: list[Any] | None = None) -> dict[str, MediaType]:
         "Creates the content subtree for a request or response."
 
-        if is_generic_list(payload_type):
+        if typing.get_origin(payload_type) is list:
             media_type = "application/jsonl"
-            item_type = unwrap_generic_list(payload_type)
+            (item_type,) = typing.get_args(payload_type)  # unpack single tuple element
         else:
             media_type = "application/json"
             item_type = payload_type
 
         return {media_type: self.build_media_type(item_type, examples)}
 
-    def build_media_type(self, item_type: type, examples: Optional[List[Any]] = None) -> MediaType:
+    def build_media_type(self, item_type: type[Any], examples: list[Any] | None = None) -> MediaType:
         schema = self.schema_builder.classdef_to_ref(item_type)
         if self.schema_transformer:
-            schema_transformer: Callable[[SchemaOrRef], SchemaOrRef] = self.schema_transformer
+            schema_transformer: Callable[[Schema | SchemaRef], Schema | SchemaRef] = self.schema_transformer
             schema = schema_transformer(schema)
 
         if not examples:
@@ -179,12 +187,12 @@ class ContentBuilder:
             examples=self._build_examples(examples),
         )
 
-    def _build_examples(self, examples: List[Any]) -> Dict[str, Union[Example, ExampleRef]]:
+    def _build_examples(self, examples: list[Any]) -> dict[str, Example | ExampleRef]:
         "Creates a set of several examples for a media type."
 
         builder = ExampleBuilder(self.sample_transformer)
 
-        results: Dict[str, Union[Example, ExampleRef]] = {}
+        results: dict[str, Example | ExampleRef] = {}
         for example in examples:
             name, value = builder.get_named(example)
             results[name] = Example(value=value)
@@ -203,12 +211,12 @@ class ExampleBuilder:
 
     def __init__(
         self,
-        sample_transformer: Optional[Callable[[JsonType], JsonType]] = None,
+        sample_transformer: Callable[[JsonType], JsonType] | None = None,
     ) -> None:
         if sample_transformer:
             self.sample_transformer = sample_transformer
         else:
-            self.sample_transformer = lambda sample: sample  # noqa: E731
+            self.sample_transformer = lambda sample: sample
 
     def _get_value(self, example: Any) -> JsonType:
         return self.sample_transformer(object_to_json(example))
@@ -216,12 +224,12 @@ class ExampleBuilder:
     def get_anonymous(self, example: Any) -> JsonType:
         return self._get_value(example)
 
-    def get_named(self, example: Any) -> Tuple[str, JsonType]:
+    def get_named(self, example: Any) -> tuple[str, JsonType]:
         value = self._get_value(example)
 
-        name: Optional[str] = None
+        name: str | None = None
 
-        if type(example).__str__ is not object.__str__:
+        if type(example).__str__ is not object.__str__:  # type: ignore[comparison-overlap]
             friendly_name = str(example)
             if friendly_name.isprintable():
                 name = friendly_name
@@ -244,17 +252,17 @@ class ResponseOptions:
     :param default_status_code: HTTP status code assigned to responses that have no mapping.
     """
 
-    type_descriptions: Dict[type, str]
-    examples: Optional[List[Any]]
-    status_catalog: Dict[type, HTTPStatusCode]
+    type_descriptions: dict[type[Any], str]
+    examples: list[Any] | None
+    status_catalog: dict[type, HTTPStatusCode]
     default_status_code: HTTPStatusCode
 
 
 @dataclass
 class StatusResponse:
     status_code: str
-    types: List[type] = dataclasses.field(default_factory=list)
-    examples: List[Any] = dataclasses.field(default_factory=list)
+    types: list[type[Any]] = dataclasses.field(default_factory=list[type[Any]])
+    examples: list[Any] = dataclasses.field(default_factory=list[Any])
 
 
 class ResponseBuilder:
@@ -263,8 +271,8 @@ class ResponseBuilder:
     def __init__(self, content_builder: ContentBuilder) -> None:
         self.content_builder = content_builder
 
-    def _get_status_responses(self, options: ResponseOptions) -> Dict[str, StatusResponse]:
-        status_responses: Dict[str, StatusResponse] = {}
+    def _get_status_responses(self, options: ResponseOptions) -> dict[str, StatusResponse]:
+        status_responses: dict[str, StatusResponse] = {}
 
         for response_type in options.type_descriptions.keys():
             status_code = http_status_to_string(options.status_catalog.get(response_type, options.default_status_code))
@@ -283,20 +291,20 @@ class ResponseBuilder:
 
         return dict(sorted(status_responses.items()))
 
-    def build_response(self, options: ResponseOptions) -> Dict[str, Union[Response, ResponseRef]]:
+    def build_response(self, options: ResponseOptions) -> dict[str, Response | ResponseRef]:
         """
         Groups responses that have the same status code.
         """
 
-        responses: Dict[str, Union[Response, ResponseRef]] = {}
+        responses: dict[str, Response | ResponseRef] = {}
         status_responses = self._get_status_responses(options)
         for status_code, status_response in status_responses.items():
             response_types = tuple(status_response.types)
-            if len(response_types) > 1:
-                composite_response_type: type = Union[response_types]  # type: ignore
+            composite_response_type: type[Any] | None
+            if len(response_types) > 0:
+                composite_response_type = reduce(operator.or_, response_types)
             else:
-                (response_type,) = response_types
-                composite_response_type = response_type
+                composite_response_type = None
 
             description = " **OR** ".join(
                 filter(
@@ -315,9 +323,9 @@ class ResponseBuilder:
 
     def _build_response(
         self,
-        response_type: type,
+        response_type: type[Any] | None,
         description: str,
-        examples: Optional[List[Any]] = None,
+        examples: list[Any] | None = None,
     ) -> Response:
         "Creates a response subtree."
 
@@ -330,7 +338,7 @@ class ResponseBuilder:
             return Response(description=description)
 
 
-def schema_error_wrapper(schema: SchemaOrRef) -> Schema:
+def schema_error_wrapper(schema: Schema | SchemaRef) -> Schema:
     "Wraps an error output schema into a top-level error schema."
 
     return {
@@ -352,12 +360,12 @@ def sample_error_wrapper(error: JsonType) -> JsonType:
 
 
 class Generator:
-    endpoint: type
+    endpoint: type[Any]
     options: Options
     schema_builder: SchemaBuilder
-    responses: Dict[str, Response]
+    responses: dict[str, Response]
 
-    def __init__(self, endpoint: type, options: Options) -> None:
+    def __init__(self, endpoint: type[Any], options: Options) -> None:
         self.endpoint = endpoint
         self.options = options
         schema_generator = JsonSchemaGenerator(
@@ -372,24 +380,24 @@ class Generator:
 
     def _build_type_tag(self, ref: str, schema: Schema) -> Tag:
         definition = f'<SchemaDefinition schemaRef="#/components/schemas/{ref}" />'
-        title = typing.cast(str, schema.get("title"))
-        description = typing.cast(str, schema.get("description"))
+        title = typing.cast(str | None, schema.get("title"))
+        description = typing.cast(str | None, schema.get("description"))
         return Tag(
             name=ref,
             description="\n\n".join(s for s in (title, description, definition) if s is not None),
         )
 
-    def _build_extra_tag_groups(self, extra_types: Dict[str, List[type]]) -> Dict[str, List[Tag]]:
+    def _build_extra_tag_groups(self, extra_types: dict[str, list[type[Any]]]) -> dict[str, list[Tag]]:
         """
         Creates a dictionary of tag group captions as keys, and tag lists as values.
 
         :param extra_types: A dictionary of type categories and list of types in that category.
         """
 
-        extra_tags: Dict[str, List[Tag]] = {}
+        extra_tags: dict[str, list[Tag]] = {}
 
         for category_name, category_items in extra_types.items():
-            tag_list: List[Tag] = []
+            tag_list: list[Tag] = []
 
             for extra_type in category_items:
                 name = python_type_to_name(extra_type)
@@ -418,10 +426,10 @@ class Generator:
         ]
 
         # parameters passed in URL component query string
-        query_parameters = []
+        query_parameters: list[Parameter] = []
         for param_name, param_type in op.query_params:
             if is_type_optional(param_type):
-                inner_type: type = unwrap_optional_type(param_type)
+                inner_type: type[Any] = unwrap_optional_type(param_type)
                 required = False
             else:
                 inner_type = param_type
@@ -454,7 +462,9 @@ class Generator:
         # success response types
         if doc_string.returns is None and is_type_union(op.response_type):
             # split union of return types into a list of response types
-            success_type_docstring: Dict[type, Docstring] = {typing.cast(type, item): parse_type(item) for item in unwrap_union_types(op.response_type)}
+            success_type_docstring: dict[type[Any], Docstring] = {
+                typing.cast(type[Any], item): parse_type(item) for item in unwrap_union_types(op.response_type)
+            }
             success_type_descriptions = {
                 item: doc_string.short_description for item, doc_string in success_type_docstring.items() if doc_string.short_description
             }
@@ -477,7 +487,7 @@ class Generator:
 
         # failure response types
         if doc_string.raises:
-            exception_types: Dict[type, str] = {item.raise_type: item.description for item in doc_string.raises.values()}
+            exception_types: dict[type, str] = {item.raise_type: item.description for item in doc_string.raises.values()}
             exception_examples = [example for example in response_examples if isinstance(example, Exception)]
 
             if self.options.error_wrapper:
@@ -525,12 +535,13 @@ class Generator:
             requestBody=requestBody,
             responses=responses,
             callbacks=callbacks,
+            deprecated=op.deprecated,
             security=[] if op.public else None,
         )
 
     def generate(self) -> Document:
-        paths: Dict[str, PathItem] = {}
-        endpoint_classes: Set[type] = set()
+        paths: dict[str, PathItem] = {}
+        endpoint_classes: set[type[Any]] = set()
         for op in get_endpoint_operations(self.endpoint, use_examples=self.options.use_examples):
             endpoint_classes.add(op.defining_class)
 
@@ -555,9 +566,9 @@ class Generator:
             else:
                 paths[route] = pathItem
 
-        operation_tags: List[Tag] = []
+        operation_tags: list[Tag] = []
         for cls in endpoint_classes:
-            doc_string = parse_type(cls)
+            doc_string = parse_type(cls)  # type: ignore[arg-type]
             operation_tags.append(
                 Tag(
                     name=cls.__name__,
@@ -570,31 +581,30 @@ class Generator:
         type_tags = [self._build_type_tag(ref, schema) for ref, schema in self.schema_builder.schemas.items()]
 
         # types that are emitted by events
-        event_tags: List[Tag] = []
+        event_tags: list[Tag] = []
         events = get_endpoint_events(self.endpoint)
         for ref, event_type in events.items():
             event_schema = self.schema_builder.classdef_to_named_schema(ref, event_type)
             event_tags.append(self._build_type_tag(ref, event_schema))
 
         # types that are explicitly declared
-        extra_tag_groups: Dict[str, List[Tag]] = {}
+        extra_tag_groups: dict[str, list[Tag]] = {}
         if self.options.extra_types is not None:
-            if isinstance(self.options.extra_types, list):
-                extra_tag_groups = self._build_extra_tag_groups({"AdditionalTypes": self.options.extra_types})
-            elif isinstance(self.options.extra_types, dict):
-                extra_tag_groups = self._build_extra_tag_groups(self.options.extra_types)
-            else:
-                raise TypeError(f"type mismatch for collection of extra types: {type(self.options.extra_types)}")
+            match self.options.extra_types:
+                case list():
+                    extra_tag_groups = self._build_extra_tag_groups({"AdditionalTypes": self.options.extra_types})
+                case dict():
+                    extra_tag_groups = self._build_extra_tag_groups(self.options.extra_types)
 
         # list all operations and types
-        tags: List[Tag] = []
+        tags: list[Tag] = []
         tags.extend(operation_tags)
         tags.extend(type_tags)
         tags.extend(event_tags)
         for extra_tag_group in extra_tag_groups.values():
             tags.extend(extra_tag_group)
 
-        tag_groups = []
+        tag_groups: list[TagGroup] = []
         if operation_tags:
             tag_groups.append(
                 TagGroup(

pyopenapi/metadata.py

@@ -1,5 +1,13 @@
+"""
+Generate an OpenAPI specification from a Python class definition
+
+Copyright 2021-2026, Levente Hunyadi
+
+:see: https://github.com/hunyadi/pyopenapi
+"""
+
 from dataclasses import dataclass
-from typing import Any, List, Optional
+from typing import Any
 
 
 @dataclass
@@ -9,11 +17,13 @@ class WebMethod:
 
     :param route: The URL path pattern associated with this operation which path parameters are substituted into.
     :param public: True if the operation can be invoked without prior authentication.
+    :param deprecated: True if consumers should refrain from using the operation.
     :param request_examples: Sample requests that the operation might take. Pass a list of objects, not JSON.
     :param response_examples: Sample responses that the operation might produce. Pass a list of objects, not JSON.
     """
 
-    route: Optional[str] = None
+    route: str | None = None
     public: bool = False
-    request_examples: Optional[List[Any]] = None
-    response_examples: Optional[List[Any]] = None
+    deprecated: bool = False
+    request_examples: list[Any] | None = None
+    response_examples: list[Any] | None = None