Sofie Van Landeghem
2 months ago
committed by
GitHub
GitHub
55 changed files with 1777 additions and 6145 deletions
@ -1,7 +0,0 @@ |
|||||
FROM python:3.9 |
|
||||
|
|
||||
RUN pip install httpx PyGithub "pydantic==1.5.1" "pyyaml>=5.3.1,<6.0.0" |
|
||||
|
|
||||
COPY ./app /app |
|
||||
|
|
||||
CMD ["python", "/app/main.py"] |
|
||||
@ -1,10 +0,0 @@ |
|||||
name: "Notify Translations" |
|
||||
description: "Notify in the issue for a translation when there's a new PR available" |
|
||||
author: "Sebastián Ramírez <[email protected]>" |
|
||||
inputs: |
|
||||
token: |
|
||||
description: 'Token, to read the GitHub API. Can be passed in using {{ secrets.GITHUB_TOKEN }}' |
|
||||
required: true |
|
||||
runs: |
|
||||
using: 'docker' |
|
||||
image: 'Dockerfile' |
|
||||
@ -1,7 +0,0 @@ |
|||||
FROM python:3.9 |
|
||||
|
|
||||
RUN pip install httpx PyGithub "pydantic==2.0.2" pydantic-settings "pyyaml>=5.3.1,<6.0.0" |
|
||||
|
|
||||
COPY ./app /app |
|
||||
|
|
||||
CMD ["python", "/app/main.py"] |
|
||||
@ -1,10 +0,0 @@ |
|||||
name: "Generate FastAPI People" |
|
||||
description: "Generate the data for the FastAPI People page" |
|
||||
author: "Sebastián Ramírez <[email protected]>" |
|
||||
inputs: |
|
||||
token: |
|
||||
description: 'User token, to read the GitHub API. Can be passed in using {{ secrets.FASTAPI_PEOPLE }}' |
|
||||
required: true |
|
||||
runs: |
|
||||
using: 'docker' |
|
||||
image: 'Dockerfile' |
|
||||
@ -1,682 +0,0 @@ |
|||||
import logging |
|
||||
import subprocess |
|
||||
import sys |
|
||||
from collections import Counter, defaultdict |
|
||||
from datetime import datetime, timedelta, timezone |
|
||||
from pathlib import Path |
|
||||
from typing import Any, Container, DefaultDict, Dict, List, Set, Union |
|
||||
|
|
||||
import httpx |
|
||||
import yaml |
|
||||
from github import Github |
|
||||
from pydantic import BaseModel, SecretStr |
|
||||
from pydantic_settings import BaseSettings |
|
||||
|
|
||||
github_graphql_url = "https://api.github.com/graphql" |
|
||||
questions_category_id = "MDE4OkRpc2N1c3Npb25DYXRlZ29yeTMyMDAxNDM0" |
|
||||
|
|
||||
discussions_query = """ |
|
||||
query Q($after: String, $category_id: ID) { |
|
||||
repository(name: "fastapi", owner: "fastapi") { |
|
||||
discussions(first: 100, after: $after, categoryId: $category_id) { |
|
||||
edges { |
|
||||
cursor |
|
||||
node { |
|
||||
number |
|
||||
author { |
|
||||
login |
|
||||
avatarUrl |
|
||||
url |
|
||||
} |
|
||||
title |
|
||||
createdAt |
|
||||
comments(first: 100) { |
|
||||
nodes { |
|
||||
createdAt |
|
||||
author { |
|
||||
login |
|
||||
avatarUrl |
|
||||
url |
|
||||
} |
|
||||
isAnswer |
|
||||
replies(first: 10) { |
|
||||
nodes { |
|
||||
createdAt |
|
||||
author { |
|
||||
login |
|
||||
avatarUrl |
|
||||
url |
|
||||
} |
|
||||
} |
|
||||
} |
|
||||
} |
|
||||
} |
|
||||
} |
|
||||
} |
|
||||
} |
|
||||
} |
|
||||
} |
|
||||
""" |
|
||||
|
|
||||
|
|
||||
prs_query = """ |
|
||||
query Q($after: String) { |
|
||||
repository(name: "fastapi", owner: "fastapi") { |
|
||||
pullRequests(first: 100, after: $after) { |
|
||||
edges { |
|
||||
cursor |
|
||||
node { |
|
||||
number |
|
||||
labels(first: 100) { |
|
||||
nodes { |
|
||||
name |
|
||||
} |
|
||||
} |
|
||||
author { |
|
||||
login |
|
||||
avatarUrl |
|
||||
url |
|
||||
} |
|
||||
title |
|
||||
createdAt |
|
||||
state |
|
||||
comments(first: 100) { |
|
||||
nodes { |
|
||||
createdAt |
|
||||
author { |
|
||||
login |
|
||||
avatarUrl |
|
||||
url |
|
||||
} |
|
||||
} |
|
||||
} |
|
||||
reviews(first:100) { |
|
||||
nodes { |
|
||||
author { |
|
||||
login |
|
||||
avatarUrl |
|
||||
url |
|
||||
} |
|
||||
state |
|
||||
} |
|
||||
} |
|
||||
} |
|
||||
} |
|
||||
} |
|
||||
} |
|
||||
} |
|
||||
""" |
|
||||
|
|
||||
sponsors_query = """ |
|
||||
query Q($after: String) { |
|
||||
user(login: "fastapi") { |
|
||||
sponsorshipsAsMaintainer(first: 100, after: $after) { |
|
||||
edges { |
|
||||
cursor |
|
||||
node { |
|
||||
sponsorEntity { |
|
||||
... on Organization { |
|
||||
login |
|
||||
avatarUrl |
|
||||
url |
|
||||
} |
|
||||
... on User { |
|
||||
login |
|
||||
avatarUrl |
|
||||
url |
|
||||
} |
|
||||
} |
|
||||
tier { |
|
||||
name |
|
||||
monthlyPriceInDollars |
|
||||
} |
|
||||
} |
|
||||
} |
|
||||
} |
|
||||
} |
|
||||
} |
|
||||
""" |
|
||||
|
|
||||
|
|
||||
class Author(BaseModel): |
|
||||
login: str |
|
||||
avatarUrl: str |
|
||||
url: str |
|
||||
|
|
||||
|
|
||||
# Discussions |
|
||||
|
|
||||
|
|
||||
class CommentsNode(BaseModel): |
|
||||
createdAt: datetime |
|
||||
author: Union[Author, None] = None |
|
||||
|
|
||||
|
|
||||
class Replies(BaseModel): |
|
||||
nodes: List[CommentsNode] |
|
||||
|
|
||||
|
|
||||
class DiscussionsCommentsNode(CommentsNode): |
|
||||
replies: Replies |
|
||||
|
|
||||
|
|
||||
class Comments(BaseModel): |
|
||||
nodes: List[CommentsNode] |
|
||||
|
|
||||
|
|
||||
class DiscussionsComments(BaseModel): |
|
||||
nodes: List[DiscussionsCommentsNode] |
|
||||
|
|
||||
|
|
||||
class DiscussionsNode(BaseModel): |
|
||||
number: int |
|
||||
author: Union[Author, None] = None |
|
||||
title: str |
|
||||
createdAt: datetime |
|
||||
comments: DiscussionsComments |
|
||||
|
|
||||
|
|
||||
class DiscussionsEdge(BaseModel): |
|
||||
cursor: str |
|
||||
node: DiscussionsNode |
|
||||
|
|
||||
|
|
||||
class Discussions(BaseModel): |
|
||||
edges: List[DiscussionsEdge] |
|
||||
|
|
||||
|
|
||||
class DiscussionsRepository(BaseModel): |
|
||||
discussions: Discussions |
|
||||
|
|
||||
|
|
||||
class DiscussionsResponseData(BaseModel): |
|
||||
repository: DiscussionsRepository |
|
||||
|
|
||||
|
|
||||
class DiscussionsResponse(BaseModel): |
|
||||
data: DiscussionsResponseData |
|
||||
|
|
||||
|
|
||||
# PRs |
|
||||
|
|
||||
|
|
||||
class LabelNode(BaseModel): |
|
||||
name: str |
|
||||
|
|
||||
|
|
||||
class Labels(BaseModel): |
|
||||
nodes: List[LabelNode] |
|
||||
|
|
||||
|
|
||||
class ReviewNode(BaseModel): |
|
||||
author: Union[Author, None] = None |
|
||||
state: str |
|
||||
|
|
||||
|
|
||||
class Reviews(BaseModel): |
|
||||
nodes: List[ReviewNode] |
|
||||
|
|
||||
|
|
||||
class PullRequestNode(BaseModel): |
|
||||
number: int |
|
||||
labels: Labels |
|
||||
author: Union[Author, None] = None |
|
||||
title: str |
|
||||
createdAt: datetime |
|
||||
state: str |
|
||||
comments: Comments |
|
||||
reviews: Reviews |
|
||||
|
|
||||
|
|
||||
class PullRequestEdge(BaseModel): |
|
||||
cursor: str |
|
||||
node: PullRequestNode |
|
||||
|
|
||||
|
|
||||
class PullRequests(BaseModel): |
|
||||
edges: List[PullRequestEdge] |
|
||||
|
|
||||
|
|
||||
class PRsRepository(BaseModel): |
|
||||
pullRequests: PullRequests |
|
||||
|
|
||||
|
|
||||
class PRsResponseData(BaseModel): |
|
||||
repository: PRsRepository |
|
||||
|
|
||||
|
|
||||
class PRsResponse(BaseModel): |
|
||||
data: PRsResponseData |
|
||||
|
|
||||
|
|
||||
# Sponsors |
|
||||
|
|
||||
|
|
||||
class SponsorEntity(BaseModel): |
|
||||
login: str |
|
||||
avatarUrl: str |
|
||||
url: str |
|
||||
|
|
||||
|
|
||||
class Tier(BaseModel): |
|
||||
name: str |
|
||||
monthlyPriceInDollars: float |
|
||||
|
|
||||
|
|
||||
class SponsorshipAsMaintainerNode(BaseModel): |
|
||||
sponsorEntity: SponsorEntity |
|
||||
tier: Tier |
|
||||
|
|
||||
|
|
||||
class SponsorshipAsMaintainerEdge(BaseModel): |
|
||||
cursor: str |
|
||||
node: SponsorshipAsMaintainerNode |
|
||||
|
|
||||
|
|
||||
class SponsorshipAsMaintainer(BaseModel): |
|
||||
edges: List[SponsorshipAsMaintainerEdge] |
|
||||
|
|
||||
|
|
||||
class SponsorsUser(BaseModel): |
|
||||
sponsorshipsAsMaintainer: SponsorshipAsMaintainer |
|
||||
|
|
||||
|
|
||||
class SponsorsResponseData(BaseModel): |
|
||||
user: SponsorsUser |
|
||||
|
|
||||
|
|
||||
class SponsorsResponse(BaseModel): |
|
||||
data: SponsorsResponseData |
|
||||
|
|
||||
|
|
||||
class Settings(BaseSettings): |
|
||||
input_token: SecretStr |
|
||||
github_repository: str |
|
||||
httpx_timeout: int = 30 |
|
||||
|
|
||||
|
|
||||
def get_graphql_response( |
|
||||
*, |
|
||||
settings: Settings, |
|
||||
query: str, |
|
||||
after: Union[str, None] = None, |
|
||||
category_id: Union[str, None] = None, |
|
||||
) -> Dict[str, Any]: |
|
||||
headers = {"Authorization": f"token {settings.input_token.get_secret_value()}"} |
|
||||
# category_id is only used by one query, but GraphQL allows unused variables, so |
|
||||
# keep it here for simplicity |
|
||||
variables = {"after": after, "category_id": category_id} |
|
||||
response = httpx.post( |
|
||||
github_graphql_url, |
|
||||
headers=headers, |
|
||||
timeout=settings.httpx_timeout, |
|
||||
json={"query": query, "variables": variables, "operationName": "Q"}, |
|
||||
) |
|
||||
if response.status_code != 200: |
|
||||
logging.error( |
|
||||
f"Response was not 200, after: {after}, category_id: {category_id}" |
|
||||
) |
|
||||
logging.error(response.text) |
|
||||
raise RuntimeError(response.text) |
|
||||
data = response.json() |
|
||||
if "errors" in data: |
|
||||
logging.error(f"Errors in response, after: {after}, category_id: {category_id}") |
|
||||
logging.error(data["errors"]) |
|
||||
logging.error(response.text) |
|
||||
raise RuntimeError(response.text) |
|
||||
return data |
|
||||
|
|
||||
|
|
||||
def get_graphql_question_discussion_edges( |
|
||||
*, |
|
||||
settings: Settings, |
|
||||
after: Union[str, None] = None, |
|
||||
): |
|
||||
data = get_graphql_response( |
|
||||
settings=settings, |
|
||||
query=discussions_query, |
|
||||
after=after, |
|
||||
category_id=questions_category_id, |
|
||||
) |
|
||||
graphql_response = DiscussionsResponse.model_validate(data) |
|
||||
return graphql_response.data.repository.discussions.edges |
|
||||
|
|
||||
|
|
||||
def get_graphql_pr_edges(*, settings: Settings, after: Union[str, None] = None): |
|
||||
data = get_graphql_response(settings=settings, query=prs_query, after=after) |
|
||||
graphql_response = PRsResponse.model_validate(data) |
|
||||
return graphql_response.data.repository.pullRequests.edges |
|
||||
|
|
||||
|
|
||||
def get_graphql_sponsor_edges(*, settings: Settings, after: Union[str, None] = None): |
|
||||
data = get_graphql_response(settings=settings, query=sponsors_query, after=after) |
|
||||
graphql_response = SponsorsResponse.model_validate(data) |
|
||||
return graphql_response.data.user.sponsorshipsAsMaintainer.edges |
|
||||
|
|
||||
|
|
||||
class DiscussionExpertsResults(BaseModel): |
|
||||
commenters: Counter |
|
||||
last_month_commenters: Counter |
|
||||
three_months_commenters: Counter |
|
||||
six_months_commenters: Counter |
|
||||
one_year_commenters: Counter |
|
||||
authors: Dict[str, Author] |
|
||||
|
|
||||
|
|
||||
def get_discussion_nodes(settings: Settings) -> List[DiscussionsNode]: |
|
||||
discussion_nodes: List[DiscussionsNode] = [] |
|
||||
discussion_edges = get_graphql_question_discussion_edges(settings=settings) |
|
||||
|
|
||||
while discussion_edges: |
|
||||
for discussion_edge in discussion_edges: |
|
||||
discussion_nodes.append(discussion_edge.node) |
|
||||
last_edge = discussion_edges[-1] |
|
||||
discussion_edges = get_graphql_question_discussion_edges( |
|
||||
settings=settings, after=last_edge.cursor |
|
||||
) |
|
||||
return discussion_nodes |
|
||||
|
|
||||
|
|
||||
def get_discussions_experts( |
|
||||
discussion_nodes: List[DiscussionsNode], |
|
||||
) -> DiscussionExpertsResults: |
|
||||
commenters = Counter() |
|
||||
last_month_commenters = Counter() |
|
||||
three_months_commenters = Counter() |
|
||||
six_months_commenters = Counter() |
|
||||
one_year_commenters = Counter() |
|
||||
authors: Dict[str, Author] = {} |
|
||||
|
|
||||
now = datetime.now(tz=timezone.utc) |
|
||||
one_month_ago = now - timedelta(days=30) |
|
||||
three_months_ago = now - timedelta(days=90) |
|
||||
six_months_ago = now - timedelta(days=180) |
|
||||
one_year_ago = now - timedelta(days=365) |
|
||||
|
|
||||
for discussion in discussion_nodes: |
|
||||
discussion_author_name = None |
|
||||
if discussion.author: |
|
||||
authors[discussion.author.login] = discussion.author |
|
||||
discussion_author_name = discussion.author.login |
|
||||
discussion_commentors: dict[str, datetime] = {} |
|
||||
for comment in discussion.comments.nodes: |
|
||||
if comment.author: |
|
||||
authors[comment.author.login] = comment.author |
|
||||
if comment.author.login != discussion_author_name: |
|
||||
author_time = discussion_commentors.get( |
|
||||
comment.author.login, comment.createdAt |
|
||||
) |
|
||||
discussion_commentors[comment.author.login] = max( |
|
||||
author_time, comment.createdAt |
|
||||
) |
|
||||
for reply in comment.replies.nodes: |
|
||||
if reply.author: |
|
||||
authors[reply.author.login] = reply.author |
|
||||
if reply.author.login != discussion_author_name: |
|
||||
author_time = discussion_commentors.get( |
|
||||
reply.author.login, reply.createdAt |
|
||||
) |
|
||||
discussion_commentors[reply.author.login] = max( |
|
||||
author_time, reply.createdAt |
|
||||
) |
|
||||
for author_name, author_time in discussion_commentors.items(): |
|
||||
commenters[author_name] += 1 |
|
||||
if author_time > one_month_ago: |
|
||||
last_month_commenters[author_name] += 1 |
|
||||
if author_time > three_months_ago: |
|
||||
three_months_commenters[author_name] += 1 |
|
||||
if author_time > six_months_ago: |
|
||||
six_months_commenters[author_name] += 1 |
|
||||
if author_time > one_year_ago: |
|
||||
one_year_commenters[author_name] += 1 |
|
||||
discussion_experts_results = DiscussionExpertsResults( |
|
||||
authors=authors, |
|
||||
commenters=commenters, |
|
||||
last_month_commenters=last_month_commenters, |
|
||||
three_months_commenters=three_months_commenters, |
|
||||
six_months_commenters=six_months_commenters, |
|
||||
one_year_commenters=one_year_commenters, |
|
||||
) |
|
||||
return discussion_experts_results |
|
||||
|
|
||||
|
|
||||
def get_pr_nodes(settings: Settings) -> List[PullRequestNode]: |
|
||||
pr_nodes: List[PullRequestNode] = [] |
|
||||
pr_edges = get_graphql_pr_edges(settings=settings) |
|
||||
|
|
||||
while pr_edges: |
|
||||
for edge in pr_edges: |
|
||||
pr_nodes.append(edge.node) |
|
||||
last_edge = pr_edges[-1] |
|
||||
pr_edges = get_graphql_pr_edges(settings=settings, after=last_edge.cursor) |
|
||||
return pr_nodes |
|
||||
|
|
||||
|
|
||||
class ContributorsResults(BaseModel): |
|
||||
contributors: Counter |
|
||||
commenters: Counter |
|
||||
reviewers: Counter |
|
||||
translation_reviewers: Counter |
|
||||
authors: Dict[str, Author] |
|
||||
|
|
||||
|
|
||||
def get_contributors(pr_nodes: List[PullRequestNode]) -> ContributorsResults: |
|
||||
contributors = Counter() |
|
||||
commenters = Counter() |
|
||||
reviewers = Counter() |
|
||||
translation_reviewers = Counter() |
|
||||
authors: Dict[str, Author] = {} |
|
||||
|
|
||||
for pr in pr_nodes: |
|
||||
author_name = None |
|
||||
if pr.author: |
|
||||
authors[pr.author.login] = pr.author |
|
||||
author_name = pr.author.login |
|
||||
pr_commentors: Set[str] = set() |
|
||||
pr_reviewers: Set[str] = set() |
|
||||
for comment in pr.comments.nodes: |
|
||||
if comment.author: |
|
||||
authors[comment.author.login] = comment.author |
|
||||
if comment.author.login == author_name: |
|
||||
continue |
|
||||
pr_commentors.add(comment.author.login) |
|
||||
for author_name in pr_commentors: |
|
||||
commenters[author_name] += 1 |
|
||||
for review in pr.reviews.nodes: |
|
||||
if review.author: |
|
||||
authors[review.author.login] = review.author |
|
||||
pr_reviewers.add(review.author.login) |
|
||||
for label in pr.labels.nodes: |
|
||||
if label.name == "lang-all": |
|
||||
translation_reviewers[review.author.login] += 1 |
|
||||
break |
|
||||
for reviewer in pr_reviewers: |
|
||||
reviewers[reviewer] += 1 |
|
||||
if pr.state == "MERGED" and pr.author: |
|
||||
contributors[pr.author.login] += 1 |
|
||||
return ContributorsResults( |
|
||||
contributors=contributors, |
|
||||
commenters=commenters, |
|
||||
reviewers=reviewers, |
|
||||
translation_reviewers=translation_reviewers, |
|
||||
authors=authors, |
|
||||
) |
|
||||
|
|
||||
|
|
||||
def get_individual_sponsors(settings: Settings): |
|
||||
nodes: List[SponsorshipAsMaintainerNode] = [] |
|
||||
edges = get_graphql_sponsor_edges(settings=settings) |
|
||||
|
|
||||
while edges: |
|
||||
for edge in edges: |
|
||||
nodes.append(edge.node) |
|
||||
last_edge = edges[-1] |
|
||||
edges = get_graphql_sponsor_edges(settings=settings, after=last_edge.cursor) |
|
||||
|
|
||||
tiers: DefaultDict[float, Dict[str, SponsorEntity]] = defaultdict(dict) |
|
||||
for node in nodes: |
|
||||
tiers[node.tier.monthlyPriceInDollars][node.sponsorEntity.login] = ( |
|
||||
node.sponsorEntity |
|
||||
) |
|
||||
return tiers |
|
||||
|
|
||||
|
|
||||
def get_top_users( |
|
||||
*, |
|
||||
counter: Counter, |
|
||||
authors: Dict[str, Author], |
|
||||
skip_users: Container[str], |
|
||||
min_count: int = 2, |
|
||||
): |
|
||||
users = [] |
|
||||
for commenter, count in counter.most_common(50): |
|
||||
if commenter in skip_users: |
|
||||
continue |
|
||||
if count >= min_count: |
|
||||
author = authors[commenter] |
|
||||
users.append( |
|
||||
{ |
|
||||
"login": commenter, |
|
||||
"count": count, |
|
||||
"avatarUrl": author.avatarUrl, |
|
||||
"url": author.url, |
|
||||
} |
|
||||
) |
|
||||
return users |
|
||||
|
|
||||
|
|
||||
if __name__ == "__main__": |
|
||||
logging.basicConfig(level=logging.INFO) |
|
||||
settings = Settings() |
|
||||
logging.info(f"Using config: {settings.model_dump_json()}") |
|
||||
g = Github(settings.input_token.get_secret_value()) |
|
||||
repo = g.get_repo(settings.github_repository) |
|
||||
discussion_nodes = get_discussion_nodes(settings=settings) |
|
||||
experts_results = get_discussions_experts(discussion_nodes=discussion_nodes) |
|
||||
pr_nodes = get_pr_nodes(settings=settings) |
|
||||
contributors_results = get_contributors(pr_nodes=pr_nodes) |
|
||||
authors = {**experts_results.authors, **contributors_results.authors} |
|
||||
maintainers_logins = {"tiangolo"} |
|
||||
bot_names = {"codecov", "github-actions", "pre-commit-ci", "dependabot"} |
|
||||
maintainers = [] |
|
||||
for login in maintainers_logins: |
|
||||
user = authors[login] |
|
||||
maintainers.append( |
|
||||
{ |
|
||||
"login": login, |
|
||||
"answers": experts_results.commenters[login], |
|
||||
"prs": contributors_results.contributors[login], |
|
||||
"avatarUrl": user.avatarUrl, |
|
||||
"url": user.url, |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
skip_users = maintainers_logins | bot_names |
|
||||
experts = get_top_users( |
|
||||
counter=experts_results.commenters, |
|
||||
authors=authors, |
|
||||
skip_users=skip_users, |
|
||||
) |
|
||||
last_month_experts = get_top_users( |
|
||||
counter=experts_results.last_month_commenters, |
|
||||
authors=authors, |
|
||||
skip_users=skip_users, |
|
||||
) |
|
||||
three_months_experts = get_top_users( |
|
||||
counter=experts_results.three_months_commenters, |
|
||||
authors=authors, |
|
||||
skip_users=skip_users, |
|
||||
) |
|
||||
six_months_experts = get_top_users( |
|
||||
counter=experts_results.six_months_commenters, |
|
||||
authors=authors, |
|
||||
skip_users=skip_users, |
|
||||
) |
|
||||
one_year_experts = get_top_users( |
|
||||
counter=experts_results.one_year_commenters, |
|
||||
authors=authors, |
|
||||
skip_users=skip_users, |
|
||||
) |
|
||||
top_contributors = get_top_users( |
|
||||
counter=contributors_results.contributors, |
|
||||
authors=authors, |
|
||||
skip_users=skip_users, |
|
||||
) |
|
||||
top_reviewers = get_top_users( |
|
||||
counter=contributors_results.reviewers, |
|
||||
authors=authors, |
|
||||
skip_users=skip_users, |
|
||||
) |
|
||||
top_translations_reviewers = get_top_users( |
|
||||
counter=contributors_results.translation_reviewers, |
|
||||
authors=authors, |
|
||||
skip_users=skip_users, |
|
||||
) |
|
||||
|
|
||||
tiers = get_individual_sponsors(settings=settings) |
|
||||
keys = list(tiers.keys()) |
|
||||
keys.sort(reverse=True) |
|
||||
sponsors = [] |
|
||||
for key in keys: |
|
||||
sponsor_group = [] |
|
||||
for login, sponsor in tiers[key].items(): |
|
||||
sponsor_group.append( |
|
||||
{"login": login, "avatarUrl": sponsor.avatarUrl, "url": sponsor.url} |
|
||||
) |
|
||||
sponsors.append(sponsor_group) |
|
||||
|
|
||||
people = { |
|
||||
"maintainers": maintainers, |
|
||||
"experts": experts, |
|
||||
"last_month_experts": last_month_experts, |
|
||||
"three_months_experts": three_months_experts, |
|
||||
"six_months_experts": six_months_experts, |
|
||||
"one_year_experts": one_year_experts, |
|
||||
"top_contributors": top_contributors, |
|
||||
"top_reviewers": top_reviewers, |
|
||||
"top_translations_reviewers": top_translations_reviewers, |
|
||||
} |
|
||||
github_sponsors = { |
|
||||
"sponsors": sponsors, |
|
||||
} |
|
||||
# For local development |
|
||||
# people_path = Path("../../../../docs/en/data/people.yml") |
|
||||
people_path = Path("./docs/en/data/people.yml") |
|
||||
github_sponsors_path = Path("./docs/en/data/github_sponsors.yml") |
|
||||
people_old_content = people_path.read_text(encoding="utf-8") |
|
||||
github_sponsors_old_content = github_sponsors_path.read_text(encoding="utf-8") |
|
||||
new_people_content = yaml.dump( |
|
||||
people, sort_keys=False, width=200, allow_unicode=True |
|
||||
) |
|
||||
new_github_sponsors_content = yaml.dump( |
|
||||
github_sponsors, sort_keys=False, width=200, allow_unicode=True |
|
||||
) |
|
||||
if ( |
|
||||
people_old_content == new_people_content |
|
||||
and github_sponsors_old_content == new_github_sponsors_content |
|
||||
): |
|
||||
logging.info("The FastAPI People data hasn't changed, finishing.") |
|
||||
sys.exit(0) |
|
||||
people_path.write_text(new_people_content, encoding="utf-8") |
|
||||
github_sponsors_path.write_text(new_github_sponsors_content, encoding="utf-8") |
|
||||
logging.info("Setting up GitHub Actions git user") |
|
||||
subprocess.run(["git", "config", "user.name", "github-actions"], check=True) |
|
||||
subprocess.run( |
|
||||
["git", "config", "user.email", "[email protected]"], check=True |
|
||||
) |
|
||||
branch_name = "fastapi-people" |
|
||||
logging.info(f"Creating a new branch {branch_name}") |
|
||||
subprocess.run(["git", "checkout", "-b", branch_name], check=True) |
|
||||
logging.info("Adding updated file") |
|
||||
subprocess.run( |
|
||||
["git", "add", str(people_path), str(github_sponsors_path)], check=True |
|
||||
) |
|
||||
logging.info("Committing updated file") |
|
||||
message = "👥 Update FastAPI People" |
|
||||
result = subprocess.run(["git", "commit", "-m", message], check=True) |
|
||||
logging.info("Pushing branch") |
|
||||
subprocess.run(["git", "push", "origin", branch_name], check=True) |
|
||||
logging.info("Creating PR") |
|
||||
pr = repo.create_pull(title=message, body=message, base="master", head=branch_name) |
|
||||
logging.info(f"Created PR: {pr.number}") |
|
||||
logging.info("Finished") |
|
||||
@ -35,7 +35,7 @@ jobs: |
|||||
TIANGOLO_BUILD_PACKAGE: ${{ matrix.package }} |
TIANGOLO_BUILD_PACKAGE: ${{ matrix.package }} |
||||
run: python -m build |
run: python -m build |
||||
- name: Publish |
- name: Publish |
||||
uses: pypa/[email protected].3 |
uses: pypa/[email protected].4 |
||||
- name: Dump GitHub context |
- name: Dump GitHub context |
||||
env: |
env: |
||||
GITHUB_CONTEXT: ${{ toJson(github) }} |
GITHUB_CONTEXT: ${{ toJson(github) }} |
||||
|
|||||
File diff suppressed because it is too large
@ -0,0 +1,301 @@ |
|||||
|
# 環境変数 |
||||
|
|
||||
|
/// tip |
||||
|
|
||||
|
もし、「環境変数」とは何か、それをどう使うかを既に知っている場合は、このセクションをスキップして構いません。 |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
環境変数（**env var**とも呼ばれる）はPythonコードの**外側**、つまり**OS**に存在する変数で、Pythonから読み取ることができます。（他のプログラムでも同様に読み取れます。） |
||||
|
|
||||
|
環境変数は、アプリケーションの**設定**の管理や、Pythonの**インストール**などに役立ちます。 |
||||
|
|
||||
|
## 環境変数の作成と使用 |
||||
|
|
||||
|
環境変数は**シェル（ターミナル）**内で**作成**して使用でき、それらにPythonは不要です。 |
||||
|
|
||||
|
//// tab | Linux, macOS, Windows Bash |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
// You could create an env var MY_NAME with |
||||
|
$ export MY_NAME="Wade Wilson" |
||||
|
|
||||
|
// Then you could use it with other programs, like |
||||
|
$ echo "Hello $MY_NAME" |
||||
|
|
||||
|
Hello Wade Wilson |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
//// tab | Windows PowerShell |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
|
||||
|
```console |
||||
|
// Create an env var MY_NAME |
||||
|
$ $Env:MY_NAME = "Wade Wilson" |
||||
|
|
||||
|
// Use it with other programs, like |
||||
|
$ echo "Hello $Env:MY_NAME" |
||||
|
|
||||
|
Hello Wade Wilson |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
## Pythonで環境変数を読み取る |
||||
|
|
||||
|
環境変数をPythonの**外側**、ターミナル（や他の方法）で作成し、**Python内で読み取る**こともできます。 |
||||
|
|
||||
|
例えば、以下のような`main.py`ファイルを用意します: |
||||
|
|
||||
|
```Python hl_lines="3" |
||||
|
import os |
||||
|
|
||||
|
name = os.getenv("MY_NAME", "World") |
||||
|
print(f"Hello {name} from Python") |
||||
|
``` |
||||
|
|
||||
|
/// tip |
||||
|
|
||||
|
<a href="https://docs.python.org/3.8/library/os.html#os.getenv" class="external-link" target="_blank">`os.getenv()`</a> の第2引数は、デフォルトで返される値を指定します。 |
||||
|
|
||||
|
この引数を省略するとデフォルト値として`None`が返されますが、ここではデフォルト値として`"World"`を指定しています。 |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
次に、このPythonプログラムを呼び出します。 |
||||
|
|
||||
|
//// tab | Linux, macOS, Windows Bash |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
// Here we don't set the env var yet |
||||
|
$ python main.py |
||||
|
|
||||
|
// As we didn't set the env var, we get the default value |
||||
|
|
||||
|
Hello World from Python |
||||
|
|
||||
|
// But if we create an environment variable first |
||||
|
$ export MY_NAME="Wade Wilson" |
||||
|
|
||||
|
// And then call the program again |
||||
|
$ python main.py |
||||
|
|
||||
|
// Now it can read the environment variable |
||||
|
|
||||
|
Hello Wade Wilson from Python |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
//// tab | Windows PowerShell |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
// Here we don't set the env var yet |
||||
|
$ python main.py |
||||
|
|
||||
|
// As we didn't set the env var, we get the default value |
||||
|
|
||||
|
Hello World from Python |
||||
|
|
||||
|
// But if we create an environment variable first |
||||
|
$ $Env:MY_NAME = "Wade Wilson" |
||||
|
|
||||
|
// And then call the program again |
||||
|
$ python main.py |
||||
|
|
||||
|
// Now it can read the environment variable |
||||
|
|
||||
|
Hello Wade Wilson from Python |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
環境変数はコードの外側で設定し、内側から読み取ることができるので、他のファイルと一緒に（`git`に）保存する必要がありません。そのため、環境変数をコンフィグレーションや**設定**に使用することが一般的です。 |
||||
|
|
||||
|
また、**特定のプログラムの呼び出し**のための環境変数を、そのプログラムのみ、その実行中に限定して利用できるよう作成できます。 |
||||
|
|
||||
|
そのためには、プログラム起動コマンドと同じコマンドライン上の、起動コマンド直前で環境変数を作成してください。 |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
// Create an env var MY_NAME in line for this program call |
||||
|
$ MY_NAME="Wade Wilson" python main.py |
||||
|
|
||||
|
// Now it can read the environment variable |
||||
|
|
||||
|
Hello Wade Wilson from Python |
||||
|
|
||||
|
// The env var no longer exists afterwards |
||||
|
$ python main.py |
||||
|
|
||||
|
Hello World from Python |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
/// tip |
||||
|
|
||||
|
詳しくは <a href="https://12factor.net/config" class="external-link" target="_blank">The Twelve-Factor App: Config</a> を参照してください。 |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
## 型とバリデーション |
||||
|
|
||||
|
環境変数は**テキスト文字列**のみを扱うことができます。これは、環境変数がPython外部に存在し、他のプログラムやシステム全体（Linux、Windows、macOS間の互換性を含む）と連携する必要があるためです。 |
||||
|
|
||||
|
つまり、Pythonが環境変数から読み取る**あらゆる値**は **`str`型となり**、他の型への変換やバリデーションはコード内で行う必要があります。 |
||||
|
|
||||
|
環境変数を使用して**アプリケーション設定**を管理する方法については、[高度なユーザーガイド - Settings and Environment Variables](./advanced/settings.md){.internal-link target=_blank}で詳しく学べます。 |
||||
|
|
||||
|
## `PATH`環境変数 |
||||
|
|
||||
|
**`PATH`**という**特別な**環境変数があります。この環境変数は、OS（Linux、macOS、Windows）が実行するプログラムを発見するために使用されます。 |
||||
|
|
||||
|
`PATH`変数は、複数のディレクトリのパスから成る長い文字列です。このパスはLinuxやMacOSの場合は`:`で、Windowsの場合は`;`で区切られています。 |
||||
|
|
||||
|
例えば、`PATH`環境変数は次のような文字列かもしれません: |
||||
|
|
||||
|
//// tab | Linux, macOS |
||||
|
|
||||
|
```plaintext |
||||
|
/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin |
||||
|
``` |
||||
|
|
||||
|
これは、OSはプログラムを見つけるために以下のディレクトリを探す、ということを意味します: |
||||
|
|
||||
|
* `/usr/local/bin` |
||||
|
* `/usr/bin` |
||||
|
* `/bin` |
||||
|
* `/usr/sbin` |
||||
|
* `/sbin` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
//// tab | Windows |
||||
|
|
||||
|
```plaintext |
||||
|
C:\Program Files\Python312\Scripts;C:\Program Files\Python312;C:\Windows\System32 |
||||
|
``` |
||||
|
|
||||
|
これは、OSはプログラムを見つけるために以下のディレクトリを探す、ということを意味します: |
||||
|
|
||||
|
* `C:\Program Files\Python312\Scripts` |
||||
|
* `C:\Program Files\Python312` |
||||
|
* `C:\Windows\System32` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
ターミナル上で**コマンド**を入力すると、 OSはそのプログラムを見つけるために、`PATH`環境変数のリストに記載された**それぞれのディレクトリを探し**ます。 |
||||
|
|
||||
|
例えば、ターミナル上で`python`を入力すると、OSは`python`によって呼ばれるプログラムを見つけるために、そのリストの**先頭のディレクトリ**を最初に探します。 |
||||
|
|
||||
|
OSは、もしそのプログラムをそこで発見すれば**実行し**ますが、そうでなければリストの**他のディレクトリ**を探していきます。 |
||||
|
|
||||
|
### PythonのインストールとPATH環境変数の更新 |
||||
|
|
||||
|
Pythonのインストール時に`PATH`環境変数を更新したいか聞かれるかもしれません。 |
||||
|
|
||||
|
/// tab | Linux, macOS |
||||
|
|
||||
|
Pythonをインストールして、そのプログラムが`/opt/custompython/bin`というディレクトリに配置されたとします。 |
||||
|
|
||||
|
もし、`PATH`環境変数を更新するように答えると、`PATH`環境変数に`/opt/custompython/bin`が追加されます。 |
||||
|
|
||||
|
`PATH`環境変数は以下のように更新されるでしょう： |
||||
|
|
||||
|
``` plaintext |
||||
|
/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/opt/custompython/bin |
||||
|
``` |
||||
|
|
||||
|
このようにして、ターミナルで`python`と入力したときに、OSは`/opt/custompython/bin`（リストの末尾のディレクトリ）にあるPythonプログラムを見つけ、使用します。 |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
/// tab | Windows |
||||
|
|
||||
|
Pythonをインストールして、そのプログラムが`C:\opt\custompython\bin`というディレクトリに配置されたとします。 |
||||
|
|
||||
|
もし、`PATH`環境変数を更新するように答えると、`PATH`環境変数に`C:\opt\custompython\bin`が追加されます。 |
||||
|
|
||||
|
`PATH`環境変数は以下のように更新されるでしょう： |
||||
|
|
||||
|
```plaintext |
||||
|
C:\Program Files\Python312\Scripts;C:\Program Files\Python312;C:\Windows\System32;C:\opt\custompython\bin |
||||
|
``` |
||||
|
|
||||
|
このようにして、ターミナルで`python`と入力したときに、OSは`C:\opt\custompython\bin\python`（リストの末尾のディレクトリ）にあるPythonプログラムを見つけ、使用します。 |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
つまり、ターミナルで以下のコマンドを入力すると： |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
``` console |
||||
|
$ python |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
/// tab | Linux, macOS |
||||
|
|
||||
|
OSは`/opt/custompython/bin`にある`python`プログラムを**見つけ**て実行します。 |
||||
|
|
||||
|
これは、次のコマンドを入力した場合とほとんど同等です： |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ /opt/custompython/bin/python |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
/// tab | Windows |
||||
|
|
||||
|
OSは`C:\opt\custompython\bin\python`にある`python`プログラムを**見つけ**て実行します。 |
||||
|
|
||||
|
これは、次のコマンドを入力した場合とほとんど同等です： |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ C:\opt\custompython\bin\python |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
この情報は、[Virtual Environments](virtual-environments.md) について学ぶ際にも役立ちます。 |
||||
|
|
||||
|
## まとめ |
||||
|
|
||||
|
これで、**環境変数**とは何か、Pythonでどのように使用するかについて、基本的な理解が得られたはずです。 |
||||
|
|
||||
|
環境変数についての詳細は、<a href="https://en.wikipedia.org/wiki/Environment_variable" class="external-link" target="_blank">Wikipedia: Environment Variable</a> を参照してください。 |
||||
|
|
||||
|
環境変数の用途や適用方法が最初は直感的ではないかもしれませんが、開発中のさまざまなシナリオで繰り返し登場します。そのため、基本を知っておくことが重要です。 |
||||
|
|
||||
|
たとえば、この情報は次のセクションで扱う[Virtual Environments](virtual-environments.md)にも関連します。 |
||||
@ -0,0 +1,99 @@ |
|||||
|
# Асинхронное тестирование |
||||
|
|
||||
|
Вы уже видели как тестировать **FastAPI** приложение, используя имеющийся класс `TestClient`. К этому моменту вы видели только как писать тесты в синхронном стиле без использования `async` функций. |
||||
|
|
||||
|
Возможность использования асинхронных функций в ваших тестах может быть полезнa, когда, например, вы асинхронно обращаетесь к вашей базе данных. Представьте, что вы хотите отправить запросы в ваше FastAPI приложение, а затем при помощи асинхронной библиотеки для работы с базой данных удостовериться, что ваш бекэнд корректно записал данные в базу данных. |
||||
|
|
||||
|
Давайте рассмотрим, как мы можем это реализовать. |
||||
|
|
||||
|
## pytest.mark.anyio |
||||
|
|
||||
|
Если мы хотим вызывать асинхронные функции в наших тестах, то наши тестовые функции должны быть асинхронными. AnyIO предоставляет для этого отличный плагин, который позволяет нам указывать, какие тестовые функции должны вызываться асинхронно. |
||||
|
|
||||
|
## HTTPX |
||||
|
|
||||
|
Даже если **FastAPI** приложение использует обычные функции `def` вместо `async def`, это все равно `async` приложение 'под капотом'. |
||||
|
|
||||
|
Чтобы работать с асинхронным FastAPI приложением в ваших обычных тестовых функциях `def`, используя стандартный pytest, `TestClient` внутри себя делает некоторую магию. Но эта магия перестает работать, когда мы используем его внутри асинхронных функций. Запуская наши тесты асинхронно, мы больше не можем использовать `TestClient` внутри наших тестовых функций. |
||||
|
|
||||
|
`TestClient` основан на <a href="https://www.python-httpx.org" class="external-link" target="_blank">HTTPX</a>, и, к счастью, мы можем использовать его (`HTTPX`) напрямую для тестирования API. |
||||
|
|
||||
|
## Пример |
||||
|
|
||||
|
В качестве простого примера, давайте рассмотрим файловую структуру, схожую с описанной в [Большие приложения](../tutorial/bigger-applications.md){.internal-link target=_blank} и [Тестирование](../tutorial/testing.md){.internal-link target=_blank}: |
||||
|
|
||||
|
``` |
||||
|
. |
||||
|
├── app |
||||
|
│ ├── __init__.py |
||||
|
│ ├── main.py |
||||
|
│ └── test_main.py |
||||
|
``` |
||||
|
|
||||
|
Файл `main.py`: |
||||
|
|
||||
|
{* ../../docs_src/async_tests/main.py *} |
||||
|
|
||||
|
Файл `test_main.py` содержит тесты для `main.py`, теперь он может выглядеть так: |
||||
|
|
||||
|
{* ../../docs_src/async_tests/test_main.py *} |
||||
|
|
||||
|
## Запуск тестов |
||||
|
|
||||
|
Вы можете запустить свои тесты как обычно: |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ pytest |
||||
|
|
||||
|
---> 100% |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
## Подробнее |
||||
|
|
||||
|
Маркер `@pytest.mark.anyio` говорит pytest, что тестовая функция должна быть вызвана асинхронно: |
||||
|
|
||||
|
{* ../../docs_src/async_tests/test_main.py hl[7] *} |
||||
|
|
||||
|
/// tip | Подсказка |
||||
|
|
||||
|
Обратите внимание, что тестовая функция теперь `async def` вместо простого `def`, как это было при использовании `TestClient`. |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
Затем мы можем создать `AsyncClient` со ссылкой на приложение и посылать асинхронные запросы, используя `await`. |
||||
|
|
||||
|
{* ../../docs_src/async_tests/test_main.py hl[9:12] *} |
||||
|
|
||||
|
Это эквивалентно следующему: |
||||
|
|
||||
|
```Python |
||||
|
response = client.get('/') |
||||
|
``` |
||||
|
|
||||
|
...которое мы использовали для отправки наших запросов с `TestClient`. |
||||
|
|
||||
|
/// tip | Подсказка |
||||
|
|
||||
|
Обратите внимание, что мы используем async/await с `AsyncClient` - запрос асинхронный. |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
/// warning | Внимание |
||||
|
|
||||
|
Если ваше приложение полагается на lifespan события, то `AsyncClient` не запустит эти события. Чтобы обеспечить их срабатывание используйте `LifespanManager` из <a href="https://github.com/florimondmanca/asgi-lifespan#usage" class="external-link" target="_blank">florimondmanca/asgi-lifespan</a>. |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
## Вызов других асинхронных функций |
||||
|
|
||||
|
Теперь тестовая функция стала асинхронной, поэтому внутри нее вы можете вызывать также и другие `async` функции, не связанные с отправлением запросов в ваше FastAPI приложение. Как если бы вы вызывали их в любом другом месте вашего кода. |
||||
|
|
||||
|
/// tip | Подсказка |
||||
|
|
||||
|
Если вы столкнулись с `RuntimeError: Task attached to a different loop` при вызове асинхронных функций в ваших тестах (например, при использовании <a href="https://stackoverflow.com/questions/41584243/runtimeerror-task-attached-to-a-different-loop" class="external-link" target="_blank">MongoDB's MotorClient</a>), то не забывайте инициализировать объекты, которым нужен цикл событий (event loop), только внутри асинхронных функций, например, в `'@app.on_event("startup")` callback. |
||||
|
|
||||
|
/// |
||||
@ -0,0 +1,401 @@ |
|||||
|
import logging |
||||
|
import secrets |
||||
|
import subprocess |
||||
|
import time |
||||
|
from collections import Counter |
||||
|
from datetime import datetime, timedelta, timezone |
||||
|
from pathlib import Path |
||||
|
from typing import Any, Container, Union |
||||
|
|
||||
|
import httpx |
||||
|
import yaml |
||||
|
from github import Github |
||||
|
from pydantic import BaseModel, SecretStr |
||||
|
from pydantic_settings import BaseSettings |
||||
|
|
||||
|
github_graphql_url = "https://api.github.com/graphql" |
||||
|
questions_category_id = "MDE4OkRpc2N1c3Npb25DYXRlZ29yeTMyMDAxNDM0" |
||||
|
|
||||
|
discussions_query = """ |
||||
|
query Q($after: String, $category_id: ID) { |
||||
|
repository(name: "fastapi", owner: "fastapi") { |
||||
|
discussions(first: 100, after: $after, categoryId: $category_id) { |
||||
|
edges { |
||||
|
cursor |
||||
|
node { |
||||
|
number |
||||
|
author { |
||||
|
login |
||||
|
avatarUrl |
||||
|
url |
||||
|
} |
||||
|
createdAt |
||||
|
comments(first: 50) { |
||||
|
totalCount |
||||
|
nodes { |
||||
|
createdAt |
||||
|
author { |
||||
|
login |
||||
|
avatarUrl |
||||
|
url |
||||
|
} |
||||
|
isAnswer |
||||
|
replies(first: 10) { |
||||
|
totalCount |
||||
|
nodes { |
||||
|
createdAt |
||||
|
author { |
||||
|
login |
||||
|
avatarUrl |
||||
|
url |
||||
|
} |
||||
|
} |
||||
|
} |
||||
|
} |
||||
|
} |
||||
|
} |
||||
|
} |
||||
|
} |
||||
|
} |
||||
|
} |
||||
|
""" |
||||
|
|
||||
|
|
||||
|
class Author(BaseModel): |
||||
|
login: str |
||||
|
avatarUrl: str | None = None |
||||
|
url: str | None = None |
||||
|
|
||||
|
|
||||
|
class CommentsNode(BaseModel): |
||||
|
createdAt: datetime |
||||
|
author: Union[Author, None] = None |
||||
|
|
||||
|
|
||||
|
class Replies(BaseModel): |
||||
|
totalCount: int |
||||
|
nodes: list[CommentsNode] |
||||
|
|
||||
|
|
||||
|
class DiscussionsCommentsNode(CommentsNode): |
||||
|
replies: Replies |
||||
|
|
||||
|
|
||||
|
class DiscussionsComments(BaseModel): |
||||
|
totalCount: int |
||||
|
nodes: list[DiscussionsCommentsNode] |
||||
|
|
||||
|
|
||||
|
class DiscussionsNode(BaseModel): |
||||
|
number: int |
||||
|
author: Union[Author, None] = None |
||||
|
title: str | None = None |
||||
|
createdAt: datetime |
||||
|
comments: DiscussionsComments |
||||
|
|
||||
|
|
||||
|
class DiscussionsEdge(BaseModel): |
||||
|
cursor: str |
||||
|
node: DiscussionsNode |
||||
|
|
||||
|
|
||||
|
class Discussions(BaseModel): |
||||
|
edges: list[DiscussionsEdge] |
||||
|
|
||||
|
|
||||
|
class DiscussionsRepository(BaseModel): |
||||
|
discussions: Discussions |
||||
|
|
||||
|
|
||||
|
class DiscussionsResponseData(BaseModel): |
||||
|
repository: DiscussionsRepository |
||||
|
|
||||
|
|
||||
|
class DiscussionsResponse(BaseModel): |
||||
|
data: DiscussionsResponseData |
||||
|
|
||||
|
|
||||
|
class Settings(BaseSettings): |
||||
|
github_token: SecretStr |
||||
|
github_repository: str |
||||
|
httpx_timeout: int = 30 |
||||
|
|
||||
|
|
||||
|
def get_graphql_response( |
||||
|
*, |
||||
|
settings: Settings, |
||||
|
query: str, |
||||
|
after: Union[str, None] = None, |
||||
|
category_id: Union[str, None] = None, |
||||
|
) -> dict[str, Any]: |
||||
|
headers = {"Authorization": f"token {settings.github_token.get_secret_value()}"} |
||||
|
variables = {"after": after, "category_id": category_id} |
||||
|
response = httpx.post( |
||||
|
github_graphql_url, |
||||
|
headers=headers, |
||||
|
timeout=settings.httpx_timeout, |
||||
|
json={"query": query, "variables": variables, "operationName": "Q"}, |
||||
|
) |
||||
|
if response.status_code != 200: |
||||
|
logging.error( |
||||
|
f"Response was not 200, after: {after}, category_id: {category_id}" |
||||
|
) |
||||
|
logging.error(response.text) |
||||
|
raise RuntimeError(response.text) |
||||
|
data = response.json() |
||||
|
if "errors" in data: |
||||
|
logging.error(f"Errors in response, after: {after}, category_id: {category_id}") |
||||
|
logging.error(data["errors"]) |
||||
|
logging.error(response.text) |
||||
|
raise RuntimeError(response.text) |
||||
|
return data |
||||
|
|
||||
|
|
||||
|
def get_graphql_question_discussion_edges( |
||||
|
*, |
||||
|
settings: Settings, |
||||
|
after: Union[str, None] = None, |
||||
|
) -> list[DiscussionsEdge]: |
||||
|
data = get_graphql_response( |
||||
|
settings=settings, |
||||
|
query=discussions_query, |
||||
|
after=after, |
||||
|
category_id=questions_category_id, |
||||
|
) |
||||
|
graphql_response = DiscussionsResponse.model_validate(data) |
||||
|
return graphql_response.data.repository.discussions.edges |
||||
|
|
||||
|
|
||||
|
class DiscussionExpertsResults(BaseModel): |
||||
|
commenters: Counter[str] |
||||
|
last_month_commenters: Counter[str] |
||||
|
three_months_commenters: Counter[str] |
||||
|
six_months_commenters: Counter[str] |
||||
|
one_year_commenters: Counter[str] |
||||
|
authors: dict[str, Author] |
||||
|
|
||||
|
|
||||
|
def get_discussion_nodes(settings: Settings) -> list[DiscussionsNode]: |
||||
|
discussion_nodes: list[DiscussionsNode] = [] |
||||
|
discussion_edges = get_graphql_question_discussion_edges(settings=settings) |
||||
|
|
||||
|
while discussion_edges: |
||||
|
for discussion_edge in discussion_edges: |
||||
|
discussion_nodes.append(discussion_edge.node) |
||||
|
last_edge = discussion_edges[-1] |
||||
|
# Handle GitHub secondary rate limits, requests per minute |
||||
|
time.sleep(5) |
||||
|
discussion_edges = get_graphql_question_discussion_edges( |
||||
|
settings=settings, after=last_edge.cursor |
||||
|
) |
||||
|
return discussion_nodes |
||||
|
|
||||
|
|
||||
|
def get_discussions_experts( |
||||
|
discussion_nodes: list[DiscussionsNode], |
||||
|
) -> DiscussionExpertsResults: |
||||
|
commenters = Counter[str]() |
||||
|
last_month_commenters = Counter[str]() |
||||
|
three_months_commenters = Counter[str]() |
||||
|
six_months_commenters = Counter[str]() |
||||
|
one_year_commenters = Counter[str]() |
||||
|
authors: dict[str, Author] = {} |
||||
|
|
||||
|
now = datetime.now(tz=timezone.utc) |
||||
|
one_month_ago = now - timedelta(days=30) |
||||
|
three_months_ago = now - timedelta(days=90) |
||||
|
six_months_ago = now - timedelta(days=180) |
||||
|
one_year_ago = now - timedelta(days=365) |
||||
|
|
||||
|
for discussion in discussion_nodes: |
||||
|
discussion_author_name = None |
||||
|
if discussion.author: |
||||
|
authors[discussion.author.login] = discussion.author |
||||
|
discussion_author_name = discussion.author.login |
||||
|
discussion_commentors: dict[str, datetime] = {} |
||||
|
for comment in discussion.comments.nodes: |
||||
|
if comment.author: |
||||
|
authors[comment.author.login] = comment.author |
||||
|
if comment.author.login != discussion_author_name: |
||||
|
author_time = discussion_commentors.get( |
||||
|
comment.author.login, comment.createdAt |
||||
|
) |
||||
|
discussion_commentors[comment.author.login] = max( |
||||
|
author_time, comment.createdAt |
||||
|
) |
||||
|
for reply in comment.replies.nodes: |
||||
|
if reply.author: |
||||
|
authors[reply.author.login] = reply.author |
||||
|
if reply.author.login != discussion_author_name: |
||||
|
author_time = discussion_commentors.get( |
||||
|
reply.author.login, reply.createdAt |
||||
|
) |
||||
|
discussion_commentors[reply.author.login] = max( |
||||
|
author_time, reply.createdAt |
||||
|
) |
||||
|
for author_name, author_time in discussion_commentors.items(): |
||||
|
commenters[author_name] += 1 |
||||
|
if author_time > one_month_ago: |
||||
|
last_month_commenters[author_name] += 1 |
||||
|
if author_time > three_months_ago: |
||||
|
three_months_commenters[author_name] += 1 |
||||
|
if author_time > six_months_ago: |
||||
|
six_months_commenters[author_name] += 1 |
||||
|
if author_time > one_year_ago: |
||||
|
one_year_commenters[author_name] += 1 |
||||
|
discussion_experts_results = DiscussionExpertsResults( |
||||
|
authors=authors, |
||||
|
commenters=commenters, |
||||
|
last_month_commenters=last_month_commenters, |
||||
|
three_months_commenters=three_months_commenters, |
||||
|
six_months_commenters=six_months_commenters, |
||||
|
one_year_commenters=one_year_commenters, |
||||
|
) |
||||
|
return discussion_experts_results |
||||
|
|
||||
|
|
||||
|
def get_top_users( |
||||
|
*, |
||||
|
counter: Counter[str], |
||||
|
authors: dict[str, Author], |
||||
|
skip_users: Container[str], |
||||
|
min_count: int = 2, |
||||
|
) -> list[dict[str, Any]]: |
||||
|
users: list[dict[str, Any]] = [] |
||||
|
for commenter, count in counter.most_common(50): |
||||
|
if commenter in skip_users: |
||||
|
continue |
||||
|
if count >= min_count: |
||||
|
author = authors[commenter] |
||||
|
users.append( |
||||
|
{ |
||||
|
"login": commenter, |
||||
|
"count": count, |
||||
|
"avatarUrl": author.avatarUrl, |
||||
|
"url": author.url, |
||||
|
} |
||||
|
) |
||||
|
return users |
||||
|
|
||||
|
|
||||
|
def get_users_to_write( |
||||
|
*, |
||||
|
counter: Counter[str], |
||||
|
authors: dict[str, Author], |
||||
|
min_count: int = 2, |
||||
|
) -> list[dict[str, Any]]: |
||||
|
users: dict[str, Any] = {} |
||||
|
users_list: list[dict[str, Any]] = [] |
||||
|
for user, count in counter.most_common(60): |
||||
|
if count >= min_count: |
||||
|
author = authors[user] |
||||
|
user_data = { |
||||
|
"login": user, |
||||
|
"count": count, |
||||
|
"avatarUrl": author.avatarUrl, |
||||
|
"url": author.url, |
||||
|
} |
||||
|
users[user] = user_data |
||||
|
users_list.append(user_data) |
||||
|
return users_list |
||||
|
|
||||
|
|
||||
|
def update_content(*, content_path: Path, new_content: Any) -> bool: |
||||
|
old_content = content_path.read_text(encoding="utf-8") |
||||
|
|
||||
|
new_content = yaml.dump(new_content, sort_keys=False, width=200, allow_unicode=True) |
||||
|
if old_content == new_content: |
||||
|
logging.info(f"The content hasn't changed for {content_path}") |
||||
|
return False |
||||
|
content_path.write_text(new_content, encoding="utf-8") |
||||
|
logging.info(f"Updated {content_path}") |
||||
|
return True |
||||
|
|
||||
|
|
||||
|
def main() -> None: |
||||
|
logging.basicConfig(level=logging.INFO) |
||||
|
settings = Settings() |
||||
|
logging.info(f"Using config: {settings.model_dump_json()}") |
||||
|
g = Github(settings.github_token.get_secret_value()) |
||||
|
repo = g.get_repo(settings.github_repository) |
||||
|
|
||||
|
discussion_nodes = get_discussion_nodes(settings=settings) |
||||
|
experts_results = get_discussions_experts(discussion_nodes=discussion_nodes) |
||||
|
|
||||
|
authors = experts_results.authors |
||||
|
maintainers_logins = {"tiangolo"} |
||||
|
maintainers = [] |
||||
|
for login in maintainers_logins: |
||||
|
user = authors[login] |
||||
|
maintainers.append( |
||||
|
{ |
||||
|
"login": login, |
||||
|
"answers": experts_results.commenters[login], |
||||
|
"avatarUrl": user.avatarUrl, |
||||
|
"url": user.url, |
||||
|
} |
||||
|
) |
||||
|
|
||||
|
experts = get_users_to_write( |
||||
|
counter=experts_results.commenters, |
||||
|
authors=authors, |
||||
|
) |
||||
|
last_month_experts = get_users_to_write( |
||||
|
counter=experts_results.last_month_commenters, |
||||
|
authors=authors, |
||||
|
) |
||||
|
three_months_experts = get_users_to_write( |
||||
|
counter=experts_results.three_months_commenters, |
||||
|
authors=authors, |
||||
|
) |
||||
|
six_months_experts = get_users_to_write( |
||||
|
counter=experts_results.six_months_commenters, |
||||
|
authors=authors, |
||||
|
) |
||||
|
one_year_experts = get_users_to_write( |
||||
|
counter=experts_results.one_year_commenters, |
||||
|
authors=authors, |
||||
|
) |
||||
|
|
||||
|
people = { |
||||
|
"maintainers": maintainers, |
||||
|
"experts": experts, |
||||
|
"last_month_experts": last_month_experts, |
||||
|
"three_months_experts": three_months_experts, |
||||
|
"six_months_experts": six_months_experts, |
||||
|
"one_year_experts": one_year_experts, |
||||
|
} |
||||
|
|
||||
|
# For local development |
||||
|
# people_path = Path("../docs/en/data/people.yml") |
||||
|
people_path = Path("./docs/en/data/people.yml") |
||||
|
|
||||
|
updated = update_content(content_path=people_path, new_content=people) |
||||
|
|
||||
|
if not updated: |
||||
|
logging.info("The data hasn't changed, finishing.") |
||||
|
return |
||||
|
|
||||
|
logging.info("Setting up GitHub Actions git user") |
||||
|
subprocess.run(["git", "config", "user.name", "github-actions"], check=True) |
||||
|
subprocess.run( |
||||
|
["git", "config", "user.email", "[email protected]"], check=True |
||||
|
) |
||||
|
branch_name = f"fastapi-people-experts-{secrets.token_hex(4)}" |
||||
|
logging.info(f"Creating a new branch {branch_name}") |
||||
|
subprocess.run(["git", "checkout", "-b", branch_name], check=True) |
||||
|
logging.info("Adding updated file") |
||||
|
subprocess.run(["git", "add", str(people_path)], check=True) |
||||
|
logging.info("Committing updated file") |
||||
|
message = "👥 Update FastAPI People - Experts" |
||||
|
subprocess.run(["git", "commit", "-m", message], check=True) |
||||
|
logging.info("Pushing branch") |
||||
|
subprocess.run(["git", "push", "origin", branch_name], check=True) |
||||
|
logging.info("Creating PR") |
||||
|
pr = repo.create_pull(title=message, body=message, base="master", head=branch_name) |
||||
|
logging.info(f"Created PR: {pr.number}") |
||||
|
logging.info("Finished") |
||||
|
|
||||
|
|
||||
|
if __name__ == "__main__": |
||||
|
main() |
||||
@ -1,273 +0,0 @@ |
|||||
import pytest |
|
||||
from dirty_equals import IsDict |
|
||||
from fastapi.testclient import TestClient |
|
||||
|
|
||||
|
|
||||
@pytest.fixture(name="client") |
|
||||
def get_client(): |
|
||||
from docs_src.body_multiple_params.tutorial003_an import app |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
return client |
|
||||
|
|
||||
|
|
||||
def test_post_body_valid(client: TestClient): |
|
||||
response = client.put( |
|
||||
"/items/5", |
|
||||
json={ |
|
||||
"importance": 2, |
|
||||
"item": {"name": "Foo", "price": 50.5}, |
|
||||
"user": {"username": "Dave"}, |
|
||||
}, |
|
||||
) |
|
||||
assert response.status_code == 200 |
|
||||
assert response.json() == { |
|
||||
"item_id": 5, |
|
||||
"importance": 2, |
|
||||
"item": { |
|
||||
"name": "Foo", |
|
||||
"price": 50.5, |
|
||||
"description": None, |
|
||||
"tax": None, |
|
||||
}, |
|
||||
"user": {"username": "Dave", "full_name": None}, |
|
||||
} |
|
||||
|
|
||||
|
|
||||
def test_post_body_no_data(client: TestClient): |
|
||||
response = client.put("/items/5", json=None) |
|
||||
assert response.status_code == 422 |
|
||||
assert response.json() == IsDict( |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "item"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "user"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "importance"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
] |
|
||||
} |
|
||||
) | IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "item"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
{ |
|
||||
"loc": ["body", "user"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
{ |
|
||||
"loc": ["body", "importance"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
] |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
|
|
||||
def test_post_body_empty_list(client: TestClient): |
|
||||
response = client.put("/items/5", json=[]) |
|
||||
assert response.status_code == 422 |
|
||||
assert response.json() == IsDict( |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "item"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "user"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "importance"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
] |
|
||||
} |
|
||||
) | IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "item"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
{ |
|
||||
"loc": ["body", "user"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
{ |
|
||||
"loc": ["body", "importance"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
] |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
|
|
||||
def test_openapi_schema(client: TestClient): |
|
||||
response = client.get("/openapi.json") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == { |
|
||||
"openapi": "3.1.0", |
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|
||||
"paths": { |
|
||||
"/items/{item_id}": { |
|
||||
"put": { |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
"summary": "Update Item", |
|
||||
"operationId": "update_item_items__item_id__put", |
|
||||
"parameters": [ |
|
||||
{ |
|
||||
"required": True, |
|
||||
"schema": {"title": "Item Id", "type": "integer"}, |
|
||||
"name": "item_id", |
|
||||
"in": "path", |
|
||||
} |
|
||||
], |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_update_item_items__item_id__put" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"components": { |
|
||||
"schemas": { |
|
||||
"Item": { |
|
||||
"title": "Item", |
|
||||
"required": ["name", "price"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"name": {"title": "Name", "type": "string"}, |
|
||||
"description": IsDict( |
|
||||
{ |
|
||||
"title": "Description", |
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "Description", "type": "string"} |
|
||||
), |
|
||||
"price": {"title": "Price", "type": "number"}, |
|
||||
"tax": IsDict( |
|
||||
{ |
|
||||
"title": "Tax", |
|
||||
"anyOf": [{"type": "number"}, {"type": "null"}], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "Tax", "type": "number"} |
|
||||
), |
|
||||
}, |
|
||||
}, |
|
||||
"User": { |
|
||||
"title": "User", |
|
||||
"required": ["username"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"username": {"title": "Username", "type": "string"}, |
|
||||
"full_name": IsDict( |
|
||||
{ |
|
||||
"title": "Full Name", |
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "Full Name", "type": "string"} |
|
||||
), |
|
||||
}, |
|
||||
}, |
|
||||
"Body_update_item_items__item_id__put": { |
|
||||
"title": "Body_update_item_items__item_id__put", |
|
||||
"required": ["item", "user", "importance"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"item": {"$ref": "#/components/schemas/Item"}, |
|
||||
"user": {"$ref": "#/components/schemas/User"}, |
|
||||
"importance": {"title": "Importance", "type": "integer"}, |
|
||||
}, |
|
||||
}, |
|
||||
"ValidationError": { |
|
||||
"title": "ValidationError", |
|
||||
"required": ["loc", "msg", "type"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"loc": { |
|
||||
"title": "Location", |
|
||||
"type": "array", |
|
||||
"items": { |
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|
||||
}, |
|
||||
}, |
|
||||
"msg": {"title": "Message", "type": "string"}, |
|
||||
"type": {"title": "Error Type", "type": "string"}, |
|
||||
}, |
|
||||
}, |
|
||||
"HTTPValidationError": { |
|
||||
"title": "HTTPValidationError", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"detail": { |
|
||||
"title": "Detail", |
|
||||
"type": "array", |
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
@ -1,279 +0,0 @@ |
|||||
import pytest |
|
||||
from dirty_equals import IsDict |
|
||||
from fastapi.testclient import TestClient |
|
||||
|
|
||||
from ...utils import needs_py310 |
|
||||
|
|
||||
|
|
||||
@pytest.fixture(name="client") |
|
||||
def get_client(): |
|
||||
from docs_src.body_multiple_params.tutorial003_an_py310 import app |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
return client |
|
||||
|
|
||||
|
|
||||
@needs_py310 |
|
||||
def test_post_body_valid(client: TestClient): |
|
||||
response = client.put( |
|
||||
"/items/5", |
|
||||
json={ |
|
||||
"importance": 2, |
|
||||
"item": {"name": "Foo", "price": 50.5}, |
|
||||
"user": {"username": "Dave"}, |
|
||||
}, |
|
||||
) |
|
||||
assert response.status_code == 200 |
|
||||
assert response.json() == { |
|
||||
"item_id": 5, |
|
||||
"importance": 2, |
|
||||
"item": { |
|
||||
"name": "Foo", |
|
||||
"price": 50.5, |
|
||||
"description": None, |
|
||||
"tax": None, |
|
||||
}, |
|
||||
"user": {"username": "Dave", "full_name": None}, |
|
||||
} |
|
||||
|
|
||||
|
|
||||
@needs_py310 |
|
||||
def test_post_body_no_data(client: TestClient): |
|
||||
response = client.put("/items/5", json=None) |
|
||||
assert response.status_code == 422 |
|
||||
assert response.json() == IsDict( |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "item"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "user"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "importance"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
] |
|
||||
} |
|
||||
) | IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "item"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
{ |
|
||||
"loc": ["body", "user"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
{ |
|
||||
"loc": ["body", "importance"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
] |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
|
|
||||
@needs_py310 |
|
||||
def test_post_body_empty_list(client: TestClient): |
|
||||
response = client.put("/items/5", json=[]) |
|
||||
assert response.status_code == 422 |
|
||||
assert response.json() == IsDict( |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "item"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "user"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "importance"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
] |
|
||||
} |
|
||||
) | IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "item"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
{ |
|
||||
"loc": ["body", "user"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
{ |
|
||||
"loc": ["body", "importance"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
] |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
|
|
||||
@needs_py310 |
|
||||
def test_openapi_schema(client: TestClient): |
|
||||
response = client.get("/openapi.json") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == { |
|
||||
"openapi": "3.1.0", |
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|
||||
"paths": { |
|
||||
"/items/{item_id}": { |
|
||||
"put": { |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
"summary": "Update Item", |
|
||||
"operationId": "update_item_items__item_id__put", |
|
||||
"parameters": [ |
|
||||
{ |
|
||||
"required": True, |
|
||||
"schema": {"title": "Item Id", "type": "integer"}, |
|
||||
"name": "item_id", |
|
||||
"in": "path", |
|
||||
} |
|
||||
], |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_update_item_items__item_id__put" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"components": { |
|
||||
"schemas": { |
|
||||
"Item": { |
|
||||
"title": "Item", |
|
||||
"required": ["name", "price"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"name": {"title": "Name", "type": "string"}, |
|
||||
"description": IsDict( |
|
||||
{ |
|
||||
"title": "Description", |
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "Description", "type": "string"} |
|
||||
), |
|
||||
"price": {"title": "Price", "type": "number"}, |
|
||||
"tax": IsDict( |
|
||||
{ |
|
||||
"title": "Tax", |
|
||||
"anyOf": [{"type": "number"}, {"type": "null"}], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "Tax", "type": "number"} |
|
||||
), |
|
||||
}, |
|
||||
}, |
|
||||
"User": { |
|
||||
"title": "User", |
|
||||
"required": ["username"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"username": {"title": "Username", "type": "string"}, |
|
||||
"full_name": IsDict( |
|
||||
{ |
|
||||
"title": "Full Name", |
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "Full Name", "type": "string"} |
|
||||
), |
|
||||
}, |
|
||||
}, |
|
||||
"Body_update_item_items__item_id__put": { |
|
||||
"title": "Body_update_item_items__item_id__put", |
|
||||
"required": ["item", "user", "importance"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"item": {"$ref": "#/components/schemas/Item"}, |
|
||||
"user": {"$ref": "#/components/schemas/User"}, |
|
||||
"importance": {"title": "Importance", "type": "integer"}, |
|
||||
}, |
|
||||
}, |
|
||||
"ValidationError": { |
|
||||
"title": "ValidationError", |
|
||||
"required": ["loc", "msg", "type"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"loc": { |
|
||||
"title": "Location", |
|
||||
"type": "array", |
|
||||
"items": { |
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|
||||
}, |
|
||||
}, |
|
||||
"msg": {"title": "Message", "type": "string"}, |
|
||||
"type": {"title": "Error Type", "type": "string"}, |
|
||||
}, |
|
||||
}, |
|
||||
"HTTPValidationError": { |
|
||||
"title": "HTTPValidationError", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"detail": { |
|
||||
"title": "Detail", |
|
||||
"type": "array", |
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
@ -1,279 +0,0 @@ |
|||||
import pytest |
|
||||
from dirty_equals import IsDict |
|
||||
from fastapi.testclient import TestClient |
|
||||
|
|
||||
from ...utils import needs_py39 |
|
||||
|
|
||||
|
|
||||
@pytest.fixture(name="client") |
|
||||
def get_client(): |
|
||||
from docs_src.body_multiple_params.tutorial003_an_py39 import app |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
return client |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_body_valid(client: TestClient): |
|
||||
response = client.put( |
|
||||
"/items/5", |
|
||||
json={ |
|
||||
"importance": 2, |
|
||||
"item": {"name": "Foo", "price": 50.5}, |
|
||||
"user": {"username": "Dave"}, |
|
||||
}, |
|
||||
) |
|
||||
assert response.status_code == 200 |
|
||||
assert response.json() == { |
|
||||
"item_id": 5, |
|
||||
"importance": 2, |
|
||||
"item": { |
|
||||
"name": "Foo", |
|
||||
"price": 50.5, |
|
||||
"description": None, |
|
||||
"tax": None, |
|
||||
}, |
|
||||
"user": {"username": "Dave", "full_name": None}, |
|
||||
} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_body_no_data(client: TestClient): |
|
||||
response = client.put("/items/5", json=None) |
|
||||
assert response.status_code == 422 |
|
||||
assert response.json() == IsDict( |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "item"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "user"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "importance"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
] |
|
||||
} |
|
||||
) | IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "item"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
{ |
|
||||
"loc": ["body", "user"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
{ |
|
||||
"loc": ["body", "importance"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
] |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_body_empty_list(client: TestClient): |
|
||||
response = client.put("/items/5", json=[]) |
|
||||
assert response.status_code == 422 |
|
||||
assert response.json() == IsDict( |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "item"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "user"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "importance"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
] |
|
||||
} |
|
||||
) | IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "item"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
{ |
|
||||
"loc": ["body", "user"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
{ |
|
||||
"loc": ["body", "importance"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
] |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_openapi_schema(client: TestClient): |
|
||||
response = client.get("/openapi.json") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == { |
|
||||
"openapi": "3.1.0", |
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|
||||
"paths": { |
|
||||
"/items/{item_id}": { |
|
||||
"put": { |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
"summary": "Update Item", |
|
||||
"operationId": "update_item_items__item_id__put", |
|
||||
"parameters": [ |
|
||||
{ |
|
||||
"required": True, |
|
||||
"schema": {"title": "Item Id", "type": "integer"}, |
|
||||
"name": "item_id", |
|
||||
"in": "path", |
|
||||
} |
|
||||
], |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_update_item_items__item_id__put" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"components": { |
|
||||
"schemas": { |
|
||||
"Item": { |
|
||||
"title": "Item", |
|
||||
"required": ["name", "price"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"name": {"title": "Name", "type": "string"}, |
|
||||
"description": IsDict( |
|
||||
{ |
|
||||
"title": "Description", |
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "Description", "type": "string"} |
|
||||
), |
|
||||
"price": {"title": "Price", "type": "number"}, |
|
||||
"tax": IsDict( |
|
||||
{ |
|
||||
"title": "Tax", |
|
||||
"anyOf": [{"type": "number"}, {"type": "null"}], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "Tax", "type": "number"} |
|
||||
), |
|
||||
}, |
|
||||
}, |
|
||||
"User": { |
|
||||
"title": "User", |
|
||||
"required": ["username"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"username": {"title": "Username", "type": "string"}, |
|
||||
"full_name": IsDict( |
|
||||
{ |
|
||||
"title": "Full Name", |
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "Full Name", "type": "string"} |
|
||||
), |
|
||||
}, |
|
||||
}, |
|
||||
"Body_update_item_items__item_id__put": { |
|
||||
"title": "Body_update_item_items__item_id__put", |
|
||||
"required": ["item", "user", "importance"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"item": {"$ref": "#/components/schemas/Item"}, |
|
||||
"user": {"$ref": "#/components/schemas/User"}, |
|
||||
"importance": {"title": "Importance", "type": "integer"}, |
|
||||
}, |
|
||||
}, |
|
||||
"ValidationError": { |
|
||||
"title": "ValidationError", |
|
||||
"required": ["loc", "msg", "type"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"loc": { |
|
||||
"title": "Location", |
|
||||
"type": "array", |
|
||||
"items": { |
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|
||||
}, |
|
||||
}, |
|
||||
"msg": {"title": "Message", "type": "string"}, |
|
||||
"type": {"title": "Error Type", "type": "string"}, |
|
||||
}, |
|
||||
}, |
|
||||
"HTTPValidationError": { |
|
||||
"title": "HTTPValidationError", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"detail": { |
|
||||
"title": "Detail", |
|
||||
"type": "array", |
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
@ -1,279 +0,0 @@ |
|||||
import pytest |
|
||||
from dirty_equals import IsDict |
|
||||
from fastapi.testclient import TestClient |
|
||||
|
|
||||
from ...utils import needs_py310 |
|
||||
|
|
||||
|
|
||||
@pytest.fixture(name="client") |
|
||||
def get_client(): |
|
||||
from docs_src.body_multiple_params.tutorial003_py310 import app |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
return client |
|
||||
|
|
||||
|
|
||||
@needs_py310 |
|
||||
def test_post_body_valid(client: TestClient): |
|
||||
response = client.put( |
|
||||
"/items/5", |
|
||||
json={ |
|
||||
"importance": 2, |
|
||||
"item": {"name": "Foo", "price": 50.5}, |
|
||||
"user": {"username": "Dave"}, |
|
||||
}, |
|
||||
) |
|
||||
assert response.status_code == 200 |
|
||||
assert response.json() == { |
|
||||
"item_id": 5, |
|
||||
"importance": 2, |
|
||||
"item": { |
|
||||
"name": "Foo", |
|
||||
"price": 50.5, |
|
||||
"description": None, |
|
||||
"tax": None, |
|
||||
}, |
|
||||
"user": {"username": "Dave", "full_name": None}, |
|
||||
} |
|
||||
|
|
||||
|
|
||||
@needs_py310 |
|
||||
def test_post_body_no_data(client: TestClient): |
|
||||
response = client.put("/items/5", json=None) |
|
||||
assert response.status_code == 422 |
|
||||
assert response.json() == IsDict( |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "item"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "user"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "importance"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
] |
|
||||
} |
|
||||
) | IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "item"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
{ |
|
||||
"loc": ["body", "user"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
{ |
|
||||
"loc": ["body", "importance"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
] |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
|
|
||||
@needs_py310 |
|
||||
def test_post_body_empty_list(client: TestClient): |
|
||||
response = client.put("/items/5", json=[]) |
|
||||
assert response.status_code == 422 |
|
||||
assert response.json() == IsDict( |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "item"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "user"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "importance"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
}, |
|
||||
] |
|
||||
} |
|
||||
) | IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "item"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
{ |
|
||||
"loc": ["body", "user"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
{ |
|
||||
"loc": ["body", "importance"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
}, |
|
||||
] |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
|
|
||||
@needs_py310 |
|
||||
def test_openapi_schema(client: TestClient): |
|
||||
response = client.get("/openapi.json") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == { |
|
||||
"openapi": "3.1.0", |
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|
||||
"paths": { |
|
||||
"/items/{item_id}": { |
|
||||
"put": { |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
"summary": "Update Item", |
|
||||
"operationId": "update_item_items__item_id__put", |
|
||||
"parameters": [ |
|
||||
{ |
|
||||
"required": True, |
|
||||
"schema": {"title": "Item Id", "type": "integer"}, |
|
||||
"name": "item_id", |
|
||||
"in": "path", |
|
||||
} |
|
||||
], |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_update_item_items__item_id__put" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"components": { |
|
||||
"schemas": { |
|
||||
"Item": { |
|
||||
"title": "Item", |
|
||||
"required": ["name", "price"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"name": {"title": "Name", "type": "string"}, |
|
||||
"description": IsDict( |
|
||||
{ |
|
||||
"title": "Description", |
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "Description", "type": "string"} |
|
||||
), |
|
||||
"price": {"title": "Price", "type": "number"}, |
|
||||
"tax": IsDict( |
|
||||
{ |
|
||||
"title": "Tax", |
|
||||
"anyOf": [{"type": "number"}, {"type": "null"}], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "Tax", "type": "number"} |
|
||||
), |
|
||||
}, |
|
||||
}, |
|
||||
"User": { |
|
||||
"title": "User", |
|
||||
"required": ["username"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"username": {"title": "Username", "type": "string"}, |
|
||||
"full_name": IsDict( |
|
||||
{ |
|
||||
"title": "Full Name", |
|
||||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "Full Name", "type": "string"} |
|
||||
), |
|
||||
}, |
|
||||
}, |
|
||||
"Body_update_item_items__item_id__put": { |
|
||||
"title": "Body_update_item_items__item_id__put", |
|
||||
"required": ["item", "user", "importance"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"item": {"$ref": "#/components/schemas/Item"}, |
|
||||
"user": {"$ref": "#/components/schemas/User"}, |
|
||||
"importance": {"title": "Importance", "type": "integer"}, |
|
||||
}, |
|
||||
}, |
|
||||
"ValidationError": { |
|
||||
"title": "ValidationError", |
|
||||
"required": ["loc", "msg", "type"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"loc": { |
|
||||
"title": "Location", |
|
||||
"type": "array", |
|
||||
"items": { |
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|
||||
}, |
|
||||
}, |
|
||||
"msg": {"title": "Message", "type": "string"}, |
|
||||
"type": {"title": "Error Type", "type": "string"}, |
|
||||
}, |
|
||||
}, |
|
||||
"HTTPValidationError": { |
|
||||
"title": "HTTPValidationError", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"detail": { |
|
||||
"title": "Detail", |
|
||||
"type": "array", |
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
@ -1,208 +0,0 @@ |
|||||
from dirty_equals import IsDict |
|
||||
from fastapi.testclient import TestClient |
|
||||
|
|
||||
from docs_src.request_files.tutorial001_02_an import app |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
|
|
||||
|
|
||||
def test_post_form_no_body(): |
|
||||
response = client.post("/files/") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"message": "No file sent"} |
|
||||
|
|
||||
|
|
||||
def test_post_uploadfile_no_body(): |
|
||||
response = client.post("/uploadfile/") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"message": "No upload file sent"} |
|
||||
|
|
||||
|
|
||||
def test_post_file(tmp_path): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file: |
|
||||
response = client.post("/files/", files={"file": file}) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"file_size": 14} |
|
||||
|
|
||||
|
|
||||
def test_post_upload_file(tmp_path): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file: |
|
||||
response = client.post("/uploadfile/", files={"file": file}) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"filename": "test.txt"} |
|
||||
|
|
||||
|
|
||||
def test_openapi_schema(): |
|
||||
response = client.get("/openapi.json") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == { |
|
||||
"openapi": "3.1.0", |
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|
||||
"paths": { |
|
||||
"/files/": { |
|
||||
"post": { |
|
||||
"summary": "Create File", |
|
||||
"operationId": "create_file_files__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": IsDict( |
|
||||
{ |
|
||||
"allOf": [ |
|
||||
{ |
|
||||
"$ref": "#/components/schemas/Body_create_file_files__post" |
|
||||
} |
|
||||
], |
|
||||
"title": "Body", |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"$ref": "#/components/schemas/Body_create_file_files__post" |
|
||||
} |
|
||||
) |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/uploadfile/": { |
|
||||
"post": { |
|
||||
"summary": "Create Upload File", |
|
||||
"operationId": "create_upload_file_uploadfile__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": IsDict( |
|
||||
{ |
|
||||
"allOf": [ |
|
||||
{ |
|
||||
"$ref": "#/components/schemas/Body_create_upload_file_uploadfile__post" |
|
||||
} |
|
||||
], |
|
||||
"title": "Body", |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"$ref": "#/components/schemas/Body_create_upload_file_uploadfile__post" |
|
||||
} |
|
||||
) |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"components": { |
|
||||
"schemas": { |
|
||||
"Body_create_file_files__post": { |
|
||||
"title": "Body_create_file_files__post", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"file": IsDict( |
|
||||
{ |
|
||||
"title": "File", |
|
||||
"anyOf": [ |
|
||||
{"type": "string", "format": "binary"}, |
|
||||
{"type": "null"}, |
|
||||
], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "File", "type": "string", "format": "binary"} |
|
||||
) |
|
||||
}, |
|
||||
}, |
|
||||
"Body_create_upload_file_uploadfile__post": { |
|
||||
"title": "Body_create_upload_file_uploadfile__post", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"file": IsDict( |
|
||||
{ |
|
||||
"title": "File", |
|
||||
"anyOf": [ |
|
||||
{"type": "string", "format": "binary"}, |
|
||||
{"type": "null"}, |
|
||||
], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "File", "type": "string", "format": "binary"} |
|
||||
) |
|
||||
}, |
|
||||
}, |
|
||||
"HTTPValidationError": { |
|
||||
"title": "HTTPValidationError", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"detail": { |
|
||||
"title": "Detail", |
|
||||
"type": "array", |
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"ValidationError": { |
|
||||
"title": "ValidationError", |
|
||||
"required": ["loc", "msg", "type"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"loc": { |
|
||||
"title": "Location", |
|
||||
"type": "array", |
|
||||
"items": { |
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|
||||
}, |
|
||||
}, |
|
||||
"msg": {"title": "Message", "type": "string"}, |
|
||||
"type": {"title": "Error Type", "type": "string"}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
@ -1,220 +0,0 @@ |
|||||
from pathlib import Path |
|
||||
|
|
||||
import pytest |
|
||||
from dirty_equals import IsDict |
|
||||
from fastapi.testclient import TestClient |
|
||||
|
|
||||
from ...utils import needs_py310 |
|
||||
|
|
||||
|
|
||||
@pytest.fixture(name="client") |
|
||||
def get_client(): |
|
||||
from docs_src.request_files.tutorial001_02_an_py310 import app |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
return client |
|
||||
|
|
||||
|
|
||||
@needs_py310 |
|
||||
def test_post_form_no_body(client: TestClient): |
|
||||
response = client.post("/files/") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"message": "No file sent"} |
|
||||
|
|
||||
|
|
||||
@needs_py310 |
|
||||
def test_post_uploadfile_no_body(client: TestClient): |
|
||||
response = client.post("/uploadfile/") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"message": "No upload file sent"} |
|
||||
|
|
||||
|
|
||||
@needs_py310 |
|
||||
def test_post_file(tmp_path: Path, client: TestClient): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
|
|
||||
with path.open("rb") as file: |
|
||||
response = client.post("/files/", files={"file": file}) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"file_size": 14} |
|
||||
|
|
||||
|
|
||||
@needs_py310 |
|
||||
def test_post_upload_file(tmp_path: Path, client: TestClient): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
|
|
||||
with path.open("rb") as file: |
|
||||
response = client.post("/uploadfile/", files={"file": file}) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"filename": "test.txt"} |
|
||||
|
|
||||
|
|
||||
@needs_py310 |
|
||||
def test_openapi_schema(client: TestClient): |
|
||||
response = client.get("/openapi.json") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == { |
|
||||
"openapi": "3.1.0", |
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|
||||
"paths": { |
|
||||
"/files/": { |
|
||||
"post": { |
|
||||
"summary": "Create File", |
|
||||
"operationId": "create_file_files__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": IsDict( |
|
||||
{ |
|
||||
"allOf": [ |
|
||||
{ |
|
||||
"$ref": "#/components/schemas/Body_create_file_files__post" |
|
||||
} |
|
||||
], |
|
||||
"title": "Body", |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"$ref": "#/components/schemas/Body_create_file_files__post" |
|
||||
} |
|
||||
) |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/uploadfile/": { |
|
||||
"post": { |
|
||||
"summary": "Create Upload File", |
|
||||
"operationId": "create_upload_file_uploadfile__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": IsDict( |
|
||||
{ |
|
||||
"allOf": [ |
|
||||
{ |
|
||||
"$ref": "#/components/schemas/Body_create_upload_file_uploadfile__post" |
|
||||
} |
|
||||
], |
|
||||
"title": "Body", |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"$ref": "#/components/schemas/Body_create_upload_file_uploadfile__post" |
|
||||
} |
|
||||
) |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"components": { |
|
||||
"schemas": { |
|
||||
"Body_create_file_files__post": { |
|
||||
"title": "Body_create_file_files__post", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"file": IsDict( |
|
||||
{ |
|
||||
"title": "File", |
|
||||
"anyOf": [ |
|
||||
{"type": "string", "format": "binary"}, |
|
||||
{"type": "null"}, |
|
||||
], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "File", "type": "string", "format": "binary"} |
|
||||
) |
|
||||
}, |
|
||||
}, |
|
||||
"Body_create_upload_file_uploadfile__post": { |
|
||||
"title": "Body_create_upload_file_uploadfile__post", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"file": IsDict( |
|
||||
{ |
|
||||
"title": "File", |
|
||||
"anyOf": [ |
|
||||
{"type": "string", "format": "binary"}, |
|
||||
{"type": "null"}, |
|
||||
], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "File", "type": "string", "format": "binary"} |
|
||||
) |
|
||||
}, |
|
||||
}, |
|
||||
"HTTPValidationError": { |
|
||||
"title": "HTTPValidationError", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"detail": { |
|
||||
"title": "Detail", |
|
||||
"type": "array", |
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"ValidationError": { |
|
||||
"title": "ValidationError", |
|
||||
"required": ["loc", "msg", "type"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"loc": { |
|
||||
"title": "Location", |
|
||||
"type": "array", |
|
||||
"items": { |
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|
||||
}, |
|
||||
}, |
|
||||
"msg": {"title": "Message", "type": "string"}, |
|
||||
"type": {"title": "Error Type", "type": "string"}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
@ -1,220 +0,0 @@ |
|||||
from pathlib import Path |
|
||||
|
|
||||
import pytest |
|
||||
from dirty_equals import IsDict |
|
||||
from fastapi.testclient import TestClient |
|
||||
|
|
||||
from ...utils import needs_py39 |
|
||||
|
|
||||
|
|
||||
@pytest.fixture(name="client") |
|
||||
def get_client(): |
|
||||
from docs_src.request_files.tutorial001_02_an_py39 import app |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
return client |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_form_no_body(client: TestClient): |
|
||||
response = client.post("/files/") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"message": "No file sent"} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_uploadfile_no_body(client: TestClient): |
|
||||
response = client.post("/uploadfile/") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"message": "No upload file sent"} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_file(tmp_path: Path, client: TestClient): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
|
|
||||
with path.open("rb") as file: |
|
||||
response = client.post("/files/", files={"file": file}) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"file_size": 14} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_upload_file(tmp_path: Path, client: TestClient): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
|
|
||||
with path.open("rb") as file: |
|
||||
response = client.post("/uploadfile/", files={"file": file}) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"filename": "test.txt"} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_openapi_schema(client: TestClient): |
|
||||
response = client.get("/openapi.json") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == { |
|
||||
"openapi": "3.1.0", |
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|
||||
"paths": { |
|
||||
"/files/": { |
|
||||
"post": { |
|
||||
"summary": "Create File", |
|
||||
"operationId": "create_file_files__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": IsDict( |
|
||||
{ |
|
||||
"allOf": [ |
|
||||
{ |
|
||||
"$ref": "#/components/schemas/Body_create_file_files__post" |
|
||||
} |
|
||||
], |
|
||||
"title": "Body", |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"$ref": "#/components/schemas/Body_create_file_files__post" |
|
||||
} |
|
||||
) |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/uploadfile/": { |
|
||||
"post": { |
|
||||
"summary": "Create Upload File", |
|
||||
"operationId": "create_upload_file_uploadfile__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": IsDict( |
|
||||
{ |
|
||||
"allOf": [ |
|
||||
{ |
|
||||
"$ref": "#/components/schemas/Body_create_upload_file_uploadfile__post" |
|
||||
} |
|
||||
], |
|
||||
"title": "Body", |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"$ref": "#/components/schemas/Body_create_upload_file_uploadfile__post" |
|
||||
} |
|
||||
) |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"components": { |
|
||||
"schemas": { |
|
||||
"Body_create_file_files__post": { |
|
||||
"title": "Body_create_file_files__post", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"file": IsDict( |
|
||||
{ |
|
||||
"title": "File", |
|
||||
"anyOf": [ |
|
||||
{"type": "string", "format": "binary"}, |
|
||||
{"type": "null"}, |
|
||||
], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "File", "type": "string", "format": "binary"} |
|
||||
) |
|
||||
}, |
|
||||
}, |
|
||||
"Body_create_upload_file_uploadfile__post": { |
|
||||
"title": "Body_create_upload_file_uploadfile__post", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"file": IsDict( |
|
||||
{ |
|
||||
"title": "File", |
|
||||
"anyOf": [ |
|
||||
{"type": "string", "format": "binary"}, |
|
||||
{"type": "null"}, |
|
||||
], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "File", "type": "string", "format": "binary"} |
|
||||
) |
|
||||
}, |
|
||||
}, |
|
||||
"HTTPValidationError": { |
|
||||
"title": "HTTPValidationError", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"detail": { |
|
||||
"title": "Detail", |
|
||||
"type": "array", |
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"ValidationError": { |
|
||||
"title": "ValidationError", |
|
||||
"required": ["loc", "msg", "type"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"loc": { |
|
||||
"title": "Location", |
|
||||
"type": "array", |
|
||||
"items": { |
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|
||||
}, |
|
||||
}, |
|
||||
"msg": {"title": "Message", "type": "string"}, |
|
||||
"type": {"title": "Error Type", "type": "string"}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
@ -1,220 +0,0 @@ |
|||||
from pathlib import Path |
|
||||
|
|
||||
import pytest |
|
||||
from dirty_equals import IsDict |
|
||||
from fastapi.testclient import TestClient |
|
||||
|
|
||||
from ...utils import needs_py310 |
|
||||
|
|
||||
|
|
||||
@pytest.fixture(name="client") |
|
||||
def get_client(): |
|
||||
from docs_src.request_files.tutorial001_02_py310 import app |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
return client |
|
||||
|
|
||||
|
|
||||
@needs_py310 |
|
||||
def test_post_form_no_body(client: TestClient): |
|
||||
response = client.post("/files/") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"message": "No file sent"} |
|
||||
|
|
||||
|
|
||||
@needs_py310 |
|
||||
def test_post_uploadfile_no_body(client: TestClient): |
|
||||
response = client.post("/uploadfile/") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"message": "No upload file sent"} |
|
||||
|
|
||||
|
|
||||
@needs_py310 |
|
||||
def test_post_file(tmp_path: Path, client: TestClient): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
|
|
||||
with path.open("rb") as file: |
|
||||
response = client.post("/files/", files={"file": file}) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"file_size": 14} |
|
||||
|
|
||||
|
|
||||
@needs_py310 |
|
||||
def test_post_upload_file(tmp_path: Path, client: TestClient): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
|
|
||||
with path.open("rb") as file: |
|
||||
response = client.post("/uploadfile/", files={"file": file}) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"filename": "test.txt"} |
|
||||
|
|
||||
|
|
||||
@needs_py310 |
|
||||
def test_openapi_schema(client: TestClient): |
|
||||
response = client.get("/openapi.json") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == { |
|
||||
"openapi": "3.1.0", |
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|
||||
"paths": { |
|
||||
"/files/": { |
|
||||
"post": { |
|
||||
"summary": "Create File", |
|
||||
"operationId": "create_file_files__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": IsDict( |
|
||||
{ |
|
||||
"allOf": [ |
|
||||
{ |
|
||||
"$ref": "#/components/schemas/Body_create_file_files__post" |
|
||||
} |
|
||||
], |
|
||||
"title": "Body", |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"$ref": "#/components/schemas/Body_create_file_files__post" |
|
||||
} |
|
||||
) |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/uploadfile/": { |
|
||||
"post": { |
|
||||
"summary": "Create Upload File", |
|
||||
"operationId": "create_upload_file_uploadfile__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": IsDict( |
|
||||
{ |
|
||||
"allOf": [ |
|
||||
{ |
|
||||
"$ref": "#/components/schemas/Body_create_upload_file_uploadfile__post" |
|
||||
} |
|
||||
], |
|
||||
"title": "Body", |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"$ref": "#/components/schemas/Body_create_upload_file_uploadfile__post" |
|
||||
} |
|
||||
) |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"components": { |
|
||||
"schemas": { |
|
||||
"Body_create_file_files__post": { |
|
||||
"title": "Body_create_file_files__post", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"file": IsDict( |
|
||||
{ |
|
||||
"title": "File", |
|
||||
"anyOf": [ |
|
||||
{"type": "string", "format": "binary"}, |
|
||||
{"type": "null"}, |
|
||||
], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "File", "type": "string", "format": "binary"} |
|
||||
) |
|
||||
}, |
|
||||
}, |
|
||||
"Body_create_upload_file_uploadfile__post": { |
|
||||
"title": "Body_create_upload_file_uploadfile__post", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"file": IsDict( |
|
||||
{ |
|
||||
"title": "File", |
|
||||
"anyOf": [ |
|
||||
{"type": "string", "format": "binary"}, |
|
||||
{"type": "null"}, |
|
||||
], |
|
||||
} |
|
||||
) |
|
||||
| IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{"title": "File", "type": "string", "format": "binary"} |
|
||||
) |
|
||||
}, |
|
||||
}, |
|
||||
"HTTPValidationError": { |
|
||||
"title": "HTTPValidationError", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"detail": { |
|
||||
"title": "Detail", |
|
||||
"type": "array", |
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"ValidationError": { |
|
||||
"title": "ValidationError", |
|
||||
"required": ["loc", "msg", "type"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"loc": { |
|
||||
"title": "Location", |
|
||||
"type": "array", |
|
||||
"items": { |
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|
||||
}, |
|
||||
}, |
|
||||
"msg": {"title": "Message", "type": "string"}, |
|
||||
"type": {"title": "Error Type", "type": "string"}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
@ -1,159 +0,0 @@ |
|||||
from fastapi.testclient import TestClient |
|
||||
|
|
||||
from docs_src.request_files.tutorial001_03_an import app |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
|
|
||||
|
|
||||
def test_post_file(tmp_path): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file: |
|
||||
response = client.post("/files/", files={"file": file}) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"file_size": 14} |
|
||||
|
|
||||
|
|
||||
def test_post_upload_file(tmp_path): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file: |
|
||||
response = client.post("/uploadfile/", files={"file": file}) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"filename": "test.txt"} |
|
||||
|
|
||||
|
|
||||
def test_openapi_schema(): |
|
||||
response = client.get("/openapi.json") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == { |
|
||||
"openapi": "3.1.0", |
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|
||||
"paths": { |
|
||||
"/files/": { |
|
||||
"post": { |
|
||||
"summary": "Create File", |
|
||||
"operationId": "create_file_files__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_file_files__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/uploadfile/": { |
|
||||
"post": { |
|
||||
"summary": "Create Upload File", |
|
||||
"operationId": "create_upload_file_uploadfile__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_upload_file_uploadfile__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"components": { |
|
||||
"schemas": { |
|
||||
"Body_create_file_files__post": { |
|
||||
"title": "Body_create_file_files__post", |
|
||||
"required": ["file"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"file": { |
|
||||
"title": "File", |
|
||||
"type": "string", |
|
||||
"description": "A file read as bytes", |
|
||||
"format": "binary", |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"Body_create_upload_file_uploadfile__post": { |
|
||||
"title": "Body_create_upload_file_uploadfile__post", |
|
||||
"required": ["file"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"file": { |
|
||||
"title": "File", |
|
||||
"type": "string", |
|
||||
"description": "A file read as UploadFile", |
|
||||
"format": "binary", |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"HTTPValidationError": { |
|
||||
"title": "HTTPValidationError", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"detail": { |
|
||||
"title": "Detail", |
|
||||
"type": "array", |
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"ValidationError": { |
|
||||
"title": "ValidationError", |
|
||||
"required": ["loc", "msg", "type"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"loc": { |
|
||||
"title": "Location", |
|
||||
"type": "array", |
|
||||
"items": { |
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|
||||
}, |
|
||||
}, |
|
||||
"msg": {"title": "Message", "type": "string"}, |
|
||||
"type": {"title": "Error Type", "type": "string"}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
@ -1,167 +0,0 @@ |
|||||
import pytest |
|
||||
from fastapi.testclient import TestClient |
|
||||
|
|
||||
from ...utils import needs_py39 |
|
||||
|
|
||||
|
|
||||
@pytest.fixture(name="client") |
|
||||
def get_client(): |
|
||||
from docs_src.request_files.tutorial001_03_an_py39 import app |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
return client |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_file(tmp_path, client: TestClient): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
|
|
||||
with path.open("rb") as file: |
|
||||
response = client.post("/files/", files={"file": file}) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"file_size": 14} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_upload_file(tmp_path, client: TestClient): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
|
|
||||
with path.open("rb") as file: |
|
||||
response = client.post("/uploadfile/", files={"file": file}) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"filename": "test.txt"} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_openapi_schema(client: TestClient): |
|
||||
response = client.get("/openapi.json") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == { |
|
||||
"openapi": "3.1.0", |
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|
||||
"paths": { |
|
||||
"/files/": { |
|
||||
"post": { |
|
||||
"summary": "Create File", |
|
||||
"operationId": "create_file_files__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_file_files__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/uploadfile/": { |
|
||||
"post": { |
|
||||
"summary": "Create Upload File", |
|
||||
"operationId": "create_upload_file_uploadfile__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_upload_file_uploadfile__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"components": { |
|
||||
"schemas": { |
|
||||
"Body_create_file_files__post": { |
|
||||
"title": "Body_create_file_files__post", |
|
||||
"required": ["file"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"file": { |
|
||||
"title": "File", |
|
||||
"type": "string", |
|
||||
"description": "A file read as bytes", |
|
||||
"format": "binary", |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"Body_create_upload_file_uploadfile__post": { |
|
||||
"title": "Body_create_upload_file_uploadfile__post", |
|
||||
"required": ["file"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"file": { |
|
||||
"title": "File", |
|
||||
"type": "string", |
|
||||
"description": "A file read as UploadFile", |
|
||||
"format": "binary", |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"HTTPValidationError": { |
|
||||
"title": "HTTPValidationError", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"detail": { |
|
||||
"title": "Detail", |
|
||||
"type": "array", |
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"ValidationError": { |
|
||||
"title": "ValidationError", |
|
||||
"required": ["loc", "msg", "type"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"loc": { |
|
||||
"title": "Location", |
|
||||
"type": "array", |
|
||||
"items": { |
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|
||||
}, |
|
||||
}, |
|
||||
"msg": {"title": "Message", "type": "string"}, |
|
||||
"type": {"title": "Error Type", "type": "string"}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
@ -1,218 +0,0 @@ |
|||||
from dirty_equals import IsDict |
|
||||
from fastapi.testclient import TestClient |
|
||||
|
|
||||
from docs_src.request_files.tutorial001_an import app |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
|
|
||||
|
|
||||
def test_post_form_no_body(): |
|
||||
response = client.post("/files/") |
|
||||
assert response.status_code == 422, response.text |
|
||||
assert response.json() == IsDict( |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "file"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) | IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "file"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
|
|
||||
def test_post_body_json(): |
|
||||
response = client.post("/files/", json={"file": "Foo"}) |
|
||||
assert response.status_code == 422, response.text |
|
||||
assert response.json() == IsDict( |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "file"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) | IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "file"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
|
|
||||
def test_post_file(tmp_path): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file: |
|
||||
response = client.post("/files/", files={"file": file}) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"file_size": 14} |
|
||||
|
|
||||
|
|
||||
def test_post_large_file(tmp_path): |
|
||||
default_pydantic_max_size = 2**16 |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"x" * (default_pydantic_max_size + 1)) |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file: |
|
||||
response = client.post("/files/", files={"file": file}) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"file_size": default_pydantic_max_size + 1} |
|
||||
|
|
||||
|
|
||||
def test_post_upload_file(tmp_path): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file: |
|
||||
response = client.post("/uploadfile/", files={"file": file}) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"filename": "test.txt"} |
|
||||
|
|
||||
|
|
||||
def test_openapi_schema(): |
|
||||
response = client.get("/openapi.json") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == { |
|
||||
"openapi": "3.1.0", |
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|
||||
"paths": { |
|
||||
"/files/": { |
|
||||
"post": { |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
"summary": "Create File", |
|
||||
"operationId": "create_file_files__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_file_files__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/uploadfile/": { |
|
||||
"post": { |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
"summary": "Create Upload File", |
|
||||
"operationId": "create_upload_file_uploadfile__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_upload_file_uploadfile__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"components": { |
|
||||
"schemas": { |
|
||||
"Body_create_upload_file_uploadfile__post": { |
|
||||
"title": "Body_create_upload_file_uploadfile__post", |
|
||||
"required": ["file"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"file": {"title": "File", "type": "string", "format": "binary"} |
|
||||
}, |
|
||||
}, |
|
||||
"Body_create_file_files__post": { |
|
||||
"title": "Body_create_file_files__post", |
|
||||
"required": ["file"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"file": {"title": "File", "type": "string", "format": "binary"} |
|
||||
}, |
|
||||
}, |
|
||||
"ValidationError": { |
|
||||
"title": "ValidationError", |
|
||||
"required": ["loc", "msg", "type"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"loc": { |
|
||||
"title": "Location", |
|
||||
"type": "array", |
|
||||
"items": { |
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|
||||
}, |
|
||||
}, |
|
||||
"msg": {"title": "Message", "type": "string"}, |
|
||||
"type": {"title": "Error Type", "type": "string"}, |
|
||||
}, |
|
||||
}, |
|
||||
"HTTPValidationError": { |
|
||||
"title": "HTTPValidationError", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"detail": { |
|
||||
"title": "Detail", |
|
||||
"type": "array", |
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
@ -1,228 +0,0 @@ |
|||||
import pytest |
|
||||
from dirty_equals import IsDict |
|
||||
from fastapi.testclient import TestClient |
|
||||
|
|
||||
from ...utils import needs_py39 |
|
||||
|
|
||||
|
|
||||
@pytest.fixture(name="client") |
|
||||
def get_client(): |
|
||||
from docs_src.request_files.tutorial001_an_py39 import app |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
return client |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_form_no_body(client: TestClient): |
|
||||
response = client.post("/files/") |
|
||||
assert response.status_code == 422, response.text |
|
||||
assert response.json() == IsDict( |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "file"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) | IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "file"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_body_json(client: TestClient): |
|
||||
response = client.post("/files/", json={"file": "Foo"}) |
|
||||
assert response.status_code == 422, response.text |
|
||||
assert response.json() == IsDict( |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "file"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) | IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "file"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_file(tmp_path, client: TestClient): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
|
|
||||
with path.open("rb") as file: |
|
||||
response = client.post("/files/", files={"file": file}) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"file_size": 14} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_large_file(tmp_path, client: TestClient): |
|
||||
default_pydantic_max_size = 2**16 |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"x" * (default_pydantic_max_size + 1)) |
|
||||
|
|
||||
with path.open("rb") as file: |
|
||||
response = client.post("/files/", files={"file": file}) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"file_size": default_pydantic_max_size + 1} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_upload_file(tmp_path, client: TestClient): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
|
|
||||
with path.open("rb") as file: |
|
||||
response = client.post("/uploadfile/", files={"file": file}) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"filename": "test.txt"} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_openapi_schema(client: TestClient): |
|
||||
response = client.get("/openapi.json") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == { |
|
||||
"openapi": "3.1.0", |
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|
||||
"paths": { |
|
||||
"/files/": { |
|
||||
"post": { |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
"summary": "Create File", |
|
||||
"operationId": "create_file_files__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_file_files__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/uploadfile/": { |
|
||||
"post": { |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
"summary": "Create Upload File", |
|
||||
"operationId": "create_upload_file_uploadfile__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_upload_file_uploadfile__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"components": { |
|
||||
"schemas": { |
|
||||
"Body_create_upload_file_uploadfile__post": { |
|
||||
"title": "Body_create_upload_file_uploadfile__post", |
|
||||
"required": ["file"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"file": {"title": "File", "type": "string", "format": "binary"} |
|
||||
}, |
|
||||
}, |
|
||||
"Body_create_file_files__post": { |
|
||||
"title": "Body_create_file_files__post", |
|
||||
"required": ["file"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"file": {"title": "File", "type": "string", "format": "binary"} |
|
||||
}, |
|
||||
}, |
|
||||
"ValidationError": { |
|
||||
"title": "ValidationError", |
|
||||
"required": ["loc", "msg", "type"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"loc": { |
|
||||
"title": "Location", |
|
||||
"type": "array", |
|
||||
"items": { |
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|
||||
}, |
|
||||
}, |
|
||||
"msg": {"title": "Message", "type": "string"}, |
|
||||
"type": {"title": "Error Type", "type": "string"}, |
|
||||
}, |
|
||||
}, |
|
||||
"HTTPValidationError": { |
|
||||
"title": "HTTPValidationError", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"detail": { |
|
||||
"title": "Detail", |
|
||||
"type": "array", |
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
@ -1,249 +0,0 @@ |
|||||
from dirty_equals import IsDict |
|
||||
from fastapi.testclient import TestClient |
|
||||
|
|
||||
from docs_src.request_files.tutorial002_an import app |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
|
|
||||
|
|
||||
def test_post_form_no_body(): |
|
||||
response = client.post("/files/") |
|
||||
assert response.status_code == 422, response.text |
|
||||
assert response.json() == IsDict( |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "files"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) | IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "files"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
|
|
||||
def test_post_body_json(): |
|
||||
response = client.post("/files/", json={"file": "Foo"}) |
|
||||
assert response.status_code == 422, response.text |
|
||||
assert response.json() == IsDict( |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "files"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) | IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "files"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
|
|
||||
def test_post_files(tmp_path): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
path2 = tmp_path / "test2.txt" |
|
||||
path2.write_bytes(b"<file content2>") |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file, path2.open("rb") as file2: |
|
||||
response = client.post( |
|
||||
"/files/", |
|
||||
files=( |
|
||||
("files", ("test.txt", file)), |
|
||||
("files", ("test2.txt", file2)), |
|
||||
), |
|
||||
) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"file_sizes": [14, 15]} |
|
||||
|
|
||||
|
|
||||
def test_post_upload_file(tmp_path): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
path2 = tmp_path / "test2.txt" |
|
||||
path2.write_bytes(b"<file content2>") |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file, path2.open("rb") as file2: |
|
||||
response = client.post( |
|
||||
"/uploadfiles/", |
|
||||
files=( |
|
||||
("files", ("test.txt", file)), |
|
||||
("files", ("test2.txt", file2)), |
|
||||
), |
|
||||
) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"filenames": ["test.txt", "test2.txt"]} |
|
||||
|
|
||||
|
|
||||
def test_get_root(): |
|
||||
client = TestClient(app) |
|
||||
response = client.get("/") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert b"<form" in response.content |
|
||||
|
|
||||
|
|
||||
def test_openapi_schema(): |
|
||||
response = client.get("/openapi.json") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == { |
|
||||
"openapi": "3.1.0", |
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|
||||
"paths": { |
|
||||
"/files/": { |
|
||||
"post": { |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
"summary": "Create Files", |
|
||||
"operationId": "create_files_files__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_files_files__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/uploadfiles/": { |
|
||||
"post": { |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
"summary": "Create Upload Files", |
|
||||
"operationId": "create_upload_files_uploadfiles__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_upload_files_uploadfiles__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/": { |
|
||||
"get": { |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
} |
|
||||
}, |
|
||||
"summary": "Main", |
|
||||
"operationId": "main__get", |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"components": { |
|
||||
"schemas": { |
|
||||
"Body_create_upload_files_uploadfiles__post": { |
|
||||
"title": "Body_create_upload_files_uploadfiles__post", |
|
||||
"required": ["files"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"files": { |
|
||||
"title": "Files", |
|
||||
"type": "array", |
|
||||
"items": {"type": "string", "format": "binary"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"Body_create_files_files__post": { |
|
||||
"title": "Body_create_files_files__post", |
|
||||
"required": ["files"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"files": { |
|
||||
"title": "Files", |
|
||||
"type": "array", |
|
||||
"items": {"type": "string", "format": "binary"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"ValidationError": { |
|
||||
"title": "ValidationError", |
|
||||
"required": ["loc", "msg", "type"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"loc": { |
|
||||
"title": "Location", |
|
||||
"type": "array", |
|
||||
"items": { |
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|
||||
}, |
|
||||
}, |
|
||||
"msg": {"title": "Message", "type": "string"}, |
|
||||
"type": {"title": "Error Type", "type": "string"}, |
|
||||
}, |
|
||||
}, |
|
||||
"HTTPValidationError": { |
|
||||
"title": "HTTPValidationError", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"detail": { |
|
||||
"title": "Detail", |
|
||||
"type": "array", |
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
@ -1,268 +0,0 @@ |
|||||
import pytest |
|
||||
from dirty_equals import IsDict |
|
||||
from fastapi import FastAPI |
|
||||
from fastapi.testclient import TestClient |
|
||||
|
|
||||
from ...utils import needs_py39 |
|
||||
|
|
||||
|
|
||||
@pytest.fixture(name="app") |
|
||||
def get_app(): |
|
||||
from docs_src.request_files.tutorial002_an_py39 import app |
|
||||
|
|
||||
return app |
|
||||
|
|
||||
|
|
||||
@pytest.fixture(name="client") |
|
||||
def get_client(app: FastAPI): |
|
||||
client = TestClient(app) |
|
||||
return client |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_form_no_body(client: TestClient): |
|
||||
response = client.post("/files/") |
|
||||
assert response.status_code == 422, response.text |
|
||||
assert response.json() == IsDict( |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "files"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) | IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "files"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_body_json(client: TestClient): |
|
||||
response = client.post("/files/", json={"file": "Foo"}) |
|
||||
assert response.status_code == 422, response.text |
|
||||
assert response.json() == IsDict( |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "files"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) | IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "files"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_files(tmp_path, app: FastAPI): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
path2 = tmp_path / "test2.txt" |
|
||||
path2.write_bytes(b"<file content2>") |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file, path2.open("rb") as file2: |
|
||||
response = client.post( |
|
||||
"/files/", |
|
||||
files=( |
|
||||
("files", ("test.txt", file)), |
|
||||
("files", ("test2.txt", file2)), |
|
||||
), |
|
||||
) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"file_sizes": [14, 15]} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_upload_file(tmp_path, app: FastAPI): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
path2 = tmp_path / "test2.txt" |
|
||||
path2.write_bytes(b"<file content2>") |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file, path2.open("rb") as file2: |
|
||||
response = client.post( |
|
||||
"/uploadfiles/", |
|
||||
files=( |
|
||||
("files", ("test.txt", file)), |
|
||||
("files", ("test2.txt", file2)), |
|
||||
), |
|
||||
) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"filenames": ["test.txt", "test2.txt"]} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_get_root(app: FastAPI): |
|
||||
client = TestClient(app) |
|
||||
response = client.get("/") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert b"<form" in response.content |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_openapi_schema(client: TestClient): |
|
||||
response = client.get("/openapi.json") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == { |
|
||||
"openapi": "3.1.0", |
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|
||||
"paths": { |
|
||||
"/files/": { |
|
||||
"post": { |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
"summary": "Create Files", |
|
||||
"operationId": "create_files_files__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_files_files__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/uploadfiles/": { |
|
||||
"post": { |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
"summary": "Create Upload Files", |
|
||||
"operationId": "create_upload_files_uploadfiles__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_upload_files_uploadfiles__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/": { |
|
||||
"get": { |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
} |
|
||||
}, |
|
||||
"summary": "Main", |
|
||||
"operationId": "main__get", |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"components": { |
|
||||
"schemas": { |
|
||||
"Body_create_upload_files_uploadfiles__post": { |
|
||||
"title": "Body_create_upload_files_uploadfiles__post", |
|
||||
"required": ["files"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"files": { |
|
||||
"title": "Files", |
|
||||
"type": "array", |
|
||||
"items": {"type": "string", "format": "binary"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"Body_create_files_files__post": { |
|
||||
"title": "Body_create_files_files__post", |
|
||||
"required": ["files"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"files": { |
|
||||
"title": "Files", |
|
||||
"type": "array", |
|
||||
"items": {"type": "string", "format": "binary"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"ValidationError": { |
|
||||
"title": "ValidationError", |
|
||||
"required": ["loc", "msg", "type"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"loc": { |
|
||||
"title": "Location", |
|
||||
"type": "array", |
|
||||
"items": { |
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|
||||
}, |
|
||||
}, |
|
||||
"msg": {"title": "Message", "type": "string"}, |
|
||||
"type": {"title": "Error Type", "type": "string"}, |
|
||||
}, |
|
||||
}, |
|
||||
"HTTPValidationError": { |
|
||||
"title": "HTTPValidationError", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"detail": { |
|
||||
"title": "Detail", |
|
||||
"type": "array", |
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
@ -1,279 +0,0 @@ |
|||||
import pytest |
|
||||
from dirty_equals import IsDict |
|
||||
from fastapi import FastAPI |
|
||||
from fastapi.testclient import TestClient |
|
||||
|
|
||||
from ...utils import needs_py39 |
|
||||
|
|
||||
|
|
||||
@pytest.fixture(name="app") |
|
||||
def get_app(): |
|
||||
from docs_src.request_files.tutorial002_py39 import app |
|
||||
|
|
||||
return app |
|
||||
|
|
||||
|
|
||||
@pytest.fixture(name="client") |
|
||||
def get_client(app: FastAPI): |
|
||||
client = TestClient(app) |
|
||||
return client |
|
||||
|
|
||||
|
|
||||
file_required = { |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "files"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_form_no_body(client: TestClient): |
|
||||
response = client.post("/files/") |
|
||||
assert response.status_code == 422, response.text |
|
||||
assert response.json() == IsDict( |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "files"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) | IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "files"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_body_json(client: TestClient): |
|
||||
response = client.post("/files/", json={"file": "Foo"}) |
|
||||
assert response.status_code == 422, response.text |
|
||||
assert response.json() == IsDict( |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"type": "missing", |
|
||||
"loc": ["body", "files"], |
|
||||
"msg": "Field required", |
|
||||
"input": None, |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) | IsDict( |
|
||||
# TODO: remove when deprecating Pydantic v1 |
|
||||
{ |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "files"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
) |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_files(tmp_path, app: FastAPI): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
path2 = tmp_path / "test2.txt" |
|
||||
path2.write_bytes(b"<file content2>") |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file, path2.open("rb") as file2: |
|
||||
response = client.post( |
|
||||
"/files/", |
|
||||
files=( |
|
||||
("files", ("test.txt", file)), |
|
||||
("files", ("test2.txt", file2)), |
|
||||
), |
|
||||
) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"file_sizes": [14, 15]} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_upload_file(tmp_path, app: FastAPI): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
path2 = tmp_path / "test2.txt" |
|
||||
path2.write_bytes(b"<file content2>") |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file, path2.open("rb") as file2: |
|
||||
response = client.post( |
|
||||
"/uploadfiles/", |
|
||||
files=( |
|
||||
("files", ("test.txt", file)), |
|
||||
("files", ("test2.txt", file2)), |
|
||||
), |
|
||||
) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"filenames": ["test.txt", "test2.txt"]} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_get_root(app: FastAPI): |
|
||||
client = TestClient(app) |
|
||||
response = client.get("/") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert b"<form" in response.content |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_openapi_schema(client: TestClient): |
|
||||
response = client.get("/openapi.json") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == { |
|
||||
"openapi": "3.1.0", |
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|
||||
"paths": { |
|
||||
"/files/": { |
|
||||
"post": { |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
"summary": "Create Files", |
|
||||
"operationId": "create_files_files__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_files_files__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/uploadfiles/": { |
|
||||
"post": { |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
"summary": "Create Upload Files", |
|
||||
"operationId": "create_upload_files_uploadfiles__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_upload_files_uploadfiles__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/": { |
|
||||
"get": { |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
} |
|
||||
}, |
|
||||
"summary": "Main", |
|
||||
"operationId": "main__get", |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"components": { |
|
||||
"schemas": { |
|
||||
"Body_create_upload_files_uploadfiles__post": { |
|
||||
"title": "Body_create_upload_files_uploadfiles__post", |
|
||||
"required": ["files"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"files": { |
|
||||
"title": "Files", |
|
||||
"type": "array", |
|
||||
"items": {"type": "string", "format": "binary"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"Body_create_files_files__post": { |
|
||||
"title": "Body_create_files_files__post", |
|
||||
"required": ["files"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"files": { |
|
||||
"title": "Files", |
|
||||
"type": "array", |
|
||||
"items": {"type": "string", "format": "binary"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"ValidationError": { |
|
||||
"title": "ValidationError", |
|
||||
"required": ["loc", "msg", "type"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"loc": { |
|
||||
"title": "Location", |
|
||||
"type": "array", |
|
||||
"items": { |
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|
||||
}, |
|
||||
}, |
|
||||
"msg": {"title": "Message", "type": "string"}, |
|
||||
"type": {"title": "Error Type", "type": "string"}, |
|
||||
}, |
|
||||
}, |
|
||||
"HTTPValidationError": { |
|
||||
"title": "HTTPValidationError", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"detail": { |
|
||||
"title": "Detail", |
|
||||
"type": "array", |
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
@ -1,194 +0,0 @@ |
|||||
from fastapi.testclient import TestClient |
|
||||
|
|
||||
from docs_src.request_files.tutorial003_an import app |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
|
|
||||
|
|
||||
def test_post_files(tmp_path): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
path2 = tmp_path / "test2.txt" |
|
||||
path2.write_bytes(b"<file content2>") |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file, path2.open("rb") as file2: |
|
||||
response = client.post( |
|
||||
"/files/", |
|
||||
files=( |
|
||||
("files", ("test.txt", file)), |
|
||||
("files", ("test2.txt", file2)), |
|
||||
), |
|
||||
) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"file_sizes": [14, 15]} |
|
||||
|
|
||||
|
|
||||
def test_post_upload_file(tmp_path): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
path2 = tmp_path / "test2.txt" |
|
||||
path2.write_bytes(b"<file content2>") |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file, path2.open("rb") as file2: |
|
||||
response = client.post( |
|
||||
"/uploadfiles/", |
|
||||
files=( |
|
||||
("files", ("test.txt", file)), |
|
||||
("files", ("test2.txt", file2)), |
|
||||
), |
|
||||
) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"filenames": ["test.txt", "test2.txt"]} |
|
||||
|
|
||||
|
|
||||
def test_get_root(): |
|
||||
client = TestClient(app) |
|
||||
response = client.get("/") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert b"<form" in response.content |
|
||||
|
|
||||
|
|
||||
def test_openapi_schema(): |
|
||||
response = client.get("/openapi.json") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == { |
|
||||
"openapi": "3.1.0", |
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|
||||
"paths": { |
|
||||
"/files/": { |
|
||||
"post": { |
|
||||
"summary": "Create Files", |
|
||||
"operationId": "create_files_files__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_files_files__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/uploadfiles/": { |
|
||||
"post": { |
|
||||
"summary": "Create Upload Files", |
|
||||
"operationId": "create_upload_files_uploadfiles__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_upload_files_uploadfiles__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/": { |
|
||||
"get": { |
|
||||
"summary": "Main", |
|
||||
"operationId": "main__get", |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"components": { |
|
||||
"schemas": { |
|
||||
"Body_create_files_files__post": { |
|
||||
"title": "Body_create_files_files__post", |
|
||||
"required": ["files"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"files": { |
|
||||
"title": "Files", |
|
||||
"type": "array", |
|
||||
"items": {"type": "string", "format": "binary"}, |
|
||||
"description": "Multiple files as bytes", |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"Body_create_upload_files_uploadfiles__post": { |
|
||||
"title": "Body_create_upload_files_uploadfiles__post", |
|
||||
"required": ["files"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"files": { |
|
||||
"title": "Files", |
|
||||
"type": "array", |
|
||||
"items": {"type": "string", "format": "binary"}, |
|
||||
"description": "Multiple files as UploadFile", |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"HTTPValidationError": { |
|
||||
"title": "HTTPValidationError", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"detail": { |
|
||||
"title": "Detail", |
|
||||
"type": "array", |
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"ValidationError": { |
|
||||
"title": "ValidationError", |
|
||||
"required": ["loc", "msg", "type"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"loc": { |
|
||||
"title": "Location", |
|
||||
"type": "array", |
|
||||
"items": { |
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|
||||
}, |
|
||||
}, |
|
||||
"msg": {"title": "Message", "type": "string"}, |
|
||||
"type": {"title": "Error Type", "type": "string"}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
@ -1,222 +0,0 @@ |
|||||
import pytest |
|
||||
from fastapi import FastAPI |
|
||||
from fastapi.testclient import TestClient |
|
||||
|
|
||||
from ...utils import needs_py39 |
|
||||
|
|
||||
|
|
||||
@pytest.fixture(name="app") |
|
||||
def get_app(): |
|
||||
from docs_src.request_files.tutorial003_an_py39 import app |
|
||||
|
|
||||
return app |
|
||||
|
|
||||
|
|
||||
@pytest.fixture(name="client") |
|
||||
def get_client(app: FastAPI): |
|
||||
client = TestClient(app) |
|
||||
return client |
|
||||
|
|
||||
|
|
||||
file_required = { |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "files"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_files(tmp_path, app: FastAPI): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
path2 = tmp_path / "test2.txt" |
|
||||
path2.write_bytes(b"<file content2>") |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file, path2.open("rb") as file2: |
|
||||
response = client.post( |
|
||||
"/files/", |
|
||||
files=( |
|
||||
("files", ("test.txt", file)), |
|
||||
("files", ("test2.txt", file2)), |
|
||||
), |
|
||||
) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"file_sizes": [14, 15]} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_upload_file(tmp_path, app: FastAPI): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
path2 = tmp_path / "test2.txt" |
|
||||
path2.write_bytes(b"<file content2>") |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file, path2.open("rb") as file2: |
|
||||
response = client.post( |
|
||||
"/uploadfiles/", |
|
||||
files=( |
|
||||
("files", ("test.txt", file)), |
|
||||
("files", ("test2.txt", file2)), |
|
||||
), |
|
||||
) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"filenames": ["test.txt", "test2.txt"]} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_get_root(app: FastAPI): |
|
||||
client = TestClient(app) |
|
||||
response = client.get("/") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert b"<form" in response.content |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_openapi_schema(client: TestClient): |
|
||||
response = client.get("/openapi.json") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == { |
|
||||
"openapi": "3.1.0", |
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|
||||
"paths": { |
|
||||
"/files/": { |
|
||||
"post": { |
|
||||
"summary": "Create Files", |
|
||||
"operationId": "create_files_files__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_files_files__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/uploadfiles/": { |
|
||||
"post": { |
|
||||
"summary": "Create Upload Files", |
|
||||
"operationId": "create_upload_files_uploadfiles__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_upload_files_uploadfiles__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/": { |
|
||||
"get": { |
|
||||
"summary": "Main", |
|
||||
"operationId": "main__get", |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"components": { |
|
||||
"schemas": { |
|
||||
"Body_create_files_files__post": { |
|
||||
"title": "Body_create_files_files__post", |
|
||||
"required": ["files"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"files": { |
|
||||
"title": "Files", |
|
||||
"type": "array", |
|
||||
"items": {"type": "string", "format": "binary"}, |
|
||||
"description": "Multiple files as bytes", |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"Body_create_upload_files_uploadfiles__post": { |
|
||||
"title": "Body_create_upload_files_uploadfiles__post", |
|
||||
"required": ["files"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"files": { |
|
||||
"title": "Files", |
|
||||
"type": "array", |
|
||||
"items": {"type": "string", "format": "binary"}, |
|
||||
"description": "Multiple files as UploadFile", |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"HTTPValidationError": { |
|
||||
"title": "HTTPValidationError", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"detail": { |
|
||||
"title": "Detail", |
|
||||
"type": "array", |
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"ValidationError": { |
|
||||
"title": "ValidationError", |
|
||||
"required": ["loc", "msg", "type"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"loc": { |
|
||||
"title": "Location", |
|
||||
"type": "array", |
|
||||
"items": { |
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|
||||
}, |
|
||||
}, |
|
||||
"msg": {"title": "Message", "type": "string"}, |
|
||||
"type": {"title": "Error Type", "type": "string"}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
@ -1,222 +0,0 @@ |
|||||
import pytest |
|
||||
from fastapi import FastAPI |
|
||||
from fastapi.testclient import TestClient |
|
||||
|
|
||||
from ...utils import needs_py39 |
|
||||
|
|
||||
|
|
||||
@pytest.fixture(name="app") |
|
||||
def get_app(): |
|
||||
from docs_src.request_files.tutorial003_py39 import app |
|
||||
|
|
||||
return app |
|
||||
|
|
||||
|
|
||||
@pytest.fixture(name="client") |
|
||||
def get_client(app: FastAPI): |
|
||||
client = TestClient(app) |
|
||||
return client |
|
||||
|
|
||||
|
|
||||
file_required = { |
|
||||
"detail": [ |
|
||||
{ |
|
||||
"loc": ["body", "files"], |
|
||||
"msg": "field required", |
|
||||
"type": "value_error.missing", |
|
||||
} |
|
||||
] |
|
||||
} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_files(tmp_path, app: FastAPI): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
path2 = tmp_path / "test2.txt" |
|
||||
path2.write_bytes(b"<file content2>") |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file, path2.open("rb") as file2: |
|
||||
response = client.post( |
|
||||
"/files/", |
|
||||
files=( |
|
||||
("files", ("test.txt", file)), |
|
||||
("files", ("test2.txt", file2)), |
|
||||
), |
|
||||
) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"file_sizes": [14, 15]} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_post_upload_file(tmp_path, app: FastAPI): |
|
||||
path = tmp_path / "test.txt" |
|
||||
path.write_bytes(b"<file content>") |
|
||||
path2 = tmp_path / "test2.txt" |
|
||||
path2.write_bytes(b"<file content2>") |
|
||||
|
|
||||
client = TestClient(app) |
|
||||
with path.open("rb") as file, path2.open("rb") as file2: |
|
||||
response = client.post( |
|
||||
"/uploadfiles/", |
|
||||
files=( |
|
||||
("files", ("test.txt", file)), |
|
||||
("files", ("test2.txt", file2)), |
|
||||
), |
|
||||
) |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == {"filenames": ["test.txt", "test2.txt"]} |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_get_root(app: FastAPI): |
|
||||
client = TestClient(app) |
|
||||
response = client.get("/") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert b"<form" in response.content |
|
||||
|
|
||||
|
|
||||
@needs_py39 |
|
||||
def test_openapi_schema(client: TestClient): |
|
||||
response = client.get("/openapi.json") |
|
||||
assert response.status_code == 200, response.text |
|
||||
assert response.json() == { |
|
||||
"openapi": "3.1.0", |
|
||||
"info": {"title": "FastAPI", "version": "0.1.0"}, |
|
||||
"paths": { |
|
||||
"/files/": { |
|
||||
"post": { |
|
||||
"summary": "Create Files", |
|
||||
"operationId": "create_files_files__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_files_files__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/uploadfiles/": { |
|
||||
"post": { |
|
||||
"summary": "Create Upload Files", |
|
||||
"operationId": "create_upload_files_uploadfiles__post", |
|
||||
"requestBody": { |
|
||||
"content": { |
|
||||
"multipart/form-data": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/Body_create_upload_files_uploadfiles__post" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
"required": True, |
|
||||
}, |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
}, |
|
||||
"422": { |
|
||||
"description": "Validation Error", |
|
||||
"content": { |
|
||||
"application/json": { |
|
||||
"schema": { |
|
||||
"$ref": "#/components/schemas/HTTPValidationError" |
|
||||
} |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
"/": { |
|
||||
"get": { |
|
||||
"summary": "Main", |
|
||||
"operationId": "main__get", |
|
||||
"responses": { |
|
||||
"200": { |
|
||||
"description": "Successful Response", |
|
||||
"content": {"application/json": {"schema": {}}}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"components": { |
|
||||
"schemas": { |
|
||||
"Body_create_files_files__post": { |
|
||||
"title": "Body_create_files_files__post", |
|
||||
"required": ["files"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"files": { |
|
||||
"title": "Files", |
|
||||
"type": "array", |
|
||||
"items": {"type": "string", "format": "binary"}, |
|
||||
"description": "Multiple files as bytes", |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"Body_create_upload_files_uploadfiles__post": { |
|
||||
"title": "Body_create_upload_files_uploadfiles__post", |
|
||||
"required": ["files"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"files": { |
|
||||
"title": "Files", |
|
||||
"type": "array", |
|
||||
"items": {"type": "string", "format": "binary"}, |
|
||||
"description": "Multiple files as UploadFile", |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"HTTPValidationError": { |
|
||||
"title": "HTTPValidationError", |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"detail": { |
|
||||
"title": "Detail", |
|
||||
"type": "array", |
|
||||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|
||||
} |
|
||||
}, |
|
||||
}, |
|
||||
"ValidationError": { |
|
||||
"title": "ValidationError", |
|
||||
"required": ["loc", "msg", "type"], |
|
||||
"type": "object", |
|
||||
"properties": { |
|
||||
"loc": { |
|
||||
"title": "Location", |
|
||||
"type": "array", |
|
||||
"items": { |
|
||||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|
||||
}, |
|
||||
}, |
|
||||
"msg": {"title": "Message", "type": "string"}, |
|
||||
"type": {"title": "Error Type", "type": "string"}, |
|
||||
}, |
|
||||
}, |
|
||||
} |
|
||||
}, |
|
||||
} |
|
||||
Loading…
Reference in new issue