SharePoint API list namespace updates

Author: vgrem

examples/sharepoint/files/get_file_properties.py

@@ -7,9 +7,12 @@
 file_url = '/sites/team/Shared Documents/big_buck_bunny.mp4'
 file = ctx.web.get_file_by_server_relative_url(file_url).get().execute_query()
 
+
 # print all file properties
 print(json.dumps(file.properties, indent=4))
 
 # or directly via object properties
 print("file size: ", file.length)
 print("file name: ", file.name)
+
+

examples/sharepoint/listitems/read_listitems.py

@@ -1,9 +1,9 @@
 from office365.sharepoint.client_context import ClientContext
+from office365.sharepoint.listitems.listitem import ListItem
 from tests import test_client_credentials, test_team_site_url
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
-tasks_list = ctx.web.lists.get_by_title("Tasks")
+tasks_list = ctx.web.lists.get_by_title("Company Tasks")
 items = tasks_list.items.get().select(["*", "Author/Id", "Author/Title", "Editor/Title"]).expand(["Author", "Editor"]).execute_query()
-for item in items:
+for item in items:  # type:ListItem
     print("{0}".format(item.properties.get('Author').get("Title")))
-

examples/sharepoint/lists/read_list.py

@@ -5,4 +5,3 @@
 
 target_list = ctx.web.lists.get_by_title("Site Pages").get().execute_query()
 print("List title: {0}".format(target_list.title))
-

examples/sharepoint/lists/read_list_via_query.py

@@ -1,12 +1,9 @@
 from office365.sharepoint.client_context import ClientContext
 from office365.sharepoint.listitems.caml.query import CamlQuery
+from office365.sharepoint.listitems.listitem import ListItem
 from tests import test_client_credentials, test_team_site_url
 
 
-def print_progress(items_read):
-    print("Items read: {0}".format(items_read))
-
-
 def create_paged_query(page_size):
     qry = CamlQuery()
     qry.ViewXml = f"""
@@ -19,10 +16,9 @@ def create_paged_query(page_size):
 
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
-target_list = ctx.web.lists.get_by_title("Tasks")
+target_list = ctx.web.lists.get_by_title("Contacts_Large")
 list_qry = create_paged_query(50)
 items = target_list.get_items(list_qry).execute_query()
 print("Loaded items count: {0}".format(len(items)))
-for index, item in enumerate(items):
-    pass
-    #print("{0}: {1}".format(index, item.properties['Title']))
+for index, item in enumerate(items):  # type: int, ListItem
+    print("{0}: {1}".format(index, item.properties['Title']))

office365/sharepoint/contenttypes/content_type.py

@@ -95,6 +95,7 @@ def group(self, value):
     @property
     def schema_xml(self):
         """Specifies the XML schema that represents the content type.
+
         :rtype: str or None
         """
         return self.properties.get("SchemaXml", None)

office365/sharepoint/listitems/caml/query.py

@@ -27,7 +27,8 @@ def __init__(self, dates_in_utc=True, view_xml=None, listitem_collection_positio
     @staticmethod
     def parse(query_expr, scope=ViewScope.DefaultValue):
         """
