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

office365/sharepoint/files/versions/version.py

@@ -1,7 +1,10 @@
+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.service_operation import ServiceOperationPath
+from office365.runtime.paths.v3.entity import EntityPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
@@ -9,25 +12,30 @@ from office365.sharepoint.entity import Entity
 class FileVersion(Entity):
     """Represents a version of a File object."""
 
+    def __str__(self):
+        return self.version_label
+
+    def __repr__(self):
+        return "Is Current: {0}, {1}".format(
+            self.is_current_version, self.version_label
+        )
+
     def download(self, file_object):
-        """Downloads the file version as a stream and save into a file.
+        # type: (IO) -> Self
+        """Downloads the file version as a stream and save into a file."""
 
-        :type file_object: typing.IO
-        """
+        def _save_file(return_type):
+            # type: (ClientResult[AnyStr]) -> None
+            file_object.write(return_type.value)
 
         def _file_version_loaded():
-            def _save_file(return_type):
-                """
-                :type return_type:ClientResult
-                """
-                file_object.write(return_type.value)
-
             self.open_binary_stream().after_execute(_save_file)
 
         self.ensure_property("ID", _file_version_loaded)
         return self
 
     def open_binary_stream(self):
+        # type: () -> ClientResult[AnyStr]
         """Opens the file as a stream."""
         return_type = ClientResult(self.context)
         qry = ServiceOperationQuery(
@@ -37,6 +45,7 @@ class FileVersion(Entity):
         return return_type
 
     def open_binary_stream_with_options(self, open_options):
+        # type: (int) -> ClientResult[AnyStr]
         """Opens the file as a stream."""
         return_type = ClientResult(self.context)
         qry = ServiceOperationQuery(
@@ -57,30 +66,32 @@ class FileVersion(Entity):
 
     @property
     def id(self):
+        # type: () -> Optional[int]
         """Gets a file version identifier"""
         return int(self.properties.get("ID", -1))
 
     @property
     def url(self):
+        # type: () -> Optional[str]
         """Gets a value that specifies the relative URL of the file version based on the URL for the site or subsite."""
         return self.properties.get("Url", None)
 
     @property
     def version_label(self):
+        # type: () -> Optional[str]
         """Gets a value that specifies the implementation specific identifier of the file."""
         return self.properties.get("VersionLabel", None)
 
     @property
     def is_current_version(self):
+        # type: () -> Optional[bool]
         """Gets a value that specifies whether the file version is the current version."""
         return self.properties.get("IsCurrentVersion", None)
 
     @property
     def checkin_comment(self):
-        """Gets a value that specifies the check-in comment.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets a value that specifies the check-in comment."""
         return self.properties.get("CheckInComment", None)
 
     def get_property(self, name, default_value=None):
@@ -93,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
@@ -15,22 +15,20 @@ class FolderCollection(EntityCollection[Folder]):
     def add_using_path(self, decoded_url, overwrite):
         """
         Adds the folder located at the specified path to the collection.
-
         :param str decoded_url: Specifies the path for the folder.
         :param bool overwrite:  bool
         """
         parameters = {"DecodedUrl": decoded_url, "Overwrite": overwrite}
-        target_folder = Folder(self.context)
+        return_type = Folder(self.context)
         qry = ServiceOperationQuery(
-            self, "AddUsingPath", parameters, None, None, target_folder
+            self, "AddUsingPath", parameters, None, None, return_type
         )
         self.context.add_query(qry)
-        return target_folder
+        return return_type
 
     def ensure_path(self, path):
         """
         Ensures a folder exist
-
         :param str path: server or site relative url to a folder
         """
         path = path.replace(self.context.site_path, "")
@@ -46,10 +44,9 @@ class FolderCollection(EntityCollection[Folder]):
 
     def add(self, name):
         """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)
@@ -57,7 +54,6 @@ class FolderCollection(EntityCollection[Folder]):
 
     def get_by_url(self, url):
         """Retrieve Folder resource by url
-
         :param str url: Specifies the URL of the list folder. The URL MUST be an absolute URL, a server-relative URL,
             a site-relative URL relative to the site (2) containing the collection of list folders, or relative to the
             list folder that directly contains this collection of list folders.
@@ -69,7 +65,6 @@ class FolderCollection(EntityCollection[Folder]):
     def get_by_path(self, decoded_url):
         """
         Get folder at the specified path.
-
         :param str decoded_url: Specifies the path for the folder.
         """
         return Folder(

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
@@ -28,11 +29,16 @@ if TYPE_CHECKING:
 class Folder(Entity):
     """Represents a folder in a SharePoint Web site."""
 
+    def __str__(self):
+        return self.name
+
+    def __repr__(self):
+        return self.serverRelativeUrl or self.unique_id or self.entity_type_name
+
     @staticmethod
     def from_url(abs_url):
         """
         Addresses a Folder by absolute url
-
         :type abs_url: str
         """
         from office365.sharepoint.client_context import ClientContext
@@ -54,12 +60,31 @@ class Folder(Entity):
             self, download_file, after_file_downloaded, recursive
         )
 
+    def get_folders(self, recursive=False):
+        """
+        Retrieves folders
+        :param bool recursive: Determines whether to enumerate folders recursively
+        """
+        from office365.sharepoint.folders.collection import FolderCollection  # noqa
+
+        return_type = FolderCollection(self.context, self.folders.resource_path, self)
+
+        def _loaded(parent):
+            # type: ("Folder") -> None
+            [return_type.add_child(f) for f in parent.folders]
+            if recursive:
+                for folder in parent.folders:
+                    folder.ensure_properties(["Folders"], _loaded, parent=folder)
+
+        self.ensure_properties(["Folders"], _loaded, parent=self)
+        return return_type
+
     def get_files(self, recursive=False):
         """
         Retrieves files
         :param bool recursive: Determines whether to enumerate folders recursively
         """
-        from office365.sharepoint.files.collection import FileCollection
+        from office365.sharepoint.files.collection import FileCollection  # noqa
 
         return_type = FileCollection(self.context, self.files.resource_path, self)
 
@@ -125,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]
             )
