alihan/textual-serve
1
0
Fork 0
mirror of https://github.com/Textualize/textual-serve.git synced 2025-10-17 02:50:37 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add docstrings for Download object

Browse Source
This commit is contained in:
Darren Burns
2024-08-29 10:08:50 +01:00
parent 609d36376d
commit a5ddc3aa0b
1 changed files with 15 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/textual_serve/download_manager.py
View File

@@ -17,15 +17,30 @@ DOWNLOAD_CHUNK_SIZE = 1024 * 64 # 64 KB
@dataclass @dataclass
class Download: class Download:
app_service: "AppService" app_service: "AppService"
"""The app service that the download is associated with."""
delivery_key: str delivery_key: str
"""Key which identifies the download."""
file_name: str file_name: str
"""The name of the file to download. This will be used to set
the Content-Disposition filename."""
open_method: str open_method: str
"""The method to open the file with. "browser" or "download"."""
mime_type: str mime_type: str
"""The mime type of the content."""
encoding: str | None = None encoding: str | None = None
"""The encoding of the content. """The encoding of the content.
Will be None if the content is binary. Will be None if the content is binary.
""" """
incoming_chunks: asyncio.Queue[bytes | None] = field(default_factory=asyncio.Queue) incoming_chunks: asyncio.Queue[bytes | None] = field(default_factory=asyncio.Queue)
"""A queue of incoming chunks for the download.
Chunks are sent from the app service to the download handler
via this queue."""
class DownloadManager: class DownloadManager:
@@ -80,7 +95,6 @@ class DownloadManager:
"""Download a file from the given app service. """Download a file from the given app service.
Args: Args:
app_service: The app service to download from.
delivery_key: The delivery key to download. delivery_key: The delivery key to download.
""" """