1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
|
from __future__ import annotations
from typing_extensions import Literal
from transmission_rpc.types import Container
class Stats(Container):
@property
def uploaded_bytes(self) -> int:
return self.fields["uploadedBytes"]
@property
def downloaded_bytes(self) -> int:
return self.fields["downloadedBytes"]
@property
def files_added(self) -> int:
return self.fields["filesAdded"]
@property
def session_count(self) -> int:
return self.fields["sessionCount"]
@property
def seconds_active(self) -> int:
return self.fields["secondsActive"]
class SessionStats(Container):
# https://github.com/transmission/transmission/blob/main/docs/rpc-spec.md
# 42-session-statistics
@property
def active_torrent_count(self) -> int:
return self.fields["activeTorrentCount"]
@property
def download_speed(self) -> int:
return self.fields["downloadSpeed"]
@property
def paused_torrent_count(self) -> int:
return self.fields["pausedTorrentCount"]
@property
def torrent_count(self) -> int:
return self.fields["torrentCount"]
@property
def upload_speed(self) -> int:
return self.fields["uploadSpeed"]
@property
def cumulative_stats(self) -> Stats:
return Stats(fields=self.fields["cumulative-stats"])
@property
def current_stats(self) -> Stats:
return Stats(fields=self.fields["current-stats"])
class Units(Container):
# 4 strings: KB/s, MB/s, GB/s, TB/s
@property
def speed_units(self) -> list[str]:
return self.fields["speed-units"]
# number of bytes in a KB (1000 for kB; 1024 for KiB)
@property
def speed_bytes(self) -> int:
return self.fields["speed-bytes"]
# 4 strings: KB/s, MB/s, GB/s, TB/s
@property
def size_units(self) -> list[str]:
return self.fields["size-units"]
# number of bytes in a KB (1000 for kB; 1024 for KiB)
@property
def size_bytes(self) -> int:
return self.fields["size-bytes"]
# 4 strings: KB/s, MB/s, GB/s, TB/s
@property
def memory_units(self) -> list[str]:
return self.fields["memory-units"]
# number of bytes in a KB (1000 for kB; 1024 for KiB)
@property
def memory_bytes(self) -> int:
return self.fields["memory-bytes"]
class Session(Container):
"""
Session is a class holding the session data for a Transmission daemon.
Access the session field can be done through attributes.
The attributes available are the same as the session arguments in the
Transmission RPC specification, but with underscore instead of hyphen.
You should use ``session.download_dir`` to get ``'download-dir'``.
.. code-block:: python
session = Client().get_session()
current = session.download_dir
https://github.com/transmission/transmission/blob/main/docs/rpc-spec.md#41-session-arguments
Warnings:
setter on session's properties has been removed, please use :py:meth`Client.set_session` instead
"""
@property
def alt_speed_down(self) -> int:
"""max global download speed (KBps)"""
return self.fields["alt-speed-down"]
@property
def alt_speed_enabled(self) -> bool:
# true means use the alt speeds
return self.fields["alt-speed-enabled"]
@property
def alt_speed_time_begin(self) -> int:
"""when to turn on alt speeds (units: minutes after midnight)"""
return self.fields["alt-speed-time-begin"]
@property
def alt_speed_time_day(self) -> int:
"""what day(s) to turn on alt speeds (look at tr_sched_day)"""
return self.fields["alt-speed-time-day"]
@property
def alt_speed_time_enabled(self) -> bool:
"""true means the scheduled on/off times are used"""
return self.fields["alt-speed-time-enabled"]
@property
def alt_speed_time_end(self) -> int:
"""when to turn off alt speeds (units: same)"""
return self.fields["alt-speed-time-end"]
@property
def alt_speed_up(self) -> int:
"""max global upload speed (KBps)"""
return self.fields["alt-speed-up"]
@property
def blocklist_enabled(self) -> bool:
"""true means enabled"""
return self.fields["blocklist-enabled"]
@property
def blocklist_size(self) -> int:
"""int of rules in the blocklist"""
return self.fields["blocklist-size"]
@property
def blocklist_url(self) -> str:
"""location of the blocklist to use for `blocklist-update`"""
return self.fields["blocklist-url"]
@property
def cache_size_mb(self) -> int:
"""maximum size of the disk cache (MB)"""
return self.fields["cache-size-mb"]
@property
def config_dir(self) -> str:
"""location of transmission's configuration directory"""
return self.fields["config-dir"]
@property
def dht_enabled(self) -> bool:
"""true means allow dht in public torrents"""
return self.fields["dht-enabled"]
@property
def download_dir(self) -> str:
"""default path to download torrents"""
return self.fields["download-dir"]
@property
def download_dir_free_space(self) -> int:
"""**DEPRECATED** Use the `free-space` method instead."""
return self.fields["download-dir-free-space"]
@property
def download_queue_enabled(self) -> bool:
"""if true, limit how many torrents can be downloaded at once"""
return self.fields["download-queue-enabled"]
@property
def download_queue_size(self) -> int:
"""max int of torrents to download at once (see download-queue-enabled)"""
return self.fields["download-queue-size"]
@property
def encryption(self) -> Literal["required", "preferred", "tolerated"]:
return self.fields["encryption"]
@property
def idle_seeding_limit_enabled(self) -> bool:
"""true if the seeding inactivity limit is honored by default"""
return self.fields["idle-seeding-limit-enabled"]
@property
def idle_seeding_limit(self) -> int:
"""torrents we're seeding will be stopped if they're idle for this long"""
return self.fields["idle-seeding-limit"]
@property
def incomplete_dir_enabled(self) -> bool:
"""true means keep torrents in incomplete-dir until done"""
return self.fields["incomplete-dir-enabled"]
@property
def incomplete_dir(self) -> str:
"""path for incomplete torrents, when enabled"""
return self.fields["incomplete-dir"]
@property
def lpd_enabled(self) -> bool:
"""true means allow Local Peer Discovery in public torrents"""
return self.fields["lpd-enabled"]
@property
def peer_limit_global(self) -> int:
"""maximum global int of peers"""
return self.fields["peer-limit-global"]
@property
def peer_limit_per_torrent(self) -> int:
"""maximum global int of peers"""
return self.fields["peer-limit-per-torrent"]
@property
def peer_port_random_on_start(self) -> bool:
"""true means pick a random peer port on launch"""
return self.fields["peer-port-random-on-start"]
@property
def peer_port(self) -> int:
"""port int"""
return self.fields["peer-port"]
@property
def pex_enabled(self) -> bool:
"""true means allow pex in public torrents"""
return self.fields["pex-enabled"]
@property
def port_forwarding_enabled(self) -> bool:
"""true means ask upstream router to forward the configured peer port to transmission using UPnP or NAT-PMP"""
return self.fields["port-forwarding-enabled"]
@property
def queue_stalled_enabled(self) -> bool:
"""whether or not to consider idle torrents as stalled"""
return self.fields["queue-stalled-enabled"]
@property
def queue_stalled_minutes(self) -> int:
"""torrents that are idle for N minutes aren't counted toward seed-queue-size or download-queue-size"""
return self.fields["queue-stalled-minutes"]
@property
def rename_partial_files(self) -> bool:
"""true means append `.part` to incomplete files"""
return self.fields["rename-partial-files"]
@property
def rpc_version_minimum(self) -> int:
"""the minimum RPC API version supported"""
return self.fields["rpc-version-minimum"]
@property
def rpc_version(self) -> int:
"""the current RPC API version"""
return self.fields["rpc-version"]
@property
def script_torrent_done_enabled(self) -> bool:
"""whether or not to call the `done` script"""
return self.fields["script-torrent-done-enabled"]
@property
def script_torrent_done_filename(self) -> str:
"""filename of the script to run"""
return self.fields["script-torrent-done-filename"]
@property
def seed_queue_enabled(self) -> bool:
"""if true, limit how many torrents can be uploaded at once"""
return self.fields["seed-queue-enabled"]
@property
def seed_queue_size(self) -> int:
"""max int of torrents to uploaded at once (see seed-queue-enabled)"""
return self.fields["seed-queue-size"]
@property
def seed_ratio_limit(self) -> float:
"""the default seed ratio for torrents to use"""
return float(self.fields["seedRatioLimit"])
@property
def seed_ratio_limited(self) -> bool:
"""true if seedRatioLimit is honored by default"""
return self.fields["seedRatioLimited"]
@property
def speed_limit_down_enabled(self) -> bool:
"""true means enabled"""
return self.fields["speed-limit-down-enabled"]
@property
def speed_limit_down(self) -> int:
"""max global download speed (KBps)"""
return self.fields["speed-limit-down"]
@property
def speed_limit_up_enabled(self) -> bool:
"""true means enabled"""
return self.fields["speed-limit-up-enabled"]
@property
def speed_limit_up(self) -> int:
"""max global upload speed (KBps)"""
return self.fields["speed-limit-up"]
@property
def start_added_torrents(self) -> bool:
"""true means added torrents will be started right away"""
return self.fields["start-added-torrents"]
@property
def trash_original_torrent_files(self) -> bool:
"""true means the .torrent file of added torrents will be deleted"""
return self.fields["trash-original-torrent-files"]
# see below
@property
def units(self) -> Units:
return Units(fields=self.fields["units"])
@property
def utp_enabled(self) -> bool:
"""true means allow utp"""
return self.fields["utp-enabled"]
@property
def version(self) -> str:
"""long version str `$version ($revision)`"""
return self.fields["version"]
@property
def default_trackers(self) -> list[str] | None:
"""
list of default trackers to use on public torrents
new at rpc-version 17
"""
trackers = self.get("default-trackers")
if trackers:
return trackers.split("\n")
return None
@property
def rpc_version_semver(self) -> str | None:
"""
the current RPC API version in a semver-compatible str
new at rpc-version 17
"""
return self.get("rpc-version-semver")
@property
def script_torrent_added_enabled(self) -> bool | None:
"""
whether to call the `added` script
new at rpc-version 17
"""
return self.get("script-torrent-added-enabled")
@property
def script_torrent_added_filename(self) -> str | None:
"""
filename of the script to run
new at rpc-version 17
"""
return self.get("script-torrent-added-filename")
@property
def script_torrent_done_seeding_enabled(self) -> bool | None:
"""
whether to call the `seeding-done` script
new at rpc-version 17
"""
return self.get("script-torrent-done-seeding-enabled")
@property
def script_torrent_done_seeding_filename(self) -> str | None:
"""
filename of the script to run
new at rpc-version 17
"""
return self.get("script-torrent-done-seeding-filename")
|