SharePoint API: Improved support for fields (create tax field, create field from schema)

Author: [email protected]

examples/sharepoint/lists_and_items/read_large_list.py

@@ -2,7 +2,7 @@
 
 from office365.runtime.auth.client_credential import ClientCredential
 from office365.sharepoint.client_context import ClientContext
-from office365.sharepoint.file_system_object_type import FileSystemObjectType
+from office365.sharepoint.files.file_system_object_type import FileSystemObjectType
 
 
 def print_progress(items_read):

office365/runtime/client_object_collection.py

@@ -6,16 +6,16 @@
 
 class ClientObjectCollection(ClientObject):
 
-    def __init__(self, context, item_type, resource_path=None):
+    def __init__(self, context, child_item_type, resource_path=None):
         """Client object collection
 
         :type context: office365.runtime.client_runtime_context.ClientRuntimeContext
-        :type item_type: type[ClientObject]
+        :type child_item_type: type[ClientObject]
         :type resource_path: office365.runtime.resource_path.ResourcePath
         """
         super(ClientObjectCollection, self).__init__(context, resource_path)
         self._data = []
-        self._item_type = item_type
+        self._item_type = child_item_type
         self.page_loaded = EventHandler(False)
         self._default_page_size = 100
         self._paged_mode = True

office365/sharepoint/base_entity.py

@@ -6,11 +6,11 @@ class BaseEntity(ClientObject):
 
     def __init__(self, context, resource_path=None, namespace="SP", parent_collection=None):
         """
-        SharePoint base entity
+        SharePoint entity
 
         :param office365.sharepoint.client_context.ClientContext context: SharePoint context
-        :param ResourcePath resource_path:
-        :param str namespace:
+        :param ResourcePath resource_path: Resource Path
+        :param str namespace:  default namespace
         """
         super().__init__(context, resource_path, None, parent_collection)
         self._namespace = namespace

office365/sharepoint/base_entity_collection.py

@@ -0,0 +1,17 @@
+from office365.runtime.client_object_collection import ClientObjectCollection
+
+
+class BaseEntityCollection(ClientObjectCollection):
+    """Represents a collection of View resources."""
+
+    def __init__(self, context, child_item_type=None, resource_path=None, parent=None):
+        """
+        SharePoint entity set
+
+        :param office365.sharepoint.client_context.ClientContext context: SharePoint context
+        :type child_item_type: type[ClientObject]
+        :type resource_path: office365.runtime.resource_path.ResourcePath
+        :type parent: office365.sharepoint.base_entity.BaseEntity or None
+        """
+        super(BaseEntityCollection, self).__init__(context, child_item_type, resource_path)
+        self._parent = parent

office365/sharepoint/eventreceivers/__init__.py

@@ -1,14 +1,18 @@
-from office365.runtime.client_object_collection import ClientObjectCollection
+import uuid
+
 from office365.runtime.queries.create_entity_query import CreateEntityQuery
+from office365.runtime.queries.service_operation_query import ServiceOperationQuery
 from office365.runtime.resource_path_service_operation import ResourcePathServiceOperation
+from office365.sharepoint.base_entity_collection import BaseEntityCollection
 from office365.sharepoint.fields.field import Field
+from office365.sharepoint.fields.xmlSchemaFieldCreationInformation import XmlSchemaFieldCreationInformation
 
 
-class FieldCollection(ClientObjectCollection):
+class FieldCollection(BaseEntityCollection):
     """Represents a collection of Field resource."""
 
-    def __init__(self, context, resource_path=None):
-        super(FieldCollection, self).__init__(context, Field, resource_path)
+    def __init__(self, context, resource_path=None, parent=None):
+        super(FieldCollection, self).__init__(context, Field, resource_path, parent)
 
     def create_typed_object(self, properties):
         field = super(FieldCollection, self).create_typed_object(properties)
@@ -25,6 +29,177 @@ def add(self, field_create_information):
         self.context.add_query(qry)
         return field
 
