Schema¶

Bases: NamedTuple

Options for adding a torrent.

Each attribute maps to the options accepted by Deluge when adding a torrent. All fields are optional; unset fields will use server-side defaults.

add_paused:: If True, add the torrent in a paused state. Default is False.
auto_managed:: If True, the torrent will be managed automatically by the client’s queueing/automanager. When False, the torrent won’t be auto-managed.
download_location:: Absolute path on the host where the torrent’s data should be stored.
file_priorities:: Integer or list describing per-file priorities when adding a multi-file torrent (implementation-dependent); leave None to use defaults.
max_connections:: Maximum number of peer connections allowed for this torrent (None to inherit global/default setting).
max_download_speed:: Per-torrent download speed limit in bytes/sec. None means unlimited or use the global setting.
max_upload_slots:: Maximum number of upload slots for this torrent (None to use global defaults).
max_upload_speed:: Per-torrent upload speed limit in bytes/sec. None means unlimited or use the global setting.
move_completed:: If True, move completed torrents to move_completed_path after they finish. Defaults to False.
move_completed_path:: Destination path to move completed torrents to when move_completed is True.
name:: Suggested name for the torrent (may be used by some CSV/import flows or when metadata lacks a name).
owner:: Username/owner string to associate with the torrent (implementation specific; often unused in simple setups).
prioritize_first_last_pieces:: If True, prioritize the first and last pieces of files. Useful for streaming playback of media files.
remove_at_ratio:: If True, remove the torrent when it reaches stop_ratio (requires stop_at_ratio to be set to True).
seed_mode:: If True, enable seed mode where the client assumes data is already present and avoids re-checking; useful when adding a torrent whose data already exists on disk.
sequential_download:: If True, request pieces sequentially (often used for streaming). Use with caution as it reduces swarming efficiency.
shared:: If True, mark the torrent as shared (affects how it is displayed or managed in some frontends/plugins).
stop_at_ratio:: If True, stop the torrent once it reaches stop_ratio.
stop_ratio:: Floating-point ratio at which the torrent should be stopped/removed (combined with stop_at_ratio / remove_at_ratio).
super_seeding:: If True, enable super-seeding mode (server will use super-seed algorithm where supported). Typically useful when initially seeding scarce content.
label:: Label or category to assign to the torrent for organizational purposes.

add_paused: bool | None¶: Alias for field number 0

auto_managed: bool | None¶: Alias for field number 1

download_location: str | None¶: Alias for field number 2

file_priorities: int | None¶: Alias for field number 3

label: str | None¶: Alias for field number 20

max_connections: int | None¶: Alias for field number 4

max_download_speed: int | None¶: Alias for field number 5

max_upload_slots: int | None¶: Alias for field number 6

max_upload_speed: int | None¶: Alias for field number 7

move_completed: bool | None¶: Alias for field number 8

move_completed_path: str | None¶: Alias for field number 9

name: str | None¶: Alias for field number 10

owner: str | None¶: Alias for field number 11

prioritize_first_last_pieces: bool | None¶: Alias for field number 12

remove_at_ratio: bool | None¶: Alias for field number 13

seed_mode: bool | None¶: Alias for field number 14

sequential_download: bool | None¶: Alias for field number 15

shared: bool | None¶: Alias for field number 16

stop_at_ratio: bool | None¶: Alias for field number 17

stop_ratio: float | None¶: Alias for field number 18

super_seeding: bool | None¶: Alias for field number 19

to_dict() → dict[str, bool | int | float | str]¶

Convert the TorrentOptions to a dictionary, excluding None values.

Return type:: dict[str, bool | int | float | str]