trim21 / transmission-rpc

https://transmission-rpc.readthedocs.io/en/stable/

MIT License

136 stars 34 forks source link

Cannot get files of a torrent without unnecessary priorities and wanted fields #455

Open cheeseandcereal opened 1 month ago

cheeseandcereal commented 1 month ago

Description

Currently, it is impossible to get files of a torrent (with the .get_files() interface) unless you fetch the priorities and wanted fields.

This is due to trying to directly reference these fields here: https://github.com/trim21/transmission-rpc/blob/57c064f6b740b67be1ed7c5afad5ce18476616f4/transmission_rpc/torrent.py#L436-L437

It currently returns a key error if you try to use this:

    priorities = self.fields["priorities"]
                 ~~~~~~~~~~~^^^^^^^^^^^^^^
KeyError: 'priorities'

This doesn't really seem necessary and forces fetching these fields onto users for use-cases that may not need them.

I would propose updating this function or providing an alternative interface to get the files of a Torrent class

(as a side note, why are getting files a function interface while everything else on the class is a property? It seems a bit weird/inconsistent)

cheeseandcereal commented 1 month ago

(As a note to others who find this issue before it's fixed)

A hacky workaround to this without actually fetching the additional fields is to just manually set the internal field state of the torrent yourself before calling .get_files() - i.e.:

torrent.fields["priorities"] = [0] * len(torrent.fields["files"])
torrent.fields["wanted"] = [True] * len(torrent.fields["files"])
# get_files() should now work
torrent.get_files()