+    def create_taxonomy_field(self, name, ssp_id, term_set_id, anchor_id="00000000-0000-0000-0000-000000000000",
+                              field_id=None, text_field_id=None, web_id=None, list_id=None):
+
+        target_field = Field(self.context)
+        field_params = {
+            "name": name,
+            "ssp_id": ssp_id,
+            "term_set_id": term_set_id,
+            "anchor_id": anchor_id,
+            "field_id": field_id,
+            "text_field_id": text_field_id,
+            "list_id": list_id,
+            "web_id": web_id,
+            "target_field": target_field
+        }
+
+        if field_id is None:
+            field_params["field_id"] = str(uuid.uuid1())
+
+        from office365.sharepoint.lists.list import List
+        if isinstance(self._parent, List):
+            parent_list = self._parent
+
+            def _list_loaded():
+                field_params["web_id"] = parent_list.parentWeb.properties["Id"]
+                field_params["list_id"] = parent_list.properties["Id"]
+                self._create_taxonomy_field_query(**field_params)
+            self._parent.ensure_properties(["Id", "ParentWeb"], _list_loaded)
+        else:
+            def _web_loaded():
+                field_params["web_id"] = self.context.web.properties["Id"]
+                self._create_taxonomy_field_query(**field_params)
+            self.context.web.ensure_property("Id", _web_loaded)
+        return target_field
+
+    def _create_taxonomy_field_query(self, name, ssp_id, term_set_id, anchor_id,
+                                     field_id=None, text_field_id=None, web_id=None, list_id=None,
+                                     target_field=None):
+        """
+
+        :param str text_field_id: Text Field Id
+        :param str web_id: Web Id
+        :param str list_id: List Id
+        :param str field_id: Field Id
+        :type name: str
+        :type ssp_id: str
+        :type term_set_id: str
+        :type anchor_id: str
+        :type target_field: Field
+        """
+
+        list_attr = f'List="{{{list_id}}}"' if list_id is not None else ""
+
+        schema_xml = f'''
+<Field Type="TaxonomyFieldType" DisplayName="{name}" {list_attr}
+       WebId="{web_id}" Required="FALSE" EnforceUniqueValues="FALSE"
+       ID="{{{field_id}}}" StaticName="{name}" Name="{name}">
+    <Default/>
+    <Customization>
+        <ArrayOfProperty>
+            <Property>
+                <Name>SspId</Name>
+                <Value xmlns:q1="http://www.w3.org/2001/XMLSchema" p4:type="q1:string"
+                       xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">{ssp_id}
+                </Value>
+            </Property>
+            <Property>
+                <Name>GroupId</Name>
+            </Property>
+            <Property>
+                <Name>TermSetId</Name>
+                <Value xmlns:q2="http://www.w3.org/2001/XMLSchema" p4:type="q2:string"
+                       xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">{term_set_id}
+                </Value>
+            </Property>
+            <Property>
+                <Name>AnchorId</Name>
+                <Value xmlns:q3="http://www.w3.org/2001/XMLSchema" p4:type="q3:string"
+                       xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">{anchor_id}
+                </Value>
+            </Property>
+            <Property>
+                <Name>UserCreated</Name>
+                <Value xmlns:q4="http://www.w3.org/2001/XMLSchema" p4:type="q4:boolean"
+                       xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">false
+                </Value>
+            </Property>
+            <Property>
+                <Name>Open</Name>
+                <Value xmlns:q5="http://www.w3.org/2001/XMLSchema" p4:type="q5:boolean"
+                       xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">true
+                </Value>
+            </Property>
+            <Property>
+                <Name>TextField</Name>
+                <Value xmlns:q6="http://www.w3.org/2001/XMLSchema" p4:type="q6:string"
+                       xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">{{{text_field_id}}}
+                </Value>
+            </Property>
+            <Property>
+                <Name>IsPathRendered</Name>
+                <Value xmlns:q7="http://www.w3.org/2001/XMLSchema" p4:type="q7:boolean"
+                       xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">false
+                </Value>
+            </Property>
+            <Property>
+                <Name>IsKeyword</Name>
+                <Value xmlns:q8="http://www.w3.org/2001/XMLSchema" p4:type="q8:boolean"
+                       xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">false
+                </Value>
+            </Property>
+            <Property>
+                <Name>TargetTemplate</Name>
+            </Property>
+            <Property>
+                <Name>CreateValuesInEditForm</Name>
+                <Value xmlns:q9="http://www.w3.org/2001/XMLSchema" p4:type="q9:boolean"
+                       xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">false
+                </Value>
+            </Property>
+            <Property>
+                <Name>FilterAssemblyStrongName</Name>
+                <Value xmlns:q10="http://www.w3.org/2001/XMLSchema" p4:type="q10:string"
+                       xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">Microsoft.SharePoint.Taxonomy,
+                    Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c
+                </Value>
+            </Property>
+            <Property>
+                <Name>FilterClassName</Name>
+                <Value xmlns:q11="http://www.w3.org/2001/XMLSchema" p4:type="q11:string"
+                       xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">Microsoft.SharePoint.Taxonomy.TaxonomyField
+                </Value>
+            </Property>
+            <Property>
+                <Name>FilterMethodName</Name>
+                <Value xmlns:q12="http://www.w3.org/2001/XMLSchema" p4:type="q12:string"
+                       xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">GetFilteringHtml
+                </Value>
+            </Property>
+            <Property>
+                <Name>FilterJavascriptProperty</Name>
+                <Value xmlns:q13="http://www.w3.org/2001/XMLSchema" p4:type="q13:string"
+                       xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">FilteringJavascript
+                </Value>
+            </Property>
+        </ArrayOfProperty>
+    </Customization>
+</Field>
+'''
+
+        field_schema = XmlSchemaFieldCreationInformation(schema_xml)
+        self._create_field_as_xml_query(field_schema, target_field)
+
+    def create_field_as_xml(self, schema_xml):
+        """
+        :type schema_xml: str
+        """
+        field = Field(self.context)
+        field_schema = XmlSchemaFieldCreationInformation(schema_xml)
+        self._create_field_as_xml_query(field_schema, field)
+        return field
+
+    def _create_field_as_xml_query(self, schema_xml, field):
+        """
+        :type field: Field
+        :type schema_xml: XmlSchemaFieldCreationInformation
+        """
+        self.add_child(field)
+        qry = ServiceOperationQuery(self, "CreateFieldAsXml", None, schema_xml, "parameters", field)
+        self.context.add_query(qry)
+
     def get_by_id(self, _id):
         """Gets the fields with the specified ID."""
         return Field(self.context, ResourcePathServiceOperation("getById", [_id], self.resource_path))

