python-openapi 0.1.9__tar.gz → 0.2.0__tar.gz

{python-openapi-0.1.9 → python_openapi-0.2.0}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021-2022 Levente Hunyadi
+Copyright (c) 2021-2025 Levente Hunyadi
 Copyright (c) 2021-2022 Instructure Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

python_openapi-0.2.0/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include tests *.py
+recursive-include tests *.md

{python-openapi-0.1.9 → python_openapi-0.2.0}/PKG-INFO

@@ -1,26 +1,32 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-openapi
-Version: 0.1.9
+Version: 0.2.0
 Summary: Generate an OpenAPI specification from a Python class definition
-Home-page: https://github.com/hunyadi/pyopenapi
-Author: Levente Hunyadi
-Author-email: hunyadi@gmail.com
-License: MIT
+Author-email: Levente Hunyadi <hunyadi@gmail.com>
+Maintainer-email: Levente Hunyadi <hunyadi@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/hunyadi/pyopenapi
+Project-URL: Source, https://github.com/hunyadi/pyopenapi
+Keywords: openapi3,openapi,redoc,swagger,json-schema-generator,dataclasses,type-inspection
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Software Development :: Code Generators
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: aiohttp>=3.12
+Requires-Dist: json_strong_typing>=0.3.9
+Dynamic: license-file
 
 # Generate an OpenAPI specification from a Python class
 
@@ -31,7 +37,7 @@ License-File: LICENSE
 * supports standard and asynchronous functions (`async def`)
 * maps function name prefixes such as `get_` or `create_` to HTTP GET, POST, PUT, DELETE, PATCH
 * handles both simple and composite types (`int`, `str`, `Enum`, `@dataclass`)
-* handles generic types (`List[T]`, `Dict[K, V]`, `Optional[T]`, `Union[T1, T2, T3]`)
+* handles generic types (`list[T]`, `dict[K, V]`, `Optional[T]`, `Union[T1, T2, T3]`)
 * maps Python positional-only and keyword-only arguments (of simple types) to path and query parameters, respectively
 * maps composite types to HTTP request body
 * supports user-defined routes, request and response samples with decorator `@webmethod`
@@ -84,7 +90,7 @@ Let's take a look at the definition of a simple endpoint called `JobManagement`:
 
 ```python
 class JobManagement:
-    def create_job(self, items: List[URL]) -> uuid.UUID:
+    def create_job(self, items: list[URL]) -> uuid.UUID:
         ...
 
     def get_job(self, job_id: uuid.UUID, /, format: Format) -> Job:
@@ -123,7 +129,7 @@ The custom path must have placeholders for all positional-only parameters in the
 
 ### Documenting operations
 
-Use Python ReST (ReStructured Text) doc-strings to attach documentation to operations: 
+Use Python ReST (ReStructured Text) doc-strings to attach documentation to operations:
 
 ```python
 def get_job(self, job_id: uuid.UUID, /, format: Format) -> Job:
@@ -166,7 +172,7 @@ The Python objects in `request_examples` and `response_examples` are translated
 
 ### Mapping function name prefixes to HTTP verbs
 
-The following table identifies which function name prefixes map to which HTTP verbs: 
+The following table identifies which function name prefixes map to which HTTP verbs:
 
 | Prefix | HTTP verb   |
 | ------ | ----------- |

{python-openapi-0.1.9 → python_openapi-0.2.0}/README.md

@@ -7,7 +7,7 @@
 * supports standard and asynchronous functions (`async def`)
 * maps function name prefixes such as `get_` or `create_` to HTTP GET, POST, PUT, DELETE, PATCH
 * handles both simple and composite types (`int`, `str`, `Enum`, `@dataclass`)
-* handles generic types (`List[T]`, `Dict[K, V]`, `Optional[T]`, `Union[T1, T2, T3]`)
+* handles generic types (`list[T]`, `dict[K, V]`, `Optional[T]`, `Union[T1, T2, T3]`)
 * maps Python positional-only and keyword-only arguments (of simple types) to path and query parameters, respectively
 * maps composite types to HTTP request body
 * supports user-defined routes, request and response samples with decorator `@webmethod`
@@ -60,7 +60,7 @@ Let's take a look at the definition of a simple endpoint called `JobManagement`:
 
 ```python
 class JobManagement:
-    def create_job(self, items: List[URL]) -> uuid.UUID:
+    def create_job(self, items: list[URL]) -> uuid.UUID:
         ...
 
     def get_job(self, job_id: uuid.UUID, /, format: Format) -> Job:
@@ -99,7 +99,7 @@ The custom path must have placeholders for all positional-only parameters in the
 
 ### Documenting operations
 
-Use Python ReST (ReStructured Text) doc-strings to attach documentation to operations: 
+Use Python ReST (ReStructured Text) doc-strings to attach documentation to operations:
 
 ```python
 def get_job(self, job_id: uuid.UUID, /, format: Format) -> Job:
