def add_non_field_param_to_dependency(
*, param: inspect.Parameter, dependant: Dependant
) -> Optional[bool]:
"""
Checks if the annotated class is subclass of `Request`, `WebSocket`, `Response`, `BackgroundTasks` or `SecurityScopes`,
and sets one of the `dependant.*_param_name` fields to `param.name` accordingly.
:returns: `True` or `None`.
"""
if lenient_issubclass(param.annotation, Request):
dependant.request_param_name = param.name
return True
elif lenient_issubclass(param.annotation, WebSocket):
dependant.websocket_param_name = param.name
return True
elif lenient_issubclass(param.annotation, Response):
dependant.response_param_name = param.name
return True
elif lenient_issubclass(param.annotation, BackgroundTasks):
dependant.background_tasks_param_name = param.name
return True
elif lenient_issubclass(param.annotation, SecurityScopes):
dependant.security_scopes_param_name = param.name
return True
return None
def get_dependant(*, path: str, call: Callable, name: str = None) -> Dependant:
path_param_names = get_path_param_names(path)
endpoint_signature = inspect.signature(call)
signature_params = endpoint_signature.parameters
dependant = Dependant(call=call, name=name)
for param_name in signature_params:
param = signature_params[param_name]
if isinstance(param.default, params.Depends):
sub_dependant = get_sub_dependant(param=param, path=path)
dependant.dependencies.append(sub_dependant)
for param_name in signature_params:
param = signature_params[param_name]
if ((param.default == param.empty) or isinstance(
param.default, params.Path)) and (param_name
in path_param_names):
assert (lenient_issubclass(param.annotation, param_supported_types)
or param.annotation == param.empty
), f"Path params must be of one of the supported types"
param = signature_params[param_name]
add_param_to_fields(
param=param,
dependant=dependant,
default_schema=params.Path,
force_type=params.ParamTypes.path,
)
elif (param.default == param.empty or param.default is None
or isinstance(param.default, param_supported_types)) and (
param.annotation == param.empty or lenient_issubclass(
param.annotation, param_supported_types)):
add_param_to_fields(param=param,
dependant=dependant,
default_schema=params.Query)
elif isinstance(param.default, params.Param):
if param.annotation != param.empty:
origin = getattr(param.annotation, "__origin__", None)
param_all_types = param_supported_types + (list, tuple, set)
if isinstance(param.default, (params.Query, params.Header)):
assert lenient_issubclass(
param.annotation, param_all_types
) or lenient_issubclass(
origin, param_all_types
), f"Parameters for Query and Header must be of type str, int, float, bool, list, tuple or set: {param}"
else:
assert lenient_issubclass(
param.annotation, param_supported_types
), f"Parameters for Path and Cookies must be of type str, int, float, bool: {param}"
add_param_to_fields(param=param,
dependant=dependant,
default_schema=params.Query)
elif lenient_issubclass(param.annotation, Request):
dependant.request_param_name = param_name
elif lenient_issubclass(param.annotation, BackgroundTasks):
dependant.background_tasks_param_name = param_name
elif not isinstance(param.default, params.Depends):
add_param_to_body_fields(param=param, dependant=dependant)
return dependant
def add_non_field_param_to_dependency(*, param: inspect.Parameter,
dependant: Dependant) -> Optional[bool]:
if lenient_issubclass(param.annotation, Request):
dependant.request_param_name = param.name
return True
elif lenient_issubclass(param.annotation, WebSocket):
dependant.websocket_param_name = param.name
return True
elif lenient_issubclass(param.annotation, BackgroundTasks):
dependant.background_tasks_param_name = param.name
return True
elif lenient_issubclass(param.annotation, SecurityScopes):
dependant.security_scopes_param_name = param.name
return True
return None
def clone_dependant(dependant: Dependant) -> Dependant:
new_dependant = Dependant()
new_dependant.path_params = dependant.path_params
new_dependant.query_params = dependant.query_params
new_dependant.header_params = dependant.header_params
new_dependant.cookie_params = dependant.cookie_params
new_dependant.body_params = dependant.body_params
new_dependant.dependencies = dependant.dependencies
new_dependant.security_requirements = dependant.security_requirements
new_dependant.request_param_name = dependant.request_param_name
new_dependant.websocket_param_name = dependant.websocket_param_name
new_dependant.response_param_name = dependant.response_param_name
new_dependant.background_tasks_param_name = dependant.background_tasks_param_name
new_dependant.security_scopes = dependant.security_scopes
new_dependant.security_scopes_param_name = dependant.security_scopes_param_name
new_dependant.name = dependant.name
new_dependant.call = dependant.call
new_dependant.use_cache = dependant.use_cache
new_dependant.path = dependant.path
new_dependant.cache_key = dependant.cache_key
return new_dependant