@@ -177,18 +200,19 @@ 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]) -> 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.
 
-        :param int link_kind: The kind of the tokenized sharing link to be created/updated or retrieved.
-        :param datetime.datetime or None expiration: A date/time string for which the format conforms to the ISO 8601:2004(E)
+        :param link_kind: The kind of the tokenized sharing link to be created/updated or retrieved.
+        :param expiration: A date/time string for which the format conforms to the ISO 8601:2004(E)
             complete representation for calendar date and time of day and which represents the time and date of expiry
             for the tokenized sharing link. Both the minutes and hour value MUST be specified for the difference
             between the local and UTC time. Midnight is represented as 00:00:00. A null value indicates no expiry.
             This value is only applicable to tokenized sharing links that are anonymous access links.
-        :param int role: The role to be used for the tokenized sharing link. This is required for Flexible links
+        :param role: The role to be used for the tokenized sharing link. This is required for Flexible links
             and ignored for all other kinds.
-        :param str password: Optional password value to apply to the tokenized sharing link,
+        :param password: Optional password value to apply to the tokenized sharing link,
             if it can support password protection.
         """
         return self.list_item_all_fields.share_link(
@@ -264,10 +288,8 @@ class Folder(Entity):
         return self.folders.add(name)
 
     def rename(self, name):
-        """Rename a Folder resource
-
-        :type name: str
-        """
+        # type: (str) -> Self
+        """Rename a Folder resource"""
         item = self.list_item_all_fields
         item.set_property("Title", name)
         item.set_property("FileLeafRef", name)
@@ -428,6 +450,7 @@ class Folder(Entity):
 
     @property
     def storage_metrics(self):
+        # type: () -> StorageMetrics
         """Specifies the storage-related metrics for list folders in the site"""
         return self.properties.get(
             "StorageMetrics",
@@ -451,7 +474,7 @@ class Folder(Entity):
     def files(self):
         # type: () -> FileCollection
         """Specifies the collection of files contained in the list folder."""
-        from office365.sharepoint.files.collection import FileCollection
+        from office365.sharepoint.files.collection import FileCollection  # noqa
 
         return self.properties.get(
             "Files",
@@ -464,7 +487,7 @@ class Folder(Entity):
     def folders(self):
         # type: () -> FolderCollection
         """Specifies the collection of list folders contained within the list folder."""
-        from office365.sharepoint.folders.collection import FolderCollection
+        from office365.sharepoint.folders.collection import FolderCollection  # noqa
 
         return self.properties.get(
             "Folders",
@@ -489,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
@@ -545,17 +566,13 @@ 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
     def server_relative_path(self):
         # type: () -> Optional[SPResPath]
-        """
-        Gets the server-relative Path of the list folder.
-        """
+        """Gets the server-relative Path of the list folder."""
         return self.properties.get("ServerRelativePath", SPResPath())
 
     @property

office365/sharepoint/forms/collection.py

@@ -3,7 +3,7 @@ from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.forms.form import Form
 
 
-class FormCollection(EntityCollection):
+class FormCollection(EntityCollection[Form]):
     def __init__(self, context, resource_path=None):
         """Specifies a collection of list forms for a list."""
         super(FormCollection, self).__init__(context, Form, resource_path)

office365/sharepoint/forms/form.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 
@@ -7,19 +9,17 @@ class Form(Entity):
 
     @property
     def form_type(self):
+        # type: () -> Optional[str]
         """
         Gets the type of the form.
-
-        :rtype: str or None
         """
         return self.properties.get("FormType", None)
 
     @property
     def server_relative_url(self):
+        # type: () -> Optional[str]
         """
         Gets the server-relative URL of the form.
-
-        :rtype: str or None
         """
         return self.properties.get("ServerRelativeUrl", None)
 

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

@@ -1,9 +1,10 @@
 import json
+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
@@ -33,6 +34,10 @@ from office365.sharepoint.ui.applicationpages.peoplepicker.web_service_interface
     ClientPeoplePickerWebServiceInterface,
 )
 
+if TYPE_CHECKING:
+    import datetime
+    from typing import Optional
+
 
 class ListItem(SecurableObject):
     """An individual entry within a SharePoint list. Each list item has a schema that maps to fields in the list
