Search#
- class SearchAPIMixIn(host=None, port=None, username=None, password=None, EXTRA_HEADERS=None, REQUESTS_ARGS=None, VERIFY_WEBUI_CERTIFICATE=True, FORCE_SCHEME_FROM_HOST=False, RAISE_NOTIMPLEMENTEDERROR_FOR_UNIMPLEMENTED_API_ENDPOINTS=False, RAISE_ERROR_FOR_UNSUPPORTED_QBITTORRENT_VERSIONS=False, VERBOSE_RESPONSE_LOGGING=False, SIMPLE_RESPONSES=False, DISABLE_LOGGING_DEBUG_OUTPUT=False) None #
Bases:
AppAPIMixIn
Implementation for all
Search
API methods.- Usage:
>>> from qbittorrentapi import Client >>> client = Client(host="localhost:8080", username="admin", password="adminadmin") >>> search_job = client.search_start(pattern="Ubuntu", plugins="all", category="all") >>> client.search_stop(search_id=search_job.id) >>> # or >>> search_job.stop()
- search_categories(plugin_name=None, **kwargs) SearchCategoriesList #
Retrieve categories for search.
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1) and removed with qBittorrent v4.3.0 (Web API v2.6).
- search_delete(search_id=None, **kwargs) None #
Delete a search job.
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1).
- search_enable_plugin(plugins=None, enable=None, **kwargs) None #
Enable or disable search plugin(s).
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1).
- search_install_plugin(sources=None, **kwargs) None #
Install search plugins from either URL or file.
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1).
- search_plugins(**kwargs) SearchPluginsList #
Retrieve details of search plugins.
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1).
- Return type:
- search_results(search_id=None, limit=None, offset=None, **kwargs) SearchResultsDictionary #
Retrieve the results for the search.
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1).
- Raises:
- Parameters:
- Return type:
- search_start(pattern=None, plugins=None, category=None, **kwargs) SearchJobDictionary #
Start a search. Python must be installed. Host may limit number of concurrent searches.
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1).
- Raises:
- Parameters:
- Return type:
- search_status(search_id=None, **kwargs) SearchStatusesList #
Retrieve status of one or all searches.
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1).
- search_stop(search_id=None, **kwargs) None #
Stop a running search.
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1).
- class Search(*args, client, **kwargs)#
Allows interaction with
Search
API endpoints.- Usage:
>>> from qbittorrentapi import Client >>> client = Client(host="localhost:8080", username="admin", password="adminadmin") >>> # this is all the same attributes that are available as named in the >>> # endpoints or the more pythonic names in Client (with or without 'search_' prepended) >>> # initiate searches and retrieve results >>> search_job = client.search.start(pattern="Ubuntu", plugins="all", category="all") >>> status = search_job.status() >>> results = search_job.result() >>> search_job.delete() >>> # inspect and manage plugins >>> plugins = client.search.plugins >>> cats = client.search.categories(plugin_name="...") >>> client.search.install_plugin(sources="...") >>> client.search.update_plugins()
- categories(plugin_name=None, **kwargs) SearchCategoriesList #
Retrieve categories for search.
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1) and removed with qBittorrent v4.3.0 (Web API v2.6).
- delete(search_id=None, **kwargs) None #
Delete a search job.
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1).
- enable_plugin(plugins=None, enable=None, **kwargs) None #
Enable or disable search plugin(s).
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1).
- install_plugin(sources=None, **kwargs) None #
Install search plugins from either URL or file.
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1).
- property plugins: SearchPluginsList#
Retrieve details of search plugins.
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1).
- results(search_id=None, limit=None, offset=None, **kwargs) SearchResultsDictionary #
Retrieve the results for the search.
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1).
- Raises:
- Parameters:
- Return type:
- start(pattern=None, plugins=None, category=None, **kwargs) SearchJobDictionary #
Start a search. Python must be installed. Host may limit number of concurrent searches.
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1).
- Raises:
- Parameters:
- Return type:
- status(search_id=None, **kwargs) SearchStatusesList #
Retrieve status of one or all searches.
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1).
- stop(search_id=None, **kwargs) None #
Stop a running search.
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1).
- class SearchJobDictionary(data, client)#
Bases:
ClientCache
[SearchAPIMixIn
],Dictionary
[Union
[None
,int
,str
,bool
,Sequence
[JsonValueT
],Mapping
[str
,JsonValueT
]]]Response for
search_start()
- delete(search_id=None, **kwargs) None #
Delete a search job.
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1).
- results(search_id=None, limit=None, offset=None, **kwargs) SearchResultsDictionary #
Retrieve the results for the search.
This method was introduced with qBittorrent v4.1.4 (Web API v2.1.1).
- Raises:
- Parameters:
- Return type:
- class SearchResultsDictionary(data=None, **kwargs)#
Bases:
Dictionary
[Union
[None
,int
,str
,bool
,Sequence
[JsonValueT
],Mapping
[str
,JsonValueT
]]]Response for
search_results()
Definition: https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#user-content-get-search-results
- class SearchStatusesList(list_entries, client=None)#
Bases:
List
[SearchStatus
]Response for
search_status()
Definition: https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#user-content-get-search-status
- class SearchStatus(data=None, **kwargs)#
Bases:
ListEntry
Item in
SearchStatusesList
- class SearchCategoriesList(list_entries, client=None)#
Bases:
List
[SearchCategory
]Response for
search_categories()
- class SearchCategory(data=None, **kwargs)#
Bases:
ListEntry
Item in
SearchCategoriesList
- class SearchPluginsList(list_entries, client=None)#
Bases:
List
[SearchPlugin
]Response for
search_plugins()
.Definition: https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#user-content-get-search-plugins
- class SearchPlugin(data=None, **kwargs)#
Bases:
ListEntry
Item in
SearchPluginsList