-        Construct CamlQuery object from expression
+        Initiates a CamlQuery object from a query expression
+
         :type query_expr: str
         :type scope: ViewScope
         """
@@ -47,11 +48,13 @@ def create_all_items_query():
 
     @staticmethod
     def create_all_folders_query():
+        """Constructs a query to return folder objects"""
         qry_text = "<Where><Eq><FieldRef Name=\"FSObjType\" /><Value Type=\"Integer\">1</Value></Eq></Where>"
         return CamlQuery.parse(qry_text, ViewScope.RecursiveAll)
 
     @staticmethod
     def create_all_files_query():
+        """Constructs a query to return file objects"""
         qry_text = "<Where><Eq><FieldRef Name=\"FSObjType\" /><Value Type=\"Integer\">0</Value></Eq></Where>"
         return CamlQuery.parse(qry_text, ViewScope.RecursiveAll)
 

office365/sharepoint/listitems/compliance_info.py

@@ -0,0 +1,16 @@
+from office365.runtime.client_value import ClientValue
+
+
+class ListItemComplianceInfo(ClientValue):
+
+    def __init__(self, compliance_tag=None, tag_policy_event_based=None, tag_policy_hold=None, tag_policy_record=None):
+        """
+        :param str compliance_tag:
+        :param bool tag_policy_event_based:
+        :param bool tag_policy_hold:
+        :param bool tag_policy_record:
+        """
+        self.ComplianceTag = compliance_tag
+        self.TagPolicyEventBased = tag_policy_event_based
+        self.TagPolicyHold = tag_policy_hold
+        self.TagPolicyRecord = tag_policy_record

office365/sharepoint/listitems/creation_information.py

@@ -3,21 +3,18 @@
 
 class ListItemCreationInformation(ClientValue):
 
-    def __init__(self, leafName=None, folderUrl=None, underlyingObjectType=None):
+    def __init__(self, leaf_name=None, folder_url=None, underlying_object_type=None):
         """
         Specifies the properties of the new list item.
 
-        :param int underlyingObjectType: Specifies whether the new list item is a file or a folder.
-        :param str leafName: Specifies the name of the new list item. It MUST be the name of the file if the parent
+        :param int underlying_object_type: Specifies whether the new list item is a file or a folder.
+        :param str leaf_name: Specifies the name of the new list item. It MUST be the name of the file if the parent
             list of the list item is a document library.
-        :param str folderUrl: Specifies the folder for the new list item. It MUST be NULL, empty, a server-relative
+        :param str folder_url: Specifies the folder for the new list item. It MUST be NULL, empty, a server-relative
             URL, or an absolute URL. If the value is a server-relative URL or an absolute URL, it MUST be under the root
             folder of the list.
-
-
-
         """
         super(ListItemCreationInformation, self).__init__()
-        self.FolderUrl = folderUrl
-        self.LeafName = leafName
-        self.UnderlyingObjectType = underlyingObjectType
+        self.FolderUrl = folder_url
+        self.LeafName = leaf_name
+        self.UnderlyingObjectType = underlying_object_type

office365/sharepoint/listitems/listitem.py

@@ -10,6 +10,7 @@
 from office365.sharepoint.fields.lookup_value import FieldLookupValue
 from office365.sharepoint.fields.multi_lookup_value import FieldMultiLookupValue
 from office365.sharepoint.likes.liked_by_information import LikedByInformation
+from office365.sharepoint.listitems.compliance_info import ListItemComplianceInfo
 from office365.sharepoint.listitems.form_update_value import ListItemFormUpdateValue
 from office365.sharepoint.listitems.version import ListItemVersion
 from office365.sharepoint.permissions.securable_object import SecurableObject
@@ -350,6 +351,8 @@ def field_values(self):
     @property
     def comments_disabled(self):
         """
+        Indicates whether comments for this item are disabled or not.
+
         :rtype: bool or None
         """
         return self.properties.get("CommentsDisabled", None)
@@ -358,6 +361,7 @@ def comments_disabled(self):
     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
         """
         return self.properties.get("FileSystemObjectType", None)
@@ -366,15 +370,19 @@ def file_system_object_type(self):
     def id(self):
         """
         Gets a value that specifies the list item identifier.
+
         :rtype: int
         """
         return self.properties.get("Id", None)
 
