Add support to filter torrents/info by private flag

- Add `str` to type hints alongside `Iterable[str]`
- Use `always_use_bars_union=True` to remove `Union[]` in docs

CHANGELOG.md

@@ -1,5 +1,8 @@
 Change Log
 ==========
+### v2024.x.64 (dd mmm 2024)
+- Added support for ``private`` argument for ``torrents/info`` (#464)
+
 ### v2024.5.63 (31 may 2024)
 - Added support to configure ``HTTPAdapter`` (#459)
 

docs/source/conf.py

@@ -58,6 +58,7 @@
 ]
 
 autodoc_type_aliases = {"JsonValueT": "qbittorrentapi.definitions.JsonValueT"}
+always_use_bars_union = True
 add_module_names = False
 autodoc_typehints_format = "short"
 python_use_unqualified_type_names = True

src/qbittorrentapi/search.py

@@ -92,7 +92,7 @@ def search(self) -> Search:
     def search_start(
         self,
         pattern: str | None = None,
-        plugins: Iterable[str] | None = None,
+        plugins: str | Iterable[str] | None = None,
         category: str | None = None,
         **kwargs: APIKwargsT,
     ) -> SearchJobDictionary:
@@ -262,7 +262,7 @@ def search_plugins(self, **kwargs: APIKwargsT) -> SearchPluginsList:
 
     def search_install_plugin(
         self,
-        sources: Iterable[str] | None = None,
+        sources: str | Iterable[str] | None = None,
         **kwargs: APIKwargsT,
     ) -> None:
         """
@@ -285,7 +285,7 @@ def search_install_plugin(
 
     def search_uninstall_plugin(
         self,
-        names: Iterable[str] | None = None,
+        names: str | Iterable[str] | None = None,
         **kwargs: APIKwargsT,
     ) -> None:
         """
@@ -308,7 +308,7 @@ def search_uninstall_plugin(
 
     def search_enable_plugin(
         self,
-        plugins: Iterable[str] | None = None,
+        plugins: str | Iterable[str] | None = None,
         enable: bool | None = None,
         **kwargs: APIKwargsT,
     ) -> None:
@@ -438,7 +438,7 @@ class Search(ClientCache[SearchAPIMixIn]):
     def start(
         self,
         pattern: str | None = None,
-        plugins: Iterable[str] | None = None,
+        plugins: str | Iterable[str] | None = None,
         category: str | None = None,
         **kwargs: APIKwargsT,
     ) -> SearchJobDictionary:
@@ -504,7 +504,7 @@ def plugins(self) -> SearchPluginsList:
     @wraps(SearchAPIMixIn.search_install_plugin)
     def install_plugin(
         self,
-        sources: Iterable[str] | None = None,
+        sources: str | Iterable[str] | None = None,
         **kwargs: APIKwargsT,
     ) -> None:
         return self._client.search_install_plugin(sources=sources, **kwargs)
@@ -514,7 +514,7 @@ def install_plugin(
     @wraps(SearchAPIMixIn.search_uninstall_plugin)
     def uninstall_plugin(
         self,
-        sources: Iterable[str] | None = None,
+        sources: str | Iterable[str] | None = None,
         **kwargs: APIKwargsT,
     ) -> None:
         return self._client.search_uninstall_plugin(sources=sources, **kwargs)
@@ -524,7 +524,7 @@ def uninstall_plugin(
     @wraps(SearchAPIMixIn.search_enable_plugin)
     def enable_plugin(
         self,
-        plugins: Iterable[str] | None = None,
+        plugins: str | Iterable[str] | None = None,
         enable: bool | None = None,
         **kwargs: APIKwargsT,
     ) -> None: