From: memsuser <108115586+memsuser@users.noreply.github.com> Date: Mon, 27 Jun 2022 04:56:00 +0000 (-0500) Subject: Add notes on "filename" form-data field (#1704) X-Git-Tag: 0.20.4~4 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=92c1f1e5503012f48d6bfbc3ed5af4f4bad23e28;p=thirdparty%2Fstarlette.git Add notes on "filename" form-data field (#1704) Co-authored-by: Marcelo Trylesinski Co-authored-by: Adrian Garcia Badaracco <1755071+adriangb@users.noreply.github.com> --- diff --git a/docs/requests.md b/docs/requests.md index 87294663..a50c0753 100644 --- a/docs/requests.md +++ b/docs/requests.md @@ -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