Office365-REST-Python-Client 2.5.1__py3-none-any.whl → 2.5.3__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,20 +63,31 @@ 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):
-            for permission in return_type:  # type: Permission
+            # type: (PermissionCollection) -> None
+            for permission in return_type:
                 permission.delete_object()
 
         self.context.load(self, after_loaded=_after_loaded)

office365/onedrive/permissions/permission.py

@@ -1,6 +1,7 @@
+from typing import Optional
+
 from office365.directory.permissions.identity_set import IdentitySet
 from office365.entity import Entity
-from office365.entity_collection import EntityCollection
 from office365.onedrive.drives.recipient import DriveRecipient
 from office365.onedrive.listitems.item_reference import ItemReference
 from office365.onedrive.permissions.sharepoint_identity_set import SharePointIdentitySet
@@ -89,18 +90,15 @@ class Permission(Entity):
 
     @property
     def share_id(self):
-        """A unique token that can be used to access this shared item via the shares API. Read-only.
-
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """A unique token that can be used to access this shared item via the shares API. Read-only."""
         return self.properties.get("shareId", None)
 
     @property
     def has_password(self):
+        # type: () -> Optional[bool]
         """This indicates whether password is set for this permission, it's only showing in response.
         Optional and Read-only and for OneDrive Personal only.
-
-        :rtype: bool
         """
         return self.properties.get("hasPassword", None)
 

office365/onedrive/permissions/sharing_link.py

@@ -34,4 +34,4 @@ class SharingLink(ClientValue):
         self.application = application
 
     def __repr__(self):
-        return self.webUrl
+        return self.webUrl or ""

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

@@ -15,6 +15,7 @@ class SharedDriveItem(BaseItem):
 
     @property
     def items(self):
+        # type: () -> EntityCollection[DriveItem]
         """All driveItems contained in the sharing root. This collection cannot be enumerated."""
         return self.properties.get(
             "items",
@@ -25,6 +26,7 @@ class SharedDriveItem(BaseItem):
 
     @property
     def list_item(self):
+        # type: () -> ListItem
         """Used to access the underlying listItem"""
         return self.properties.get(
             "listItem",
@@ -33,6 +35,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))
@@ -40,6 +43,7 @@ class SharedDriveItem(BaseItem):
 
     @property
     def drive_item(self):
+        # type: () -> DriveItem
         """Used to access the underlying driveItem"""
         return self.properties.get(
             "driveItem",

office365/onedrive/sites/site.py

@@ -24,6 +24,12 @@ from office365.runtime.queries.service_operation import ServiceOperationQuery
 class Site(BaseItem):
     """The site resource provides metadata and relationships for a SharePoint site."""
 
+    def __str__(self):
+        return self.name
+
+    def __repr__(self):
+        return self.name or self.web_url or self.id or self.entity_type_name
+
     def get_by_path(self, path):
         # type: (str) -> Site
         """

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 Optional
+
 from office365.onedrive.versions.base_item import BaseItemVersion
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 
@@ -23,8 +25,8 @@ class DriveItemVersion(BaseItemVersion):
 
     @property
     def size(self):
+        # type: () -> Optional[int]
         """
         Indicates the size of the content stream for this version of the item.
-        :rtype: int
         """
         return self.properties.get("size", None)

office365/onedrive/workbooks/ranges/range.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.onedrive.workbooks.ranges.format import WorkbookRangeFormat
 from office365.onedrive.workbooks.ranges.sort import WorkbookRangeSort
@@ -18,35 +20,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

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/rows/row.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
@@ -6,6 +8,7 @@ class WorkbookTableRow(Entity):
 
     @property
     def index(self):
+        # type: () -> Optional[int]
         """Returns the index number of the row within the rows collection of the table. Zero-indexed."""
         return self.properties.get("index", None)
 

office365/onedrive/workbooks/tables/table.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.onedrive.workbooks.ranges.range import WorkbookRange
 from office365.onedrive.workbooks.tables.columns.collection import (
@@ -49,11 +51,13 @@ class WorkbookTable(Entity):
 
     @property
     def name(self):
+        # type: () -> Optional[str]
         """Name of the table."""
-        return self.properties.get("name", str())
+        return self.properties.get("name", None)
 
     @property
     def columns(self):
+        # type: () -> WorkbookTableColumnCollection
         """
         Represents a collection of all the columns in the table.
         """
@@ -66,9 +70,8 @@ class WorkbookTable(Entity):
 
     @property
     def rows(self):
-        """
-        Represents a collection of all the rows in the table.
-        """
+        # type: () -> WorkbookTableRowCollection
+        """Represents a collection of all the rows in the table."""
         return self.properties.get(
             "rows",
             WorkbookTableRowCollection(

office365/onedrive/workbooks/worksheets/worksheet.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.onedrive.workbooks.charts.chart import WorkbookChart
@@ -18,8 +20,12 @@ class WorkbookWorksheet(Entity):
     def __repr__(self):
         return self.name
 
+    def __str__(self):
+        return self.name
+
     @property
     def charts(self):
+        # type: () -> EntityCollection[WorkbookChart]
         """Returns collection of charts that are part of the worksheet"""
         return self.properties.get(
             "charts",
@@ -30,14 +36,13 @@ class WorkbookWorksheet(Entity):
 
     @property
     def name(self):
-        """
-        The display name of the worksheet.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The display name of the worksheet."""
         return self.properties.get("name", None)
 
     @property
     def names(self):
+        # type: () -> EntityCollection[WorkbookNamedItem]
         """Returns collection of names that are associated with the worksheet"""
         return self.properties.get(
             "names",
@@ -50,6 +55,7 @@ class WorkbookWorksheet(Entity):
 
     @property
     def tables(self):
+        # type: () -> WorkbookTableCollection
         """Collection of tables that are part of the worksheet."""
         return self.properties.get(
             "tables",
@@ -60,6 +66,7 @@ class WorkbookWorksheet(Entity):
 
     @property
     def pivot_tables(self):
+        # type: () -> EntityCollection[WorkbookPivotTable]
         """Collection of PivotTables that are part of the worksheet."""
         return self.properties.get(
             "pivotTables",
@@ -72,6 +79,7 @@ class WorkbookWorksheet(Entity):
 
     @property
     def protection(self):
+        # type: () -> WorkbookWorksheetProtection
         """Returns sheet protection object for a worksheet."""
         return self.properties.get(
             "protection",

office365/onenote/entity_hierarchy_model.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.directory.permissions.identity_set import IdentitySet
 from office365.onenote.entity_schema_object_model import OnenoteEntitySchemaObjectModel
 
@@ -5,11 +7,13 @@ from office365.onenote.entity_schema_object_model import OnenoteEntitySchemaObje
 class OnenoteEntityHierarchyModel(OnenoteEntitySchemaObjectModel):
     @property
     def display_name(self):
+        # type: () -> Optional[str]
         """The name of the section."""
         return self.properties.get("displayName", None)
 
     @property
     def created_by(self):
+        # type: () -> IdentitySet
         """Identity of the user, device, and application which created the item. Read-only."""
         return self.properties.get("createdBy", IdentitySet())
 

office365/onenote/internal/multipart_page_query.py

@@ -1,4 +1,5 @@
 from email.message import Message
+from typing import AnyStr
 
 from office365.runtime.compat import get_mime_type, message_as_bytes_or_string
 from office365.runtime.http.http_method import HttpMethod
@@ -7,9 +8,7 @@ from office365.runtime.queries.client_query import ClientQuery
 
 
 def _message_to_payload(message):
-    """
-    :type message: Message
-    """
+    # type: (Message) -> AnyStr
     lf = b"\n"
     crlf = b"\r\n"
     payload = message_as_bytes_or_string(message)
@@ -48,7 +47,7 @@ class OneNotePageCreateQuery(ClientQuery):
         )
         main_message.set_boundary(boundary)
 
-        c_type, enc = get_mime_type(self._presentation.name)
+        c_type, _enc = get_mime_type(self._presentation.name)
         presentation_message = Message()
         presentation_message.add_header("Content-Type", c_type)
         presentation_message.add_header(
@@ -59,7 +58,7 @@ class OneNotePageCreateQuery(ClientQuery):
 
         for name, file in self._files.items():
             file_message = Message()
-            c_type, enc = get_mime_type(file.name)
+            c_type, _enc = get_mime_type(file.name)
             file_message.add_header("Content-Type", c_type)
             file_message.add_header(
                 "Content-Disposition", 'form-data; name="{0}"'.format(name)

office365/onenote/notebooks/notebook.py

@@ -1,3 +1,5 @@
+from typing import TYPE_CHECKING
+
 from office365.entity_collection import EntityCollection
 from office365.onenote.entity_hierarchy_model import OnenoteEntityHierarchyModel
 from office365.onenote.sections.section import OnenoteSection
@@ -9,6 +11,7 @@ class Notebook(OnenoteEntityHierarchyModel):
 
     @property
     def sections(self):
+        # type: () -> EntityCollection[OnenoteSection]
         """
         Retrieve a list of onenoteSection objects from the specified notebook.
         """
@@ -26,6 +29,7 @@ class Notebook(OnenoteEntityHierarchyModel):
         """
         Retrieve a list of onenoteSection objects from the specified notebook.
         """
+
         from office365.onenote.sectiongroups.section_group import SectionGroup
 
         return self.properties.get(

office365/onenote/pages/collection.py

@@ -1,3 +1,5 @@
+from typing import IO
+
 from office365.entity_collection import EntityCollection
 from office365.onenote.internal.multipart_page_query import OneNotePageCreateQuery
 from office365.onenote.pages.page import OnenotePage
@@ -10,12 +12,11 @@ class OnenotePageCollection(EntityCollection[OnenotePage]):
         super(OnenotePageCollection, self).__init__(context, OnenotePage, resource_path)
 
     def add(self, presentation_file, attachment_files=None):
+        # type: (IO, dict) -> OnenotePage
         """
         Create a new OneNote page.
-
         :param typing.IO presentation_file: Presentation file
         :param dict or None attachment_files: Attachment files
-        :rtype: OnenotePage
         """
         qry = OneNotePageCreateQuery(self, presentation_file, attachment_files)
         self.context.add_query(qry)

office365/onenote/resources/resource.py

@@ -1,3 +1,5 @@
+from typing import AnyStr, Optional
+
 from office365.onenote.entity_base_model import OnenoteEntityBaseModel
 from office365.runtime.client_result import ClientResult
 from office365.runtime.queries.function import FunctionQuery
@@ -7,6 +9,7 @@ class OnenoteResource(OnenoteEntityBaseModel):
     """An image or other file resource on a OneNote page."""
 
     def get_content(self):
+        # type: () -> ClientResult[AnyStr]
         """Retrieve the binary data of a file or image resource object."""
         return_type = ClientResult(self.context)
         qry = FunctionQuery(self, "content", None, return_type)
@@ -15,8 +18,6 @@ class OnenoteResource(OnenoteEntityBaseModel):
 
     @property
     def content_url(self):
-        """The URL for downloading the content
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The URL for downloading the content"""
         return self.properties.get("contentUrl", None)