2022-01-23 20:14:13 +01:00
|
|
|
from typing import Any, Callable, Dict, Iterable, Type, TypeVar
|
2019-03-03 20:52:37 +04:00
|
|
|
|
2021-07-29 11:30:18 -04:00
|
|
|
from starlette.datastructures import URL as URL # noqa: F401
|
|
|
|
|
from starlette.datastructures import Address as Address # noqa: F401
|
|
|
|
|
from starlette.datastructures import FormData as FormData # noqa: F401
|
|
|
|
|
from starlette.datastructures import Headers as Headers # noqa: F401
|
|
|
|
|
from starlette.datastructures import QueryParams as QueryParams # noqa: F401
|
2020-12-20 19:50:00 +01:00
|
|
|
from starlette.datastructures import State as State # noqa: F401
|
2019-03-03 20:52:37 +04:00
|
|
|
from starlette.datastructures import UploadFile as StarletteUploadFile
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class UploadFile(StarletteUploadFile):
|
|
|
|
|
@classmethod
|
2020-12-20 19:50:00 +01:00
|
|
|
def __get_validators__(cls: Type["UploadFile"]) -> Iterable[Callable[..., Any]]:
|
2019-03-03 20:52:37 +04:00
|
|
|
yield cls.validate
|
|
|
|
|
|
|
|
|
|
@classmethod
|
|
|
|
|
def validate(cls: Type["UploadFile"], v: Any) -> Any:
|
|
|
|
|
if not isinstance(v, StarletteUploadFile):
|
|
|
|
|
raise ValueError(f"Expected UploadFile, received: {type(v)}")
|
|
|
|
|
return v
|
✨ Add support for shared/top-level parameters (dependencies, tags, etc) (#2434)
* ✨ Add Default and DefaultPlaceholder data structures
to handle defaults and overrides
* ✨ Add utils to get values by priority handling DefaultPlaceholders
* ✨ Add support for top-level parameters in FastAPI, APIRouter, include_router
including: prefix, tags, dependencies, deprecated, include_in_schema, responses, default_response_class, callbacks
* ♻️ Update openapi utils to handle DefaultPlaceholder for response_class
* 📝 Update bigger-application example code to use top-level params
and showcase them in APIRouter, FastAPI, include_router
* 📝 Update docs for Bigger Applications, include diagrams, top-level params
* 🔥 Simplify code and docs for callbacks as default_response_class is no longer required
* 📝 Add docs for top-level dependencies, in FastAPI()
* 📝 Add docs reference to top-level dependencies in docs for decorator
* ✅ Update/increase tests for Bigger Applications including shared parameters
* ✅ Add tests for top-level dependencies in FastAPI()
* ✅ Add tests for internal DefaultPlaceholder
* ✅ Update/increase tests for callbacks with top-level parameters
* ✅ Add LOTS of tests covering branches and cases for shared parameters
in top-level FastAPI, path operations, include_router, APIRouter, its path operations, nested include_router, nested APIRouter, and its path operations
* 🎨 Format/reorder parameters for consistency in FastAPI, APIRouter, include_router
2020-11-29 18:32:18 +01:00
|
|
|
|
2022-01-23 20:14:13 +01:00
|
|
|
@classmethod
|
|
|
|
|
def __modify_schema__(cls, field_schema: Dict[str, Any]) -> None:
|
|
|
|
|
field_schema.update({"type": "string", "format": "binary"})
|
|
|
|
|
|
✨ Add support for shared/top-level parameters (dependencies, tags, etc) (#2434)
* ✨ Add Default and DefaultPlaceholder data structures
to handle defaults and overrides
* ✨ Add utils to get values by priority handling DefaultPlaceholders
* ✨ Add support for top-level parameters in FastAPI, APIRouter, include_router
including: prefix, tags, dependencies, deprecated, include_in_schema, responses, default_response_class, callbacks
* ♻️ Update openapi utils to handle DefaultPlaceholder for response_class
* 📝 Update bigger-application example code to use top-level params
and showcase them in APIRouter, FastAPI, include_router
* 📝 Update docs for Bigger Applications, include diagrams, top-level params
* 🔥 Simplify code and docs for callbacks as default_response_class is no longer required
* 📝 Add docs for top-level dependencies, in FastAPI()
* 📝 Add docs reference to top-level dependencies in docs for decorator
* ✅ Update/increase tests for Bigger Applications including shared parameters
* ✅ Add tests for top-level dependencies in FastAPI()
* ✅ Add tests for internal DefaultPlaceholder
* ✅ Update/increase tests for callbacks with top-level parameters
* ✅ Add LOTS of tests covering branches and cases for shared parameters
in top-level FastAPI, path operations, include_router, APIRouter, its path operations, nested include_router, nested APIRouter, and its path operations
* 🎨 Format/reorder parameters for consistency in FastAPI, APIRouter, include_router
2020-11-29 18:32:18 +01:00
|
|
|
|
|
|
|
|
class DefaultPlaceholder:
|
|
|
|
|
"""
|
|
|
|
|
You shouldn't use this class directly.
|
|
|
|
|
|
|
|
|
|
It's used internally to recognize when a default value has been overwritten, even
|
2021-07-21 14:14:34 +02:00
|
|
|
if the overridden default value was truthy.
|
✨ Add support for shared/top-level parameters (dependencies, tags, etc) (#2434)
* ✨ Add Default and DefaultPlaceholder data structures
to handle defaults and overrides
* ✨ Add utils to get values by priority handling DefaultPlaceholders
* ✨ Add support for top-level parameters in FastAPI, APIRouter, include_router
including: prefix, tags, dependencies, deprecated, include_in_schema, responses, default_response_class, callbacks
* ♻️ Update openapi utils to handle DefaultPlaceholder for response_class
* 📝 Update bigger-application example code to use top-level params
and showcase them in APIRouter, FastAPI, include_router
* 📝 Update docs for Bigger Applications, include diagrams, top-level params
* 🔥 Simplify code and docs for callbacks as default_response_class is no longer required
* 📝 Add docs for top-level dependencies, in FastAPI()
* 📝 Add docs reference to top-level dependencies in docs for decorator
* ✅ Update/increase tests for Bigger Applications including shared parameters
* ✅ Add tests for top-level dependencies in FastAPI()
* ✅ Add tests for internal DefaultPlaceholder
* ✅ Update/increase tests for callbacks with top-level parameters
* ✅ Add LOTS of tests covering branches and cases for shared parameters
in top-level FastAPI, path operations, include_router, APIRouter, its path operations, nested include_router, nested APIRouter, and its path operations
* 🎨 Format/reorder parameters for consistency in FastAPI, APIRouter, include_router
2020-11-29 18:32:18 +01:00
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
def __init__(self, value: Any):
|
|
|
|
|
self.value = value
|
|
|
|
|
|
|
|
|
|
def __bool__(self) -> bool:
|
|
|
|
|
return bool(self.value)
|
|
|
|
|
|
|
|
|
|
def __eq__(self, o: object) -> bool:
|
|
|
|
|
return isinstance(o, DefaultPlaceholder) and o.value == self.value
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
DefaultType = TypeVar("DefaultType")
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def Default(value: DefaultType) -> DefaultType:
|
|
|
|
|
"""
|
|
|
|
|
You shouldn't use this function directly.
|
|
|
|
|
|
|
|
|
|
It's used internally to recognize when a default value has been overwritten, even
|
2021-07-21 14:14:34 +02:00
|
|
|
if the overridden default value was truthy.
|
✨ Add support for shared/top-level parameters (dependencies, tags, etc) (#2434)
* ✨ Add Default and DefaultPlaceholder data structures
to handle defaults and overrides
* ✨ Add utils to get values by priority handling DefaultPlaceholders
* ✨ Add support for top-level parameters in FastAPI, APIRouter, include_router
including: prefix, tags, dependencies, deprecated, include_in_schema, responses, default_response_class, callbacks
* ♻️ Update openapi utils to handle DefaultPlaceholder for response_class
* 📝 Update bigger-application example code to use top-level params
and showcase them in APIRouter, FastAPI, include_router
* 📝 Update docs for Bigger Applications, include diagrams, top-level params
* 🔥 Simplify code and docs for callbacks as default_response_class is no longer required
* 📝 Add docs for top-level dependencies, in FastAPI()
* 📝 Add docs reference to top-level dependencies in docs for decorator
* ✅ Update/increase tests for Bigger Applications including shared parameters
* ✅ Add tests for top-level dependencies in FastAPI()
* ✅ Add tests for internal DefaultPlaceholder
* ✅ Update/increase tests for callbacks with top-level parameters
* ✅ Add LOTS of tests covering branches and cases for shared parameters
in top-level FastAPI, path operations, include_router, APIRouter, its path operations, nested include_router, nested APIRouter, and its path operations
* 🎨 Format/reorder parameters for consistency in FastAPI, APIRouter, include_router
2020-11-29 18:32:18 +01:00
|
|
|
"""
|
|
|
|
|
return DefaultPlaceholder(value) # type: ignore
|