+    @property
+    def compliance_info(self):
+        return self.properties.get("ComplianceInfo", ListItemComplianceInfo())
+
     @property
     def liked_by_information(self):
         """
         Gets a value that specifies the list item identifier.
-        :rtype: LikedByInformation
         """
         return self.properties.get("LikedByInformation",
                                    LikedByInformation(self.context,
@@ -392,6 +400,7 @@ def get_property(self, name, default_value=None):
             property_mapping = {
                 "AttachmentFiles": self.attachment_files,
                 "ContentType": self.content_type,
+                "ComplianceInfo": self.compliance_info,
                 "EffectiveBasePermissions": self.effective_base_permissions,
                 "LikedByInformation": self.liked_by_information,
                 "ParentList": self.parent_list,

office365/sharepoint/lists/creatable_item_info.py

@@ -0,0 +1,21 @@
+from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+
+
+class CreatableItemInfo(ClientValue):
+    """
+    Information on a creatable item: what the item is and where to go to create it. Alternatively, the information
+    provided here can be used to call CreateDocument (section 3.2.5.79.2.2.9) or
+    CreateDocumentAndGetEditLink (section 3.2.5.79.2.1.13).
+    """
+
+
+class CreatableItemInfoCollection(ClientValue):
+    """Represents a collection of CreatableItemInfo (section 3.2.5.283) objects."""
+
+    def __init__(self, items=None):
+        """
+        :param list[CreatableItemInfo] items:
+        """
+        super(CreatableItemInfoCollection, self).__init__()
+        self.Items = ClientValueCollection(CreatableItemInfo, items)

office365/sharepoint/lists/creatables_info.py

@@ -0,0 +1,58 @@
+from office365.sharepoint.base_entity import BaseEntity
+from office365.sharepoint.lists.creatable_item_info import CreatableItemInfoCollection
+
+
+class CreatablesInfo(BaseEntity):
+    """
+    Returns an object that describes what this list can create, and a collection of links to visit in order to create
+    those things. If it can't create certain things, it contains an error message describing why.
+
+    The consumer MUST append the encoded URL of the current page to the links returned here.
+    (This page the link goes to needs it as a query parameter to function correctly.) The consumer SHOULD also consider
+    appending &IsDlg=1 to the link, to remove the UI from the linked page, if desired.
+    """
+
+    @property
+    def can_create_folders(self):
+        """
+        Indicates if the user is able to create folders in the current list. The user MUST have the appropriate
+        permissions and the list MUST allow folder creation.
+
+        :rtype: bool or None
+        """
+        return self.properties.get("CanCreateFolders", None)
+
+    @property
+    def can_create_items(self):
+        """
+        Indicates whether this list can create items (such as documents (Word/Excel/PowerPoint))
+        using Microsoft Office Online.
+
+        :rtype: bool or None
+        """
+        return self.properties.get("CanCreateItems", None)
+
+    @property
+    def can_upload_files(self):
+        """
+        Indicates whether the user is able to upload files to this list.
+
+        :rtype: bool or None
+        """
+        return self.properties.get("CanUploadFiles", None)
+
+    @property
+    def creatables_collection(self):
+        """
+        Represents a collection of CreatableItemInfo (section 3.2.5.283) objects describing what can be created,
+        one CreatableItemInfo for each creatable type.
+        """
+        return self.properties.get("CreatablesCollection", CreatableItemInfoCollection())
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "CreatablesCollection": self.creatables_collection
+            }
+            default_value = property_mapping.get(name, None)
+        return super(CreatablesInfo, self).get_property(name, default_value)

office365/sharepoint/lists/creation_information.py

@@ -9,8 +9,8 @@ def __init__(self, title=None, description=None, base_template=None, allow_conte
 
         :type base_template: int or None
         :type allow_content_types: bool
-        :type description: str or None
-        :type title: str
+        :poram str or None description: Specifies the description of the new list.
+        :param str title: Specifies the display name of the new list.
         """
         super(ListCreationInformation, self).__init__()
         self.Title = title

office365/sharepoint/lists/document_template_type.py

@@ -0,0 +1,11 @@
+class DocumentTemplateType:
+    """Specifies the type for the document template (1) for the new list."""
+
+    Invalid = 0
+    """Invalid document template."""
+
+    Word = 1
+    """Word template."""
+
+    Excel = 2
+    """Excel template."""