Application¶
-
class
qbittorrentapi.app.
AppAPIMixIn
(host='', port=None, username=None, password=None, **kwargs)¶ Bases:
qbittorrentapi.request.Request
Implementation of all Application API methods
Usage: >>> from qbittorrentapi import Client >>> client = Client(host='localhost:8080', username='admin', password='adminadmin') >>> client.app_version() >>> client.app_preferences()
-
app_build_info
(**kwargs)¶ Retrieve build info. (alias: app_buildInfo)
Returns: BuildInfoDictionary
- https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-build-info
-
app_default_save_path
(**kwargs)¶ Retrieves the default path for where torrents are saved. (alias: app_defaultSavePath)
Returns: string
-
app_preferences
(**kwargs)¶ Retrieve qBittorrent application preferences.
Returns: ApplicationPreferencesDictionary
- https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-application-preferences
-
app_set_preferences
(prefs=None, **kwargs)¶ Set one or more preferences in qBittorrent application. (alias: app_setPreferences)
Parameters: prefs – dictionary of preferences to set Returns: None
-
app_shutdown
(**kwargs)¶ Shutdown qBittorrent.
-
app_version
(**kwargs)¶ Retrieve application version
Returns: string
-
app_web_api_version
(**kwargs)¶ Retrieve web API version. (alias: app_webapiVersion)
Returns: string
-
-
class
qbittorrentapi.app.
Application
(*args, **kwargs)¶ Allows interaction with “Application” API endpoints.
Usage: >>> from qbittorrentapi import Client >>> client = Client(host='localhost:8080', username='admin', password='adminadmin') >>> # these are all the same attributes that are available as named in the >>> # endpoints or the more pythonic names in Client (with or without 'app_' prepended) >>> webapiVersion = client.application.webapiVersion >>> web_api_version = client.application.web_api_version >>> app_web_api_version = client.application.web_api_version >>> # access and set preferences as attributes >>> is_dht_enabled = client.application.preferences.dht >>> # supports sending a just subset of preferences to update >>> client.application.preferences = dict(dht=(not is_dht_enabled)) >>> prefs = client.application.preferences >>> prefs['web_ui_clickjacking_protection_enabled'] = True >>> client.app.preferences = prefs >>> >>> client.application.shutdown()
-
build_info
¶ Implements
app_build_info()
-
default_save_path
¶ Implements
app_default_save_path()
-
preferences
¶ Implements
app_preferences()
andapp_set_preferences()
-
set_preferences
(prefs=None, **kwargs)¶ Implements
app_set_preferences()
-
shutdown
()¶ Implements
app_shutdown()
-
version
¶ Implements
app_version()
-
web_api_version
¶ Implements
app_web_api_version()
-
-
class
qbittorrentapi.app.
ApplicationPreferencesDictionary
(data=None, client=None)¶ Bases:
qbittorrentapi.definitions.Dictionary
Response for
app_preferences()
-
class
qbittorrentapi.app.
BuildInfoDictionary
(data=None, client=None)¶ Bases:
qbittorrentapi.definitions.Dictionary
Response for
app_build_info()