@@ -50,28 +55,31 @@ class ListItem(SecurableObject):
             self.set_property("ParentList", parent_list, False)
 
     def share_link(self, link_kind, expiration=None, role=None, password=None):
+        # type: (int, Optional[datetime.datetime], Optional[int], Optional[str]) -> ClientResult[ShareLinkResponse]
         """Creates a tokenized sharing link for a list item based on the specified parameters and optionally
         sends an email to the people that are listed in the specified parameters.
 
-        :param int link_kind: The kind of the tokenized sharing link to be created/updated or retrieved.
-        :param datetime.datetime or None expiration: A date/time string for which the format conforms to the ISO 8601:2004(E)
+        :param link_kind: The kind of the tokenized sharing link to be created/updated or retrieved.
+        :param expiration: A date/time string for which the format conforms to the ISO 8601:2004(E)
             complete representation for calendar date and time of day and which represents the time and date of expiry
             for the tokenized sharing link. Both the minutes and hour value MUST be specified for the difference
             between the local and UTC time. Midnight is represented as 00:00:00. A null value indicates no expiry.
             This value is only applicable to tokenized sharing links that are anonymous access links.
-        :param int role: The role to be used for the tokenized sharing link. This is required for Flexible links
+        :param role: The role to be used for the tokenized sharing link. This is required for Flexible links
             and ignored for all other kinds.
-        :param str password: Optional password value to apply to the tokenized sharing link,
+        :param password: Optional password value to apply to the tokenized sharing link,
             if it can support password protection.
         """
-        return_type = ClientResult(
-            self.context, ShareLinkResponse()
-        )  # type: ClientResult[ShareLinkResponse]
+        return_type = ClientResult(self.context, ShareLinkResponse())
         request = ShareLinkRequest(
             settings=ShareLinkSettings(
                 link_kind=link_kind, expiration=expiration, role=role, password=password
             )
         )
+        if password:
+            request.settings.allowAnonymousAccess = True
+            request.settings.updatePassword = True
+
         payload = {"request": request}
         qry = ServiceOperationQuery(self, "ShareLink", None, payload, None, return_type)
         self.context.add_query(qry)
@@ -233,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():
@@ -364,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
@@ -402,7 +406,9 @@ class ListItem(SecurableObject):
     def attachment_files(self):
         # type: () -> AttachmentCollection
         """Specifies the collection of attachments that are associated with the list item.<62>"""
-        from office365.sharepoint.attachments.collection import AttachmentCollection
+        from office365.sharepoint.attachments.collection import (
+            AttachmentCollection,  # noqa
+        )
 
         return self.properties.get(
             "AttachmentFiles",
@@ -431,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
@@ -467,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)
 
@@ -492,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(
@@ -560,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
         """

office365/sharepoint/listitems/versions/collection.py

@@ -7,7 +7,7 @@ from office365.sharepoint.listitems.versions.get_parameters import (
 from office365.sharepoint.listitems.versions.version import ListItemVersion
 
 
-class ListItemVersionCollection(EntityCollection):
+class ListItemVersionCollection(EntityCollection[ListItemVersion]):
     """Specifies a collection of versions of a list item."""
 
     def __init__(self, context, resource_path=None):

office365/sharepoint/listitems/versions/version.py

@@ -1,30 +1,39 @@
 import datetime
+from typing import TYPE_CHECKING, Optional
 
 from office365.runtime.paths.resource_path import ResourcePath
-from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.sharepoint.entity import Entity
 
+if TYPE_CHECKING:
+    from office365.sharepoint.listitems.versions.collection import (
+        ListItemVersionCollection,
+    )
+
 
 class ListItemVersion(Entity):
     """Represents a version of a list item."""
 
+    def __repr__(self):
+        return "Label: {0}, Url: {1}".format(
+            self.version_label, self.properties.get("FileRef", None)
+        )
+
     @property
     def version_id(self):
+        # type: () -> Optional[int]
         """Gets the ID of the version."""
-        return int(self.properties.get("VersionId", -1))
+        return int(self.properties.get("VersionId", None))
 
     @property
     def version_label(self):
-        """Gets the version number of the item version.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the version number of the item version."""
         return self.properties.get("VersionLabel", None)
 
     @property
     def is_current_version(self):
-        """Gets a value that specifies whether the file version is the current version.
-        :rtype: bool
-        """
+        # type: () -> Optional[bool]
+        """Gets a value that specifies whether the file version is the current version."""
         return self.properties.get("IsCurrentVersion", None)
 
     @property
@@ -68,9 +77,7 @@ class ListItemVersion(Entity):
 
     @property
     def parent_collection(self):
-        """
-        :rtype: office365.sharepoint.listitems.versions.collection.ListItemVersionCollection
-        """
+        # type: () -> ListItemVersionCollection
         return self._parent_collection
 
     def get_property(self, name, default_value=None):