OneDrive API : fix for shared path addressing (#801)

Author: vgrem

examples/onedrive/files/get_by_abs_url.py

@@ -5,7 +5,7 @@
 from tests import test_team_site_url
 from tests.graph_case import acquire_token_by_username_password
 
-file_abs_url = "{0}/Shared Documents/big_buck_bunny.mp4".format(test_team_site_url)
+file_abs_url = "{0}/Shared Documents/Financial Sample.xlsx".format(test_team_site_url)
 
 client = GraphClient(acquire_token_by_username_password)
 file_item = client.shares.by_url(file_abs_url).drive_item.get().execute_query()

examples/onedrive/shares/read_workbook.py

@@ -0,0 +1,14 @@
+"""
+Get workbook
+"""
+from office365.graph_client import GraphClient
+from tests import test_team_site_url
+from tests.graph_case import acquire_token_by_username_password
+
+file_abs_url = "{0}/Shared Documents/Financial Sample.xlsx".format(test_team_site_url)
+
+client = GraphClient(acquire_token_by_username_password)
+drive_item = client.shares.by_url(file_abs_url).drive_item.get().execute_query()
+worksheets = drive_item.workbook.worksheets.get().execute_query()
+for ws in worksheets:
+    print(ws)

examples/onenote/__init__.py

@@ -1,7 +1,7 @@
 """
 Demonstrates how to create a new OneNote notebook
 
-https://learn.microsoft.com/en-us/graph/api/onenote-post-notebooks?view=graph-rest-1.0&tabs=http
+https://learn.microsoft.com/en-us/graph/api/onenote-post-notebooks?view=graph-rest-1.0
 """
 
 from office365.graph_client import GraphClient

examples/onenote/create_notebook.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.runtime.client_result import ClientResult
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -25,11 +27,8 @@ def instantiate(self, display_name):
 
     @property
     def display_name(self):
-        """
-        The name of the application.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The name of the application."""
         return self.properties.get("displayName", None)
 
     @property
@@ -44,9 +43,7 @@ def categories(self):
 
     @property
     def supported_provisioning_types(self):
-        """
-        The list of provisioning modes supported by this application
-        """
+        """The list of provisioning modes supported by this application"""
         return self.properties.get("supportedProvisioningTypes", StringCollection())
 
     @property

office365/directory/applications/template.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.directory.protection.riskyusers.activity import RiskUserActivity
 from office365.directory.protection.riskyusers.risky_user import RiskyUser
 
@@ -13,7 +15,6 @@ def activity(self):
 
     @property
     def initiated_by(self):
-        """The ID of actor that does the operation.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The ID of actor that does the operation."""
         return self.properties.get("initiatedBy", None)

office365/directory/protection/riskyusers/history_item.py

@@ -795,6 +795,12 @@ def subscriptions(self):
             ),
         )
 
+    def set_property(self, name, value, persist_changes=True):
+        super(DriveItem, self).set_property(name, value, persist_changes)
+        if name == "parentReference":
+            self._resource_path.parent.patch(self.parent_reference.driveId)
+        return self
+
     def get_property(self, name, default_value=None):
         # type: (str, P_T) -> P_T
         if default_value is None:

office365/onedrive/driveitems/driveItem.py

@@ -1,22 +1,27 @@
 import base64
 
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.paths.v4.entity import EntityPath
 
 
 def _url_to_shared_token(url):
-    """
-    Converts url into shared token
-    :param str url:
-    """
+    # type: (str) -> str
+    """Converts url into shared token"""
     value = base64.b64encode(url.encode("ascii")).decode("ascii")
     if value.endswith("="):
         value = value[:-1]
     return "u!" + value.replace("/", "_").replace("+", "-")
 
 
-class SharedPath(ResourcePath):
+class SharedPath(EntityPath):
     """Shared token path"""
 
+    def patch(self, key):
+        self._key = "items"
+        self._parent = ResourcePath(key, ResourcePath("drives"))
+        self.__class__ = ResourcePath
+        return self
+
     @property
     def segment(self):
         return _url_to_shared_token(self._key)

office365/onedrive/internal/paths/shared.py

@@ -8,6 +8,7 @@
 from office365.onedrive.permissions.permission import Permission
 from office365.onedrive.sites.site import Site
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.paths.v4.entity import EntityPath
 
 
 class SharedDriveItem(BaseItem):
@@ -47,7 +48,7 @@ def drive_item(self):
         """Used to access the underlying driveItem"""
         return self.properties.get(
             "driveItem",
-            DriveItem(self.context, ResourcePath("driveItem", self.resource_path)),
+            DriveItem(self.context, EntityPath("driveItem", self.resource_path)),
         )
 
     @property

office365/onedrive/shares/drive_item.py

@@ -1,24 +1,36 @@
+from typing import Optional
+
 from office365.entity import Entity
+from office365.onedrive.workbooks.ranges.range import WorkbookRange
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.function import FunctionQuery
 
 
 class WorkbookNamedItem(Entity):
     """Represents a defined name for a range of cells or value. Names can be primitive named objects
     (as seen in the type below), range object, reference to a range. This object can be used to obtain range
     object associated with names."""
 
+    def range(self):
+        """Returns the range object that is associated with the name. Throws an exception if the named item's type
+        isn't a range."""
+        return_type = WorkbookRange(
+            self.context, ResourcePath("range", self.resource_path)
+        )
+        qry = FunctionQuery(self, "range", return_type=return_type)
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def name(self):
-        """The name of the object. Read-only.
-        :rtype str or None
-        """
+        # type: () -> Optional[str]
+        """The name of the object."""
         return self.properties.get("name", None)
 
     @property
     def comment(self):
-        """Represents the comment associated with this name.
-        :rtype str or None
-        """
+        # type: () -> Optional[str]
+        """Represents the comment associated with this name."""
         return self.properties.get("comment", None)
 
     @property