mirror of https://github.com/tiangolo/fastapi.git
🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
This commit is contained in:
parent
3f5ad3689c
commit
5a38a03bf8
|
|
@ -143,23 +143,22 @@ class UploadFile(StarletteUploadFile):
|
|||
str,
|
||||
Doc("The text encoding to use when decoding bytes. Defaults to 'utf-8'."),
|
||||
] = "utf-8",
|
||||
) -> str:
|
||||
|
||||
) -> str:
|
||||
"""
|
||||
Read the entire file as a text string.
|
||||
This is a convenience wrapper around `await self.read()`
|
||||
that decodes the bytes using the given encoding.
|
||||
## Example
|
||||
```python
|
||||
@app.post("/upload-text/")
|
||||
async def upload_text(file: UploadFile):
|
||||
text = await file.read_text()
|
||||
return {"length": len(text)}
|
||||
```
|
||||
Args:
|
||||
encoding: The text encoding to use (default: 'utf-8').
|
||||
Returns:
|
||||
The decoded file content as a string.
|
||||
Read the entire file as a text string.
|
||||
This is a convenience wrapper around `await self.read()`
|
||||
that decodes the bytes using the given encoding.
|
||||
## Example
|
||||
```python
|
||||
@app.post("/upload-text/")
|
||||
async def upload_text(file: UploadFile):
|
||||
text = await file.read_text()
|
||||
return {"length": len(text)}
|
||||
```
|
||||
Args:
|
||||
encoding: The text encoding to use (default: 'utf-8').
|
||||
Returns:
|
||||
The decoded file content as a string.
|
||||
"""
|
||||
data = await self.read()
|
||||
return data.decode(encoding)
|
||||
|
|
|
|||
|
|
@ -74,7 +74,6 @@ async def test_upload_file():
|
|||
|
||||
@pytest.mark.asyncio
|
||||
async def test_uploadfile_read_text(tmp_path):
|
||||
|
||||
file_path = tmp_path / "sample.txt"
|
||||
file_path.write_text("Hello FastAPI!")
|
||||
|
||||
|
|
@ -82,4 +81,6 @@ async def test_uploadfile_read_text(tmp_path):
|
|||
upload = UploadFile(filename="sample.txt", file=f)
|
||||
content = await upload.read_text()
|
||||
assert content == "Hello FastAPI!"
|
||||
assert upload.filename == "sample.txt" # make sure .read_text() doesn't modify filename or headers
|
||||
assert (
|
||||
upload.filename == "sample.txt"
|
||||
) # make sure .read_text() doesn't modify filename or headers
|
||||
|
|
|
|||
Loading…
Reference in New Issue