fastapi 0.118.2__py3-none-any.whl → 0.119.0__py3-none-any.whl

fastapi/__init__.py

@@ -1,6 +1,6 @@
 """FastAPI framework, high performance, easy to learn, fast to code, ready for production"""
 
-__version__ = "0.118.2"
+__version__ = "0.119.0"
 
 from starlette import status as status
 

fastapi/_compat/__init__.py

@@ -0,0 +1,50 @@
+from .main import BaseConfig as BaseConfig
+from .main import PydanticSchemaGenerationError as PydanticSchemaGenerationError
+from .main import RequiredParam as RequiredParam
+from .main import Undefined as Undefined
+from .main import UndefinedType as UndefinedType
+from .main import Url as Url
+from .main import Validator as Validator
+from .main import _get_model_config as _get_model_config
+from .main import _is_error_wrapper as _is_error_wrapper
+from .main import _is_model_class as _is_model_class
+from .main import _is_model_field as _is_model_field
+from .main import _is_undefined as _is_undefined
+from .main import _model_dump as _model_dump
+from .main import _model_rebuild as _model_rebuild
+from .main import copy_field_info as copy_field_info
+from .main import create_body_model as create_body_model
+from .main import evaluate_forwardref as evaluate_forwardref
+from .main import get_annotation_from_field_info as get_annotation_from_field_info
+from .main import get_cached_model_fields as get_cached_model_fields
+from .main import get_compat_model_name_map as get_compat_model_name_map
+from .main import get_definitions as get_definitions
+from .main import get_missing_field_error as get_missing_field_error
+from .main import get_schema_from_model_field as get_schema_from_model_field
+from .main import is_bytes_field as is_bytes_field
+from .main import is_bytes_sequence_field as is_bytes_sequence_field
+from .main import is_scalar_field as is_scalar_field
+from .main import is_scalar_sequence_field as is_scalar_sequence_field
+from .main import is_sequence_field as is_sequence_field
+from .main import serialize_sequence_value as serialize_sequence_value
+from .main import (
+    with_info_plain_validator_function as with_info_plain_validator_function,
+)
+from .model_field import ModelField as ModelField
+from .shared import PYDANTIC_V2 as PYDANTIC_V2
+from .shared import PYDANTIC_VERSION_MINOR_TUPLE as PYDANTIC_VERSION_MINOR_TUPLE
+from .shared import annotation_is_pydantic_v1 as annotation_is_pydantic_v1
+from .shared import field_annotation_is_scalar as field_annotation_is_scalar
+from .shared import (
+    is_uploadfile_or_nonable_uploadfile_annotation as is_uploadfile_or_nonable_uploadfile_annotation,
+)
+from .shared import (
+    is_uploadfile_sequence_annotation as is_uploadfile_sequence_annotation,
+)
+from .shared import lenient_issubclass as lenient_issubclass
+from .shared import sequence_types as sequence_types
+from .shared import value_is_sequence as value_is_sequence
+from .v1 import CoreSchema as CoreSchema
+from .v1 import GetJsonSchemaHandler as GetJsonSchemaHandler
+from .v1 import JsonSchemaValue as JsonSchemaValue
+from .v1 import _normalize_errors as _normalize_errors

fastapi/_compat/main.py

