fastapi 0.96.1__py3-none-any.whl → 0.100.0b1__py3-none-any.whl

fastapi/openapi/utils.py

@@ -1,32 +1,32 @@
 import http.client
 import inspect
 import warnings
-from enum import Enum
 from typing import Any, Dict, List, Optional, Sequence, Set, Tuple, Type, Union, cast
 
 from fastapi import routing
+from fastapi._compat import (
+    GenerateJsonSchema,
+    ModelField,
+    Undefined,
+    get_compat_model_name_map,
+    get_definitions,
+    get_schema_from_model_field,
+    lenient_issubclass,
+)
 from fastapi.datastructures import DefaultPlaceholder
 from fastapi.dependencies.models import Dependant
 from fastapi.dependencies.utils import get_flat_dependant, get_flat_params
 from fastapi.encoders import jsonable_encoder
-from fastapi.openapi.constants import METHODS_WITH_BODY, REF_PREFIX
+from fastapi.openapi.constants import METHODS_WITH_BODY, REF_PREFIX, REF_TEMPLATE
 from fastapi.openapi.models import OpenAPI
 from fastapi.params import Body, Param
 from fastapi.responses import Response
+from fastapi.types import ModelNameMap
 from fastapi.utils import (
     deep_dict_update,
     generate_operation_id_for_path,
-    get_model_definitions,
     is_body_allowed_for_status_code,
 )
-from pydantic import BaseModel
-from pydantic.fields import ModelField, Undefined
-from pydantic.schema import (
-    field_schema,
-    get_flat_models_from_fields,
-    get_model_name_map,
-)
-from pydantic.utils import lenient_issubclass
 from starlette.responses import JSONResponse
 from starlette.routing import BaseRoute
 from starlette.status import HTTP_422_UNPROCESSABLE_ENTITY
@@ -88,7 +88,8 @@ def get_openapi_security_definitions(
 def get_openapi_operation_parameters(
     *,
     all_route_params: Sequence[ModelField],
-    model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],
+    schema_generator: GenerateJsonSchema,
+    model_name_map: ModelNameMap,
 ) -> List[Dict[str, Any]]:
     parameters = []
     for param in all_route_params:
@@ -96,13 +97,16 @@ def get_openapi_operation_parameters(
         field_info = cast(Param, field_info)
         if not field_info.include_in_schema:
             continue
+        param_schema = get_schema_from_model_field(
+            field=param,
+            schema_generator=schema_generator,
+            model_name_map=model_name_map,
+        )
         parameter = {
             "name": param.alias,
             "in": field_info.in_.value,
             "required": param.required,
-            "schema": field_schema(
-                param, model_name_map=model_name_map, ref_prefix=REF_PREFIX
-            )[0],
+            "schema": param_schema,
         }
         if field_info.description:
             parameter["description"] = field_info.description
@@ -119,13 +123,16 @@ def get_openapi_operation_parameters(
 def get_openapi_operation_request_body(
     *,
     body_field: Optional[ModelField],
-    model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],
+    schema_generator: GenerateJsonSchema,
+    model_name_map: ModelNameMap,
 ) -> Optional[Dict[str, Any]]:
     if not body_field:
         return None
     assert isinstance(body_field, ModelField)
-    body_schema, _, _ = field_schema(
-        body_field, model_name_map=model_name_map, ref_prefix=REF_PREFIX
+    body_schema = get_schema_from_model_field(
+        field=body_field,
+        schema_generator=schema_generator,
+        model_name_map=model_name_map,
     )
     field_info = cast(Body, body_field.field_info)
     request_media_type = field_info.media_type
@@ -181,7 +188,7 @@ def get_openapi_operation_metadata(
         file_name = getattr(route.endpoint, "__globals__", {}).get("__file__")
         if file_name:
             message += f" at {file_name}"
-        warnings.warn(message)
+        warnings.warn(message, stacklevel=1)
     operation_ids.add(operation_id)
     operation["operationId"] = operation_id
     if route.deprecated:
@@ -190,7 +197,11 @@ def get_openapi_operation_metadata(
 
 
 def get_openapi_path(
-    *, route: routing.APIRoute, model_name_map: Dict[type, str], operation_ids: Set[str]
+    *,
+    route: routing.APIRoute,
+    operation_ids: Set[str],
+    schema_generator: GenerateJsonSchema,
+    model_name_map: ModelNameMap,
 ) -> Tuple[Dict[str, Any], Dict[str, Any], Dict[str, Any]]:
     path = {}
     security_schemes: Dict[str, Any] = {}
@@ -218,7 +229,9 @@ def get_openapi_path(
                 security_schemes.update(security_definitions)
             all_route_params = get_flat_params(route.dependant)
             operation_parameters = get_openapi_operation_parameters(
-                all_route_params=all_route_params, model_name_map=model_name_map
+                all_route_params=all_route_params,
+                schema_generator=schema_generator,
+                model_name_map=model_name_map,
             )
             parameters.extend(operation_parameters)
             if parameters:
@@ -236,7 +249,9 @@ def get_openapi_path(
                 operation["parameters"] = list(all_parameters.values())
             if method in METHODS_WITH_BODY:
                 request_body_oai = get_openapi_operation_request_body(
-                    body_field=route.body_field, model_name_map=model_name_map
+                    body_field=route.body_field,
+                    schema_generator=schema_generator,
+                    model_name_map=model_name_map,
                 )
                 if request_body_oai:
                     operation["requestBody"] = request_body_oai
@@ -250,8 +265,9 @@ def get_openapi_path(
                             cb_definitions,
                         ) = get_openapi_path(
                             route=callback,
-                            model_name_map=model_name_map,
                             operation_ids=operation_ids,
+                            schema_generator=schema_generator,
+                            model_name_map=model_name_map,
                         )
                         callbacks[callback.name] = {callback.path: cb_path}
                 operation["callbacks"] = callbacks
@@ -277,10 +293,10 @@ def get_openapi_path(
                 response_schema = {"type": "string"}
                 if lenient_issubclass(current_response_class, JSONResponse):
                     if route.response_field:
-                        response_schema, _, _ = field_schema(
-                            route.response_field,
+                        response_schema = get_schema_from_model_field(
+                            field=route.response_field,
+                            schema_generator=schema_generator,
                             model_name_map=model_name_map,
-                            ref_prefix=REF_PREFIX,
                         )
                     else:
                         response_schema = {}
@@ -309,8 +325,10 @@ def get_openapi_path(
                     field = route.response_fields.get(additional_status_code)
                     additional_field_schema: Optional[Dict[str, Any]] = None
                     if field:
-                        additional_field_schema, _, _ = field_schema(
-                            field, model_name_map=model_name_map, ref_prefix=REF_PREFIX
+                        additional_field_schema = get_schema_from_model_field(
+                            field=field,
+                            schema_generator=schema_generator,
+                            model_name_map=model_name_map,
                         )
                         media_type = route_response_media_type or "application/json"
                         additional_schema = (
@@ -332,10 +350,8 @@ def get_openapi_path(
                     openapi_response["description"] = description
             http422 = str(HTTP_422_UNPROCESSABLE_ENTITY)
             if (all_route_params or route.body_field) and not any(
-                [
-                    status in operation["responses"]
-                    for status in [http422, "4XX", "default"]
-                ]
+                status in operation["responses"]
+                for status in [http422, "4XX", "default"]
             ):
                 operation["responses"][http422] = {
                     "description": "Validation Error",
@@ -358,13 +374,13 @@ def get_openapi_path(
     return path, security_schemes, definitions
 
 
-def get_flat_models_from_routes(
+def get_fields_from_routes(
     routes: Sequence[BaseRoute],
-) -> Set[Union[Type[BaseModel], Type[Enum]]]:
+) -> List[ModelField]:
     body_fields_from_routes: List[ModelField] = []
     responses_from_routes: List[ModelField] = []
     request_fields_from_routes: List[ModelField] = []
-    callback_flat_models: Set[Union[Type[BaseModel], Type[Enum]]] = set()
+    callback_flat_models: List[ModelField] = []
     for route in routes:
         if getattr(route, "include_in_schema", None) and isinstance(
             route, routing.APIRoute
@@ -379,13 +395,12 @@ def get_flat_models_from_routes(
             if route.response_fields:
                 responses_from_routes.extend(route.response_fields.values())
             if route.callbacks:
-                callback_flat_models |= get_flat_models_from_routes(route.callbacks)
+                callback_flat_models.extend(get_fields_from_routes(route.callbacks))
             params = get_flat_params(route.dependant)
             request_fields_from_routes.extend(params)
 
-    flat_models = callback_flat_models | get_flat_models_from_fields(
-        body_fields_from_routes + responses_from_routes + request_fields_from_routes,
-        known_models=set(),
+    flat_models = callback_flat_models + list(
+        body_fields_from_routes + responses_from_routes + request_fields_from_routes
     )
     return flat_models
 
@@ -418,15 +433,21 @@ def get_openapi(
     components: Dict[str, Dict[str, Any]] = {}
     paths: Dict[str, Dict[str, Any]] = {}
     operation_ids: Set[str] = set()
-    flat_models = get_flat_models_from_routes(routes)
-    model_name_map = get_model_name_map(flat_models)
-    definitions = get_model_definitions(
-        flat_models=flat_models, model_name_map=model_name_map
+    all_fields = get_fields_from_routes(routes)
+    model_name_map = get_compat_model_name_map(all_fields)
+    schema_generator = GenerateJsonSchema(ref_template=REF_TEMPLATE)
+    definitions = get_definitions(
+        fields=all_fields,
+        schema_generator=schema_generator,
+        model_name_map=model_name_map,
     )
     for route in routes:
         if isinstance(route, routing.APIRoute):
             result = get_openapi_path(
-                route=route, model_name_map=model_name_map, operation_ids=operation_ids
+                route=route,
+                operation_ids=operation_ids,
+                schema_generator=schema_generator,
+                model_name_map=model_name_map,
             )
             if result:
                 path, security_schemes, path_definitions = result

fastapi/param_functions.py

@@ -1,7 +1,7 @@
 from typing import Any, Callable, Dict, Optional, Sequence
 
 from fastapi import params
-from pydantic.fields import Undefined
+from fastapi._compat import Undefined
 
 
 def Path(  # noqa: N802
@@ -16,6 +16,7 @@ def Path(  # noqa: N802
     le: Optional[float] = None,
     min_length: Optional[int] = None,
     max_length: Optional[int] = None,
+    pattern: Optional[str] = None,
     regex: Optional[str] = None,
     example: Any = Undefined,
     examples: Optional[Dict[str, Any]] = None,
@@ -34,6 +35,7 @@ def Path(  # noqa: N802
         le=le,
         min_length=min_length,
         max_length=max_length,
+        pattern=pattern,
         regex=regex,
         example=example,
         examples=examples,
@@ -55,6 +57,7 @@ def Query(  # noqa: N802
     le: Optional[float] = None,
     min_length: Optional[int] = None,
     max_length: Optional[int] = None,
+    pattern: Optional[str] = None,
     regex: Optional[str] = None,
     example: Any = Undefined,
     examples: Optional[Dict[str, Any]] = None,
@@ -73,6 +76,7 @@ def Query(  # noqa: N802
         le=le,
         min_length=min_length,
         max_length=max_length,
+        pattern=pattern,
         regex=regex,
         example=example,
         examples=examples,
@@ -95,6 +99,7 @@ def Header(  # noqa: N802
     le: Optional[float] = None,
     min_length: Optional[int] = None,
     max_length: Optional[int] = None,
+    pattern: Optional[str] = None,
     regex: Optional[str] = None,
     example: Any = Undefined,
     examples: Optional[Dict[str, Any]] = None,
@@ -114,6 +119,7 @@ def Header(  # noqa: N802
         le=le,
         min_length=min_length,
         max_length=max_length,
+        pattern=pattern,
         regex=regex,
         example=example,
         examples=examples,
@@ -135,6 +141,7 @@ def Cookie(  # noqa: N802
     le: Optional[float] = None,
     min_length: Optional[int] = None,
     max_length: Optional[int] = None,
+    pattern: Optional[str] = None,
     regex: Optional[str] = None,
     example: Any = Undefined,
     examples: Optional[Dict[str, Any]] = None,
@@ -153,6 +160,7 @@ def Cookie(  # noqa: N802
         le=le,
         min_length=min_length,
         max_length=max_length,
+        pattern=pattern,
         regex=regex,
         example=example,
         examples=examples,
@@ -176,6 +184,7 @@ def Body(  # noqa: N802
     le: Optional[float] = None,
     min_length: Optional[int] = None,
     max_length: Optional[int] = None,
+    pattern: Optional[str] = None,
     regex: Optional[str] = None,
     example: Any = Undefined,
     examples: Optional[Dict[str, Any]] = None,
@@ -194,6 +203,7 @@ def Body(  # noqa: N802
         le=le,
         min_length=min_length,
         max_length=max_length,
+        pattern=pattern,
         regex=regex,
         example=example,
         examples=examples,
@@ -214,6 +224,7 @@ def Form(  # noqa: N802
     le: Optional[float] = None,
     min_length: Optional[int] = None,
     max_length: Optional[int] = None,
+    pattern: Optional[str] = None,
     regex: Optional[str] = None,
     example: Any = Undefined,
     examples: Optional[Dict[str, Any]] = None,
@@ -231,6 +242,7 @@ def Form(  # noqa: N802
         le=le,
         min_length=min_length,
         max_length=max_length,
+        pattern=pattern,
         regex=regex,
         example=example,
         examples=examples,
@@ -251,6 +263,7 @@ def File(  # noqa: N802
     le: Optional[float] = None,
     min_length: Optional[int] = None,
     max_length: Optional[int] = None,
+    pattern: Optional[str] = None,
     regex: Optional[str] = None,
     example: Any = Undefined,
     examples: Optional[Dict[str, Any]] = None,
@@ -268,6 +281,7 @@ def File(  # noqa: N802
         le=le,
         min_length=min_length,
         max_length=max_length,
+        pattern=pattern,
         regex=regex,
         example=example,
         examples=examples,

fastapi/params.py

@@ -1,7 +1,9 @@
 from enum import Enum
-from typing import Any, Callable, Dict, Optional, Sequence
+from typing import Any, Callable, Dict, Optional, Sequence, Type
 
-from pydantic.fields import FieldInfo, Undefined
+from pydantic.fields import FieldInfo
+
+from ._compat import PYDANTIC_V2, Undefined
 
 
 class ParamTypes(Enum):
@@ -18,6 +20,7 @@ class Param(FieldInfo):
         self,
         default: Any = Undefined,
         *,
+        annotation: Optional[Type[Any]] = None,
         alias: Optional[str] = None,
         title: Optional[str] = None,
         description: Optional[str] = None,
@@ -27,6 +30,7 @@ class Param(FieldInfo):
         le: Optional[float] = None,
         min_length: Optional[int] = None,
         max_length: Optional[int] = None,
+        pattern: Optional[str] = None,
         regex: Optional[str] = None,
         example: Any = Undefined,
         examples: Optional[Dict[str, Any]] = None,
@@ -36,9 +40,8 @@ class Param(FieldInfo):
     ):
         self.deprecated = deprecated
         self.example = example
-        self.examples = examples
         self.include_in_schema = include_in_schema
-        super().__init__(
+        kwargs = dict(
             default=default,
             alias=alias,
             title=title,
@@ -49,9 +52,19 @@ class Param(FieldInfo):
             le=le,
             min_length=min_length,
             max_length=max_length,
-            regex=regex,
             **extra,
         )
+        if PYDANTIC_V2:
+            kwargs["annotation"] = annotation
+            kwargs["pattern"] = pattern or regex
+        else:
+            # TODO: pv2 figure out how to deprecate regex
+            kwargs["regex"] = pattern or regex
+
+        super().__init__(**kwargs)
+        # TODO: pv2 decide how to handle OpenAPI examples vs JSON Schema examples
+        # and how to deprecate OpenAPI examples
+        self.examples = examples  # type: ignore[assignment]
 
     def __repr__(self) -> str:
         return f"{self.__class__.__name__}({self.default})"
@@ -64,6 +77,7 @@ class Path(Param):
         self,
         default: Any = ...,
         *,
+        annotation: Optional[Type[Any]] = None,
         alias: Optional[str] = None,
         title: Optional[str] = None,
         description: Optional[str] = None,
@@ -73,6 +87,7 @@ class Path(Param):
         le: Optional[float] = None,
         min_length: Optional[int] = None,
         max_length: Optional[int] = None,
+        pattern: Optional[str] = None,
         regex: Optional[str] = None,
         example: Any = Undefined,
         examples: Optional[Dict[str, Any]] = None,
@@ -84,6 +99,7 @@ class Path(Param):
         self.in_ = self.in_
         super().__init__(
             default=default,
+            annotation=annotation,
             alias=alias,
             title=title,
             description=description,
@@ -93,6 +109,7 @@ class Path(Param):
             le=le,
             min_length=min_length,
             max_length=max_length,
+            pattern=pattern,
             regex=regex,
             deprecated=deprecated,
             example=example,
@@ -109,6 +126,7 @@ class Query(Param):
         self,
         default: Any = Undefined,
         *,
+        annotation: Optional[Type[Any]] = None,
         alias: Optional[str] = None,
         title: Optional[str] = None,
         description: Optional[str] = None,
@@ -118,6 +136,7 @@ class Query(Param):
         le: Optional[float] = None,
         min_length: Optional[int] = None,
         max_length: Optional[int] = None,
+        pattern: Optional[str] = None,
         regex: Optional[str] = None,
         example: Any = Undefined,
         examples: Optional[Dict[str, Any]] = None,
@@ -127,6 +146,7 @@ class Query(Param):
     ):
         super().__init__(
             default=default,
+            annotation=annotation,
             alias=alias,
             title=title,
             description=description,
@@ -136,6 +156,7 @@ class Query(Param):
             le=le,
             min_length=min_length,
             max_length=max_length,
+            pattern=pattern,
             regex=regex,
             deprecated=deprecated,
             example=example,
@@ -152,6 +173,7 @@ class Header(Param):
         self,
         default: Any = Undefined,
         *,
+        annotation: Optional[Type[Any]] = None,
         alias: Optional[str] = None,
         convert_underscores: bool = True,
         title: Optional[str] = None,
@@ -162,6 +184,7 @@ class Header(Param):
         le: Optional[float] = None,
         min_length: Optional[int] = None,
         max_length: Optional[int] = None,
+        pattern: Optional[str] = None,
         regex: Optional[str] = None,
         example: Any = Undefined,
         examples: Optional[Dict[str, Any]] = None,
@@ -172,6 +195,7 @@ class Header(Param):
         self.convert_underscores = convert_underscores
         super().__init__(
             default=default,
+            annotation=annotation,
             alias=alias,
             title=title,
             description=description,
@@ -181,6 +205,7 @@ class Header(Param):
             le=le,
             min_length=min_length,
             max_length=max_length,
+            pattern=pattern,
             regex=regex,
             deprecated=deprecated,
             example=example,
@@ -197,6 +222,7 @@ class Cookie(Param):
         self,
         default: Any = Undefined,
         *,
+        annotation: Optional[Type[Any]] = None,
         alias: Optional[str] = None,
         title: Optional[str] = None,
         description: Optional[str] = None,
@@ -206,6 +232,7 @@ class Cookie(Param):
         le: Optional[float] = None,
         min_length: Optional[int] = None,
         max_length: Optional[int] = None,
+        pattern: Optional[str] = None,
         regex: Optional[str] = None,
         example: Any = Undefined,
         examples: Optional[Dict[str, Any]] = None,
@@ -215,6 +242,7 @@ class Cookie(Param):
     ):
         super().__init__(
             default=default,
+            annotation=annotation,
             alias=alias,
             title=title,
             description=description,
@@ -224,6 +252,7 @@ class Cookie(Param):
             le=le,
             min_length=min_length,
             max_length=max_length,
+            pattern=pattern,
             regex=regex,
             deprecated=deprecated,
             example=example,
@@ -238,6 +267,7 @@ class Body(FieldInfo):
         self,
         default: Any = Undefined,
         *,
+        annotation: Optional[Type[Any]] = None,
         embed: bool = False,
         media_type: str = "application/json",
         alias: Optional[str] = None,
@@ -249,6 +279,7 @@ class Body(FieldInfo):
         le: Optional[float] = None,
         min_length: Optional[int] = None,
         max_length: Optional[int] = None,
+        pattern: Optional[str] = None,
         regex: Optional[str] = None,
         example: Any = Undefined,
         examples: Optional[Dict[str, Any]] = None,
@@ -257,8 +288,7 @@ class Body(FieldInfo):
         self.embed = embed
         self.media_type = media_type
         self.example = example
-        self.examples = examples
-        super().__init__(
+        kwargs = dict(
             default=default,
             alias=alias,
             title=title,
@@ -269,9 +299,20 @@ class Body(FieldInfo):
             le=le,
             min_length=min_length,
             max_length=max_length,
-            regex=regex,
             **extra,
         )
+        if PYDANTIC_V2:
+            kwargs["annotation"] = annotation
+            kwargs["pattern"] = pattern or regex
+        else:
+            # TODO: pv2 figure out how to deprecate regex
+            kwargs["regex"] = pattern or regex
+        super().__init__(
+            **kwargs,
+        )
+        # TODO: pv2 decide how to handle OpenAPI examples vs JSON Schema examples
+        # and how to deprecate OpenAPI examples
+        self.examples = examples  # type: ignore[assignment]
 
     def __repr__(self) -> str:
         return f"{self.__class__.__name__}({self.default})"
@@ -282,6 +323,7 @@ class Form(Body):
         self,
         default: Any = Undefined,
         *,
+        annotation: Optional[Type[Any]] = None,
         media_type: str = "application/x-www-form-urlencoded",
         alias: Optional[str] = None,
         title: Optional[str] = None,
@@ -292,6 +334,7 @@ class Form(Body):
         le: Optional[float] = None,
         min_length: Optional[int] = None,
         max_length: Optional[int] = None,
+        pattern: Optional[str] = None,
         regex: Optional[str] = None,
         example: Any = Undefined,
         examples: Optional[Dict[str, Any]] = None,
@@ -299,6 +342,7 @@ class Form(Body):
     ):
         super().__init__(
             default=default,
+            annotation=annotation,
             embed=True,
             media_type=media_type,
             alias=alias,
@@ -310,6 +354,7 @@ class Form(Body):
             le=le,
             min_length=min_length,
             max_length=max_length,
+            pattern=pattern,
             regex=regex,
             example=example,
             examples=examples,
@@ -322,6 +367,7 @@ class File(Form):
         self,
         default: Any = Undefined,
         *,
+        annotation: Optional[Type[Any]] = None,
         media_type: str = "multipart/form-data",
         alias: Optional[str] = None,
         title: Optional[str] = None,
@@ -332,6 +378,7 @@ class File(Form):
         le: Optional[float] = None,
         min_length: Optional[int] = None,
         max_length: Optional[int] = None,
+        pattern: Optional[str] = None,
         regex: Optional[str] = None,
         example: Any = Undefined,
         examples: Optional[Dict[str, Any]] = None,
@@ -339,6 +386,7 @@ class File(Form):
     ):
         super().__init__(
             default=default,
+            annotation=annotation,
             media_type=media_type,
             alias=alias,
             title=title,
@@ -349,6 +397,7 @@ class File(Form):
             le=le,
             min_length=min_length,
             max_length=max_length,
+            pattern=pattern,
             regex=regex,
             example=example,
             examples=examples,