Python源码示例:fastapi.Query()
示例1
def read_items(
q: Optional[str] = Query(
None,
alias="item-query",
title="Query string",
description="Query string for the items to search in the database that have a good match",
min_length=3,
max_length=50,
regex="^fixedquery$",
deprecated=True,
)
):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
示例2
def get_directions_with_coordinates(
# URL values
f_lon: float,
f_lat: float,
t_lon: float,
t_lat: float,
# Query parameters
type: str,
language: str = "en",
# Request
request: Request = Depends(directions_request),
):
from_place = Latlon(f_lat, f_lon)
to_place = Latlon(t_lat, t_lon)
if not type:
raise HTTPException(status_code=400, detail='"type" query param is required')
return directions_client.get_directions(
from_place, to_place, type, language, params=request.query_params
)
示例3
def get_directions(
# Query parameters
origin: str = Query(..., description="Origin place id"),
destination: str = Query(..., description="Destination place id"),
type: str = Query(..., description="Transport mode"),
language: str = Query("en", description="User language"),
# Request
request: Request = Depends(directions_request),
):
rate_limiter.check_limit_per_client(request)
try:
from_place = place_from_id(origin)
to_place = place_from_id(destination)
except InvalidPlaceId as exc:
raise HTTPException(status_code=404, detail=exc.message)
return directions_client.get_directions(
from_place, to_place, type, language, params=request.query_params
)
示例4
def pydantic_exception_invalid_query(q: int = Query(...)):
return {"q": q}
# def test_exception_handler_invalid_query():
# with TestClient(app) as client:
# response = client.get(
# "/pydantic/exception/invalidquery/", params={"q": "$"}
# )
# assert response.status_code == 400
# response = response.json()
# assert response["error_codes"] == [400]
# assert response["message"] == "Validation error."
# assert response["fields"] == [
# {
# "name": "q",
# "message": "Value is not a valid integer.",
# "error_code": 400,
# }
# ]
示例5
def __new__(mcs, name, bases, namespace, *args, **kwargs):
cls = super(PaginationMeta, mcs).__new__(mcs, name, bases, namespace)
_cls__init__ = cls.__init__
def __init__(
self,
request: Request,
offset: int = Query(
default=cls.default_offset, ge=0, le=cls.max_offset
),
limit: int = Query(
default=cls.default_limit, ge=1, le=cls.max_limit
),
):
_cls__init__(self, request, offset, limit)
setattr(cls, "__init__", __init__)
return cls
示例6
def __init__(
self,
request: Request,
offset: int = Query(default=default_offset, ge=0, le=max_offset),
limit: int = Query(default=default_limit, ge=-1, le=max_limit),
query: str = Query(default=""),
multiple: bool = Query(default=False),
sort: str = Query(default=""),
desc: bool = Query(default=True),
):
self.request = request
self.offset = offset
self.limit = limit
self.query = query
self.multiple = multiple
if self.multiple:
self.query = self.query.replace(",", "|")
self.sort = sort
self.desc = desc
self.desc_s = "desc" if desc else ""
self.model: Optional["ModelType"] = None
示例7
def __init__(
self,
*,
response_format: str = Query(
"json",
description="The output format requested (see section Response Format).\nDefaults to the format string 'json', which specifies the standard output format described in this specification.\nExample: `http://example.com/v1/structures?response_format=xml`",
),
email_address: EmailStr = Query(
"",
description="An email address of the user making the request.\nThe email SHOULD be that of a person and not an automatic system.\nExample: `http://example.com/v1/structures?email_address=user@example.com`",
),
response_fields: str = Query(
"",
description="A comma-delimited set of fields to be provided in the output.\nIf provided, these fields MUST be returned along with the REQUIRED fields.\nOther OPTIONAL fields MUST NOT be returned when this parameter is present.\nExample: `http://example.com/v1/structures?response_fields=last_modified,nsites`",
regex=r"([a-z_][a-z_0-9]*(,[a-z_][a-z_0-9]*)*)?",
),
include: str = Query(
"references",
description='A server MAY implement the JSON API concept of returning [compound documents](https://jsonapi.org/format/1.0/#document-compound-documents) by utilizing the `include` query parameter as specified by [JSON API 1.0](https://jsonapi.org/format/1.0/#fetching-includes).\n\nAll related resource objects MUST be returned as part of an array value for the top-level `included` field, see the section JSON Response Schema: Common Fields.\n\nThe value of `include` MUST be a comma-separated list of "relationship paths", as defined in the [JSON API](https://jsonapi.org/format/1.0/#fetching-includes).\nIf relationship paths are not supported, or a server is unable to identify a relationship path a `400 Bad Request` response MUST be made.\n\nThe **default value** for `include` is `references`.\nThis means `references` entries MUST always be included under the top-level field `included` as default, since a server assumes if `include` is not specified by a client in the request, it is still specified as `include=references`.\nNote, if a client explicitly specifies `include` and leaves out `references`, `references` resource objects MUST NOT be included under the top-level field `included`, as per the definition of `included`, see section JSON Response Schema: Common Fields.\n\n> **Note**: A query with the parameter `include` set to the empty string means no related resource objects are to be returned under the top-level field `included`.',
),
):
self.response_format = response_format
self.email_address = email_address
self.response_fields = response_fields
self.include = include
示例8
def matches(
hash: str, offset: int = Query(...), limit: int = Query(...)
) -> MatchesSchema:
"""
Returns a list of matched files, along with metadata tags and other
useful information. Results from this query can be used to download files
using the `/download` endpoint.
"""
return db.get_job_matches(JobId(hash), offset, limit)
示例9
def test_invalid_sequence():
with pytest.raises(AssertionError):
app = FastAPI()
class Item(BaseModel):
title: str
@app.get("/items/")
def read_items(q: List[Item] = Query(None)):
pass # pragma: no cover
示例10
def test_invalid_tuple():
with pytest.raises(AssertionError):
app = FastAPI()
class Item(BaseModel):
title: str
@app.get("/items/")
def read_items(q: Tuple[Item, Item] = Query(None)):
pass # pragma: no cover
示例11
def test_invalid_dict():
with pytest.raises(AssertionError):
app = FastAPI()
class Item(BaseModel):
title: str
@app.get("/items/")
def read_items(q: Dict[str, Item] = Query(None)):
pass # pragma: no cover
示例12
def test_invalid_simple_dict():
with pytest.raises(AssertionError):
app = FastAPI()
class Item(BaseModel):
title: str
@app.get("/items/")
def read_items(q: Optional[dict] = Query(None)):
pass # pragma: no cover
示例13
def get_query_param(query=Query(None)):
if query is None:
return "foo bar"
return f"foo bar {query}"
示例14
def get_query_param_required_type(query: int = Query(...)):
return f"foo bar {query}"
示例15
def read_items(q: List[int] = Query(None)):
return {"q": q}
示例16
def read_items(
*,
item_id: int = Path(..., title="The ID of the item to get", ge=0, le=1000),
q: str,
size: float = Query(..., gt=0, lt=10.5)
):
results = {"item_id": item_id}
if q:
results.update({"q": q})
return results
示例17
def read_items(
item_id: int = Path(..., title="The ID of the item to get"),
q: Optional[str] = Query(None, alias="item-query"),
):
results = {"item_id": item_id}
if q:
results.update({"q": q})
return results
示例18
def get_cookie_or_token(
websocket: WebSocket,
session: Optional[str] = Cookie(None),
token: Optional[str] = Query(None),
):
if session is None and token is None:
await websocket.close(code=status.WS_1008_POLICY_VIOLATION)
return session or token
示例19
def read_items(q: List[str] = Query(["foo", "bar"])):
query_items = {"q": q}
return query_items
示例20
def read_items(q: list = Query([])):
query_items = {"q": q}
return query_items
示例21
def read_items(
q: Optional[str] = Query(
None,
title="Query string",
description="Query string for the items to search in the database that have a good match",
min_length=3,
)
):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
示例22
def read_items(q: Optional[str] = Query(None, max_length=50)):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
示例23
def read_items(q: Optional[str] = Query(None, alias="item-query")):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
示例24
def read_items(q: str = Query(..., min_length=3)):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
示例25
def read_items(
q: Optional[str] = Query(None, min_length=3, max_length=50, regex="^fixedquery$")
):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
示例26
def read_items(q: Optional[List[str]] = Query(None)):
query_items = {"q": q}
return query_items
示例27
def read_items(q: Optional[str] = Query(None, min_length=3, max_length=50)):
results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
if q:
results.update({"q": q})
return results
示例28
def get_events_bbox(
bbox: str,
category: Optional[str] = Query(None),
size: int = Query(None),
lang: Optional[str] = Query(None),
verbosity: Optional[str] = Query(None),
):
if not kuzzle_client.enabled:
raise HTTPException(status_code=501, detail="Kuzzle client is not available")
try:
params = EventQueryParam(
**{
"category": category,
"bbox": bbox,
"size": size,
"lang": lang,
"verbosity": verbosity,
}
)
except ValidationError as e:
logger.info(f"Validation Error: {e.json()}")
raise HTTPException(status_code=400, detail=e.errors())
current_outing_lang = params.category
if params.category:
current_outing_lang = params.category.get("fr")
bbox_places = kuzzle_client.fetch_event_places(
bbox=params.bbox, collection="events", category=current_outing_lang, size=params.size
)
events_list = [Event(p["_source"]) for p in bbox_places]
return {"events": [p.load_place(params.lang, params.verbosity) for p in events_list]}
示例29
def get_articles_for_user_feed(
limit: int = Query(DEFAULT_ARTICLES_LIMIT, ge=1),
offset: int = Query(DEFAULT_ARTICLES_OFFSET, ge=0),
user: User = Depends(get_current_user_authorizer()),
articles_repo: ArticlesRepository = Depends(get_repository(ArticlesRepository)),
) -> ListOfArticlesInResponse:
articles = await articles_repo.get_articles_for_user_feed(
user=user, limit=limit, offset=offset,
)
articles_for_response = [
ArticleForResponse(**article.dict()) for article in articles
]
return ListOfArticlesInResponse(
articles=articles_for_response, articles_count=len(articles),
)
示例30
def get_articles_filters(
tag: Optional[str] = None,
author: Optional[str] = None,
favorited: Optional[str] = None,
limit: int = Query(DEFAULT_ARTICLES_LIMIT, ge=1),
offset: int = Query(DEFAULT_ARTICLES_OFFSET, ge=0),
) -> ArticlesFilters:
return ArticlesFilters(
tag=tag, author=author, favorited=favorited, limit=limit, offset=offset,
)