Fix miscellaneous issues reported by static type checker

Author: hunyadi

.vscode/settings.json

@@ -15,6 +15,7 @@
         "editor.defaultFormatter": "charliermarsh.ruff"
     },
     "cSpell.words": [
+        "Levente",
         "pyopenapi",
         "pypi",
         "Sigstore",

MANIFEST.in

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

check.bat

@@ -0,0 +1,16 @@
+@echo off
+
+rem Run static type checker and verify formatting guidelines
+ruff check
+if errorlevel 1 goto error
+ruff format --check
+if errorlevel 1 goto error
+python -m mypy pyopenapi
+if errorlevel 1 goto error
+python -m mypy tests
+if errorlevel 1 goto error
+
+goto :EOF
+
+:error
+exit /b 1

check.sh

@@ -0,0 +1,9 @@
+set -e
+
+PYTHON=python3
+
+# Run static type checker and verify formatting guidelines
+ruff check
+ruff format --check
+$PYTHON -m mypy pyopenapi
+$PYTHON -m mypy tests

mypy.ini

@@ -5,5 +5,10 @@ disallow_untyped_decorators = True
 disallow_untyped_defs = True
 ignore_missing_imports = True
 show_column_numbers = True
+strict = True
+strict_bytes = True
+strict_equality = True
 warn_redundant_casts = True
+warn_return_any = True
+warn_unreachable = True
 warn_unused_ignores = True

pyopenapi/__init__.py

@@ -1,54 +1,14 @@
-from typing import Any, Callable, 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 2022-2025, Levente Hunyadi
 
-__version__ = "0.1.10"
-
-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.
-    """
+:see: https://github.com/hunyadi/pyopenapi
+"""
 
-    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.1.10"
+__author__ = "Levente Hunyadi"
+__copyright__ = "Copyright 2022-2025, Levente Hunyadi"
+__license__ = "MIT"
+__maintainer__ = "Levente Hunyadi"
+__status__ = "Production"

pyopenapi/decorators.py

@@ -0,0 +1,51 @@
+"""
+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 *  # noqa: F403
+from .utility import Specification as Specification
+
+F = TypeVar("F", bound=Callable[..., Any])
+
+
+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[[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(route=route, public=public or False, request_examples=request_examples, response_examples=response_examples)  # type: ignore[attr-defined]
+        return cls
+
+    return wrap

pyopenapi/generator.py

@@ -1,3 +1,11 @@
+"""
+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
@@ -6,11 +14,11 @@
 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.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
@@ -208,7 +216,7 @@ def __init__(
         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))
@@ -221,7 +229,7 @@ def get_named(self, example: Any) -> tuple[str, JsonType]:
 
         name: Optional[str] = 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
@@ -315,7 +323,7 @@ def build_response(self, options: ResponseOptions) -> dict[str, Union[Response,
 
     def _build_response(
         self,
-        response_type: type,
+        response_type: Optional[type],
         description: str,
         examples: Optional[list[Any]] = None,
     ) -> Response:

pyopenapi/metadata.py

@@ -1,3 +1,11 @@
+"""
+Generate an OpenAPI specification from a Python class definition
+
+Copyright 2022-2025, Levente Hunyadi
+
+:see: https://github.com/hunyadi/pyopenapi
+"""
+
 from dataclasses import dataclass
 from typing import Any, Optional
 

pyopenapi/operations.py

@@ -1,3 +1,11 @@
+"""
+Generate an OpenAPI specification from a Python class definition
+
+Copyright 2022-2025, Levente Hunyadi
+
+:see: https://github.com/hunyadi/pyopenapi
+"""
+
 import collections.abc
 import enum
 import inspect
@@ -34,11 +42,11 @@ def split_prefix(s: str, sep: str, prefix: Union[str, Iterable[str]]) -> tuple[O
     return None, s
 
 
-def _get_annotation_type(annotation: Union[type, str], callable: Callable) -> type:
-    "Maps a stringized reference to a type, as if using `from __future__ import annotations`."
+def _get_annotation_type(annotation: Union[type, str], callable: Callable[..., Any]) -> type:
+    "Maps a string (forward) reference to a type, as if using `from __future__ import annotations`."
 
     if isinstance(annotation, str):
-        return eval(annotation, callable.__globals__)
+        return typing.cast(type, eval(annotation, callable.__globals__))
     else:
         return annotation
 
@@ -108,7 +116,7 @@ def get_route(self) -> str:
 
 
 class _FormatParameterExtractor:
-    "A visitor to exract parameters in a format string."
+    "A visitor to extract parameters in a format string."
 
     keys: list[str]
 
@@ -126,7 +134,7 @@ def _get_route_parameters(route: str) -> list[str]:
     return extractor.keys
 
 
-def _get_endpoint_functions(endpoint: type, prefixes: list[str]) -> Iterator[tuple[str, str, str, Callable]]:
+def _get_endpoint_functions(endpoint: type, prefixes: list[str]) -> Iterator[tuple[str, str, str, Callable[..., Any]]]:
     if not inspect.isclass(endpoint):
         raise ValidationError(f"object is not a class type: {endpoint}")
 
@@ -247,7 +255,8 @@ async def get_object(self, uuid: str, version: int) -> Object:
                 if request_param is not None:
                     param = (param_name, param_type)
                     raise ValidationError(
-                        f"only a single composite type is permitted in a signature but multiple composite types found in function '{func_name}': {request_param} and {param}"
+                        f"only a single composite type is permitted in a signature but multiple composite types found in function '{func_name}': "
+                        f"{request_param} and {param}"
                     )
 
                 # composite types are read from body