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

office365/sharepoint/usercustomactions/action.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
@@ -6,50 +8,40 @@ class UserCustomAction(Entity):
 
     @property
     def client_side_component_id(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """"""
         return self.properties.get("ClientSideComponentId", None)
 
     @property
     def script_block(self):
-        """
-        Gets the value that specifies the ECMAScript to be executed when the custom action is performed.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the value that specifies the ECMAScript to be executed when the custom action is performed."""
         return self.properties.get("ScriptBlock", None)
 
     @script_block.setter
     def script_block(self, value):
+        # type: (str) -> None
         """
         Sets the value that specifies the ECMAScript to be executed when the custom action is performed.
-
-        :type value: str
         """
         self.set_property("ScriptBlock", value)
 
     @property
     def script_src(self):
-        """
-        Gets a value that specifies the URI of a file which contains the ECMAScript to execute on the page
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets a value that specifies the URI of a file which contains the ECMAScript to execute on the page"""
         return self.properties.get("ScriptSrc", None)
 
     @script_src.setter
     def script_src(self, value):
+        # type: (str) -> None
         """
         Sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page
-
-        :type value: str
         """
         self.set_property("ScriptSrc", value)
 
     @property
     def url(self):
-        """
-        Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action."""
         return self.properties.get("Url", None)

office365/sharepoint/userprofiles/followed_content.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
@@ -25,20 +27,14 @@ class FollowedContent(Entity):
 
     @property
     def followed_documents_url(self):
-        """
-        The FollowedDocumentsUrl property gets the location of the followed documents view.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The FollowedDocumentsUrl property gets the location of the followed documents view."""
         return self.properties.get("FollowedDocumentsUrl", None)
 
     @property
     def followed_sites_url(self):
-        """
-        The FollowedSitesUrl property gets the location of the followed sites view.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The FollowedSitesUrl property gets the location of the followed sites view."""
         return self.properties.get("FollowedSitesUrl", None)
 
     @property

office365/sharepoint/userprofiles/people_manager.py

@@ -80,7 +80,6 @@ class PeopleManager(Entity):
         Gets the people who are following the specified user.
 
         :param str account_name: Account name of the specified user.
-        :return:
         """
         return_type = EntityCollection(self.context, PersonProperties)
         params = {"accountName": account_name}

office365/sharepoint/userprofiles/person_properties.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.entity import Entity
 
@@ -10,29 +12,20 @@ class PersonProperties(Entity):
 
     @property
     def account_name(self):
-        """
-        The AccountName property specifies the person's account name.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The AccountName property specifies the person's account name."""
         return self.properties.get("AccountName", None)
 
     @property
     def email(self):
-        """
-        The Email property specifies the person's email address.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The Email property specifies the person's email address."""
         return self.properties.get("Email", None)
 
     @property
     def latest_post(self):
-        """
-        The  LatestPost property specifies the person's latest microblog post.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The  LatestPost property specifies the person's latest microblog post."""
         return self.properties.get("LatestPost", None)
 
     @property
@@ -45,11 +38,8 @@ class PersonProperties(Entity):
 
     @property
     def personal_url(self):
-        """
-        The PersonalUrl property specifies the absolute URL of the person's personal page.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The PersonalUrl property specifies the absolute URL of the person's personal page."""
         return self.properties.get("PersonalUrl", None)
 
     @property
@@ -70,20 +60,14 @@ class PersonProperties(Entity):
 
     @property
     def picture_url(self):
-        """
-        The PictureUrl property specifies the  URL for the person's profile picture.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The PictureUrl property specifies the  URL for the person's profile picture."""
         return self.properties.get("PictureUrl", None)
 
     @property
     def user_url(self):
-        """
-        The UserUrl property specifies the URL for the person's profile.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The UserUrl property specifies the URL for the person's profile."""
         return self.properties.get("UserUrl", None)
 
     @property

office365/sharepoint/userprofiles/personal_cache.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
@@ -21,9 +23,8 @@ class PersonalCache(Entity):
 
     @property
     def cache_name(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """"""
         return self.properties.get("CacheName", None)
 
     @property

office365/sharepoint/userprofiles/properties_for_user.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -21,11 +23,8 @@ class UserProfilePropertiesForUser(Entity):
 
     @property
     def account_name(self):
-        """
-        The AccountName property specifies the account name of the user.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The AccountName property specifies the account name of the user."""
         return self.properties.get("AccountName", None)
 
     @property

office365/sharepoint/userprofiles/sharedwithme/document.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+from typing import Optional
 
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.sharepoint.entity import Entity
@@ -12,41 +13,33 @@ class SharedWithMeDocument(Entity):
 
     @property
     def authors(self):
-        """
-        Specifies a list of users that authored the document.
-        """
+        # type: () -> ClientValueCollection[SharedWithMeDocumentUser]
+        """Specifies a list of users that authored the document."""
         return self.properties.get(
             "Authors", ClientValueCollection(SharedWithMeDocumentUser)
         )
 
     @property
     def caller_stack(self):
-        """
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """ """
         return self.properties.get("CallerStack", None)
 
     @property
     def content_type_id(self):
-        """
-        Specifies the identifier of the content type of the document.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Specifies the identifier of the content type of the document."""
         return self.properties.get("ContentTypeId", None)
 
     @property
     def doc_id(self):
-        """
-        Specifies the document identifier.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Specifies the document identifier."""
         return self.properties.get("DocId", None)
 
     @property
     def editors(self):
-        """
-        Specifies a list of users that can edit the document.
-        """
+        """Specifies a list of users that can edit the document."""
         return self.properties.get(
             "Editors", ClientValueCollection(SharedWithMeDocumentUser)
         )
@@ -58,10 +51,8 @@ class SharedWithMeDocument(Entity):
 
     @property
     def file_leaf_ref(self):
-        """
-        Specifies the name of the document.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Specifies the name of the document."""
         return self.properties.get("FileLeafRef", None)
 
     @property

office365/sharepoint/utilities/move_copy_util.py

@@ -1,5 +1,5 @@
 import os
-from typing import IO, TYPE_CHECKING, Callable
+from typing import IO, TYPE_CHECKING, AnyStr, Callable
 
 from office365.runtime.client_result import ClientResult
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -156,7 +156,8 @@ class MoveCopyUtil(Entity):
         """
         import zipfile
 
-        def _get_file_name(file):
+        def _get_relative_file_path(file):
+            # type: (File) -> str
             return os.path.join(
                 file.parent_folder.serverRelativeUrl.replace(
                     remove_folder.serverRelativeUrl, ""
@@ -164,27 +165,26 @@ class MoveCopyUtil(Entity):
                 file.name,
             )
 
-        def _after_downloaded(result, file):
-            """
-            :type result: ClientResult
-            :type file: office365.sharepoint.files.file.File
-            """
-            filename = _get_file_name(file)
-            if callable(after_file_downloaded):
-                after_file_downloaded(file)
-            with zipfile.ZipFile(download_file.name, "a", zipfile.ZIP_DEFLATED) as zf:
-                zf.writestr(filename, result.value)
+        def _download_file(file):
+            # type: (File) -> None
+
+            def _after_downloaded(result):
+                # type: (ClientResult[AnyStr]) -> None
+                filename = _get_relative_file_path(file)
+                if callable(after_file_downloaded):
+                    after_file_downloaded(file)
+                with zipfile.ZipFile(
+                    download_file.name, "a", zipfile.ZIP_DEFLATED
+                ) as zf:
+                    zf.writestr(filename, result.value)
+
+            file.get_content().after_execute(_after_downloaded)
 
         def _download_folder(folder):
-            """
-            :type folder: office365.sharepoint.folders.folder.Folder
-            """
+            # type: (Folder) -> None
 
             def _download_files(rt):
-                [
-                    file.get_content().after_execute(_after_downloaded, file)
-                    for file in folder.files
-                ]
+                [_download_file(file) for file in folder.files]
                 if recursive:
                     [_download_folder(sub_folder) for sub_folder in folder.folders]
 

office365/sharepoint/utilities/upload_status.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
@@ -6,27 +8,22 @@ class UploadStatus(Entity):
 
     @property
     def expected_content_range(self):
+        # type: () -> Optional[str]
         """The string representation of the byte offset of the stream uploaded in chunk upload session that the
         next ContinueUpload (3.2.5.64.2.1.17) call uses to continue chunk upload.
-
-        :rtype: str or None
         """
         return self.properties.get("ExpectedContentRange", None)
 
     @property
     def expiration_date_time(self):
-        """The earliest time at which the chunk upload session will be automatically expired and then deleted.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The earliest time at which the chunk upload session will be automatically expired and then deleted."""
         return self.properties.get("ExpirationDateTime", None)
 
     @property
     def upload_id(self):
-        """Unique Id of the chunk session upload.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Unique Id of the chunk session upload."""
         return self.properties.get("UploadId", None)
 
     @property

office365/sharepoint/views/field_collection.py

@@ -1,3 +1,5 @@
+from typing import List, Optional
+
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
@@ -12,10 +14,8 @@ class ViewFieldCollection(Entity):
         return len(self.items)
 
     def __getitem__(self, index):
-        """
-        Gets view field by index
-        :param int index: Index
-        """
+        # type: (int) -> str
+        """Gets view field by index"""
         return self.items[index]
 
     def __repr__(self):
@@ -23,17 +23,14 @@ class ViewFieldCollection(Entity):
 
     @property
     def schema_xml(self):
-        """
-        Gets Schema Xml.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets Schema Xml."""
         return self.properties.get("SchemaXml", None)
 
     @property
     def items(self):
-        """Gets items.
-        :rtype: list[str] or None
-        """
+        # type: () -> Optional[List[str]]
+        """Gets items."""
         return self.properties.get("Items", None)
 
     def set_property(self, name, value, persist_changes=False):
@@ -63,9 +60,7 @@ class ViewFieldCollection(Entity):
         return self
 
     def remove_all_view_fields(self):
-        """
-        Removes all the fields from the collection.
-        """
+        """Removes all the fields from the collection."""
         qry = ServiceOperationQuery(self, "RemoveAllViewFields")
         self.context.add_query(qry)
         return self

office365/sharepoint/views/view.py

@@ -1,3 +1,5 @@
+from typing import TYPE_CHECKING, Optional
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -9,6 +11,9 @@ from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 from office365.sharepoint.views.field_collection import ViewFieldCollection
 from office365.sharepoint.views.visualization import Visualization
 
+if TYPE_CHECKING:
+    from office365.sharepoint.views.collection import ViewCollection
+
 
 class View(Entity):
     """Specifies a List View."""
@@ -37,9 +42,7 @@ class View(Entity):
         return return_type
 
     def render_as_html(self):
-        """
-        Returns the list view as HTML.
-        """
+        """Returns the list view as HTML."""
         return_type = ClientResult(self.context)
         qry = ServiceOperationQuery(self, "RenderAsHtml", None, None, None, return_type)
         self.context.add_query(qry)
@@ -56,43 +59,35 @@ class View(Entity):
 
     @property
     def aggregations(self):
-        """
-        Specifies fields (2) and functions that define totals shown in a list view.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies fields and functions that define totals shown in a list view."""
         return self.properties.get("Aggregations", None)
 
     @property
     def aggregations_status(self):
+        # type: () -> Optional[str]
         """
         Specifies whether totals are shown in the list view.
         It MUST be NULL If Aggregations is NULL; otherwise it MUST be "On" or "Off".
-        :rtype: str or None
         """
         return self.properties.get("AggregationsStatus", None)
 
     @property
     def associated_content_type_id(self):
-        """
-        Represents the content type identifier associated with the view.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Represents the content type identifier associated with the view."""
         return self.properties.get("AssociatedContentTypeId", None)
 
     @property
     def calendar_view_styles(self):
-        """
-        Represents an object specifying the style of a SharePoint calendar view.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Represents an object specifying the style of a SharePoint calendar view."""
         return self.properties.get("CalendarViewStyles", None)
 
     @property
     def column_width(self):
-        """
-        Specifies the width of columns.
-        :rtype: str or None
-        """
+        # type: () -> Optional[int]
+        """Specifies the width of columns."""
         return self.properties.get("ColumnWidth", None)
 
     @property
@@ -102,24 +97,19 @@ class View(Entity):
 
     @property
     def parent_collection(self):
-        """
-        :rtype: office365.sharepoint.views.collection.ViewCollection
-        """
+        # type: () -> ViewCollection
         return self._parent_collection
 
     @property
     def js_link(self):
-        """
-        Specifies the JavaScript files used for the view.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the JavaScript files used for the view."""
         return self.properties.get("JSLink", None)
 
     @property
     def content_type_id(self):
-        """Gets the identifier of the content type with which the view is associated.
-        :rtype: ContentTypeId
-        """
+        # type: () -> Optional[ContentTypeId]
+        """Gets the identifier of the content type with which the view is associated."""
         return self.properties.get("ContentTypeId", ContentTypeId())
 
     @content_type_id.setter
@@ -129,64 +119,55 @@ class View(Entity):
 
     @property
     def custom_formatter(self):
-        """
-        Specifies the Custom Formatter used for the view.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the Custom Formatter used for the view."""
         return self.properties.get("CustomFormatter", None)
 
     @property
     def custom_order(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """"""
         return self.properties.get("CustomOrder", None)
 
     @property
     def editor_modified(self):
-        """Specifies whether the list view was modified in an editor.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether the list view was modified in an editor."""
         return self.properties.get("EditorModified", None)
 
     def formats(self):
-        """Specifies the column and row formatting for the list view.
-        :stype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the column and row formatting for the list view."""
         return self.properties.get("Formats", None)
 
     @property
     def hidden(self):
-        """Gets whether the list view is hidden.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Gets whether the list view is hidden."""
         return self.properties.get("Hidden", None)
 
     @hidden.setter
     def hidden(self, value):
+        # type: (bool) -> None
         """Sets whether the list view is hidden."""
         self.set_property("Hidden", value)
 
     @property
     def default_view(self):
-        """Gets whether the list view is the default list view.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Gets whether the list view is the default list view."""
         return self.properties.get("DefaultView", None)
 
     @default_view.setter
     def default_view(self, value):
-        """
-        Sets whether the list view is the default list view.
-        """
+        # type: (bool) -> None
+        """Sets whether the list view is the default list view."""
         self.set_property("DefaultView", value)
 
     @property
     def default_view_for_content_type(self):
-        """
-        Specifies whether the list view is the default list view for the content type specified by ContentTypeId.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether the list view is the default list view for the content type specified by ContentTypeId."""
         return self.properties.get("DefaultViewForContentType", None)
 
     @property
@@ -201,18 +182,18 @@ class View(Entity):
 
     @property
     def view_query(self):
-        """
-        Gets or sets a value that specifies the query that is used by the list view.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets or sets a value that specifies the query that is used by the list view."""
         return self.properties.get("ViewQuery", None)
 
     @property
     def base_view_id(self):
+        # type: () -> Optional[str]
         """Gets a value that specifies the base view identifier of the list view."""
         return self.properties.get("BaseViewId", None)
 
     def read_only_view(self):
+        # type: () -> Optional[bool]
         """Specifies whether the list view is read-only."""
         return self.properties.get("ReadOnlyView", None)
 
@@ -223,10 +204,8 @@ class View(Entity):
 
     @property
     def view_joins(self):
-        """
-        Specifies the joins that are used in the list view
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the joins that are used in the list view"""
         return self.properties.get("ViewJoins", None)
 
     @property