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

office365/sharepoint/lists/list.py

@@ -1,5 +1,6 @@
+import os
 from datetime import datetime
-from typing import Optional
+from typing import AnyStr, Optional
 
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
@@ -7,6 +8,7 @@ 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.changes.collection import ChangeCollection
+from office365.sharepoint.changes.log_item_query import ChangeLogItemQuery
 from office365.sharepoint.changes.query import ChangeQuery
 from office365.sharepoint.changes.token import ChangeToken
 from office365.sharepoint.contenttypes.collection import ContentTypeCollection
@@ -69,6 +71,9 @@ class List(SecurableObject):
     def __init__(self, context, resource_path=None):
         super(List, self).__init__(context, resource_path)
 
+    def __repr__(self):
+        return self.id or self.title or self.entity_type_name
+
     def create_document_and_get_edit_link(
         self,
         file_name=None,
@@ -130,9 +135,7 @@ class List(SecurableObject):
         return return_type
 
     def get_metadata_navigation_settings(self):
-        """
-        Retrieves the configured metadata navigation settings for the list.
-        """
+        """Retrieves the configured metadata navigation settings for the list."""
         from office365.sharepoint.navigation.metadata_settings import (
             MetadataNavigationSettings,
         )
@@ -150,12 +153,10 @@ class List(SecurableObject):
         return return_type
 
     def get_sharing_settings(self):
-        """
-        Retrieves a sharing settings for a List
-        """
+        """Retrieves a sharing settings for a List"""
         return_type = ObjectSharingSettings(self.context)
 
-        def _list_loaded():
+        def _get_sharing_settings():
             from office365.sharepoint.webs.web import Web
 
             list_abs_path = SPResPath.create_absolute(
@@ -165,7 +166,7 @@ class List(SecurableObject):
                 self.context, str(list_abs_path), return_type=return_type
             )
 
-        self.ensure_property("RootFolder", _list_loaded)
+        self.ensure_property("RootFolder", _get_sharing_settings)
         return return_type
 
     def get_site_script(self, options=None):
@@ -173,7 +174,7 @@ class List(SecurableObject):
 
         :param dict or None options:
         """
-        return_type = ClientResult(self.context)
+        return_type = ClientResult(self.context)  # type: ClientResult[str]
 
         def _list_loaded():
             list_abs_path = SPResPath.create_absolute(
@@ -187,9 +188,7 @@ class List(SecurableObject):
         return return_type
 
     def get_all_rules(self):
-        """
-        Retrieves rules of a List
-        """
+        """Retrieves rules of a List"""
         return_type = ClientResult(self.context, ClientValueCollection(SPListRule))
         qry = ServiceOperationQuery(self, "GetAllRules", None, None, None, return_type)
         self.context.add_query(qry)
@@ -278,7 +277,7 @@ class List(SecurableObject):
         :param str folder_path: The path within the current list at which to create the document.
         :param str extension: The file extension without dot prefix.
         """
-        return_type = ClientResult(self.context)
+        return_type = ClientResult(self.context)  # type: ClientResult[str]
         payload = {"folderPath": folder_path, "extension": extension}
         qry = ServiceOperationQuery(
             self, "CreateDocumentWithDefaultName", None, payload, None, return_type
@@ -375,7 +374,6 @@ class List(SecurableObject):
 
     def get_lookup_field_choices(self, target_field_name, paging_info=None):
         """
-
         :param str target_field_name:
         :param str paging_info:
         """
@@ -388,11 +386,10 @@ class List(SecurableObject):
         return return_type
 
     def get_list_item_changes_since_token(self, query):
+        # type: (ChangeLogItemQuery) -> ClientResult[AnyStr]
         """
         Returns the changes made to the list since the date and time specified in the change token defined
-        by the query input parameter.<57>
-
-        :type query: office365.sharepoint.changes.log_item_query.ChangeLogItemQuery
+        by the query input parameter.
         """
         return_type = ClientResult(self.context, bytes())
         payload = {"query": query}
@@ -435,7 +432,6 @@ class List(SecurableObject):
         :param str description: A string that contains the description for the list template.
         :param str name: A string that contains the title for the list template.
         :param str file_name: A string that contains the file name for the list template with an .stp extension.
-        :return:
         """
         payload = {
             "strFileName": file_name,
@@ -450,7 +446,6 @@ class List(SecurableObject):
     def get_item_by_unique_id(self, unique_id):
         """
         Returns the list item with the specified ID.
-
         :param str unique_id: The unique ID that is associated with the list item.
         """
         return ListItem(
@@ -459,11 +454,10 @@ class List(SecurableObject):
         )
 
     def get_web_dav_url(self, source_url):
+        # type: (str) -> ClientResult[str]
         """
         Gets the trusted URL for opening the folder in Explorer view.
-
         :param str source_url: The URL of the current folder the user is in.
-        :return: ClientResult
         """
 
         return_type = ClientResult(self.context, str())
@@ -475,10 +469,8 @@ class List(SecurableObject):
         return return_type
 
     def get_items(self, caml_query=None):
-        """Returns a collection of items from the list based on the specified query.
-
-        :type caml_query: CamlQuery
-        """
+        # type: (CamlQuery) -> ListItemCollection
+        """Returns a collection of items from the list based on the specified query."""
         if not caml_query:
             caml_query = CamlQuery.create_all_items_query()
         return_type = ListItemCollection(self.context, self.items.resource_path)
@@ -519,7 +511,6 @@ class List(SecurableObject):
     def create_wiki_page(self, page_name, page_content):
         """
         Creates a wiki page.
-
         :param str page_name:
         :param str page_content:
         """
@@ -585,18 +576,31 @@ class List(SecurableObject):
         return return_type
 
     def get_item_by_id(self, item_id):
-        """Returns the list item with the specified list item identifier.
-
-        :type item_id: int
-        """
+        # type: (int) -> ListItem
+        """Returns the list item with the specified list item identifier."""
         return ListItem(
             self.context,
             ServiceOperationPath("getItemById", [item_id], self.resource_path),
         )
 
+    def get_item_by_url(self, url):
+        # type: (str) -> ListItem
+        """Returns the list item with the specified site or server relative url."""
+        return_type = ListItem(self.context)
+        self.items.add_child(return_type)
+
+        def _after_loaded(item):
+            [return_type.set_property(k, v, False) for k, v in item.properties.items()]
+
+        def _get_item_by_url():
+            path = os.path.join(self.root_folder.serverRelativeUrl, url)
+            self.items.get_by_url(path).after_execute(_after_loaded, execute_first=True)
+
+        self.ensure_property("RootFolder", _get_item_by_url)
+        return return_type
+
     def get_view(self, view_id):
         """Returns the list view with the specified view identifier.
-
         :type view_id: str
         """
         return View(
@@ -631,10 +635,9 @@ class List(SecurableObject):
         return return_type
 
     def reserve_list_item_id(self):
-        """
-        Reserves the returned list item identifier for the idempotent creation of a list item.
-        """
-        return_type = ClientResult(self.context, int())  # type: ClientResult[int]
+        # type: () -> ClientResult[int]
+        """Reserves the returned list item identifier for the idempotent creation of a list item."""
+        return_type = ClientResult(self.context, int())
         qry = ServiceOperationQuery(
             self, "ReserveListItemId", None, None, None, return_type
         )
@@ -673,19 +676,13 @@ class List(SecurableObject):
 
     @property
     def id(self):
-        """
-        Gets a value that specifies the list identifier.
-
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Gets a value that specifies the list identifier."""
         return self.properties.get("Id", None)
 
     @property
     def additional_ux_properties(self):
-        """
-
-        :rtype: str
-        """
+        # type: () -> Optional[str]
         return self.properties.get("AdditionalUXProperties", None)
 
     @property
@@ -697,45 +694,39 @@ class List(SecurableObject):
 
     @property
     def allow_content_types(self):
-        """
-        Specifies whether the list supports content types.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether the list supports content types."""
         return self.properties.get("AllowContentTypes", None)
 
     @property
     def allow_deletion(self):
-        """
-        Specifies whether the list could be deleted.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether the list could be deleted."""
         return self.properties.get("AllowDeletion", None)
 
     @property
     def base_template(self):
-        """
-        Specifies the list server template of the list.
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Specifies the list server template of the list."""
         return self.properties.get("BaseTemplate", None)
 
     @property
     def base_type(self):
+        # type: () -> Optional[int]
         """
         Specifies the base type of the list.
         It MUST be one of the following values: GenericList, DocumentLibrary, DiscussionBoard, Survey, or Issue.
-        :rtype: int or None
         """
         return self.properties.get("BaseType", None)
 
     @property
     def browser_file_handling(self):
+        # type: () -> Optional[int]
         """
         Specifies the override at the list level for the BrowserFileHandling property of the Web application.
         If the BrowserFileHandling property of the Web application is BrowserFileHandling.Strict,
         then this setting MUST be ignored. If the BrowserFileHandling property of the Web application is
         BrowserFileHandling.Permissive, then this setting MUST be respected.
-        :rtype: int or None
         """
         return self.properties.get("BrowserFileHandling", None)
 
@@ -746,33 +737,29 @@ class List(SecurableObject):
 
     @property
     def default_display_form_url(self):
-        """
-        Specifies the location of the default display form for the list.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the location of the default display form for the list."""
         return self.properties.get("DefaultDisplayFormUrl", None)
 
     @property
     def default_view_path(self):
-        """
-        Specifies the server-relative URL of the default view for the list.
-        """
+        """Specifies the server-relative URL of the default view for the list."""
         return self.properties.get("DefaultViewPath", SPResPath())
 
     @property
     def default_view_url(self):
+        # type: () -> Optional[str]
         """
         Specifies the server-relative URL of the default view for the list.
-        :rtype: str or None
         """
         return self.properties.get("DefaultViewUrl", None)
 
     @property
     def crawl_non_default_views(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether or not the crawler indexes the non-default views of the list.
         Specify a value of true if the crawler indexes the list's non-default views; specify false if otherwise.
-        :rtype: bool or None
         """
         return self.properties.get("CrawlNonDefaultViews", None)
 
@@ -809,41 +796,33 @@ class List(SecurableObject):
 
     @property
     def default_edit_form_url(self):
-        """
-        Gets a value that specifies the URL of the edit form to use for list items in the list.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets a value that specifies the URL of the edit form to use for list items in the list."""
         return self.properties.get("DefaultEditFormUrl", None)
 
     @property
     def default_item_open_in_browser(self):
-        """
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
         return self.properties.get("DefaultItemOpenInBrowser", None)
 
     @property
     def default_item_open_use_list_setting(self):
+        # type: () -> Optional[bool]
         """
         This property returns whether to use the List setting or the server wide setting for
         DefaultItemOpen (BrowserEnabledDocuments setting) in the Web application. This property can only be set to
         false, thereby using the server-wide setting. To set it to use List setting, set the value for DefaultItemOpen.
-        :rtype: bool or None
         """
         return self.properties.get("DefaultItemOpenUseListSetting", None)
 
     @property
     def disable_commenting(self):
-        """
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
         return self.properties.get("DisableCommenting", None)
 
     @property
     def disable_grid_editing(self):
-        """
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
         return self.properties.get("DisableGridEditing", None)
 
     @property
@@ -869,103 +848,89 @@ class List(SecurableObject):
 
     @property
     def enable_assign_to_email(self):
+        # type: () -> Optional[bool]
         """
         Gets or sets a Boolean value specifying whether e-mail notification is enabled for the list.
-        :rtype: bool or None
         """
         return self.properties.get("EnableAssignToEmail", None)
 
     @property
     def enable_attachments(self):
-        """
-        Specifies whether list item attachments are enabled for the list.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether list item attachments are enabled for the list"""
         return self.properties.get("EnableAttachments", None)
 
     @property
     def enable_folder_creation(self):
-        """
-        Specifies whether new list folders can be added to the list.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether new list folders can be added to the list."""
         return self.properties.get("EnableFolderCreation", None)
 
     @enable_folder_creation.setter
     def enable_folder_creation(self, value):
+        # type: (bool) -> None
         self.set_property("EnableFolderCreation", value, True)
 
     @property
     def enable_minor_versions(self):
-        """
-        Specifies whether minor versions are enabled for the list.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether minor versions are enabled for the list."""
         return self.properties.get("EnableMinorVersions", None)
 
     @property
     def enable_moderation(self):
-        """
-        Specifies whether content approval is enabled for the list.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether content approval is enabled for the list."""
         return self.properties.get("EnableModeration", None)
 
     @property
     def enable_request_sign_off(self):
-        """
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
         return self.properties.get("EnableRequestSignOff", None)
 
     @property
     def enable_versioning(self):
-        """
-        Specifies whether content approval is enabled for the list.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether content approval is enabled for the list."""
         return self.properties.get("EnableVersioning", None)
 
     @property
     def exclude_from_offline_client(self):
+        # type: () -> Optional[bool]
         """
         This doesn't block sync but acts as a recommendation to the client to not take this list offline.
         This gets returned as part of list properties in GetListSchema soap call.
-        :rtype: bool or None
         """
         return self.properties.get("ExcludeFromOfflineClient", None)
 
     @property
     def exempt_from_block_download_of_non_viewable_files(self):
+        # type: () -> Optional[bool]
         """
         Property indicating whether the list is exempt from the policy to block download of non-server handled files.
         This SHOULD be set using the SetExemptFromBlockDownloadOfNonViewableFiles (section 3.2.5.79.2.1.25) method.
-        :rtype: bool or None
         """
         return self.properties.get("ExemptFromBlockDownloadOfNonViewableFiles", None)
 
     @property
     def file_save_post_processing_enabled(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether or not the files in the list can be processed in asynchronous manner
         Specify a value of true if the list files can be processed asynchronously; specify false if otherwise.
-        :rtype: bool or None
         """
         return self.properties.get("FileSavePostProcessingEnabled", None)
 
     @property
     def force_checkout(self):
-        """
-        Specifies whether check out is required when adding or editing documents in the list.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether check out is required when adding or editing documents in the list"""
         return self.properties.get("ForceCheckout", None)
 
     @property
     def has_content_assembly_templates(self):
-        """
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """ """
         return self.properties.get("HasContentAssemblyTemplates", None)
 
     @property
@@ -1039,35 +1004,34 @@ class List(SecurableObject):
 
     @property
     def content_types_enabled(self):
-        """Specifies whether content types are enabled for the list.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether content types are enabled for the list."""
         return self.properties.get("ContentTypesEnabled", None)
 
     @property
     def is_private(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether the list is a private list with restricted permissions.
         True if the list is a private list, otherwise False.
-        :rtype: bool or None
         """
         return self.properties.get("IsPrivate", None)
 
     @property
     def is_site_assets_library(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether the list is designated as a default asset location for images or other files which the
         users upload to their wiki pages.
-        :rtype: bool or None
         """
         return self.properties.get("IsSiteAssetsLibrary", None)
 
     @property
     def is_system_list(self):
+        # type: () -> Optional[bool]
         """
         Indicates whether the list is system list that does not contain end user data and created by system account.
         A value of True means yes.
-        :rtype: bool or None
         """
         return self.properties.get("IsSystemList", None)
 
@@ -1117,10 +1081,8 @@ class List(SecurableObject):
 
     @property
     def item_count(self):
-        """
-        Gets a value that specifies the number of list items in the list.
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Gets a value that specifies the number of list items in the list"""
         return self.properties.get("ItemCount", None)
 
     @property
@@ -1150,33 +1112,32 @@ class List(SecurableObject):
 
     @property
     def list_experience_options(self):
+        # type: () -> Optional[int]
         """
         Gets or sets the list to new experience, classic experience or default experience set by my administrator.
-        :rtype: int or None
         """
         return self.properties.get("ListExperienceOptions", None)
 
     @property
     def list_form_customized(self):
-        """
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """ """
         return self.properties.get("ListFormCustomized", None)
 
     @property
     def list_item_entity_type_full_name(self):
+        # type: () -> Optional[str]
         """
         Specifies the full type name of the list item.
-        :rtype: str or None
         """
         return self.properties.get("ListItemEntityTypeFullName", None)
 
     @property
     def major_version_limit(self):
+        # type: () -> Optional[int]
         """
         Gets the maximum number of major versions allowed for an item in a document library that uses version
         control with major versions only.
-        :rtype: int or None
         """
         return self.properties.get("MajorVersionLimit", None)
 
@@ -1242,33 +1203,27 @@ class List(SecurableObject):
 
     @property
     def read_security(self):
-        """
-        Gets or sets the Read security setting for the list.
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Gets or sets the Read security setting for the list."""
         return self.properties.get("ReadSecurity", None)
 
     @property
     def server_template_can_create_folders(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether the list template the list is based on allows the creation of folders.
-        :rtype: bool or None
         """
         return self.properties.get("ServerTemplateCanCreateFolders", None)
 
     @property
     def show_hidden_fields_in_modern_form(self):
-        """
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
         return self.properties.get("ShowHiddenFieldsInModernForm", None)
 
     @property
     def title(self):
         # type: () -> Optional[str]
-        """
-        Gets the displayed title for the list.
-        """
+        """Gets the displayed title for the list."""
         return self.properties.get("Title", None)
 
     @title.setter
@@ -1278,22 +1233,22 @@ class List(SecurableObject):
 
     @property
     def default_content_approval_workflow_id(self):
+        # type: () -> Optional[str]
         """
         Specifies the default workflow identifier for content approval on the list. It MUST be an empty GUID
-        if there is no default content approval workflow.
-        :rtype: str
+        if there is no default content approval workflow
         """
         return self.properties.get("DefaultContentApprovalWorkflowId", None)
 
     @property
     def description(self):
-        """Gets the description for the list.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the description for the list."""
         return self.properties.get("Description", None)
 
     @description.setter
     def description(self, val):
+        # type: (str) -> None
         """Sets the description for the list."""
         self.set_property("Description", val)
 
@@ -1314,18 +1269,16 @@ class List(SecurableObject):
 
     @property
     def schema_xml(self):
-        """
-        Specifies the list schema of the list.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the list schema of the list."""
         return self.properties.get("SchemaXml", None)
 
     @property
     def template_feature_id(self):
+        # type: () -> Optional[str]
         """
         Specifies the feature identifier of the feature that contains the list schema for the list.
         It MUST be an empty GUID if the list schema for the list is not contained within a feature.
-        :rtype: str or None
         """
         return self.properties.get("TemplateFeatureId", None)
 

office365/sharepoint/marketplace/app_metadata_collection.py

@@ -3,7 +3,9 @@ from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.marketplace.app_metadata import CorporateCatalogAppMetadata
 
 
-class CorporateCatalogAppMetadataCollection(EntityCollection):
+class CorporateCatalogAppMetadataCollection(
+    EntityCollection[CorporateCatalogAppMetadata]
+):
     """Collection of app metadata."""
 
     def __init__(self, context, resource_path=None):