@@ -0,0 +1,305 @@
+from functools import lru_cache
+from typing import (
+    Any,
+    Dict,
+    List,
+    Sequence,
+    Tuple,
+    Type,
+)
+
+from fastapi._compat import v1
+from fastapi._compat.shared import PYDANTIC_V2, lenient_issubclass
+from fastapi.types import ModelNameMap
+from pydantic import BaseModel
+from typing_extensions import Literal
+
+from .model_field import ModelField
+
+if PYDANTIC_V2:
+    from .v2 import BaseConfig as BaseConfig
+    from .v2 import FieldInfo as FieldInfo
+    from .v2 import PydanticSchemaGenerationError as PydanticSchemaGenerationError
+    from .v2 import RequiredParam as RequiredParam
+    from .v2 import Undefined as Undefined
+    from .v2 import UndefinedType as UndefinedType
+    from .v2 import Url as Url
+    from .v2 import Validator as Validator
+    from .v2 import evaluate_forwardref as evaluate_forwardref
+    from .v2 import get_missing_field_error as get_missing_field_error
+    from .v2 import (
+        with_info_plain_validator_function as with_info_plain_validator_function,
+    )
+else:
+    from .v1 import BaseConfig as BaseConfig  # type: ignore[assignment]
+    from .v1 import FieldInfo as FieldInfo
+    from .v1 import (  # type: ignore[assignment]
+        PydanticSchemaGenerationError as PydanticSchemaGenerationError,
+    )
+    from .v1 import RequiredParam as RequiredParam
+    from .v1 import Undefined as Undefined
+    from .v1 import UndefinedType as UndefinedType
+    from .v1 import Url as Url  # type: ignore[assignment]
+    from .v1 import Validator as Validator
+    from .v1 import evaluate_forwardref as evaluate_forwardref
+    from .v1 import get_missing_field_error as get_missing_field_error
+    from .v1 import (  # type: ignore[assignment]
+        with_info_plain_validator_function as with_info_plain_validator_function,
+    )
+
+
+@lru_cache
+def get_cached_model_fields(model: Type[BaseModel]) -> List[ModelField]:
+    if lenient_issubclass(model, v1.BaseModel):
+        return v1.get_model_fields(model)
+    else:
+        from . import v2
+
+        return v2.get_model_fields(model)  # type: ignore[return-value]
+
+
+def _is_undefined(value: object) -> bool:
+    if isinstance(value, v1.UndefinedType):
+        return True
+    elif PYDANTIC_V2:
+        from . import v2
+
+        return isinstance(value, v2.UndefinedType)
+    return False
+
+
+def _get_model_config(model: BaseModel) -> Any:
+    if isinstance(model, v1.BaseModel):
+        return v1._get_model_config(model)
+    elif PYDANTIC_V2:
+        from . import v2
+
+        return v2._get_model_config(model)
+
+
+def _model_dump(
+    model: BaseModel, mode: Literal["json", "python"] = "json", **kwargs: Any
+) -> Any:
+    if isinstance(model, v1.BaseModel):
+        return v1._model_dump(model, mode=mode, **kwargs)
+    elif PYDANTIC_V2:
+        from . import v2
+
+        return v2._model_dump(model, mode=mode, **kwargs)
+
+
+def _is_error_wrapper(exc: Exception) -> bool:
+    if isinstance(exc, v1.ErrorWrapper):
+        return True
+    elif PYDANTIC_V2:
+        from . import v2
+
+        return isinstance(exc, v2.ErrorWrapper)
+    return False
+
+
+def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:
+    if isinstance(field_info, v1.FieldInfo):
+        return v1.copy_field_info(field_info=field_info, annotation=annotation)
+    else:
+        assert PYDANTIC_V2
+        from . import v2
+
+        return v2.copy_field_info(field_info=field_info, annotation=annotation)
+
+
+def create_body_model(
+    *, fields: Sequence[ModelField], model_name: str
+) -> Type[BaseModel]:
+    if fields and isinstance(fields[0], v1.ModelField):
+        return v1.create_body_model(fields=fields, model_name=model_name)
+    else:
+        assert PYDANTIC_V2
+        from . import v2
+
+        return v2.create_body_model(fields=fields, model_name=model_name)  # type: ignore[arg-type]
+
+
+def get_annotation_from_field_info(
+    annotation: Any, field_info: FieldInfo, field_name: str
+) -> Any:
+    if isinstance(field_info, v1.FieldInfo):
+        return v1.get_annotation_from_field_info(
+            annotation=annotation, field_info=field_info, field_name=field_name
+        )
+    else:
+        assert PYDANTIC_V2
+        from . import v2
+
+        return v2.get_annotation_from_field_info(
+            annotation=annotation, field_info=field_info, field_name=field_name
+        )
+
+
+def is_bytes_field(field: ModelField) -> bool:
+    if isinstance(field, v1.ModelField):
+        return v1.is_bytes_field(field)
+    else:
+        assert PYDANTIC_V2
+        from . import v2
+
+        return v2.is_bytes_field(field)  # type: ignore[arg-type]
+
+
+def is_bytes_sequence_field(field: ModelField) -> bool:
+    if isinstance(field, v1.ModelField):
+        return v1.is_bytes_sequence_field(field)
+    else:
+        assert PYDANTIC_V2
+        from . import v2
+
+        return v2.is_bytes_sequence_field(field)  # type: ignore[arg-type]
+
+
+def is_scalar_field(field: ModelField) -> bool:
+    if isinstance(field, v1.ModelField):
+        return v1.is_scalar_field(field)
+    else:
+        assert PYDANTIC_V2
+        from . import v2
+
+        return v2.is_scalar_field(field)  # type: ignore[arg-type]
+
+
+def is_scalar_sequence_field(field: ModelField) -> bool:
+    if isinstance(field, v1.ModelField):
+        return v1.is_scalar_sequence_field(field)
+    else:
+        assert PYDANTIC_V2
+        from . import v2
+
+        return v2.is_scalar_sequence_field(field)  # type: ignore[arg-type]
+
+
+def is_sequence_field(field: ModelField) -> bool:
+    if isinstance(field, v1.ModelField):
+        return v1.is_sequence_field(field)
+    else:
+        assert PYDANTIC_V2
+        from . import v2
+
+        return v2.is_sequence_field(field)  # type: ignore[arg-type]
+
+
+def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:
+    if isinstance(field, v1.ModelField):
+        return v1.serialize_sequence_value(field=field, value=value)
+    else:
+        assert PYDANTIC_V2
+        from . import v2
+
+        return v2.serialize_sequence_value(field=field, value=value)  # type: ignore[arg-type]
+
+
+def _model_rebuild(model: Type[BaseModel]) -> None:
+    if lenient_issubclass(model, v1.BaseModel):
+        v1._model_rebuild(model)
+    elif PYDANTIC_V2:
+        from . import v2
+
+        v2._model_rebuild(model)
+
+
+def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:
+    v1_model_fields = [field for field in fields if isinstance(field, v1.ModelField)]
+    v1_flat_models = v1.get_flat_models_from_fields(v1_model_fields, known_models=set())  # type: ignore[attr-defined]
+    all_flat_models = v1_flat_models
+    if PYDANTIC_V2:
+        from . import v2
+
+        v2_model_fields = [
+            field for field in fields if isinstance(field, v2.ModelField)
+        ]
+        v2_flat_models = v2.get_flat_models_from_fields(
+            v2_model_fields, known_models=set()
+        )
+        all_flat_models = all_flat_models.union(v2_flat_models)
+
+        model_name_map = v2.get_model_name_map(all_flat_models)
+        return model_name_map
+    model_name_map = v1.get_model_name_map(all_flat_models)
+    return model_name_map
+
+
+def get_definitions(
+    *,
+    fields: List[ModelField],
+    model_name_map: ModelNameMap,
+    separate_input_output_schemas: bool = True,
+) -> Tuple[
+    Dict[Tuple[ModelField, Literal["validation", "serialization"]], v1.JsonSchemaValue],
+    Dict[str, Dict[str, Any]],
+]:
+    v1_fields = [field for field in fields if isinstance(field, v1.ModelField)]
+    v1_field_maps, v1_definitions = v1.get_definitions(
+        fields=v1_fields,
+        model_name_map=model_name_map,
+        separate_input_output_schemas=separate_input_output_schemas,
+    )
+    if not PYDANTIC_V2:
+        return v1_field_maps, v1_definitions
+    else:
+        from . import v2
+
+        v2_fields = [field for field in fields if isinstance(field, v2.ModelField)]
+        v2_field_maps, v2_definitions = v2.get_definitions(
+            fields=v2_fields,
+            model_name_map=model_name_map,
+            separate_input_output_schemas=separate_input_output_schemas,
+        )
+        all_definitions = {**v1_definitions, **v2_definitions}
+        all_field_maps = {**v1_field_maps, **v2_field_maps}
+        return all_field_maps, all_definitions
+
+
+def get_schema_from_model_field(
+    *,
+    field: ModelField,
+    model_name_map: ModelNameMap,
+    field_mapping: Dict[
+        Tuple[ModelField, Literal["validation", "serialization"]], v1.JsonSchemaValue
+    ],
+    separate_input_output_schemas: bool = True,
+) -> Dict[str, Any]:
+    if isinstance(field, v1.ModelField):
+        return v1.get_schema_from_model_field(
+            field=field,
+            model_name_map=model_name_map,
+            field_mapping=field_mapping,
+            separate_input_output_schemas=separate_input_output_schemas,
+        )
+    else:
+        assert PYDANTIC_V2
+        from . import v2
+
+        return v2.get_schema_from_model_field(
+            field=field,  # type: ignore[arg-type]
+            model_name_map=model_name_map,
+            field_mapping=field_mapping,  # type: ignore[arg-type]
+            separate_input_output_schemas=separate_input_output_schemas,
+        )
+
+
+def _is_model_field(value: Any) -> bool:
+    if isinstance(value, v1.ModelField):
+        return True
+    elif PYDANTIC_V2:
+        from . import v2
+
+        return isinstance(value, v2.ModelField)
+    return False
+
+
+def _is_model_class(value: Any) -> bool:
+    if lenient_issubclass(value, v1.BaseModel):
+        return True
+    elif PYDANTIC_V2:
+        from . import v2
+
+        return lenient_issubclass(value, v2.BaseModel)  # type: ignore[attr-defined]
+    return False

