OneDrive API :NamedItem support

Author: vgrem

generator/import_metadata.py

@@ -21,13 +21,13 @@ def export_to_file(path, content):
     "--endpoint",
     dest="endpoint",
     help="Import metadata endpoint",
-    default="sharepoint",
+    default="microsoftgraph",
 )
 parser.add_argument(
     "-p",
     "--path",
     dest="path",
-    default="./metadata/SharePoint.xml",
+    default="./metadata/MicrosoftGraph.xml",
     help="Import metadata endpoint",
 )
 

generator/metadata/MicrosoftGraph.xml

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.directory.authentication.methods.method import AuthenticationMethod
 
 
@@ -9,8 +11,6 @@ class EmailAuthenticationMethod(AuthenticationMethod):
 
     @property
     def email_address(self):
-        """
-        The email address registered to this user.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The email address registered to this user."""
         return self.properties.get("emailAddress", None)

generator/metadata/SharePoint.xml

@@ -4,4 +4,4 @@
 class WorkbookFunctionResult(Entity):
     @property
     def value(self):
-        return self.properties.get("__value", None)
+        return self.properties.get("value", None)

office365/directory/authentication/methods/email.py

@@ -0,0 +1,26 @@
+from office365.entity_collection import EntityCollection
+from office365.onedrive.workbooks.names.named_item import WorkbookNamedItem
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+
+
+class WorkbookNamedItemCollection(EntityCollection[WorkbookNamedItem]):
+    def __init__(self, context, resource_path=None):
+        super(WorkbookNamedItemCollection, self).__init__(
+            context, WorkbookNamedItem, resource_path
+        )
+
+    def add(self, name, reference, comment=None):
+        """
+        Adds a new name to the collection of the given scope using the user's locale for the formula.
+
+        :param str name: The name of the object.
+        :param str reference: Represents the formula that the name is defined to refer to.
+             For example, =Sheet14!$B$2:$H$12, =4.75,
+        :param str comment: Represents the comment associated with this name.
+        """
+        return_type = WorkbookNamedItem(self.context)
+        self.add_child(return_type)
+        payload = {"name": name, "reference": reference, "comment": comment}
+        qry = ServiceOperationQuery(self, "add", None, payload, None, return_type)
+        self.context.add_query(qry)
+        return return_type

office365/onedrive/workbooks/functions/result.py

@@ -33,3 +33,8 @@ def worksheet(self):
                 self.context, ResourcePath("worksheet", self.resource_path)
             ),
         )
+
+    @property
+    def property_ref_name(self):
+        # type: () -> str
+        return "name"

office365/onedrive/workbooks/names/collection.py

@@ -3,14 +3,15 @@
 from office365.onedrive.workbooks.applications.application import WorkbookApplication
 from office365.onedrive.workbooks.comments.comment import WorkbookComment
 from office365.onedrive.workbooks.functions.functions import WorkbookFunctions
-from office365.onedrive.workbooks.names.named_item import WorkbookNamedItem
+from office365.onedrive.workbooks.names.collection import WorkbookNamedItemCollection
 from office365.onedrive.workbooks.operations.workbook import WorkbookOperation
 from office365.onedrive.workbooks.session_info import WorkbookSessionInfo
 from office365.onedrive.workbooks.tables.collection import WorkbookTableCollection
 from office365.onedrive.workbooks.worksheets.collection import (
     WorkbookWorksheetCollection,
 )
 from office365.runtime.client_result import ClientResult
+from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.function import FunctionQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -56,25 +57,20 @@ def refresh_session(self, session_id):
         self.context.add_query(qry)
 
         def _construct_request(request):
-            """
-            :type request: office365.runtime.http.request_options.RequestOptions
-            """
+            # type: (RequestOptions) -> None
             request.set_header("workbook-session-id", session_id)
 
         self.context.before_execute(_construct_request)
         return self
 
     def close_session(self, session_id):
         """Use this API to close an existing workbook session.
-
         :param str session_id: Identifier of the workbook session
         """
         qry = ServiceOperationQuery(self, "closeSession")
 
         def _construct_request(request):
-            """
-            :type request: office365.runtime.http.request_options.RequestOptions
-            """
+            # type: (RequestOptions) -> None
             request.set_header("workbook-session-id", session_id)
 
         self.context.before_execute(_construct_request)
@@ -126,13 +122,12 @@ def tables(self):
 
     @property
     def names(self):
-        # type: () -> EntityCollection[WorkbookNamedItem]
+        # type: () -> WorkbookNamedItemCollection
         """Represents a collection of workbook scoped named items (named ranges and constants). Read-only."""
         return self.properties.get(
             "names",
-            EntityCollection(
+            WorkbookNamedItemCollection(
                 self.context,
-                WorkbookNamedItem,
                 ResourcePath("names", self.resource_path),
             ),
         )

office365/onedrive/workbooks/names/named_item.py

@@ -1,4 +1,5 @@
 import datetime
+from typing import Optional
 
 from office365.entity import Entity
 from office365.runtime.types.collections import StringCollection
@@ -7,18 +8,16 @@
 class OutlookItem(Entity):
     @property
     def change_key(self):
+        # type: () -> Optional[str]
         """
         Identifies the version of the item. Every time the item is changed, changeKey changes as well.
         This allows Exchange to apply changes to the correct version of the object.
-        :rtype: str
         """
         return self.properties.get("ChangeKey", None)
 
     @property
     def categories(self):
-        """
-        The categories associated with the item
-        """
+        """The categories associated with the item"""
         return self.properties.get("categories", StringCollection())
 
     @property

office365/onedrive/workbooks/workbook.py

@@ -5,9 +5,7 @@ class ODataJsonFormat(object):
     """OData JSON format"""
 
     def __init__(self, metadata_level=None):
-        """
-        :type metadata_level: str
-        """
+        # type: (str) -> None
         self.metadata_level = metadata_level
 
     __metaclass__ = ABCMeta
@@ -28,15 +26,13 @@ def collection_next(self):
     def media_type(self):
         """
         Gets media type
-
         :rtype: str
         """
         raise NotImplementedError
 
     @property
     def include_control_information(self):
         """Determines whether control information that is represented as annotations should be included in payload
-
         :rtype: bool
         """
         raise NotImplementedError