@@ -142,7 +142,7 @@ The Python objects in `request_examples` and `response_examples` are translated
 
 ### Mapping function name prefixes to HTTP verbs
 
-The following table identifies which function name prefixes map to which HTTP verbs: 
+The following table identifies which function name prefixes map to which HTTP verbs:
 
 | Prefix | HTTP verb   |
 | ------ | ----------- |

python_openapi-0.2.0/pyopenapi/__init__.py

@@ -0,0 +1,14 @@
+"""
+Generate an OpenAPI specification from a Python class definition
+
+Copyright 2022-2025, Levente Hunyadi
+
+:see: https://github.com/hunyadi/pyopenapi
+"""
+
+__version__ = "0.2.0"
+__author__ = "Levente Hunyadi"
+__copyright__ = "Copyright 2022-2025, Levente Hunyadi"
+__license__ = "MIT"
+__maintainer__ = "Levente Hunyadi"
+__status__ = "Production"

python-openapi-0.1.9/pyopenapi/__init__.py → python_openapi-0.2.0/pyopenapi/decorators.py

@@ -1,12 +1,18 @@
+"""
+Generate an OpenAPI specification from a Python class definition
+
+Copyright 2022-2025, Levente Hunyadi
+
+:see: https://github.com/hunyadi/pyopenapi
+"""
+
 from typing import Any, Callable, Optional, TypeVar
 
 from .metadata import WebMethod
-from .options import *
-from .utility import Specification
-
-__version__ = "0.1.9"
+from .options import *  # noqa: F403
+from .utility import Specification as Specification
 
-T = TypeVar("T")
+F = TypeVar("F", bound=Callable[..., Any])
 
 
 def webmethod(
@@ -14,9 +20,9 @@ def webmethod(
     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]:
+    request_examples: Optional[list[Any]] = None,
+    response_examples: Optional[list[Any]] = None,
+) -> Callable[[F], F]:
     """
     Decorator that supplies additional metadata to an endpoint operation function.
 
@@ -29,30 +35,17 @@ def webmethod(
     """
 
     if request_example is not None and request_examples is not None:
-        raise ValueError(
-            "arguments `request_example` and `request_examples` are exclusive"
-        )
+        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"
-        )
+        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,
-            ),
-        )
+    def wrap(cls: F) -> F:
+        cls.__webmethod__ = WebMethod(route=route, public=public or False, request_examples=request_examples, response_examples=response_examples)  # type: ignore[attr-defined]
         return cls
 
     return wrap

{python-openapi-0.1.9 → python_openapi-0.2.0}/pyopenapi/generator.py

@@ -1,35 +1,28 @@
+"""
+Generate an OpenAPI specification from a Python class definition
+
+Copyright 2022-2025, Levente Hunyadi
+
+:see: https://github.com/hunyadi/pyopenapi
+"""
+
+import dataclasses
 import hashlib
 import ipaddress
 import typing
-from typing import Any, Dict, Set, Union
+from dataclasses import dataclass
+from http import HTTPStatus
+from typing import Any, Callable, Optional, Union
 
-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_generic_list, is_type_optional, is_type_union, unwrap_generic_list, 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,
-)
-from .options import *
+from .operations import EndpointOperation, HTTPMethod, get_endpoint_events, get_endpoint_operations
+from .options import HTTPStatusCode, Options
 from .specification import (
     Components,
     Document,
@@ -93,7 +86,7 @@ def http_status_to_string(status_code: HTTPStatusCode) -> str:
 
 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
@@ -165,9 +158,7 @@ class ContentBuilder:
         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, examples: Optional[list[Any]] = None) -> dict[str, MediaType]:
         "Creates the content subtree for a request or response."
 
         if is_generic_list(payload_type):
@@ -179,12 +170,10 @@ class ContentBuilder:
 
         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, examples: Optional[list[Any]] = None) -> MediaType:
         schema = self.schema_builder.classdef_to_ref(item_type)
         if self.schema_transformer:
-            schema_transformer: Callable[[SchemaOrRef], SchemaOrRef] = self.schema_transformer  # type: ignore
+            schema_transformer: Callable[[SchemaOrRef], SchemaOrRef] = self.schema_transformer
             schema = schema_transformer(schema)
 
         if not examples:
