nc-py-api 0.19.1__tar.gz → 0.19.2__tar.gz

{nc_py_api-0.19.1 → nc_py_api-0.19.2}/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.19.2 - 2025-03-17]
+
+### Added
+
+- Optional `response_type` parameter of `nextcloud.ocs` method for calling OCS endpoints that return raw data. #341 Thanks to @janepie
+
 ## [0.19.1 - 2025-03-07]
 
 ### Fixed

{nc_py_api-0.19.1 → nc_py_api-0.19.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nc-py-api
-Version: 0.19.1
+Version: 0.19.2
 Summary: Nextcloud Python Framework
 Project-URL: Changelog, https://github.com/cloud-py-api/nc_py_api/blob/main/CHANGELOG.md
 Project-URL: Documentation, https://cloud-py-api.github.io/nc_py_api/

{nc_py_api-0.19.1 → nc_py_api-0.19.2}/nc_py_api/_session.py

@@ -197,6 +197,7 @@ class NcSessionBasic(NcSessionBase, ABC):
         *,
         content: bytes | str | typing.Iterable[bytes] | typing.AsyncIterable[bytes] | None = None,
         json: dict | list | None = None,
+        response_type: str | None = None,
         params: dict | None = None,
         files: dict | None = None,
         **kwargs,
@@ -215,6 +216,8 @@ class NcSessionBasic(NcSessionBase, ABC):
         if response.status_code == 204:  # NO_CONTENT
             return []
         response_data = loads(response.text)
+        if response_type == "json":
+            return response_data
         ocs_meta = response_data["ocs"]["meta"]
         if ocs_meta["status"] != "ok":
             if (
@@ -319,6 +322,7 @@ class AsyncNcSessionBasic(NcSessionBase, ABC):
         *,
         content: bytes | str | typing.Iterable[bytes] | typing.AsyncIterable[bytes] | None = None,
         json: dict | list | None = None,
+        response_type: str | None = None,
         params: dict | None = None,
         files: dict | None = None,
         **kwargs,
@@ -337,6 +341,8 @@ class AsyncNcSessionBasic(NcSessionBase, ABC):
         if response.status_code == 204:  # NO_CONTENT
             return []
         response_data = loads(response.text)
+        if response_type == "json":
+            return response_data
         ocs_meta = response_data["ocs"]["meta"]
         if ocs_meta["status"] != "ok":
             if (

{nc_py_api-0.19.1 → nc_py_api-0.19.2}/nc_py_api/_version.py

@@ -1,3 +1,3 @@
 """Version of nc_py_api."""
 
-__version__ = "0.19.1"
+__version__ = "0.19.2"

{nc_py_api-0.19.1 → nc_py_api-0.19.2}/nc_py_api/nextcloud.py

@@ -137,11 +137,14 @@ class _NextcloudBasic(ABC):  # pylint: disable=too-many-instance-attributes
         *,
         content: bytes | str | typing.Iterable[bytes] | typing.AsyncIterable[bytes] | None = None,
         json: dict | list | None = None,
+        response_type: str | None = None,
         params: dict | None = None,
         **kwargs,
     ):
         """Performs OCS call and returns OCS response payload data."""
-        return self._session.ocs(method, path, content=content, json=json, params=params, **kwargs)
+        return self._session.ocs(
+            method, path, content=content, json=json, response_type=response_type, params=params, **kwargs
+        )
 
     def download_log(self, fp) -> None:
         """Downloads Nextcloud log file. Requires Admin privileges."""
@@ -238,11 +241,14 @@ class _AsyncNextcloudBasic(ABC):  # pylint: disable=too-many-instance-attributes
         *,
         content: bytes | str | typing.Iterable[bytes] | typing.AsyncIterable[bytes] | None = None,
         json: dict | list | None = None,
+        response_type: str | None = None,
         params: dict | None = None,
         **kwargs,
     ):
         """Performs OCS call and returns OCS response payload data."""
-        return await self._session.ocs(method, path, content=content, json=json, params=params, **kwargs)
+        return await self._session.ocs(
+            method, path, content=content, json=json, response_type=response_type, params=params, **kwargs
+        )
 
     async def download_log(self, fp) -> None:
         """Downloads Nextcloud log file. Requires Admin privileges."""