nc-py-api 0.17.1__py3-none-any.whl → 0.18.0__py3-none-any.whl

nc_py_api/_session.py

@@ -301,7 +301,7 @@ class NcSessionBasic(NcSessionBase, ABC):
 
     def download2fp(self, url_path: str, fp, dav: bool, params=None, **kwargs):
         adapter = self.adapter_dav if dav else self.adapter
-        with adapter.stream("GET", url_path, params=params) as response:
+        with adapter.stream("GET", url_path, params=params, headers=kwargs.get("headers")) as response:
             check_error(response)
             for data_chunk in response.iter_raw(chunk_size=kwargs.get("chunk_size", 5 * 1024 * 1024)):
                 fp.write(data_chunk)
@@ -425,7 +425,7 @@ class AsyncNcSessionBasic(NcSessionBase, ABC):
 
     async def download2fp(self, url_path: str, fp, dav: bool, params=None, **kwargs):
         adapter = self.adapter_dav if dav else self.adapter
-        async with adapter.stream("GET", url_path, params=params) as response:
+        async with adapter.stream("GET", url_path, params=params, headers=kwargs.get("headers")) as response:
             check_error(response)
             async for data_chunk in response.aiter_raw(chunk_size=kwargs.get("chunk_size", 5 * 1024 * 1024)):
                 fp.write(data_chunk)

nc_py_api/_version.py

@@ -1,3 +1,3 @@
 """Version of nc_py_api."""
 
-__version__ = "0.17.1"
+__version__ = "0.18.0"

nc_py_api/files/__init__.py

@@ -5,12 +5,18 @@ import datetime
 import email.utils
 import enum
 import os
+import re
 import warnings
 
 from pydantic import BaseModel
 
 from .. import _misc
 
+user_regex = re.compile(r"(?:files|trashbin|versions)/([^/]+)/")
+"""Regex for evaluating user from full path string; instantiated once on import."""
+user_path_regex = re.compile(r".*?(files|trashbin|versions)/([^/]+)/")
+"""Regex for evaluating user path from full path string; instantiated once on import."""
+
 
 class LockType(enum.IntEnum):
     """Nextcloud File Locks types."""
@@ -218,12 +224,12 @@ class FsNode:
     @property
     def user(self) -> str:
         """Returns user ID extracted from the `full_path`."""
-        return self.full_path.lstrip("/").split("/", maxsplit=2)[1]
+        return user_regex.findall(self.full_path)[0]
 
     @property
     def user_path(self) -> str:
         """Returns path relative to the user's root directory."""
-        return self.full_path.lstrip("/").split("/", maxsplit=2)[-1]
+        return user_path_regex.sub("", self.full_path, count=1)
 
     @property
     def is_shared(self) -> bool:

nc_py_api/files/files.py

@@ -115,9 +115,14 @@ class FilesAPI:
         path = path.user_path if isinstance(path, FsNode) else path
         result_path = local_path if local_path else os.path.basename(path)
         with open(result_path, "wb") as fp:
-            self._session.download2fp(
-                "/index.php/apps/files/ajax/download.php", fp, dav=False, params={"dir": path}, **kwargs
-            )
+            if self._session.nc_version["major"] >= 31:
+                full_path = dav_get_obj_path(self._session.user, path)
+                accept_header = f"application/{kwargs.get('format', 'zip')}"
+                self._session.download2fp(quote(full_path), fp, dav=True, headers={"Accept": accept_header})
+            else:
+                self._session.download2fp(
+                    "/index.php/apps/files/ajax/download.php", fp, dav=False, params={"dir": path}, **kwargs
+                )
         return Path(result_path)
 
     def upload(self, path: str | FsNode, content: bytes | str) -> FsNode:

nc_py_api/files/files_async.py

@@ -119,9 +119,14 @@ class AsyncFilesAPI:
         path = path.user_path if isinstance(path, FsNode) else path
         result_path = local_path if local_path else os.path.basename(path)
         with open(result_path, "wb") as fp:
-            await self._session.download2fp(
-                "/index.php/apps/files/ajax/download.php", fp, dav=False, params={"dir": path}, **kwargs
-            )
+            if (await self._session.nc_version)["major"] >= 31:
+                full_path = dav_get_obj_path(await self._session.user, path)
+                accept_header = f"application/{kwargs.get('format', 'zip')}"
+                await self._session.download2fp(quote(full_path), fp, dav=True, headers={"Accept": accept_header})
+            else:
+                await self._session.download2fp(
+                    "/index.php/apps/files/ajax/download.php", fp, dav=False, params={"dir": path}, **kwargs
+                )
         return Path(result_path)
 
     async def upload(self, path: str | FsNode, content: bytes | str) -> FsNode:

nc_py_api/users.py

@@ -369,8 +369,8 @@ class _AsyncUsersAPI:
 
 
 def _create(user_id: str, display_name: str | None, **kwargs) -> dict[str, typing.Any]:
-    password = kwargs.get("password", None)
-    email = kwargs.get("email", None)
+    password = kwargs.get("password")
+    email = kwargs.get("email")
     if not password and not email:
         raise ValueError("Either password or email must be set")
     data = {"userid": user_id}

nc_py_api/webhooks.py

@@ -3,7 +3,7 @@
 import dataclasses
 
 from ._misc import clear_from_params_empty  # , require_capabilities
-from ._session import AsyncNcSessionBasic, NcSessionBasic
+from ._session import AppConfig, AsyncNcSessionBasic, NcSessionBasic
 
 
 @dataclasses.dataclass
@@ -140,6 +140,13 @@ class _WebhooksAPI:
     def unregister(self, webhook_id: int) -> bool:
         return self._session.ocs("DELETE", f"{self._ep_base}/{webhook_id}")
 
+    def unregister_all(self, appid: str = "") -> int:
+        if not appid and isinstance(self._session.cfg, AppConfig):
+            appid = self._session.cfg.app_name
+        else:
+            raise ValueError("The `appid` parameter cannot be empty for non-ExApp use.")
+        return self._session.ocs("DELETE", f"{self._ep_base}/byappid/{appid}")
+
 
 class _AsyncWebhooksAPI:
     """The class provides the async application management API on the Nextcloud server."""
@@ -208,3 +215,10 @@ class _AsyncWebhooksAPI:
 
     async def unregister(self, webhook_id: int) -> bool:
         return await self._session.ocs("DELETE", f"{self._ep_base}/{webhook_id}")
+
+    async def unregister_all(self, appid: str = "") -> int:
+        if not appid and isinstance(self._session.cfg, AppConfig):
+            appid = self._session.cfg.app_name
+        else:
+            raise ValueError("The `appid` parameter cannot be empty for non-ExApp use.")
+        return await self._session.ocs("DELETE", f"{self._ep_base}/byappid/{appid}")