@@ -198,25 +187,14 @@ 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, Union[Example, ExampleRef]]:
         "Creates a set of several examples for a media type."
 
-        if self.sample_transformer:
-            sample_transformer: Callable[[JsonType], JsonType] = self.sample_transformer  # type: ignore
-        else:
-            sample_transformer = lambda sample: sample
+        builder = ExampleBuilder(self.sample_transformer)
 
-        results: Dict[str, Union[Example, ExampleRef]] = {}
+        results: dict[str, Union[Example, ExampleRef]] = {}
         for example in examples:
-            value = sample_transformer(object_to_json(example))
-
-            hash_string = (
-                hashlib.md5(json_dump_string(value).encode("utf-8")).digest().hex()
-            )
-            name = f"ex-{hash_string}"
-
+            name, value = builder.get_named(example)
             results[name] = Example(value=value)
 
         return results
@@ -224,12 +202,43 @@ class ContentBuilder:
     def _build_example(self, example: Any) -> Any:
         "Creates a single example for a media type."
 
-        if self.sample_transformer:
-            sample_transformer: Callable[[JsonType], JsonType] = self.sample_transformer  # type: ignore
+        builder = ExampleBuilder(self.sample_transformer)
+        return builder.get_anonymous(example)
+
+
+class ExampleBuilder:
+    sample_transformer: Callable[[JsonType], JsonType]
+
+    def __init__(
+        self,
+        sample_transformer: Optional[Callable[[JsonType], JsonType]] = None,
+    ) -> None:
+        if sample_transformer:
+            self.sample_transformer = sample_transformer
         else:
-            sample_transformer = lambda sample: sample
+            self.sample_transformer = lambda sample: sample
+
+    def _get_value(self, example: Any) -> JsonType:
+        return self.sample_transformer(object_to_json(example))
+
+    def get_anonymous(self, example: Any) -> JsonType:
+        return self._get_value(example)
+
+    def get_named(self, example: Any) -> tuple[str, JsonType]:
+        value = self._get_value(example)
 
-        return sample_transformer(object_to_json(example))
+        name: Optional[str] = None
+
+        if type(example).__str__ is not object.__str__:  # type: ignore[comparison-overlap]
+            friendly_name = str(example)
+            if friendly_name.isprintable():
+                name = friendly_name
+
+        if name is None:
+            hash_string = hashlib.md5(json_dump_string(value).encode("utf-8")).digest().hex()
+            name = f"ex-{hash_string}"
+
+        return name, value
 
 
 @dataclass
@@ -243,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, str]
+    examples: Optional[list[Any]]
+    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] = dataclasses.field(default_factory=list)
+    examples: list[Any] = dataclasses.field(default_factory=list)
 
 
 class ResponseBuilder:
@@ -262,15 +271,11 @@ 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)
-            )
+            status_code = http_status_to_string(options.status_catalog.get(response_type, options.default_status_code))
 
             # look up response for status code
             if status_code not in status_responses:
@@ -282,22 +287,16 @@ class ResponseBuilder:
 
             # append examples that have the matching response type
             if options.examples:
-                status_response.examples.extend(
-                    example
-                    for example in options.examples
-                    if isinstance(example, response_type)
-                )
+                status_response.examples.extend(example for example in options.examples if isinstance(example, response_type))
 
         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, Union[Response, ResponseRef]]:
         """
         Groups responses that have the same status code.
         """
 
-        responses: Dict[str, Union[Response, ResponseRef]] = {}
+        responses: dict[str, Union[Response, ResponseRef]] = {}
         status_responses = self._get_status_responses(options)
         for status_code, status_response in status_responses.items():
             response_types = tuple(status_response.types)
@@ -310,10 +309,7 @@ class ResponseBuilder:
             description = " **OR** ".join(
                 filter(
                     None,
-                    (
-                        options.type_descriptions[response_type]
-                        for response_type in response_types
-                    ),
+                    (options.type_descriptions[response_type] for response_type in response_types),
                 )
             )
 
@@ -327,9 +323,9 @@ class ResponseBuilder:
 
     def _build_response(
         self,
-        response_type: type,
+        response_type: Optional[type],
         description: str,
-        examples: Optional[List[Any]] = None,
+        examples: Optional[list[Any]] = None,
     ) -> Response:
         "Creates a response subtree."
 
@@ -367,7 +363,7 @@ class Generator:
     endpoint: type
     options: Options
     schema_builder: SchemaBuilder
-    responses: Dict[str, Response]
+    responses: dict[str, Response]
 
     def __init__(self, endpoint: type, options: Options) -> None:
         self.endpoint = endpoint
@@ -388,24 +384,20 @@ class Generator:
         description = typing.cast(str, schema.get("description"))
         return Tag(
             name=ref,
-            description="\n\n".join(
-                s for s in (title, description, definition) if s is not None
-            ),
+            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]]) -> 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)
@@ -419,9 +411,7 @@ class Generator:
 
     def _build_operation(self, op: EndpointOperation) -> Operation:
         doc_string = parse_type(op.func_ref)
-        doc_params = dict(
-            (param.name, param.description) for param in doc_string.params.values()
-        )
+        doc_params = dict((param.name, param.description) for param in doc_string.params.values())
 
         # parameters passed in URL component path
         path_parameters = [
@@ -462,11 +452,7 @@ class Generator:
             builder = ContentBuilder(self.schema_builder)
             request_name, request_type = op.request_param
             requestBody = RequestBody(
-                content={
-                    "application/json": builder.build_media_type(
-                        request_type, op.request_examples
-                    )
-                },
+                content={"application/json": builder.build_media_type(request_type, op.request_examples)},
                 description=doc_params.get(request_name),
                 required=True,
             )
@@ -476,29 +462,16 @@ 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, Docstring] = {typing.cast(type, 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
+                item: doc_string.short_description for item, doc_string in success_type_docstring.items() if doc_string.short_description
             }
         else:
             # use return type as a single response type
-            success_type_descriptions = {
-                op.response_type: (
-                    doc_string.returns.description if doc_string.returns else "OK"
-                )
-            }
+            success_type_descriptions = {op.response_type: (doc_string.returns.description if doc_string.returns else "OK")}
 
         response_examples = op.response_examples or []
-        success_examples = [
-            example
-            for example in response_examples
-            if not isinstance(example, Exception)
-        ]
+        success_examples = [example for example in response_examples if not isinstance(example, Exception)]
 
         content_builder = ContentBuilder(self.schema_builder)
         response_builder = ResponseBuilder(content_builder)
@@ -512,14 +485,8 @@ 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_examples = [
-                example
-                for example in response_examples
-                if isinstance(example, Exception)
-            ]
+            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:
                 schema_transformer = schema_error_wrapper
@@ -548,9 +515,7 @@ class Generator:
                 f"{op.func_name}_callback": {
                     "{$request.query.callback}": PathItem(
                         post=Operation(
-                            requestBody=RequestBody(
-                                content=builder.build_content(op.event_type)
-                            ),
+                            requestBody=RequestBody(content=builder.build_content(op.event_type)),
                             responses={"200": Response(description="OK")},
                         )
                     )
@@ -572,11 +537,9 @@ class Generator:
         )
 
     def generate(self) -> Document:
-        paths: Dict[str, PathItem] = {}
-        endpoint_classes: Set[type] = set()
-        for op in get_endpoint_operations(
-            self.endpoint, use_examples=self.options.use_examples
-        ):
+        paths: dict[str, PathItem] = {}
+        endpoint_classes: set[type] = set()
+        for op in get_endpoint_operations(self.endpoint, use_examples=self.options.use_examples):
             endpoint_classes.add(op.defining_class)
 
             operation = self._build_operation(op)
@@ -600,7 +563,7 @@ class Generator:
             else:
                 paths[route] = pathItem
 
-        operation_tags: List[Tag] = []
+        operation_tags: list[Tag] = []
         for cls in endpoint_classes:
             doc_string = parse_type(cls)
             operation_tags.append(
@@ -612,36 +575,27 @@ class Generator:
             )
 
         # types that are produced/consumed by operations
-        type_tags = [
-            self._build_type_tag(ref, schema)
-            for ref, schema in self.schema_builder.schemas.items()
-        ]
+        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}
-                )
+                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
-                )
+                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)}"
-                )
+                raise TypeError(f"type mismatch for collection of extra types: {type(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)
@@ -686,11 +640,7 @@ class Generator:
         return Document(
             openapi=".".join(str(item) for item in self.options.version),
             info=self.options.info,
-            jsonSchemaDialect=(
-                "https://json-schema.org/draft/2020-12/schema"
-                if self.options.version >= (3, 1, 0)
-                else None
-            ),
+            jsonSchemaDialect=("https://json-schema.org/draft/2020-12/schema" if self.options.version >= (3, 1, 0) else None),
             servers=[self.options.server],
             paths=paths,
             components=Components(