couchpotato.core.downloaders.hadouken module

class couchpotato.core.downloaders.hadouken.Hadouken

Bases: couchpotato.core._base.downloader.main.DownloaderBase

connect()

download(data=None, media=None, filedata=None)

Send a torrent/nzb file to the downloader

Parameters:

• data – dict returned from provider Contains the release information
• media – media dict with information Used for creating the filename when possible
• filedata – downloaded torrent/nzb filedata The file gets downloaded in the searcher and send to this function This is done to have failed checking before using the downloader, so the downloader doesn’t need to worry about that

Returns:

boolean One faile returns false, but the downloaded should log his own errors

getAllDownloadStatus(ids)

Get status of all active downloads

Parameters:ids – list of (mixed) downloader ids Used to match the releases for this downloader as there could be other downloaders active that it should ignore Returns:list of releases

hadouken_api = None

pause(release_download, pause=True)

Pauses or resumes the torrent specified by the ID field in release_download.

Keyword arguments: release_download – The CouchPotato release_download to pause/resume. pause – Boolean indicating whether to pause or resume.

processComplete(release_download, delete_files=False)

Removes the completed torrent from Hadouken and optionally removes the data associated with it.

Keyword arguments: release_download – The CouchPotato release_download to remove. delete_files: Boolean indicating whether to remove the associated data.

protocol = ['torrent', 'torrent_magnet']

removeFailed(release_download)

Removes a failed torrent and also remove the data associated with it.

Keyword arguments: release_download – The CouchPotato release_download to remove.

test()

Tests the given host:port and API key

class couchpotato.core.downloaders.hadouken.HadoukenAPI(rpc_client)

Bases: object

add_file(data, params)

Add a file to Hadouken with the specified parameters.

Keyword arguments: filedata – The binary torrent data. torrent_params – Additional parameters for the file.

add_magnet_link(link, params)

Add a magnet link to Hadouken with the specified parameters.

Keyword arguments: magnetLink – The magnet link to send. torrent_params – Additional parameters for the magnet link.

get_by_hash_list(infoHashList)

Gets a list of torrents filtered by the given info hash list.

Keyword arguments: infoHashList – A list of info hashes.

get_files_by_hash(infoHash)

Gets a list of files for the torrent identified by the given info hash.

Keyword arguments: infoHash – The info hash of the torrent to return files for.

get_version()

Gets the version, commitish and build date of Hadouken.

pause(infoHash, pause)

Pauses/unpauses the torrent identified by the given info hash.

Keyword arguments: infoHash – The info hash of the torrent to operate on. pause – If true, pauses the torrent. Otherwise resumes.

remove(infoHash, remove_data=False)

Removes the torrent identified by the given info hash and optionally removes the data as well.

Keyword arguments: infoHash – The info hash of the torrent to remove. remove_data – If true, removes the data associated with the torrent.

class couchpotato.core.downloaders.hadouken.HadoukenAPIv4

Bases: object

add_file(data, params)

add_magnet_link(link, params)

get_by_hash_list(infoHashList)

get_files_by_hash(infoHash)

get_version()

pause(infoHash, pause)

remove(infoHash, remove_data=False)

class couchpotato.core.downloaders.hadouken.HadoukenAPIv5(rpc_client)

Bases: couchpotato.core.downloaders.hadouken.HadoukenAPI

add_file(data, params)

add_magnet_link(link, params)

get_by_hash_list(infoHashList)

get_files_by_hash(infoHash)

get_version()

pause(infoHash, pause)

remove(infoHash, remove_data=False)

class couchpotato.core.downloaders.hadouken.JsonRpcClient(url, auth_header=None)

Bases: object

invoke(method, params)

class couchpotato.core.downloaders.hadouken.TorrentItem

Bases: object

get_seed_ratio()

Returns the seed ratio for a given torrent.

get_status()

Returns the CouchPotato status for a given torrent.

info_hash

name

save_path

state

class couchpotato.core.downloaders.hadouken.TorrentItemv4(obj)

Bases: couchpotato.core.downloaders.hadouken.TorrentItem

get_seed_ratio()

get_status()

info_hash()

name()

save_path()

state()

class couchpotato.core.downloaders.hadouken.TorrentItemv5(obj)

Bases: couchpotato.core.downloaders.hadouken.TorrentItem

get_seed_ratio()

get_status()

info_hash()

name()

save_path()

state()