{nc_py_api-0.17.1.dist-info → nc_py_api-0.18.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nc-py-api
-Version: 0.17.1
+Version: 0.18.0
 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/
@@ -70,8 +70,8 @@ Requires-Dist: caldav==1.3.6; extra == 'docs'
 Requires-Dist: sphinx-copybutton; extra == 'docs'
 Requires-Dist: sphinx-inline-tabs; extra == 'docs'
 Requires-Dist: sphinx-issues>=3.0.1; extra == 'docs'
-Requires-Dist: sphinx-rtd-theme>=1; extra == 'docs'
-Requires-Dist: sphinx>=6.2; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme<3; extra == 'docs'
+Requires-Dist: sphinx<8; extra == 'docs'
 Requires-Dist: uvicorn[standard]>=0.23.2; extra == 'docs'
 Description-Content-Type: text/markdown
 

{nc_py_api-0.17.1.dist-info → nc_py_api-0.18.0.dist-info}/RECORD

@@ -4,10 +4,10 @@ nc_py_api/_exceptions.py,sha256=7vbUECaLmD7RJBCU27t4fuP6NmQK6r4508u_gS4szhI,2298
 nc_py_api/_misc.py,sha256=dUzCP9VmyhtICTsn1aexlFAYUioBm40k6Zh-YE5WwCY,3333
 nc_py_api/_preferences.py,sha256=OtovFZuGHnHYKjdDjSnUappO795tW8Oxj7qVaejHWpQ,2479
 nc_py_api/_preferences_ex.py,sha256=tThj6U0ZZMaBZ-jUkjrbaI0xDnafWsBowQKsC6gjOQs,7179
-nc_py_api/_session.py,sha256=iFv8_xkPA_erhUNvSvjUJvhKL3yCnq2xHNkL8PHLbrA,20180
+nc_py_api/_session.py,sha256=ZD0TKrL-tOpxYtV6AO0cwRrYzbnjBr_ylCEUirrykjU,20242
 nc_py_api/_talk_api.py,sha256=0Uo7OduYniuuX3UQPb468RyGJJ-PWBCgJ5HoPuz5Qa0,51068
 nc_py_api/_theming.py,sha256=hTr3nuOemSuRFZaPy9iXNmBM7rDgQHECH43tHMWGqEY,1870
-nc_py_api/_version.py,sha256=CSuVzDV5v1IVnCLmZ23tjFH9hOciQqyc4WRmAjRx8qw,52
+nc_py_api/_version.py,sha256=t3qny54XTwpi3rVJqMS8yB4HNF5ZcqFIKiy_TGER6lQ,52
 nc_py_api/activity.py,sha256=t9VDSnnaXRNOvALqOSGCeXSQZ-426pCOMSfQ96JHys4,9574
 nc_py_api/apps.py,sha256=Us2y2lszdxXlD8t6kxwd5_Nrrmazc0EvZXIH9O-ol80,9315
 nc_py_api/calendar.py,sha256=-T6CJ8cRbJZTLtxSEDWuuYpD29DMJGCTfLONmtxZV9w,1445
@@ -19,10 +19,10 @@ nc_py_api/options.py,sha256=K5co-fIfFVbwF6r3sqWsJF3cKgAbS2CjLAXdyTOkP9s,1717
 nc_py_api/talk.py,sha256=OZFemYkDOaM6o4xAK3EvQbjMFiK75E5qnsCDyihIElg,29368
 nc_py_api/talk_bot.py,sha256=_RuImwb3jYvUKX3ywcX095ucOjECCxsuc59heIxNoTM,16725
 nc_py_api/user_status.py,sha256=I101nwYS8X1WvC8AnLa2f3qJUCPDPHrbq-ke0h1VT4E,13282
-nc_py_api/users.py,sha256=ixMHBFJtrlvqmZqJ73VdbOZ6CbRnppdsRpjIJnMUtYY,15488
+nc_py_api/users.py,sha256=SQG8Agplaxy7XJgguK-rxV-azpc-QdktbDmLmQtJkXo,15476
 nc_py_api/users_groups.py,sha256=IPxw-Ks5NjCm6r8_HC9xmf3IYptH00ulITbp5iazhAo,6289
 nc_py_api/weather_status.py,sha256=wAkjuJPjxc0Rxe4za0BzfwB0XeUmkCXoisJtTH3-qdQ,7582
-nc_py_api/webhooks.py,sha256=-cRqpgQFhjlGV0c7k0vLp2JtVw_UeYElecag650kD64,7044
+nc_py_api/webhooks.py,sha256=14nAMy-tnOvmRnJbo42zUHyjX-z6kc9OMDUVKzNmplY,7769
 nc_py_api/ex_app/__init__.py,sha256=hFbu6wTXs-wmjs1tavm_HYLwiqgrp7_qJe-stzCiqfI,692
 nc_py_api/ex_app/defs.py,sha256=FaQInH3jLugKxDUqpwrXdkMT-lBxmoqWmXJXc11fa6A,727
 nc_py_api/ex_app/events_listener.py,sha256=pgQ4hSQV39NuP9F9IDWxo0Qle6oG15-Ol2FlItnIBGY,4682
@@ -41,13 +41,13 @@ nc_py_api/ex_app/ui/resources.py,sha256=Vwx69oZ93Ouh6HJtGUqaKFUr4Reo74H4vT1YCpb-
 nc_py_api/ex_app/ui/settings.py,sha256=f0R17lGhBfo2JQULVw_hFxhpfoPw_CW7vBu0Rb1ABJw,6623
 nc_py_api/ex_app/ui/top_menu.py,sha256=oCgGtIoMYbp-5iN5aXEbT7Q88HtccR7hg6IBFgbbyX4,5118
 nc_py_api/ex_app/ui/ui.py,sha256=OqFHKn6oIZli8T1wnv6YtQ4glNfeNb90WwGCvtWI1Z4,1632
-nc_py_api/files/__init__.py,sha256=p1RecBNkZCuu8_mf-y_mkbotj9fGsCDSFRl7hGkI1CA,17003
+nc_py_api/files/__init__.py,sha256=uSjqZyYAq9x3xOb_yz15KNNAcPo1PhbpPLtPz_ej-Eo,17303
 nc_py_api/files/_files.py,sha256=_s_f8xbzQPEH2F2LNwomI9CxscYHryus1pMZ_vW00C4,13666
-nc_py_api/files/files.py,sha256=DuAMkfmRGtNJntMIo-yEYhZ-a3KhhhnwKATcGqpxJL4,24569
-nc_py_api/files/files_async.py,sha256=rEIT6P1Pb7TeTub1dAB5IKpR4LDqHWc5LclAEzpiHEQ,25410
+nc_py_api/files/files.py,sha256=6G4zONjnI7oSCUf4C79xrFV4QUYquxZDCLlpkGvME0M,24912
+nc_py_api/files/files_async.py,sha256=nyDeWiGx_8CHuVrNThSgfZy0l-WlC4El-TzJONo0TsM,25773
 nc_py_api/files/sharing.py,sha256=VRZCl-TYK6dbu9rUHPs3_jcVozu1EO8bLGZwoRpiLsU,14439
-nc_py_api-0.17.1.dist-info/METADATA,sha256=xSjepRylRZB3RNOy4uynbbMa-BmYI1owibOt2ggvDqI,9455
-nc_py_api-0.17.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-nc_py_api-0.17.1.dist-info/licenses/AUTHORS,sha256=Y1omFHyI8ned9k4jJXs2ATgmgi1GmQ7EZ6S1gxqnX2k,572
-nc_py_api-0.17.1.dist-info/licenses/LICENSE.txt,sha256=OLEMh401fAumGHfRSna365MLIfnjdTcdOHZ6QOzMjkg,1551
-nc_py_api-0.17.1.dist-info/RECORD,,
+nc_py_api-0.18.0.dist-info/METADATA,sha256=_cUiEBjdiSBuqx6RM9HyIMR_pjr62TanPtBpb9DFmlw,9451
+nc_py_api-0.18.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+nc_py_api-0.18.0.dist-info/licenses/AUTHORS,sha256=B2Q9q9XH3PAxJp0V3GiKQc1l0z7vtGDpDHqda-ISWKM,616
+nc_py_api-0.18.0.dist-info/licenses/LICENSE.txt,sha256=OLEMh401fAumGHfRSna365MLIfnjdTcdOHZ6QOzMjkg,1551
+nc_py_api-0.18.0.dist-info/RECORD,,

{nc_py_api-0.17.1.dist-info → nc_py_api-0.18.0.dist-info}/licenses/AUTHORS

@@ -6,6 +6,7 @@ answer newbie questions, and generally made NC-Py-API that much better:
     Alexander Piskun <bigcat88@icloud.com>
     CooperGerman <https://github.com/CooperGerman>
     Tobias Tschech <Tobias@tschech-online.de>
+    Scott Williams <scottwilliams@ucsb.edu>
     <Please alphabetize new entries>
 
 A big THANK YOU goes to: