Skip to content

Commit 337ae24

Browse files
authored
Document that UploadFile's filename and content_type can be None (#2029)
1 parent 218a6b4 commit 337ae24

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/requests.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,8 @@ multidict, containing both file uploads and text input. File upload items are re
119119

120120
`UploadFile` has the following attributes:
121121

122-
* `filename`: A `str` with the original file name that was uploaded (e.g. `myimage.jpg`).
123-
* `content_type`: A `str` with the content type (MIME type / media type) (e.g. `image/jpeg`).
122+
* `filename`: An `str` with the original file name that was uploaded or `None` if its not available (e.g. `myimage.jpg`).
123+
* `content_type`: An `str` with the content type (MIME type / media type) or `None` if it's not available (e.g. `image/jpeg`).
124124
* `file`: A <a href="https://docs.python.org/3/library/tempfile.html#tempfile.SpooledTemporaryFile" target="_blank">`SpooledTemporaryFile`</a> (a <a href="https://docs.python.org/3/glossary.html#term-file-like-object" target="_blank">file-like</a> object). This is the actual Python file that you can pass directly to other functions or libraries that expect a "file-like" object.
125125
* `headers`: A `Headers` object. Often this will only be the `Content-Type` header, but if additional headers were included in the multipart field they will be included here. Note that these headers have no relationship with the headers in `Request.headers`.
126126
* `size`: An `int` with uploaded file's size in bytes. This value is calculated from request's contents, making it better choice to find uploaded file's size than `Content-Length` header. `None` if not set.

0 commit comments

Comments
 (0)