Office365-REST-Python-Client 2.5.1__py3-none-any.whl → 2.5.3__py3-none-any.whl

office365/onedrive/columns/definition.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.base_item import BaseItem
 from office365.onedrive.columns.boolean import BooleanColumn
 from office365.onedrive.columns.calculated import CalculatedColumn
@@ -30,25 +32,27 @@ class ColumnDefinition(BaseItem):
     To list hidden field values on listItems, include the desired columns by name in your $select statement.
     """
 
+    def __str__(self):
+        return self.name
+
+    def __repr__(self):
+        return self.name or self.id or self.entity_type_name
+
     @property
     def display_name(self):
-        """The user-facing name of the column.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The user-facing name of the column."""
         return self.properties.get("displayName", None)
 
     @property
     def enforce_unique_values(self):
-        """
-        If true, no two list items may have the same value for this column.
-
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """If true, no two list items may have the same value for this column."""
         return self.properties.get("enforceUniqueValues", None)
 
     @property
     def indexed(self):
+        # type: () -> Optional[bool]
         """Specifies whether the column values can used for sorting and searching."""
         return self.properties.get("indexed", None)
 
@@ -61,6 +65,7 @@ class ColumnDefinition(BaseItem):
 
     @property
     def column_group(self):
+        # type: () -> Optional[str]
         """For site columns, the name of the group this column belongs to. Helps organize related columns."""
         return self.properties.get("columnGroup", None)
 
@@ -131,45 +136,38 @@ class ColumnDefinition(BaseItem):
 
     @property
     def hidden(self):
-        """Specifies whether the column is displayed in the user interface.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether the column is displayed in the user interface."""
         return self.properties.get("hidden", None)
 
     @property
     def is_deletable(self):
-        """Indicates whether this column can be deleted.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Indicates whether this column can be deleted."""
         return self.properties.get("isDeletable", None)
 
     @property
     def is_reorderable(self):
-        """
-        Indicates whether values in the column can be reordered. Read-only.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Indicates whether values in the column can be reordered."""
         return self.properties.get("isReorderable", None)
 
     @property
     def is_sealed(self):
-        """Specifies whether the column can be changed.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether the column can be changed."""
         return self.properties.get("isSealed", None)
 
     @property
     def propagate_changes(self):
-        """If 'true', changes to this column will be propagated to lists that implement the column.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """If 'true', changes to this column will be propagated to lists that implement the column."""
         return self.properties.get("propagateChanges", None)
 
     @property
     def read_only(self):
-        """Specifies whether the column values can be modified.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether the column values can be modified."""
         return self.properties.get("readOnly", None)
 
     @property
@@ -179,6 +177,7 @@ class ColumnDefinition(BaseItem):
 
     @property
     def source_column(self):
+        # type: () -> "ColumnDefinition"
         """The source column for the content type column."""
         return self.properties.get(
             "sourceColumn",
@@ -197,10 +196,8 @@ class ColumnDefinition(BaseItem):
 
     @property
     def type(self):
-        """
-        For site columns, the type of column.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """For site columns, the type of column."""
         return self.properties.get("type", None)
 
     def get_property(self, name, default_value=None):

office365/onedrive/columns/definition_collection.py

@@ -67,7 +67,7 @@ class ColumnDefinitionCollection(EntityCollection[ColumnDefinition]):
         :param str column_name: The name of the lookup source column.
         """
         from office365.onedrive.columns.lookup import LookupColumn
-        from office365.onedrive.lists.list import List
+        from office365.onedrive.lists.list import List  # noqa
 
         if isinstance(lookup_list, List):
             return_type = ColumnDefinition(self.context)

office365/onedrive/contenttypes/content_type.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.base_item import BaseItem
 from office365.entity_collection import EntityCollection
 from office365.onedrive.columns.column_link import ColumnLink
@@ -88,39 +90,33 @@ class ContentType(BaseItem):
 
     @property
     def name(self):
-        """
-        The name of the content type.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The name of the content type."""
         return self.properties.get("name", None)
 
     @property
     def description(self):
-        """
-        The descriptive text for the item.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The descriptive text for the item."""
         return self.properties.get("description", None)
 
     @property
     def parent_id(self):
-        """The unique identifier of the content type.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The unique identifier of the content type."""
         return self.properties.get("parentId", None)
 
     @property
     def propagate_changes(self):
-        """If 'true', changes to this column will be propagated to lists that implement the column.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """If 'true', changes to this column will be propagated to lists that implement the column."""
         return self.properties.get("propagateChanges", None)
 
     @property
     def read_only(self):
+        # type: () -> Optional[bool]
         """
         If true, the content type cannot be modified unless this value is first set to false.
-        :rtype: bool or None
         """
         return self.properties.get("readOnly", None)
 
@@ -134,6 +130,7 @@ class ContentType(BaseItem):
 
     @property
     def column_links(self):
+        # type: () -> EntityCollection[ColumnLink]
         """The collection of columns that are required by this content type"""
         return self.properties.get(
             "columnLinks",
@@ -153,6 +150,7 @@ class ContentType(BaseItem):
 
     @property
     def base_types(self):
+        # type: () -> EntityCollection["ContentType"]
         """The collection of content types that are ancestors of this content type."""
         return self.properties.get(
             "baseTypes",
@@ -163,6 +161,7 @@ class ContentType(BaseItem):
 
     @property
     def columns(self):
+        # type: () -> EntityCollection[ColumnDefinition]
         """The collection of column definitions for this contentType."""
         return self.properties.get(
             "columns",
@@ -175,6 +174,7 @@ class ContentType(BaseItem):
 
     @property
     def column_positions(self):
+        # type: () -> EntityCollection[ColumnDefinition]
         """Column order information in a content type."""
         return self.properties.get(
             "columnPositions",
@@ -187,9 +187,7 @@ class ContentType(BaseItem):
 
     @property
     def order(self):
-        """
-        Specifies the order in which the content type appears in the selection UI.
-        """
+        """Specifies the order in which the content type appears in the selection UI."""
         return self.properties.get("order", ContentTypeOrder())
 
     def get_property(self, name, default_value=None):

office365/onedrive/documentsets/version.py

@@ -1,4 +1,5 @@
 import datetime
+from typing import Optional
 
 from office365.directory.permissions.identity_set import IdentitySet
 from office365.onedrive.documentsets.version_item import DocumentSetVersionItem
@@ -11,23 +12,25 @@ class DocumentSetVersion(ListItemVersion):
 
     @property
     def comment(self):
+        # type: () -> Optional[str]
         """Comment about the captured version."""
         return self.properties.get("comment", None)
 
     @property
     def created_by(self):
+        # type: () -> IdentitySet
         """User who captured the version."""
         return self.properties.get("createdBy", IdentitySet())
 
     @property
     def created_datetime(self):
-        """
-        Date and time when this version was created.
-        """
+        # type: () -> datetime.datetime
+        """Date and time when this version was created."""
         return self.properties("createdDateTime", datetime.datetime.min)
 
     @property
     def items(self):
+        # type: () -> ClientValueCollection[DocumentSetVersionItem]
         """Items within the document set that are captured as part of this version."""
         return self.properties.get(
             "items", ClientValueCollection(DocumentSetVersionItem)
@@ -35,6 +38,7 @@ class DocumentSetVersion(ListItemVersion):
 
     @property
     def should_capture_minor_version(self):
+        # type: () -> Optional[bool]
         """
         If true, minor versions of items are also captured; otherwise, only major versions will be captured.
         Default value is false.

office365/onedrive/driveitems/driveItem.py

@@ -31,9 +31,6 @@ from office365.onedrive.files.system_info import FileSystemInfo
 from office365.onedrive.folders.folder import Folder
 from office365.onedrive.internal.paths.children import ChildrenPath
 from office365.onedrive.internal.paths.url import UrlPath
-from office365.onedrive.internal.queries.resumable_file_upload import (
-    create_resumable_file_upload_query,
-)
 from office365.onedrive.listitems.item_reference import ItemReference
 from office365.onedrive.listitems.list_item import ListItem
 from office365.onedrive.operations.pending import PendingOperations
@@ -50,6 +47,7 @@ from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.odata.v4.upload_session import UploadSession
+from office365.runtime.odata.v4.upload_session_request import UploadSessionRequest
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.create_entity import CreateEntityQuery
 from office365.runtime.queries.function import FunctionQuery
@@ -64,13 +62,30 @@ class DriveItem(BaseItem):
     """The driveItem resource represents a file, folder, or other item stored in a drive. All file system objects in
     OneDrive and SharePoint are returned as driveItem resources"""
 
-    def get_by_path(self, url_path):
-        # type: (str) -> "DriveItem"
+    def get_files(self, recursive=False):
+        """Retrieves files
+        :param bool recursive: Determines whether to enumerate folders recursively
         """
-        Retrieve DriveItem by server relative path
+        return_type = EntityCollection(self.context, DriveItem, self.resource_path)
 
-        :type url_path: str
-        """
+        def _get_files(parent_drive_item):
+            # type: (DriveItem) -> None
+            def _after_loaded():
+                for drive_item in parent_drive_item.children:
+                    if drive_item.is_folder:
+                        if recursive:
+                            _get_files(drive_item)
+                    else:
+                        return_type.add_child(drive_item)
+
+            parent_drive_item.ensure_properties(["children"], _after_loaded)
+
+        _get_files(self)
+        return return_type
+
+    def get_by_path(self, url_path):
+        # type: (str) -> "DriveItem"
+        """Retrieve DriveItem by server relative path"""
         return DriveItem(
             self.context, UrlPath(url_path, self.resource_path), self.children
         )
@@ -79,7 +94,6 @@ class DriveItem(BaseItem):
         # type: (str) -> "DriveItem"
         """
         Creates a PowerPoint file
-
         :param str name: File name
         """
         return self.upload(name, None)
@@ -142,18 +156,14 @@ class DriveItem(BaseItem):
 
     def follow(self):
         # type: () -> Self
-        """
-        Follow a driveItem.
-        """
+        """Follow a driveItem."""
         qry = ServiceOperationQuery(self, "follow")
         self.context.add_query(qry)
         return self
 
     def unfollow(self):
         # type: () -> Self
-        """
-        Unfollow a driveItem.
-        """
+        """Unfollow a driveItem."""
         qry = ServiceOperationQuery(self, "unfollow")
         self.context.add_query(qry)
         return self
@@ -198,12 +208,21 @@ class DriveItem(BaseItem):
         :param str source_path: File path
         :param int chunk_size: chunk size
         """
+
+        def _start_upload():
+            with open(source_path, "rb") as local_file:
+                session_request = UploadSessionRequest(
+                    local_file, chunk_size, chunk_uploaded
+                )
+                session_request.execute_query(qry)
+
         file_name = os.path.basename(source_path)
         return_type = DriveItem(self.context, UrlPath(file_name, self.resource_path))
-        qry = create_resumable_file_upload_query(
-            return_type, source_path, chunk_size, chunk_uploaded
+
+        qry = UploadSessionQuery(
+            return_type, {"item": DriveItemUploadableProperties(name=file_name)}
         )
-        self.context.add_query(qry)
+        self.context.add_query(qry).after_query_execute(_start_upload)
         return return_type
 
     def create_upload_session(self, item):
@@ -233,20 +252,15 @@ class DriveItem(BaseItem):
         self.children.add_child(qry.return_type)
 
         def _modify_query(request):
-            """
-            :type request: office365.runtime.http.request_options.RequestOptions
-            """
+            # type: (RequestOptions) -> None
             request.method = HttpMethod.Put
 
         self.context.add_query(qry).before_query_execute(_modify_query)
         return return_type
 
     def upload_file(self, path_or_file):
-        # type: (str or IO) -> "DriveItem"
-        """Uploads a file
-
-        :param str or typing.IO path_or_file:
-        """
+        # type: (str|IO) -> "DriveItem"
+        """Uploads a file"""
         if hasattr(path_or_file, "read"):
             content = path_or_file.read()
             name = os.path.basename(path_or_file.name)
@@ -278,8 +292,6 @@ class DriveItem(BaseItem):
         """
         Download the contents of the primary stream (file) of a DriveItem. Only driveItems with the file property
         can be downloaded
-
-        :type file_object: typing.IO
         """
 
         def _save_content(return_type):
@@ -305,9 +317,7 @@ class DriveItem(BaseItem):
         """
 
         def _construct_request(request):
-            """
-            :type request: office365.runtime.http.request_options.RequestOptions
-            """
+            # type: (RequestOptions) -> None
             request.stream = True
 
         def _process_response(response):
@@ -365,9 +375,7 @@ class DriveItem(BaseItem):
         return_type = ClientResult(self.context)  # type: ClientResult[str]
 
         def _create_request(request):
-            """
-            :type request: office365.runtime.http.request_options.RequestOptions
-            """
+            # type: (RequestOptions) -> None
             request.url += "?@microsoft.graph.conflictBehavior={0}".format(
                 conflict_behavior
             )
@@ -535,14 +543,13 @@ class DriveItem(BaseItem):
 
         qry = _create_query()
         self.context.add_query(qry)
-
         return return_type
 
     def permanent_delete(self):
         """
         Permanently delete a driveItem.
         Note that if you delete items using this method, they will be permanently removed and won't be sent to the
-        recycle bin. Therefore, they cannot be restored afterward.
+        recycle bin. Therefore, they cannot be restored afterward. For non-permanent delete, use delete_object()
         """
         qry = ServiceOperationQuery(self, "permanentDelete")
         self.context.add_query(qry)
@@ -584,11 +591,8 @@ class DriveItem(BaseItem):
         return return_type
 
     def validate_permission(self, challenge_token=None, password=None):
-        # type: (str or None, str or None) -> Self
-        """
-        :type challenge_token: str
-        :type password: str
-        """
+        # type: (Optional[str], Optional[str]) -> Self
+        """ """
         payload = {"challengeToken": challenge_token, "password": password}
         qry = ServiceOperationQuery(self, "validatePermission", None, payload)
         self.context.add_query(qry)
@@ -621,9 +625,7 @@ class DriveItem(BaseItem):
     @property
     def location(self):
         # type: () -> GeoCoordinates
-        """
-        Location metadata, if the item has location data. Read-only.
-        """
+        """Location metadata, if the item has location data"""
         return self.properties.get("location", GeoCoordinates())
 
     @property
@@ -666,15 +668,12 @@ class DriveItem(BaseItem):
     @property
     def web_dav_url(self):
         # type: () -> str or None
-        """
-        WebDAV compatible URL for the item.
-        :rtype: str or None
-        """
+        """WebDAV compatible URL for the item."""
         return self.properties.get("webDavUrl", None)
 
     @property
     def children(self):
-        # type: () -> EntityCollection[DriveItem]
+        # type: () -> EntityCollection["DriveItem"]
         """Collection containing Item objects for the immediate children of Item. Only items representing folders
         have children.
         """

office365/onedrive/drives/drive.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.base_item import BaseItem
 from office365.directory.permissions.identity_set import IdentitySet
 from office365.entity_collection import EntityCollection
@@ -73,11 +75,10 @@ class Drive(BaseItem):
 
     @property
     def drive_type(self):
+        # type: () -> Optional[str]
         """
         Describes the type of drive represented by this resource. OneDrive personal drives will return personal.
         OneDrive for Business will return business. SharePoint document libraries will return documentLibrary.
-
-        :rtype: str or None
         """
         return self.properties.get("driveType", None)
 
@@ -117,6 +118,7 @@ class Drive(BaseItem):
 
     @property
     def bundles(self):
+        # type: () -> EntityCollection[DriveItem]
         """Bundle metadata, if the item is a bundle."""
         return self.properties.get(
             "bundles",
@@ -127,6 +129,7 @@ class Drive(BaseItem):
 
     @property
     def items(self):
+        # type: () -> EntityCollection[DriveItem]
         """All items contained in the drive."""
         return self.properties.get(
             "items",
@@ -137,6 +140,7 @@ class Drive(BaseItem):
 
     @property
     def following(self):
+        # type: () -> EntityCollection[DriveItem]
         """The list of items the user is following. Only in OneDrive for Business."""
         return self.properties.get(
             "following",
@@ -152,6 +156,7 @@ class Drive(BaseItem):
 
     @property
     def special(self):
+        # type: () -> EntityCollection[DriveItem]
         """Collection of auth folders available in OneDrive. Read-only. Nullable."""
         return self.properties.get(
             "special",

office365/onedrive/internal/paths/children.py

@@ -1,4 +1,4 @@
-from office365.runtime.paths.entity import EntityPath
+from office365.runtime.paths.v4.entity import EntityPath
 
 
 class ChildrenPath(EntityPath):
@@ -13,5 +13,5 @@ class ChildrenPath(EntityPath):
             if isinstance(self.parent, EntityPath):
                 self._collection = self.parent.collection
             else:
-                self._collection = self.parent.parent
+                self._collection = self.parent
         return self._collection

office365/onedrive/internal/paths/root.py

@@ -1,4 +1,4 @@
-from office365.runtime.paths.entity import EntityPath
+from office365.runtime.paths.v4.entity import EntityPath
 
 
 class RootPath(EntityPath):

office365/onedrive/internal/paths/shared.py

@@ -19,4 +19,4 @@ class SharedPath(ResourcePath):
 
     @property
     def segment(self):
-        return _url_to_shared_token(self.key)
+        return _url_to_shared_token(self._key)

office365/onedrive/internal/paths/site.py

@@ -1,6 +1,6 @@
 from office365.runtime.compat import is_absolute_url, urlparse
-from office365.runtime.paths.entity import EntityPath
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.paths.v4.entity import EntityPath
 
 
 class SitePath(EntityPath):
@@ -8,8 +8,8 @@ class SitePath(EntityPath):
 
     @property
     def segment(self):
-        if is_absolute_url(self.key):
-            url_result = urlparse(self.key)
+        if is_absolute_url(self._key):
+            url_result = urlparse(self._key)
             return ":".join([url_result.hostname, url_result.path])
         else:
             return super(SitePath, self).segment

office365/onedrive/internal/paths/url.py

@@ -1,5 +1,5 @@
 from office365.onedrive.internal.paths.root import RootPath
-from office365.runtime.paths.entity import EntityPath
+from office365.runtime.paths.v4.entity import EntityPath
 
 
 class UrlPath(EntityPath):
@@ -11,7 +11,7 @@ class UrlPath(EntityPath):
         :type parent: office365.runtime.paths.resource_path.ResourcePath
         """
         if isinstance(parent, UrlPath):
-            url = "/".join([parent.key, url])
+            url = "/".join([parent._key, url])
             collection = parent.collection
             parent = parent.parent
         elif isinstance(parent, RootPath):

office365/onedrive/listitems/list_item.py

@@ -60,6 +60,7 @@ class ListItem(BaseItem):
 
     @property
     def content_type(self):
+        # type: () -> ContentTypeInfo
         """The content type of this list item"""
         return self.properties.get("contentType", ContentTypeInfo())
 
@@ -73,6 +74,7 @@ class ListItem(BaseItem):
 
     @property
     def document_set_versions(self):
+        # type: () -> EntityCollection[DocumentSetVersion]
         """Version information for a document set version created by a user."""
         return self.properties.get(
             "documentSetVersions",

office365/onedrive/lists/list.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.base_item import BaseItem
 from office365.entity_collection import EntityCollection
 from office365.onedrive.columns.definition_collection import ColumnDefinitionCollection
@@ -14,12 +16,13 @@ class List(BaseItem):
     """The list resource represents a list in a site. This resource contains the top level properties of the list,
     including template and field definitions."""
 
+    def __str__(self):
+        return self.display_name
+
     @property
     def display_name(self):
-        """
-        The displayable title of the list
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The displayable title of the list"""
         return self.properties.get("displayName", None)
 
     @property