clutch.schema.request.torrent package

Submodules

clutch.schema.request.torrent.accessor module

class clutch.schema.request.torrent.accessor.TorrentAccessorArgumentsRequest(**data)

Bases: BaseModel

Parameters:

data (Any)

accessor_fields: Optional[Set[Literal['activityDate', 'addedDate', 'availability', 'bandwidthPriority', 'comment', 'corruptEver', 'creator', 'dateCreated', 'desiredAvailable', 'doneDate', 'downloadDir', 'downloadedEver', 'downloadLimit', 'downloadLimited', 'editDate', 'error', 'errorString', 'eta', 'etaIdle', 'file-count', 'files', 'fileStats', 'group', 'hashString', 'haveUnchecked', 'haveValid', 'honorsSessionLimits', 'id', 'isFinished', 'isPrivate', 'isStalled', 'labels', 'leftUntilDone', 'magnetLink', 'manualAnnounceTime', 'maxConnectedPeers', 'metadataPercentComplete', 'name', 'peer-limit', 'peers', 'peersConnected', 'peersFrom', 'peersGettingFromUs', 'peersSendingToUs', 'percentComplete', 'percentDone', 'pieces', 'pieceCount', 'pieceSize', 'priorities', 'primary-mime-type', 'queuePosition', 'rateDownload', 'rateUpload', 'recheckProgress', 'secondsDownloading', 'secondsSeeding', 'seedIdleLimit', 'seedIdleMode', 'seedRatioLimit', 'seedRatioMode', 'sequentialDownload', 'sizeWhenDone', 'startDate', 'status', 'trackers', 'trackerList', 'trackerStats', 'totalSize', 'torrentFile', 'uploadedEver', 'uploadLimit', 'uploadLimited', 'uploadRatio', 'wanted', 'webseeds', 'webseedsSendingToUs']]]
classmethod accessor_fields_format(v)
format: Optional[Literal['objects', 'table']]
ids: Union[int, Iterable[Union[int, str]], Iterable[int], Iterable[str], Literal['recently_active'], None]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

clutch.schema.request.torrent.add module

class clutch.schema.request.torrent.add.Cookie(**data)

Bases: BaseModel

Parameters:

data (Any)

content: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str
class clutch.schema.request.torrent.add.TorrentAddArgumentsRequest(**data)

Bases: BaseModel

Parameters:

data (Any)

bandwidth_priority: int | None
check_required_exclusive_fields()
Return type:

Self

cookies: Optional[Sequence[Cookie]]
download_dir: str | None
filename: str | None
files_unwanted: Optional[Sequence[int]]
files_wanted: Optional[Sequence[int]]
metainfo: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

paused: bool | None
peer_limit: int | None
priority_high: Optional[Sequence[int]]
priority_low: Optional[Sequence[int]]
priority_normal: Optional[Sequence[int]]

clutch.schema.request.torrent.mutator module

class clutch.schema.request.torrent.mutator.TorrentMutatorArgumentsRequest(**data)

Bases: BaseModel

Parameters:

data (Any)

bandwidth_priority: int | None
download_limit: int | None
download_limited: bool | None
edit_date: int | None
files_unwanted: Optional[Sequence[int]]
files_wanted: Optional[Sequence[int]]
group: str | None
honors_session_limits: bool | None
ids: Union[int, Iterable[Union[int, str]], Iterable[int], Iterable[str], Literal['recently_active'], None]
labels: Optional[Sequence[str]]
location: str | None
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

peer_limit: int | None
priority_high: Optional[Sequence[int]]
priority_low: Optional[Sequence[int]]
priority_normal: Optional[Sequence[int]]
queue_position: int | None
seed_idle_limit: int | None
seed_idle_mode: int | None
seed_ratio_limit: float | None
seed_ratio_mode: int | None
tracker_list: str | None
upload_limit: int | None
upload_limited: bool | None

Module contents