SharePoint API: ViewFieldCollection methods & properties, refactorings for json mapper

Author: vvgrem@gmail.com

generator/metadata/SharePoint.xml

@@ -59,6 +59,11 @@ def expand(self, names):
         return self
 
     def select(self, names):
+        """
+
+        :param list[str] names:
+        :return:
+        """
         self.query_options.select = names
         return self
 
@@ -68,13 +73,16 @@ def remove_from_parent_collection(self):
         self._parent_collection.remove_child(self)
 
     def get_property(self, name):
-        getter_name = name[0].lower() + name[1:]
-        if hasattr(self, getter_name):
-            return getattr(self, getter_name)
-        return self._properties.get(name, None)
+        """
+        Gets property value
+
+        :param str name: property name
+        """
+        normalized_name = name[0].lower() + name[1:]
+        return getattr(self, normalized_name, self._properties.get(normalized_name, None))
 
     def set_property(self, name, value, persist_changes=True):
-        """Sets Property value
+        """Sets property value
 
         :param str name: Property name
         :param any value: Property value
@@ -83,17 +91,13 @@ def set_property(self, name, value, persist_changes=True):
         if persist_changes:
             self._changed_properties.append(name)
 
-        safe_name = name[0].lower() + name[1:]
-        if hasattr(self, safe_name) and value is not None:
-            prop_type = getattr(self, safe_name)
-            if isinstance(prop_type, ClientObject) or isinstance(prop_type, ClientValue):
-                if isinstance(value, list):
-                    [prop_type.set_property(i, v, persist_changes) for i, v in enumerate(value)]
-                else:
-                    [prop_type.set_property(k, v, persist_changes) for k, v in value.items()]
-                self._properties[name] = prop_type
+        prop_type = self.get_property(name)
+        if isinstance(prop_type, ClientObject) or isinstance(prop_type, ClientValue) and value is not None:
+            if isinstance(value, list):
+                [prop_type.set_property(i, v, persist_changes) for i, v in enumerate(value)]
             else:
-                self._properties[name] = value
+                [prop_type.set_property(k, v, persist_changes) for k, v in value.items()]
+            self._properties[name] = prop_type
         else:
             self._properties[name] = value
         return self
@@ -124,6 +128,7 @@ def ensure_properties(self, names, action):
                 def _process_query(current_query):
                     if current_query.id == qry.id:
                         action()
+
                 self.context.after_execute_query(_process_query)
         else:
             action()

office365/runtime/client_object.py

@@ -41,11 +41,6 @@ def add(self, query):
     def get(self, index):
         result = [qry for qry in self.change_sets if qry.return_type is not None] + \
                  [qry for qry in self._queries if isinstance(qry, ReadEntityQuery)]
-
-        # result = [qry for qry in self._queries
-        #          if isinstance(qry, ReadEntityQuery)
-        #          or isinstance(qry, CreateEntityQuery)
-        #          or isinstance(qry, ServiceOperationQuery)]
         return result[index]
 
     @property

office365/runtime/queries/batch_query.py

@@ -342,23 +342,23 @@ def name(self):
         return self.properties.get("Name", None)
 
     @property
-    def siteId(self):
+    def site_id(self):
         """Gets the GUID that identifies the site collection containing the file.
 
         :rtype: str or None
         """
         return self.properties.get("SiteId", None)
 
     @property
-    def webId(self):
+    def web_id(self):
         """Gets the GUID for the site containing the file.
 
         :rtype: str or None
         """
         return self.properties.get("WebId", None)
 
     @property
-    def timeLastModified(self):
+    def time_last_modified(self):
         """Specifies when the file was last modified.
 
         :rtype: str or None
@@ -379,3 +379,4 @@ def set_property(self, name, value, persist_changes=True):
                     "GetFileById",
                     [value],
                     ResourcePath("Web"))
+        return self

office365/sharepoint/files/file.py

@@ -79,7 +79,7 @@ def upload_file(self, name, content):
         target_file = self.files.add(info)
         return target_file
 
-    def copyto(self, new_relative_url, overwrite):
+    def copy_to(self, new_relative_url, overwrite):
         """Copies the folder with files to the destination URL.
 
         :type new_relative_url: str
@@ -94,7 +94,7 @@ def _copy_files():
         self.ensure_property("Files", _copy_files)
         return self
 
