Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add notes on "filename" form-data field #1704

Merged
merged 7 commits into from Jun 27, 2022
Merged

Add notes on "filename" form-data field #1704

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
87423ae
Add notes on "filename" form-data field
memsuser Jun 24, 2022
158601b
Update docs/requests.md
memsuser Jun 24, 2022
9b00289
Update docs/requests.md
adriangb Jun 25, 2022
ce7bd0c
Merge branch 'master' into patch-1
adriangb Jun 27, 2022
dd306b2
Update docs/requests.md
adriangb Jun 27, 2022
5aa1c26
move note to end of section
adriangb Jun 27, 2022
d7da8ad
Apply suggestions from code review
Kludex Jun 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/requests.md
View file
Open in desktop
Expand Up @@ -142,6 +142,13 @@ filename = form["upload_file"].filename
contents = await form["upload_file"].read()
```

!!! info
As settled in [RFC-7578: 4.2](https://www.ietf.org/rfc/rfc7578.txt), form-data content part that contains file
assumed to have `name` and `filename` fields in `Content-Disposition` header: `Content-Disposition: form-
data; name="user"; filename="somefile"`. Though `filename` field is optional according to RFC-7578, it helps
Starlette to differentiate which data should be treated as file. If `filename` field was supplied, `UploadFile`
object will be created to access underlying file, otherwise form-data part will be parsed and available as a raw
string.

#### Application

Expand Down