Office365-REST-Python-Client 2.5.2__py3-none-any.whl → 2.5.4__py3-none-any.whl

office365/onedrive/permissions/collection.py

@@ -1,9 +1,17 @@
+from typing import TYPE_CHECKING
+
 from office365.directory.permissions.identity import Identity
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.onedrive.permissions.permission import Permission
 from office365.runtime.queries.create_entity import CreateEntityQuery
 
+if TYPE_CHECKING:
+    from office365.directory.applications.application import Application
+    from office365.directory.groups.group import Group
+    from office365.directory.users.user import User
+    from office365.intune.devices.device import Device
+
 
 class PermissionCollection(EntityCollection[Permission]):
     """Permission's collection"""
@@ -12,6 +20,7 @@ class PermissionCollection(EntityCollection[Permission]):
         super(PermissionCollection, self).__init__(context, Permission, resource_path)
 
     def add(self, roles, identity=None, identity_type=None):
+        # type: (list[str], Application|User|Group|Device|str, str) -> Permission
         """
         Create a new permission object.
 
@@ -21,6 +30,7 @@ class PermissionCollection(EntityCollection[Permission]):
         """
 
         return_type = Permission(self.context)
+        self.add_child(return_type)
 
         known_identities = {
             "application": self.context.applications,
@@ -41,7 +51,7 @@ class PermissionCollection(EntityCollection[Permission]):
                 raise ValueError("Unknown identity type")
             identity = known_identity[identity]
 
-        def _create():
+        def _add():
             payload = {
                 "roles": roles,
                 "grantedToIdentities": [
@@ -53,17 +63,27 @@ class PermissionCollection(EntityCollection[Permission]):
                 ],
             }
 
-            self.add_child(return_type)
             qry = CreateEntityQuery(self, payload, return_type)
             self.context.add_query(qry)
 
-        identity.ensure_properties(["displayName"], _create)
+        identity.ensure_properties(["displayName"], _add)
         return return_type
 
+    def delete(self, roles, identity):
+        # type: (list[str], Application|User|Group|Device) -> Permission
+        """Deletes the permission."""
+
+        def _delete(col):
+            pass
+
+        def _identity_loaded():
+            self.get_all(page_loaded=_delete)
+
+        identity.ensure_property("id", _identity_loaded)
+        return self
+
     def delete_all(self):
-        """
-        Remove all access to resource
-        """
+        """Remove all access to resource"""
 
         def _after_loaded(return_type):
             # type: (PermissionCollection) -> None

office365/onedrive/sharepoint.py

@@ -8,6 +8,7 @@ class Sharepoint(Entity):
 
     @property
     def settings(self):
+        # type: () -> SharepointSettings
         """Represents the tenant-level settings for SharePoint and OneDrive."""
         return self.properties.get(
             "settings",

office365/onedrive/shares/collection.py

@@ -8,9 +8,6 @@ class SharesCollection(EntityCollection[SharedDriveItem]):
         super(SharesCollection, self).__init__(context, SharedDriveItem, resource_path)
 
     def by_url(self, url):
-        """
-        Address shared item by absolute url
-
-        :type url: str
-        """
+        # type: (str) -> SharedDriveItem
+        """Address shared item by absolute url"""
         return SharedDriveItem(self.context, SharedPath(url, self.resource_path))

office365/onedrive/shares/drive_item.py

@@ -8,6 +8,7 @@ from office365.onedrive.lists.list import List
 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):
@@ -26,6 +27,7 @@ class SharedDriveItem(BaseItem):
 
     @property
     def list_item(self):
+        # type: () -> ListItem
         """Used to access the underlying listItem"""
         return self.properties.get(
             "listItem",
@@ -34,6 +36,7 @@ class SharedDriveItem(BaseItem):
 
     @property
     def list(self):
+        # type: () -> List
         """Used to access the underlying list"""
         return self.properties.get(
             "list", List(self.context, ResourcePath("list", self.resource_path))
@@ -41,10 +44,11 @@ class SharedDriveItem(BaseItem):
 
     @property
     def drive_item(self):
+        # type: () -> DriveItem
         """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/termstore/groups/collection.py

@@ -2,24 +2,19 @@ from office365.entity_collection import EntityCollection
 from office365.onedrive.termstore.groups.group import Group
 
 
-class GroupCollection(EntityCollection):
+class GroupCollection(EntityCollection[Group]):
     def __init__(self, context, resource_path=None):
         super(GroupCollection, self).__init__(context, Group, resource_path)
 
     def add(self, display_name):
         """
         Create a new group object in a term store.
-
         :param str display_name: Name of the group to be created.
-        :rtype: Group
         """
         props = {"displayName": display_name}
         return super(GroupCollection, self).add(**props)
 
     def get_by_name(self, name):
-        """Returns the group with the specified name.
-
-        :param str name: Group name
-        :rtype: Group
-        """
+        # type: (str) -> Group
+        """Returns the group with the specified name."""
         return self.single("displayName eq '{0}'".format(name))

office365/onedrive/termstore/groups/group.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.onedrive.termstore.sets.collection import SetCollection
 from office365.runtime.paths.resource_path import ResourcePath
@@ -6,18 +8,24 @@ from office365.runtime.paths.resource_path import ResourcePath
 class Group(Entity):
     """Term Group"""
 
+    def __str__(self):
+        return self.display_name
+
     @property
     def display_name(self):
+        # type: () -> Optional[str]
         """Name of the group."""
         return self.properties.get("displayName", None)
 
     @property
     def parent_site_id(self):
+        # type: () -> Optional[str]
         """ID of the parent site of this group."""
         return self.properties.get("parentSiteId", None)
 
     @property
     def sets(self):
+        # type: () -> SetCollection
         """Collection of all sets available in the term store."""
         return self.properties.get(
             "sets",

office365/onedrive/termstore/sets/collection.py

@@ -14,12 +14,8 @@ class SetCollection(EntityCollection[Set]):
         self._parent_group = parent_group
 
     def get_by_name(self, name):
-        """
-        Returns the TermSet specified by its name.
-
-        :param str name: Term set name
-        :rtype: Set
-        """
+        # type: (str) -> Set
+        """Returns the TermSet specified by its name."""
         return self.single("displayName eq '{0}'".format(name))
 
     def add(self, name, parent_group=None):

office365/onedrive/termstore/sets/name.py

@@ -1,3 +1,5 @@
+import json
+
 from office365.runtime.client_value import ClientValue
 
 
@@ -15,3 +17,6 @@ class LocalizedName(ClientValue):
         super(LocalizedName, self).__init__()
         self.name = name
         self.languageTag = language_tag
+
+    def __repr__(self):
+        return json.dumps(self.to_json())

office365/onedrive/termstore/sets/set.py

@@ -14,8 +14,12 @@ class Set(Entity):
     terms. A group can contain multiple sets.
     """
 
+    def __repr__(self):
+        return repr(self.localized_names)
+
     @property
     def children(self):
+        # type: () -> TermCollection
         """Children terms of set in term store."""
         return self.properties.get(
             "children",
@@ -28,6 +32,7 @@ class Set(Entity):
 
     @property
     def localized_names(self):
+        # type: () -> ClientValueCollection[LocalizedName]
         """"""
         return self.properties.get(
             "localizedNames", ClientValueCollection(LocalizedName)
@@ -45,6 +50,7 @@ class Set(Entity):
 
     @property
     def relations(self):
+        # type: () -> EntityCollection[Relation]
         """Indicates which terms have been pinned or reused directly under the set."""
         return self.properties.get(
             "relations",
@@ -55,6 +61,7 @@ class Set(Entity):
 
     @property
     def terms(self):
+        # type: () -> TermCollection
         """All the terms under the set."""
         return self.properties.get(
             "terms",

office365/onedrive/termstore/store.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.onedrive.termstore.groups.collection import GroupCollection
@@ -15,17 +17,13 @@ class Store(Entity):
         """Returns a collection containing a flat list of all TermSet objects."""
         return_type = EntityCollection(self.context, Set)
 
-        def _sets_loaded(group_sets):
-            """
-            :type group_sets: EntityCollection
-            """
-            [return_type.add_child(s) for s in group_sets]
+        def _sets_loaded(sets):
+            # type: (SetCollection) -> None
+            [return_type.add_child(s) for s in sets]
 
         def _groups_loaded(groups):
-            """
-            :type groups: EntityCollection
-            """
-            for g in groups:  # type: Group
+            # type: (GroupCollection) -> None
+            for g in groups:
                 self.context.load(g.sets, after_loaded=_sets_loaded)
 
         self.context.load(self.groups, after_loaded=_groups_loaded)
@@ -34,10 +32,8 @@ class Store(Entity):
 
     @property
     def default_language_tag(self):
-        """Default language of the term store.
-
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Default language of the term store."""
         return self.properties.get("defaultLanguageTag", None)
 
     @property
@@ -47,6 +43,7 @@ class Store(Entity):
 
     @property
     def groups(self):
+        # type: () -> GroupCollection
         """Collection of all groups available in the term store."""
         return self.properties.get(
             "groups",

office365/onedrive/versions/drive_item.py

@@ -1,3 +1,5 @@
+from typing import AnyStr, Optional
+
 from office365.onedrive.versions.base_item import BaseItemVersion
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 
@@ -15,16 +17,12 @@ class DriveItemVersion(BaseItemVersion):
 
     @property
     def content(self):
-        """
-        The content stream for this version of the item.
-        :rtype: str or bytes
-        """
+        # type: () -> Optional[AnyStr]
+        """The content stream for this version of the item."""
         return self.properties.get("content", None)
 
     @property
     def size(self):
-        """
-        Indicates the size of the content stream for this version of the item.
-        :rtype: int
-        """
+        # type: () -> Optional[int]
+        """Indicates the size of the content stream for this version of the item."""
         return self.properties.get("size", None)

office365/onedrive/workbooks/functions/result.py

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

office365/onedrive/workbooks/names/collection.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/names/named_item.py

@@ -1,5 +1,9 @@
+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):
@@ -7,18 +11,26 @@ class WorkbookNamedItem(Entity):
     (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
@@ -33,3 +45,8 @@ class WorkbookNamedItem(Entity):
                 self.context, ResourcePath("worksheet", self.resource_path)
             ),
         )
+
+    @property
+    def property_ref_name(self):
+        # type: () -> str
+        return "name"

office365/onedrive/workbooks/ranges/range.py

@@ -1,16 +1,55 @@
+from typing import List, Optional
+
 from office365.entity import Entity
 from office365.onedrive.workbooks.ranges.format import WorkbookRangeFormat
 from office365.onedrive.workbooks.ranges.sort import WorkbookRangeSort
 from office365.onedrive.workbooks.ranges.view import WorkbookRangeView
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.function import FunctionQuery
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 
 
 class WorkbookRange(Entity):
     """Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc."""
 
+    def cell(self, row, column):
+        """
+        Gets the range object containing the single cell based on row and column numbers. The cell can be outside
+        the bounds of its parent range, so long as it's stays within the worksheet grid.
+        :param int row: Row number of the cell to be retrieved. Zero-indexed.
+        :param int column: Column number of the cell to be retrieved. Zero-indexed.
+        """
+        return_type = WorkbookRange(self.context)
+        params = {"row": row, "column": column}
+        qry = FunctionQuery(self, "cell", params, return_type=return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def clear(self, apply_to=None):
+        """Clear range values such as format, fill, and border.
+        :param str apply_to:
+        """
+        payload = {"applyTo": apply_to}
+        qry = ServiceOperationQuery(self, "clear", parameters_type=payload)
+        self.context.add_query(qry)
+        return self
+
+    def insert(self, shift):
+        """
+        Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to
+        make space. Returns a new Range object at the now blank space.
+        :param str shift: Specifies which way to shift the cells. The possible values are: Down, Right.
+        """
+        return_type = WorkbookRange(self.context)
+        payload = {"shift": shift}
+        qry = ServiceOperationQuery(
+            self, "insert", parameters_type=payload, return_type=return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def visible_view(self):
-        """"""
+        """Get the range visible from a filtered range."""
         return_type = WorkbookRangeView(self.context)
         qry = FunctionQuery(self, "visibleView", return_type=return_type)
         self.context.add_query(qry)
@@ -18,35 +57,29 @@ class WorkbookRange(Entity):
 
     @property
     def address(self):
+        # type: () -> Optional[str]
         """
         Represents the range reference in A1-style. Address value will contain the Sheet reference
         (e.g. Sheet1!A1:B4)
-        :rtype: str or None
         """
         return self.properties.get("address", None)
 
     @property
     def address_local(self):
-        """
-        Represents range reference for the specified range in the language of the user. Read-only.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Represents range reference for the specified range in the language of the user."""
         return self.properties.get("addressLocal", None)
 
     @property
     def cell_count(self):
-        """
-        Number of cells in the range. Read-only.
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Number of cells in the range. Read-only."""
         return self.properties.get("cellCount", None)
 
     @property
     def column_count(self):
-        """
-        Represents the total number of columns in the range. Read-only.
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Represents the total number of columns in the range. Read-only."""
         return self.properties.get("columnCount", None)
 
     @property
@@ -67,6 +100,20 @@ class WorkbookRange(Entity):
             WorkbookRangeSort(self.context, ResourcePath("sort", self.resource_path)),
         )
 
+    @property
+    def values(self):
+        # type: () -> List
+        """Represents the raw values of the specified range. The data returned could be of type string, number,
+        or a boolean. Cell that contains an error returns the error string."""
+        return self.properties.get("values", None)
+
+    @property
+    def value_types(self):
+        # type: () -> List
+        """Represents the type of data of each cell. The possible values are:
+        Unknown, Empty, String, Integer, Double, Boolean, Error."""
+        return self.properties.get("valueTypes", None)
+
     @property
     def worksheet(self):
         """The worksheet containing the current range"""

office365/onedrive/workbooks/ranges/view.py

@@ -8,6 +8,7 @@ class WorkbookRangeView(Entity):
 
     @property
     def rows(self):
+        # type: () -> EntityCollection[WorkbookRangeView]
         """Represents a collection of range views associated with the range."""
         return self.properties.get(
             "rows",

office365/onedrive/workbooks/tables/table.py

@@ -16,16 +16,23 @@ from office365.runtime.queries.service_operation import ServiceOperationQuery
 class WorkbookTable(Entity):
     """Represents an Excel table."""
 
+    def __repr__(self):
+        return self.name or self.id or self.entity_type_name
+
     def data_body_range(self):
         """Gets the range object associated with the data body of the table."""
-        return_type = WorkbookRange(self.context)
+        return_type = WorkbookRange(
+            self.context, ResourcePath("dataBodyRange", self.resource_path)
+        )
         qry = FunctionQuery(self, "dataBodyRange", return_type=return_type)
         self.context.add_query(qry)
         return return_type
 
     def range(self):
         """Get the range object associated with the entire table."""
-        return_type = WorkbookRange(self.context)
+        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
@@ -58,9 +65,7 @@ class WorkbookTable(Entity):
     @property
     def columns(self):
         # type: () -> WorkbookTableColumnCollection
-        """
-        Represents a collection of all the columns in the table.
-        """
+        """Represents a collection of all the columns in the table."""
         return self.properties.get(
             "columns",
             WorkbookTableColumnCollection(
@@ -71,9 +76,7 @@ class WorkbookTable(Entity):
     @property
     def rows(self):
         # type: () -> WorkbookTableRowCollection
-        """
-        Represents a collection of all the rows in the table.
-        """
+        """Represents a collection of all the rows in the table."""
         return self.properties.get(
             "rows",
             WorkbookTableRowCollection(

office365/onedrive/workbooks/workbook.py

@@ -3,7 +3,7 @@ from office365.entity_collection import EntityCollection
 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
@@ -11,6 +11,7 @@ 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,9 +57,7 @@ class Workbook(Entity):
         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)
@@ -66,15 +65,12 @@ class Workbook(Entity):
 
     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)
@@ -93,6 +89,7 @@ class Workbook(Entity):
 
     @property
     def comments(self):
+        # type: () -> EntityCollection[WorkbookComment]
         """"""
         return self.properties.get(
             "comments",
@@ -126,13 +123,12 @@ class Workbook(Entity):
 
     @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),
             ),
         )