-    def moveto(self, new_relative_url, flags):
+    def move_to(self, new_relative_url, flags):
         """Moves the folder with files to the destination URL.
 
         :type new_relative_url: str
@@ -128,6 +128,43 @@ def files(self):
             from office365.sharepoint.files.file_collection import FileCollection
             return FileCollection(self.context, ResourcePath("Files", self.resource_path))
 
+    @property
+    def unique_id(self):
+        """Gets the unique ID of the folder.
+        :rtype: str or None
+        """
+        return self.properties.get("UniqueId", None)
+
+    @property
+    def exists(self):
+        """Gets a Boolean value that indicates whether the folder exists.
+        :rtype: bool or None
+        """
+        return self.properties.get("Exists", None)
+
+    @property
+    def welcome_page(self):
+        """Specifies the server-relative URL for the list folder Welcome page.
+        :rtype: str or None
+        """
+        return self.properties.get("WelcomePage", None)
+
+    @property
+    def unique_content_type_order(self):
+        """Specifies the content type order for the list folder.
+
+        :rtype: office365.sharepoint.contenttypes.content_type_id.ContentTypeId or None
+        """
+        return self.properties.get("UniqueContentTypeOrder", None)
+
+    @property
+    def time_last_modified(self):
+        """Gets the last time this folder or a direct child was modified in UTC.
+
+        :rtype: str or None
+        """
+        return self.properties.get("TimeLastModified", None)
+
     @property
     def serverRelativeUrl(self):
         """Gets the server-relative URL of the list folder.

office365/sharepoint/folders/folder.py

@@ -25,7 +25,7 @@ def ensure_folder_path(self, path):
         """
 
         url_component = os.path.normpath(path).split(os.path.sep)
-        url_component = [part for part in url_component if part]  # ensure no empty elements
+        url_component = [part for part in url_component if part]
         if not url_component:
             raise NotADirectoryError("Wrong relative URL provided")
         child_folder = self

office365/sharepoint/folders/folder_collection.py

@@ -1,5 +1,5 @@
 from office365.runtime.client_value import ClientValue
-from office365.sharepoint.views.viewScope import ViewScope
+from office365.sharepoint.views.view_scope import ViewScope
 
 
 class CamlQuery(ClientValue):

office365/sharepoint/listitems/caml/caml_query.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class UserCustomAction(BaseEntity):
+    pass

office365/sharepoint/usercustomactions/__init__.py

@@ -15,14 +15,22 @@ def __init__(self, context, resource_path=None, parent_list=None):
         super(View, self).__init__(context, resource_path)
         self._parent_list = parent_list
 
+    def get_property(self, name):
+        if name == "ViewFields":
+            return self.view_fields
+        elif name == "DefaultView":
+            return self.default_view
+        else:
+            return super(View, self).get_property(name)
+
     def get_items(self):
         """Get list items per a view
 
         :rtype: office365.sharepoint.listitems.listItem_collection.ListItemCollection
         """
 
         def _get_items_inner():
-            caml_query = CamlQuery.parse(self.viewQuery)
+            caml_query = CamlQuery.parse(self.view_query)
             qry = ServiceOperationQuery(self._parent_list, "GetItems", None, caml_query, "query",
                                         self._parent_list.items)
             self.context.add_query(qry)
@@ -38,14 +46,14 @@ def delete_object(self):
         return self
 
     @property
-    def contentTypeId(self):
+    def content_type_id(self):
         """Gets the identifier of the content type with which the view is associated.
         :rtype: ContentTypeId
         """
         return self.properties.get("ContentTypeId", ContentTypeId())
 
-    @contentTypeId.setter
-    def contentTypeId(self, value):
+    @content_type_id.setter
+    def content_type_id(self, value):
         """Sets the identifier of the content type with which the view is associated."""
         self.set_property("ContentTypeId", value)
 
@@ -63,33 +71,30 @@ def hidden(self, value):
         self.set_property("Hidden", value)
 
     @property
-    def defaultView(self):
+    def default_view(self):
         """Gets whether the list view is the default list view.
         :rtype: bool or None
         """
         return self.properties.get("DefaultView", None)
 
-    @defaultView.setter
-    def defaultView(self, value):
+    @default_view.setter
+    def default_view(self, value):
         """Sets whether the list view is the default list view.
         """
         self.set_property("DefaultView", value)
 
     @property
-    def viewFields(self):
+    def view_fields(self):
         """Gets a value that specifies the collection of fields in the list view."""
         if self.is_property_available('ViewFields'):
             return self.properties['ViewFields']
         else:
             return ViewFieldCollection(self.context, ResourcePath("ViewFields", self.resource_path))
 
     @property
-    def viewQuery(self):
+    def view_query(self):
         """Gets or sets a value that specifies the query that is used by the list view."""
-        if self.is_property_available('ViewQuery'):
-            return self.properties['ViewQuery']
-        else:
-            return None
+        return self.properties.get('ViewQuery', None)
 
     def set_property(self, name, value, persist_changes=True):
         super(View, self).set_property(name, value, persist_changes)