msgraphfs 0.1__tar.gz → 0.3__tar.gz

{msgraphfs-0.1 → msgraphfs-0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: msgraphfs
-Version: 0.1
+Version: 0.3
 Dynamic: Summary
 Project-URL: Source, https://github.com/acsone/msgraphfs
 Author-email: Laurent Mignon <laurent.mignon@acsone.eu>
@@ -94,25 +94,22 @@ fs.ls("/")
 
 - `checkin`, `checkout` : These methods are used to checkin/checkout a file.
   They take the path of the file to checkin/checkout as argument. The `checking`
-  method also take an additional `comment`.
+  method also take an additional `comment` argument.
 
 - `get_versions` : This method returns the list of versions of a file. It takes
   the path of the file as argument.
 
-- `preview` : This method returns a url to a preview of the file. It takes the
+- `preview` : This method returns a url to preview the file. It takes the
   path of the file as argument.
 
 - `get_content` : This method returns the content of a file. It takes the path
-  or the item_id of the file as argument. You can also pass the `format` argument
-  to specify the expected format of the content. This is useful for example to
-  convert a word document to a pdf.
+  or the item_id of the file as argument. You can also give the `format` argument
+  to specify the expected format of the content. It can be useful when converting a word document to a pdf.
 
-In addition to the methods above, some methods can take an `item_id` additional
-arguments. This argument is the id of the drive item provided by the Microsoft
-Graph API. It can be used to avoid the need to make an additional API call to
+In addition to the methods above, some methods can take an additional argument, `item_id`. This argument is the id of the drive item provided by the Microsoft
+Graph API. It can be used to avoid making an additional API call to
 get the item id or to store a reference to a drive item independently of the
-path. (If the drive item is moved, the path will change but the item id will
-not).
+path. (If the drive item is moved, the path will changed but the item id won't).
 
 ## Installation
 
@@ -126,7 +123,7 @@ To get the drive id of your drive, you can use the microsoft graph explorer:
 https://developer.microsoft.com/en-us/graph/graph-explorer
 
 The first step is to get the site id of your site. You can do this by making a
-GET request to the following url:
+`GET` request to the following url:
 
 ```bash
 https://graph.microsoft.com/v1.0/sites/{url}
@@ -139,8 +136,7 @@ site is `https://mycompany.sharepoint.com/sites/mysite`, you should use
 In the response, you will find the `id` of the site.
 
 
-Now your can get the drive id of the drive you want to access. To do this, you
-can make a GET request to the following url:
+Now, you can get your drive id by making a `GET` request to the following url:
 
 ```bash
   https://graph.microsoft.com/v1.0/sites/{site_id}/drives/
@@ -161,7 +157,7 @@ pip install -e .
 This will install the package in editable mode, so you can make changes to the
 code and test them without having to reinstall the package every time.
 
-To run the tests, you will need to install the test dependencies. You can do this by running:
+To run the tests, you will need to install the test dependencies. You can achieve this by running:
 
 ```bash
 pip install -e .[test]
@@ -196,11 +192,11 @@ client_id=<CLIENT_ID>
 &scope=offline_access%20User.Read%20Files.ReadWrite.All%20Sites.ReadWrite.All
 ```
 
-You will be prompted to log in with your Microsoft account and grant the requested permissions.
+You will be asked to log in with your Microsoft account and to grant the requested permissions.
 
 #### 2. Copy the Authorization Code
 
-After login, you'll be redirected to:
+Once logged in, you'll be redirected to:
 
 ```bash
 http://localhost:5000/callback?code=<AUTHORIZATION_CODE>

{msgraphfs-0.1 → msgraphfs-0.3}/README.md

@@ -48,25 +48,22 @@ fs.ls("/")
 
 - `checkin`, `checkout` : These methods are used to checkin/checkout a file.
   They take the path of the file to checkin/checkout as argument. The `checking`
-  method also take an additional `comment`.
+  method also take an additional `comment` argument.
 
 - `get_versions` : This method returns the list of versions of a file. It takes
   the path of the file as argument.
 
-- `preview` : This method returns a url to a preview of the file. It takes the
+- `preview` : This method returns a url to preview the file. It takes the
   path of the file as argument.
 
 - `get_content` : This method returns the content of a file. It takes the path
-  or the item_id of the file as argument. You can also pass the `format` argument
-  to specify the expected format of the content. This is useful for example to
-  convert a word document to a pdf.
+  or the item_id of the file as argument. You can also give the `format` argument
+  to specify the expected format of the content. It can be useful when converting a word document to a pdf.
 
-In addition to the methods above, some methods can take an `item_id` additional
-arguments. This argument is the id of the drive item provided by the Microsoft
-Graph API. It can be used to avoid the need to make an additional API call to
+In addition to the methods above, some methods can take an additional argument, `item_id`. This argument is the id of the drive item provided by the Microsoft
+Graph API. It can be used to avoid making an additional API call to
 get the item id or to store a reference to a drive item independently of the
-path. (If the drive item is moved, the path will change but the item id will
-not).
+path. (If the drive item is moved, the path will changed but the item id won't).
 
 ## Installation
 
@@ -80,7 +77,7 @@ To get the drive id of your drive, you can use the microsoft graph explorer:
 https://developer.microsoft.com/en-us/graph/graph-explorer
 
 The first step is to get the site id of your site. You can do this by making a
-GET request to the following url:
+`GET` request to the following url:
 
 ```bash
 https://graph.microsoft.com/v1.0/sites/{url}
@@ -93,8 +90,7 @@ site is `https://mycompany.sharepoint.com/sites/mysite`, you should use
 In the response, you will find the `id` of the site.
 
 
-Now your can get the drive id of the drive you want to access. To do this, you
-can make a GET request to the following url:
+Now, you can get your drive id by making a `GET` request to the following url:
 
 ```bash
   https://graph.microsoft.com/v1.0/sites/{site_id}/drives/
@@ -115,7 +111,7 @@ pip install -e .
 This will install the package in editable mode, so you can make changes to the
 code and test them without having to reinstall the package every time.
 
-To run the tests, you will need to install the test dependencies. You can do this by running:
+To run the tests, you will need to install the test dependencies. You can achieve this by running:
 
 ```bash
 pip install -e .[test]
@@ -150,11 +146,11 @@ client_id=<CLIENT_ID>
 &scope=offline_access%20User.Read%20Files.ReadWrite.All%20Sites.ReadWrite.All
 ```
 
-You will be prompted to log in with your Microsoft account and grant the requested permissions.
+You will be asked to log in with your Microsoft account and to grant the requested permissions.
 
 #### 2. Copy the Authorization Code
 
-After login, you'll be redirected to:
+Once logged in, you'll be redirected to:
 
 ```bash
 http://localhost:5000/callback?code=<AUTHORIZATION_CODE>

{msgraphfs-0.1 → msgraphfs-0.3}/src/msgraphfs/core.py

@@ -181,10 +181,14 @@ class AbstractMSGraphFS(AsyncFileSystem):
             "type": _type,
             "item_info": drive_item_info,
             "time": datetime.datetime.fromisoformat(
-                drive_item_info.get("createdDateTime", "1970-01-01T00:00:00Z")
+                drive_item_info.get("createdDateTime", "1970-01-01T00:00:00Z").replace(
+                    "Z", "+00:00"
+                )
             ),
             "mtime": datetime.datetime.fromisoformat(
-                drive_item_info.get("lastModifiedDateTime", "1970-01-01T00:00:00Z")
+                drive_item_info.get(
+                    "lastModifiedDateTime", "1970-01-01T00:00:00Z"
+                ).replace("Z", "+00:00")
             ),
             "id": drive_item_info.get("id"),
         }
@@ -446,7 +450,12 @@ class AbstractMSGraphFS(AsyncFileSystem):
         if expand:
             params = {"expand": expand}
         response = await self._msgraph_get(url, params=params)
-        items = response.json().get("value", [])
+        result = response.json()
+        items = result.get("value", [])
+        while "@odata.nextLink" in result:
+            response = await self._msgraph_get(result["@odata.nextLink"])
+            result = response.json()
+            items.extend(result.get("value", []))
         if not items:
             # maybe the path is a file
             try:
@@ -861,10 +870,62 @@ class AbstractMSGraphFS(AsyncFileSystem):
             raise FileNotFoundError(f"File not found: {path}")
         url = self._path_to_url(path, item_id=item_id, action="versions")
         response = await self._msgraph_get(url)
-        return response.json().get("value", [])
+        result = response.json()
+        items = result.get("value", [])
+        while "@odata.nextLink" in result:
+            response = await self._msgraph_get(result["@odata.nextLink"])
+            result = response.json()
+            items.extend(result.get("value", []))
+        return items
 
     get_versions = sync_wrapper(_get_versions)
 
+    async def _get_sharepoint_ids(self, path: str, item_id: str | None = None) -> dict:
+        """Get the SharePoint IDs of a file or directory on a SharePoint site.
+
+        Parameters
+        ----------
+        path : str
+            Path of the file or directory to get the SharePoint IDs of
+        item_id: str
+            If given, the item_id will be used instead of the path to get
+            the SharePoint IDs of the file or directory.
+        """
+        url = self._path_to_url(path, item_id=item_id)
+        response = await self._msgraph_get(url, params={"select": "sharepointIds"})
+        return response.json().get("sharepointIds", {})
+
+    get_sharepoint_ids = sync_wrapper(_get_sharepoint_ids)
+
+    async def _set_properties(
+        self, path: str, properties: dict, item_id: str | None = None
+    ):
+        """Set the properties of a file or directory on a SharePoint site.
+
+        Parameters
+        ----------
+        path : str
+            Path of the file or directory to set the properties of
+        properties : dict
+            Dictionary of properties to set. The keys are the property names and the values are the property values.
+        item_id: str
+            If given, the item_id will be used instead of the path to set
+            the properties of the file or directory.
+        """
+        sharepoint_ids = await self._get_sharepoint_ids(path, item_id=item_id)
+        if not sharepoint_ids:
+            raise ValueError(
+                f"Cannot set properties for the given path: {path}: not a SharePoint item"
+            )
+        sharepoint_item_id = sharepoint_ids.get("listItemId")
+        site_id = sharepoint_ids.get("siteId")
+        list_id = sharepoint_ids.get("listId")
+        url = f"https://graph.microsoft.com/v1.0/sites/{site_id}/lists/{list_id}/items/{sharepoint_item_id}/fields"
+        await self._msgraph_patch(url, json=properties)
+        self.invalidate_cache(path)
+
+    set_properties = sync_wrapper(_set_properties)
+
 
 class MSGDriveFS(AbstractMSGraphFS):
     """A filesystem that represents a SharePoint site dirve as a filesystem.
@@ -958,6 +1019,11 @@ class AsyncStreamedFileMixin:
             self._item_id = await self.fs._get_item_id(self.path)
         return self._item_id
 
+    async def _get_item_id(self):
+        return await self.item_id
+
+    get_item_id = sync_wrapper(_get_item_id)
+
     async def _create_upload_session(self) -> tuple[str, datetime.datetime]:
         """Create a new upload session for the file.