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

office365/sharepoint/files/checked_out_file_collection.py

@@ -3,7 +3,7 @@ from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.files.checked_out_file import CheckedOutFile
 
 
-class CheckedOutFileCollection(EntityCollection):
+class CheckedOutFileCollection(EntityCollection[CheckedOutFile]):
     def __init__(self, context, resource_path=None):
         super(CheckedOutFileCollection, self).__init__(
             context, CheckedOutFile, resource_path

office365/sharepoint/files/collection.py

@@ -1,23 +1,31 @@
+import hashlib
 import os
 import uuid
-from typing import IO, Callable
+from typing import IO, TYPE_CHECKING, Callable
 
 from office365.runtime.client_result import ClientResult
+from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.client_context import ClientContext
 from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.files.creation_information import FileCreationInformation
 from office365.sharepoint.files.file import File
 from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 
+if TYPE_CHECKING:
+    from office365.sharepoint.folders.folder import Folder
+
 
 class FileCollection(EntityCollection[File]):
     """Represents a collection of File resources."""
 
     def __init__(self, context, resource_path=None, parent=None):
+        # type: (ClientContext, ResourcePath, Folder) -> None
         super(FileCollection, self).__init__(context, File, resource_path, parent)
 
     def upload(self, path_or_file):
+        # type: (str|IO) -> File
         """Uploads a file into folder.
 
         Note: This method only supports files up to 4MB in size!
@@ -34,6 +42,23 @@ class FileCollection(EntityCollection[File]):
             name = os.path.basename(path_or_file)
             return self.add(name, content, True)
 
+    def upload_with_checksum(self, file_object, chunk_size=1024):
+        # type: (IO, int) -> File
+        """ """
+        h = hashlib.sha1()  # hashlib.md5()
+        file_name = os.path.basename(file_object.name)
+        upload_id = str(uuid.uuid4())
+
+        def _upload_session(return_type):
+            # type: (File) -> None
+            content = file_object.read(chunk_size)
+            h.update(content)
+            return_type.upload_with_checksum(
+                upload_id, h.hexdigest(), content
+            ).after_execute(_upload_session)
+
+        return self.add(file_name, None, True).after_execute(_upload_session)
+
     def create_upload_session(
         self, file, chunk_size, chunk_uploaded=None, file_name=None, **kwargs
     ):
@@ -118,7 +143,7 @@ class FileCollection(EntityCollection[File]):
         return_type = File(self.context)
         self.add_child(return_type)
 
-        def _parent_folder_loaded():
+        def _add_template_file():
             params = {
                 "urlOfFile": str(
                     SPResPath.create_relative(
@@ -132,17 +157,24 @@ class FileCollection(EntityCollection[File]):
             )
             self.context.add_query(qry)
 
-        self.parent.ensure_property("ServerRelativeUrl", _parent_folder_loaded)
+        self.parent.ensure_property("ServerRelativeUrl", _add_template_file)
         return return_type
 
     def get_by_url(self, url):
+        # type: (str) -> File
         """Retrieve File object by url"""
         return File(
             self.context, ServiceOperationPath("GetByUrl", [url], self.resource_path)
         )
 
     def get_by_id(self, _id):
+        # type: (int) -> File
         """Gets the File with the specified ID."""
         return File(
             self.context, ServiceOperationPath("getById", [_id], self.resource_path)
         )
+
+    @property
+    def parent(self):
+        # type: () -> Folder
+        return self._parent

office365/sharepoint/files/file.py

@@ -64,6 +64,9 @@ class File(AbstractFile):
         else:
             return self.serverRelativeUrl or self.unique_id or self.entity_type_name
 
+    def __str__(self):
+        return self.name or self.entity_type_name
+
     @staticmethod
     def from_url(abs_url):
         """
@@ -251,20 +254,23 @@ class File(AbstractFile):
         self.context.add_query(qry)
         return self
 
-    def copyto(self, destination, overwrite=False):
-        # type: (Folder|str, bool) -> File
+    def copyto(self, destination, overwrite=False, file_name=None):
+        # type: (Folder|str, bool, str) -> "File"
         """Copies the file to the destination URL.
 
         :param office365.sharepoint.folders.folder.Folder or str destination: Specifies the destination folder or
             folder server relative url where to copy a file.
         :param bool overwrite: Specifies whether a file with the same name is overwritten.
+        :param str file_name: A new file name
         """
         return_type = File(self.context)
         self.parent_collection.add_child(return_type)
 
         def _copyto(destination_folder):
             # type: (Folder) -> None
-            file_path = "/".join([str(destination_folder.serverRelativeUrl), self.name])
+            file_path = "/".join(
+                [str(destination_folder.serverRelativeUrl), file_name or self.name]
+            )
             return_type.set_property("ServerRelativeUrl", file_path)
 
             params = {"strNewUrl": file_path, "boverwrite": overwrite}
@@ -280,7 +286,7 @@ class File(AbstractFile):
         self.ensure_properties(["ServerRelativeUrl", "Name"], _source_file_resolved)
         return return_type
 
-    def copyto_using_path(self, destination, overwrite=False):
+    def copyto_using_path(self, destination, overwrite=False, file_name=None):
         """
         Copies the file to the destination path. Server MUST overwrite an existing file of the same name
         if overwrite is true.
@@ -288,6 +294,7 @@ class File(AbstractFile):
         :param bool overwrite: Specifies whether a file with the same name is overwritten.
         :param office365.sharepoint.folders.folder.Folder or str destination: Specifies the destination folder or
             folder server relative url where to copy a file.
+        :param str file_name: New file name
         """
 
         return_type = File(self.context)
@@ -296,7 +303,7 @@ class File(AbstractFile):
         def _copyto_using_path(destination_folder):
             # type: (Folder) -> None
             file_path = "/".join(
-                [str(destination_folder.server_relative_path), self.name]
+                [str(destination_folder.server_relative_path), file_name or self.name]
             )
             return_type.set_property("ServerRelativePath", file_path)
 
@@ -473,7 +480,6 @@ class File(AbstractFile):
 
     def get_upload_status(self, upload_id):
         """Gets the status of a chunk upload session.
-
         :param str upload_id:  The upload session ID.
         """
         payload = {
@@ -493,9 +499,9 @@ class File(AbstractFile):
         :param bytes stream:
         """
         return_type = File(self.context)
-        payload = {"uploadId": upload_id, "checksum": checksum, "stream": stream}
+        params = {"uploadId": upload_id, "checksum": checksum}
         qry = ServiceOperationQuery(
-            self, "UploadWithChecksum", None, payload, None, return_type
+            self, "UploadWithChecksum", params, stream, None, return_type
         )
         self.context.add_query(qry)
         return return_type
@@ -564,6 +570,26 @@ class File(AbstractFile):
         self.context.add_query(qry)
         return self
 
+    def finish_upload_with_checksum(self, upload_id, file_offset, checksum, stream):
+        """Uploads the last file fragment and commits the file. The current file content is changed when this method
+        completes.
+
+        :param str upload_id: Upload session id
+        :param int file_offset: File offset
+        :param str checksum: File checksum
+        :param bytes stream: File content
+        """
+        payload = {
+            "uploadID": upload_id,
+            "fileOffset": file_offset,
+            "checksum": checksum,
+        }
+        qry = ServiceOperationQuery(
+            self, "FinishUploadWithChecksum", payload, stream, None, self
+        )
+        self.context.add_query(qry)
+        return self
+
     @staticmethod
     def save_binary(context, server_relative_url, content):
         """Uploads a file
@@ -734,9 +760,7 @@ class File(AbstractFile):
 
     @property
     def information_rights_management_settings(self):
-        """
-        Returns the Information Rights Management (IRM) settings for the file.
-        """
+        """Returns the Information Rights Management (IRM) settings for the file."""
         return self.properties.get(
             "InformationRightsManagementSettings",
             InformationRightsManagementFileSettings(

office365/sharepoint/files/versions/collection.py

@@ -17,6 +17,10 @@ class FileVersionCollection(EntityCollection[FileVersion]):
             ServiceOperationPath("getById", [version_id], self.resource_path),
         )
 
+    def get_by_label(self, label):
+        """Gets the file version with the specified Label."""
+        return self.single("VersionLabel eq '{0}'".format(label))
+
     def delete_all(self):
         """Deletes all the file version objects in the collection."""
         qry = ServiceOperationQuery(self, "DeleteAll")

office365/sharepoint/files/versions/event.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.sharing.shared_with_user import SharedWithUser
@@ -8,14 +10,14 @@ class FileVersionEvent(Entity):
 
     @property
     def event_type(self):
+        # type: () -> Optional[str]
         """Returns the type of the event."""
         return self.properties.get("EventType", None)
 
     @property
     def editor(self):
-        """Returns the name of the user who initiated the event.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Returns the name of the user who initiated the event."""
         return self.properties.get("Editor", None)
 
     @property
@@ -25,6 +27,7 @@ class FileVersionEvent(Entity):
 
     @property
     def shared_with_users(self):
+        # type: () -> ClientValueCollection[SharedWithUser]
         """Returns the array of users that have been shared in sharing action for the change log."""
         return self.properties.get(
             "SharedWithUsers", ClientValueCollection(SharedWithUser)

office365/sharepoint/files/versions/version.py

@@ -3,8 +3,8 @@ from typing import IO, AnyStr, Optional
 from typing_extensions import Self
 
 from office365.runtime.client_result import ClientResult
-from office365.runtime.paths.key import KeyPath
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.paths.v3.entity import EntityPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
@@ -104,9 +104,11 @@ class FileVersion(Entity):
 
     def set_property(self, key, value, persist_changes=True):
         super(FileVersion, self).set_property(key, value, persist_changes)
-        if self._resource_path is None:
-            if key == "ID":
-                self._resource_path = KeyPath(
+        if key.lower() == self.property_ref_name.lower():
+            if self._resource_path is None:
+                self._resource_path = EntityPath(
                     value, self.parent_collection.resource_path
                 )
+            else:
+                self._resource_path.patch(value)
         return self

office365/sharepoint/folders/collection.py

@@ -1,5 +1,5 @@
-from office365.runtime.paths.key import KeyPath
 from office365.runtime.paths.service_operation import ServiceOperationPath
+from office365.runtime.paths.v3.entity import EntityPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.folders.folder import Folder
@@ -46,7 +46,7 @@ class FolderCollection(EntityCollection[Folder]):
         """Adds the folder that is located at the specified URL to the collection.
         :param str name: Specifies the Name of the folder.
         """
-        return_type = Folder(self.context, KeyPath(name, self.resource_path))
+        return_type = Folder(self.context, EntityPath(name, self.resource_path))
         self.add_child(return_type)
         qry = ServiceOperationQuery(self, "Add", [name], None, None, return_type)
         self.context.add_query(qry)

office365/sharepoint/folders/folder.py

@@ -14,6 +14,7 @@ from office365.sharepoint.contenttypes.content_type_id import ContentTypeId
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.listitems.listitem import ListItem
 from office365.sharepoint.sharing.document_manager import DocumentSharingManager
+from office365.sharepoint.sharing.links.share_response import ShareLinkResponse
 from office365.sharepoint.sharing.user_sharing_result import UserSharingResult
 from office365.sharepoint.storagemetrics.storage_metrics import StorageMetrics
 from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
@@ -38,7 +39,6 @@ class Folder(Entity):
     def from_url(abs_url):
         """
         Addresses a Folder by absolute url
-
         :type abs_url: str
         """
         from office365.sharepoint.client_context import ClientContext
@@ -150,9 +150,7 @@ class Folder(Entity):
             self.set_property("ServerRelativePath", url)
 
         def _move_to_using_path(destination_folder):
-            """
-            :type destination_folder: Folder
-            """
+            # type: ("Folder") -> None
             destination_url = "/".join(
                 [str(destination_folder.server_relative_path), self.name]
             )
@@ -202,7 +200,7 @@ class Folder(Entity):
         return return_type
 
     def share_link(self, link_kind, expiration=None, role=None, password=None):
-        # type: (int, Optional[datetime], Optional[int], Optional[str]) -> str
+        # type: (int, Optional[datetime], Optional[int], Optional[str]) -> ClientResult[ShareLinkResponse]
         """Creates a tokenized sharing link for a folder based on the specified parameters and optionally
         sends an email to the people that are listed in the specified parameters.
 
@@ -514,9 +512,7 @@ class Folder(Entity):
     @property
     def is_wopi_enabled(self):
         # type: () -> Optional[bool]
-        """
-        Indicates whether the folder is enabled for WOPI default action.
-        """
+        """Indicates whether the folder is enabled for WOPI default action."""
         return self.properties.get("IsWOPIEnabled", None)
 
     @property
@@ -570,9 +566,7 @@ class Folder(Entity):
     @property
     def serverRelativeUrl(self):
         # type: () -> Optional[str]
-        """
-        Gets the server-relative URL of the list folder.
-        """
+        """Gets the server-relative URL of the list folder."""
         return self.properties.get("ServerRelativeUrl", None)
 
     @property

office365/sharepoint/internal/paths/static_operation.py

@@ -0,0 +1,9 @@
+from typing import Dict, Optional
+
+from office365.runtime.paths.service_operation import ServiceOperationPath
+
+
+class StaticOperationPath(ServiceOperationPath):
+    def __init__(self, static_name, parameters=None):
+        # type: (str, Optional[Dict]) -> None
+        super(StaticOperationPath, self).__init__(static_name, parameters)

office365/sharepoint/internal/paths/web.py

@@ -0,0 +1,20 @@
+from office365.runtime.compat import is_absolute_url, urlparse
+from office365.runtime.paths.resource_path import ResourcePath
+
+
+class WebPath(ResourcePath):
+    @property
+    def segment(self):
+        return "Web"
+
+    @property
+    def web_path(self):
+        if is_absolute_url(self._key):
+            url_parts = urlparse(self._key)
+            return url_parts.path
+        else:
+            return self._key
+
+    @property
+    def parent(self):
+        return None

office365/sharepoint/listitems/collection.py

@@ -31,3 +31,7 @@ class ListItemCollection(EntityCollection[ListItem]):
             self.context,
             ServiceOperationPath("GetByStringId", {"sId": s_id}, self.resource_path),
         )
+
+    def get_by_url(self, url):
+        """Returns the list item with the specified site or server relative url."""
+        return self.single("FileRef eq '{0}'".format(url))

office365/sharepoint/listitems/listitem.py

@@ -3,8 +3,8 @@ from typing import TYPE_CHECKING
 
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
-from office365.runtime.paths.key import KeyPath
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.paths.v3.entity import EntityPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.attachments.collection import AttachmentCollection
 from office365.sharepoint.changes.collection import ChangeCollection
@@ -241,9 +241,7 @@ class ListItem(SecurableObject):
         return return_type
 
     def unshare(self):
-        """
-        Unshare a ListItem (file or folder facet)
-        """
+        """Unshare a ListItem (file or folder facet)"""
         return_type = SharingResult(self.context)
 
         def _property_resolved():
@@ -372,10 +370,8 @@ class ListItem(SecurableObject):
 
     @property
     def display_name(self):
-        """Specifies the display name of the list item.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the display name of the list item."""
         return self.properties.get("DisplayName", None)
 
     @property
@@ -441,34 +437,26 @@ class ListItem(SecurableObject):
 
     @property
     def field_values(self):
+        # type: () -> Optional[dict]
         """Gets a collection of key/value pairs containing the names and values for the fields of the list item."""
         return self.properties.get("FieldValues", None)
 
     @property
     def comments_disabled(self):
-        """
-        Indicates whether comments for this item are disabled or not.
-
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Indicates whether comments for this item are disabled or not."""
         return self.properties.get("CommentsDisabled", None)
 
     @property
     def file_system_object_type(self):
-        """
-        Gets a value that specifies whether the list item is a file or a list folder.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets a value that specifies whether the list item is a file or a list folder"""
         return self.properties.get("FileSystemObjectType", None)
 
     @property
     def id(self):
-        """
-        Gets a value that specifies the list item identifier.
-
-        :rtype: int
-        """
+        # type: () -> Optional[int]
+        """Gets a value that specifies the list item identifier."""
         return self.properties.get("Id", None)
 
     @property
@@ -477,6 +465,7 @@ class ListItem(SecurableObject):
 
     @property
     def comments_disabled_scope(self):
+        # type: () -> Optional[str]
         """Indicates at what scope comments are disabled."""
         return self.properties.get("CommentsDisabledScope", None)
 
@@ -502,9 +491,7 @@ class ListItem(SecurableObject):
 
     @property
     def liked_by_information(self):
-        """
-        Gets a value that specifies the list item identifier.
-        """
+        """Gets a value that specifies the list item identifier."""
         return self.properties.get(
             "LikedByInformation",
             LikedByInformation(
@@ -570,17 +557,19 @@ class ListItem(SecurableObject):
             super(ListItem, self).set_property(name, value, persist_changes)
 
         # fallback: create a new resource path
-        if self._resource_path is None and self.parent_collection is not None:
-            if name == "Id":
-                self._resource_path = KeyPath(
+        if name == "Id":
+            if self._resource_path is None and self.parent_collection is not None:
+                self._resource_path = EntityPath(
                     value, self.parent_collection.resource_path
                 )
+            else:
+                self._resource_path.patch(value)
         return self
 
     def _set_taxonomy_field_value(self, name, value):
+        # type: (str, TaxonomyFieldValueCollection) -> None
         """
         Sets taxonomy field value
-
         :param str name: Taxonomy field name
         :param TaxonomyFieldValueCollection value: Taxonomy field value
         """