fastapi/_compat/model_field.py

@@ -0,0 +1,53 @@
+from typing import (
+    Any,
+    Dict,
+    List,
+    Tuple,
+    Union,
+)
+
+from fastapi.types import IncEx
+from pydantic.fields import FieldInfo
+from typing_extensions import Literal, Protocol
+
+
+class ModelField(Protocol):
+    field_info: "FieldInfo"
+    name: str
+    mode: Literal["validation", "serialization"] = "validation"
+    _version: Literal["v1", "v2"] = "v1"
+
+    @property
+    def alias(self) -> str: ...
+
+    @property
+    def required(self) -> bool: ...
+
+    @property
+    def default(self) -> Any: ...
+
+    @property
+    def type_(self) -> Any: ...
+
+    def get_default(self) -> Any: ...
+
+    def validate(
+        self,
+        value: Any,
+        values: Dict[str, Any] = {},  # noqa: B006
+        *,
+        loc: Tuple[Union[int, str], ...] = (),
+    ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]: ...
+
+    def serialize(
+        self,
+        value: Any,
+        *,
+        mode: Literal["json", "python"] = "json",
+        include: Union[IncEx, None] = None,
+        exclude: Union[IncEx, None] = None,
+        by_alias: bool = True,
+        exclude_unset: bool = False,
+        exclude_defaults: bool = False,
+        exclude_none: bool = False,
+    ) -> Any: ...