office365/sharepoint/fields/field_collection.py

@@ -0,0 +1,13 @@
+from office365.runtime.client_value import ClientValue
+
+
+class XmlSchemaFieldCreationInformation(ClientValue):
+
+    def __init__(self, schemaXml, options=None):
+        """
+        :type schemaXml: str
+        :type options: int or None
+        """
+        super().__init__("SP")
+        self.SchemaXml = schemaXml
+        self.Options = options

office365/sharepoint/fields/xmlSchemaFieldCreationInformation.py

@@ -197,7 +197,7 @@ def fields(self):
         if self.is_property_available('Fields'):
             return self.properties['Fields']
         else:
-            return FieldCollection(self.context, ResourcePath("Fields", self.resource_path))
+            return FieldCollection(self.context, ResourcePath("Fields", self.resource_path), self)
 
     @property
     def views(self):
@@ -231,6 +231,13 @@ def forms(self):
         return self.properties.get('Forms',
                                    FormCollection(self.context, ResourcePath("forms", self.resource_path)))
 
+    @property
+    def parentWeb(self):
+        """Gets a value that specifies the web where list resides."""
+        from office365.sharepoint.webs.web import Web
+        return self.properties.get('ParentWeb',
+                                   Web(self.context, ResourcePath("parentWeb", self.resource_path)))
+
     @property
     def item_count(self):
         """Gets a value that specifies the number of list items in the list.

office365/sharepoint/file_system_object_type.py renamed to office365/sharepoint/files/file_system_object_type.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.fields.field_lookup import FieldLookup
+
+
+class TaxonomyField(FieldLookup):
+    pass