fastapi/_compat/shared.py

@@ -0,0 +1,209 @@
+import sys
+import types
+import typing
+from collections import deque
+from dataclasses import is_dataclass
+from typing import (
+    Any,
+    Deque,
+    FrozenSet,
+    List,
+    Mapping,
+    Sequence,
+    Set,
+    Tuple,
+    Type,
+    Union,
+)
+
+from fastapi._compat import v1
+from fastapi.types import UnionType
+from pydantic import BaseModel
+from pydantic.version import VERSION as PYDANTIC_VERSION
+from starlette.datastructures import UploadFile
+from typing_extensions import Annotated, get_args, get_origin
+
+# Copy from Pydantic v2, compatible with v1
+if sys.version_info < (3, 9):
+    # Pydantic no longer supports Python 3.8, this might be incorrect, but the code
+    # this is used for is also never reached in this codebase, as it's a copy of
+    # Pydantic's lenient_issubclass, just for compatibility with v1
+    # TODO: remove when dropping support for Python 3.8
+    WithArgsTypes: Tuple[Any, ...] = ()
+elif sys.version_info < (3, 10):
+    WithArgsTypes: tuple[Any, ...] = (typing._GenericAlias, types.GenericAlias)  # type: ignore[attr-defined]
+else:
+    WithArgsTypes: tuple[Any, ...] = (
+        typing._GenericAlias,  # type: ignore[attr-defined]
+        types.GenericAlias,
+        types.UnionType,
+    )  # pyright: ignore[reportAttributeAccessIssue]
+
+PYDANTIC_VERSION_MINOR_TUPLE = tuple(int(x) for x in PYDANTIC_VERSION.split(".")[:2])
+PYDANTIC_V2 = PYDANTIC_VERSION_MINOR_TUPLE[0] == 2
+
+
+sequence_annotation_to_type = {
+    Sequence: list,
+    List: list,
+    list: list,
+    Tuple: tuple,
+    tuple: tuple,
+    Set: set,
+    set: set,
+    FrozenSet: frozenset,
+    frozenset: frozenset,
+    Deque: deque,
+    deque: deque,
+}
+
+sequence_types = tuple(sequence_annotation_to_type.keys())
+
+Url: Type[Any]
+
+
+# Copy of Pydantic v2, compatible with v1
+def lenient_issubclass(
+    cls: Any, class_or_tuple: Union[Type[Any], Tuple[Type[Any], ...], None]
+) -> bool:
+    try:
+        return isinstance(cls, type) and issubclass(cls, class_or_tuple)  # type: ignore[arg-type]
+    except TypeError:  # pragma: no cover
+        if isinstance(cls, WithArgsTypes):
+            return False
+        raise  # pragma: no cover
+
+
+def _annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:
+    if lenient_issubclass(annotation, (str, bytes)):
+        return False
+    return lenient_issubclass(annotation, sequence_types)  # type: ignore[arg-type]
+
+
+def field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:
+    origin = get_origin(annotation)
+    if origin is Union or origin is UnionType:
+        for arg in get_args(annotation):
+            if field_annotation_is_sequence(arg):
+                return True
+        return False
+    return _annotation_is_sequence(annotation) or _annotation_is_sequence(
+        get_origin(annotation)
+    )
+
+
+def value_is_sequence(value: Any) -> bool:
+    return isinstance(value, sequence_types) and not isinstance(value, (str, bytes))  # type: ignore[arg-type]
+
+
+def _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:
+    return (
+        lenient_issubclass(annotation, (BaseModel, v1.BaseModel, Mapping, UploadFile))
+        or _annotation_is_sequence(annotation)
+        or is_dataclass(annotation)
+    )
+
+
+def field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:
+    origin = get_origin(annotation)
+    if origin is Union or origin is UnionType:
+        return any(field_annotation_is_complex(arg) for arg in get_args(annotation))
+
+    if origin is Annotated:
+        return field_annotation_is_complex(get_args(annotation)[0])
+
+    return (
+        _annotation_is_complex(annotation)
+        or _annotation_is_complex(origin)
+        or hasattr(origin, "__pydantic_core_schema__")
+        or hasattr(origin, "__get_pydantic_core_schema__")
+    )
+
+
+def field_annotation_is_scalar(annotation: Any) -> bool:
+    # handle Ellipsis here to make tuple[int, ...] work nicely
+    return annotation is Ellipsis or not field_annotation_is_complex(annotation)
+
+
+def field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:
+    origin = get_origin(annotation)
+    if origin is Union or origin is UnionType:
+        at_least_one_scalar_sequence = False
+        for arg in get_args(annotation):
+            if field_annotation_is_scalar_sequence(arg):
+                at_least_one_scalar_sequence = True
+                continue
+            elif not field_annotation_is_scalar(arg):
+                return False
+        return at_least_one_scalar_sequence
+    return field_annotation_is_sequence(annotation) and all(
+        field_annotation_is_scalar(sub_annotation)
+        for sub_annotation in get_args(annotation)
+    )
+
+
+def is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:
+    if lenient_issubclass(annotation, bytes):
+        return True
+    origin = get_origin(annotation)
+    if origin is Union or origin is UnionType:
+        for arg in get_args(annotation):
+            if lenient_issubclass(arg, bytes):
+                return True
+    return False
+
+
+def is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:
+    if lenient_issubclass(annotation, UploadFile):
+        return True
+    origin = get_origin(annotation)
+    if origin is Union or origin is UnionType:
+        for arg in get_args(annotation):
+            if lenient_issubclass(arg, UploadFile):
+                return True
+    return False
+
+
+def is_bytes_sequence_annotation(annotation: Any) -> bool:
+    origin = get_origin(annotation)
+    if origin is Union or origin is UnionType:
+        at_least_one = False
+        for arg in get_args(annotation):
+            if is_bytes_sequence_annotation(arg):
+                at_least_one = True
+                continue
+        return at_least_one
+    return field_annotation_is_sequence(annotation) and all(
+        is_bytes_or_nonable_bytes_annotation(sub_annotation)
+        for sub_annotation in get_args(annotation)
+    )
+
+
+def is_uploadfile_sequence_annotation(annotation: Any) -> bool:
+    origin = get_origin(annotation)
+    if origin is Union or origin is UnionType:
+        at_least_one = False
+        for arg in get_args(annotation):
+            if is_uploadfile_sequence_annotation(arg):
+                at_least_one = True
+                continue
+        return at_least_one
+    return field_annotation_is_sequence(annotation) and all(
+        is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)
+        for sub_annotation in get_args(annotation)
+    )
+
+
+def annotation_is_pydantic_v1(annotation: Any) -> bool:
+    if lenient_issubclass(annotation, v1.BaseModel):
+        return True
+    origin = get_origin(annotation)
+    if origin is Union or origin is UnionType:
+        for arg in get_args(annotation):
+            if lenient_issubclass(arg, v1.BaseModel):
+                return True
+    if field_annotation_is_sequence(annotation):
+        for sub_annotation in get_args(annotation):
+            if annotation_is_pydantic_v1(sub_annotation):
+                return True
+    return False