SharePoint API: TaxonomyService methods

vvgrem@gmail.com · vvgrem@gmail.com · commit 37d5d25d238b · 2020-11-12T00:13:09.000+02:00
diff --git a/office365/sharepoint/fields/field.py b/office365/sharepoint/fields/field.py
@@ -24,7 +24,7 @@ def resolve_field_type(type_id_or_name):
         from office365.sharepoint.fields.field_text import FieldText
         from office365.sharepoint.fields.field_url import FieldUrl
         from office365.sharepoint.fields.field_user import FieldUser
-        from office365.sharepoint.taxonomy.taxonomyField import TaxonomyField
+        from office365.sharepoint.taxonomy.taxonomy_field import TaxonomyField
         field_known_types = {
             FieldType.Text: FieldText,
             FieldType.Calculated: FieldCalculated,
diff --git a/office365/sharepoint/sitepages/__init__.py b/office365/sharepoint/sitepages/__init__.py
diff --git a/office365/sharepoint/taxonomy/taxonomyService.py b/office365/sharepoint/taxonomy/taxonomyService.py
diff --git a/office365/sharepoint/taxonomy/taxonomy_field.py b/office365/sharepoint/taxonomy/taxonomy_field.py
diff --git a/office365/sharepoint/taxonomy/taxonomy_service.py b/office365/sharepoint/taxonomy/taxonomy_service.py
@@ -0,0 +1,28 @@
+from office365.runtime.client_runtime_context import ClientRuntimeContext
+from office365.runtime.odata.odata_request import ODataRequest
+from office365.runtime.odata.v4_json_format import V4JsonFormat
+from office365.runtime.resource_path import ResourcePath
+from office365.sharepoint.taxonomy.term_store import TermStore
+
+
+class TaxonomyService(ClientRuntimeContext):
+    """Wraps all of the associated TermStore objects for an Site object."""
+
+    def __init__(self, context):
+        """
+
+        :param ClientContext context:
+        """
+        super().__init__(context)
+        self._pendingRequest = ODataRequest(self, V4JsonFormat("minimal"))
+        self._service_root_url = f"{context.service_root_url()}v2.1/"
+
+    def pending_request(self):
+        return self._pendingRequest
+
+    def service_root_url(self):
+        return self._service_root_url
+
+    @property
+    def term_store(self):
+        return TermStore(self, ResourcePath("termStore", None))
diff --git a/office365/sharepoint/taxonomy/term.py b/office365/sharepoint/taxonomy/term.py
@@ -0,0 +1,5 @@
+from office365.runtime.client_object import ClientObject
+
+
+class Term(ClientObject):
+    pass
diff --git a/office365/sharepoint/taxonomy/termGroup.py b/office365/sharepoint/taxonomy/termGroup.py
diff --git a/office365/sharepoint/taxonomy/termGroupCollection.py b/office365/sharepoint/taxonomy/termGroupCollection.py
@@ -1,5 +1,5 @@
 from office365.runtime.client_object_collection import ClientObjectCollection
-from office365.sharepoint.taxonomy.termGroup import TermGroup
+from office365.sharepoint.taxonomy.term_group import TermGroup
 
 
 class TermGroupCollection(ClientObjectCollection):
diff --git a/office365/sharepoint/taxonomy/termSetCollection.py b/office365/sharepoint/taxonomy/termSetCollection.py
@@ -0,0 +1,8 @@
+from office365.runtime.client_object_collection import ClientObjectCollection
+from office365.sharepoint.taxonomy.term_set import TermSet
+
+
+class TermSetCollection(ClientObjectCollection):
+
+    def __init__(self, context, resource_path=None):
+        super(TermSetCollection, self).__init__(context, TermSet, resource_path)
diff --git a/office365/sharepoint/taxonomy/termStore.py b/office365/sharepoint/taxonomy/termStore.py
diff --git a/office365/sharepoint/taxonomy/term_collection.py b/office365/sharepoint/taxonomy/term_collection.py
@@ -0,0 +1,8 @@
+from office365.runtime.client_object_collection import ClientObjectCollection
+from office365.sharepoint.taxonomy.term import Term
+
+
+class TermCollection(ClientObjectCollection):
+
+    def __init__(self, context, resource_path=None):
+        super(TermCollection, self).__init__(context, Term, resource_path)
diff --git a/office365/sharepoint/taxonomy/term_group.py b/office365/sharepoint/taxonomy/term_group.py
@@ -0,0 +1,19 @@
+from office365.runtime.resource_path import ResourcePath
+from office365.sharepoint.base_entity import BaseEntity
+from office365.sharepoint.taxonomy.termSetCollection import TermSetCollection
+
+
+class TermGroup(BaseEntity):
+    """Represents the top-level container in a TermStore object."""
+
+    @property
+    def termSets(self):
+        return self.properties.get("termSets",
+                                   TermSetCollection(self.context, ResourcePath("termSets", self.resource_path)))
+
+    def set_property(self, name, value, persist_changes=True):
+        super(TermGroup, self).set_property(name, value, persist_changes)
+        if self._resource_path is None:
+            if name == "id":
+                self._resource_path = ResourcePath(value, self._parent_collection.resource_path)
+        return self
diff --git a/office365/sharepoint/taxonomy/term_set.py b/office365/sharepoint/taxonomy/term_set.py
@@ -0,0 +1,12 @@
+from office365.runtime.client_object import ClientObject
+from office365.runtime.resource_path import ResourcePath
+
+
+class TermSet(ClientObject):
+
+    def set_property(self, name, value, persist_changes=True):
+        super(TermSet, self).set_property(name, value, persist_changes)
+        if self._resource_path is None:
+            if name == "id":
+                self._resource_path = ResourcePath(value, self._parent_collection.resource_path)
+        return self
diff --git a/office365/sharepoint/taxonomy/term_store.py b/office365/sharepoint/taxonomy/term_store.py
@@ -0,0 +1,59 @@
+from office365.runtime.client_object import ClientObject
+from office365.runtime.queries.service_operation_query import ServiceOperationQuery
+from office365.runtime.resource_path import ResourcePath
+from office365.sharepoint.taxonomy.termGroupCollection import TermGroupCollection
+from office365.sharepoint.taxonomy.termSetCollection import TermSetCollection
+from office365.sharepoint.taxonomy.term_collection import TermCollection
+
+
+class TermStore(ClientObject):
+    """Represents a hierarchical or flat set of Term objects known as a 'TermSet'."""
+
+    def search_term(self, label, setId, parentTermId=None, languageTag=None):
+        """
+
+        :param str label:
+        :param str setId:
+        :param str or None parentTermId:
+        :param str or None languageTag:
+        :return:
+        """
+        return_type = TermCollection(self.context)
+        params = {"label": label, "setId": setId, "parentTermId": parentTermId, "languageTag": languageTag}
+        qry = ServiceOperationQuery(self, "searchTerm", None, params, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    @property
+    def id(self):
+        """
+        :rtype: str
+        """
+        return self.properties.get("id", None)
+
+    @property
+    def name(self):
+        """
+        :rtype: str
+        """
+        return self.properties.get("name", None)
+
+    @property
+    def default_language_tag(self):
+        """
+        :rtype: str
+        """
+        return self.properties.get("defaultLanguageTag", None)
+
+    @property
+    def language_tags(self):
+        """
+        :rtype: list[str]
+         """
+        return self.properties.get("languageTags", [])
+
+    @property
+    def term_groups(self):
+        return self.properties.get("termGroups",
+                                   TermGroupCollection(self.context, ResourcePath("termGroups", self.resource_path)))
+
diff --git a/tests/sharepoint/test_taxonomy.py b/tests/sharepoint/test_taxonomy.py
@@ -1,30 +1,42 @@
-from office365.sharepoint.taxonomy.taxonomyField import TaxonomyField
-from office365.sharepoint.taxonomy.taxonomyService import TaxonomyService
-from office365.sharepoint.taxonomy.termStore import TermStore
-
-from tests.sharepoint.sharepoint_case import SPTestCase
-
 from office365.sharepoint.fields.field import Field
+from office365.sharepoint.taxonomy.taxonomy_field import TaxonomyField
+from office365.sharepoint.taxonomy.taxonomy_service import TaxonomyService
+from office365.sharepoint.taxonomy.term_store import TermStore
+from office365.sharepoint.taxonomy.term_group import TermGroup
+from tests.sharepoint.sharepoint_case import SPTestCase
 
 
 class TestSPTaxonomy(SPTestCase):
     target_field = None  # type: Field
+    tax_svc = None  # type: TaxonomyService
 
     @classmethod
     def setUpClass(cls):
         super(TestSPTaxonomy, cls).setUpClass()
+        cls.tax_svc = TaxonomyService(cls.client)
 
     @classmethod
     def tearDownClass(cls):
         pass
 
     def test1_get_term_store(self):
-        tax_session = TaxonomyService(self.client)
-        term_store = tax_session.term_store.get().execute_query()
+        term_store = self.tax_svc.term_store.get().execute_query()
         self.assertIsInstance(term_store, TermStore)
         self.assertIsNotNone(term_store.name)
 
-    def test2_create_list_tax_field(self):
+    def test2_get_term_groups(self):
+        term_groups = self.tax_svc.term_store.term_groups.get().top(1).execute_query()
+        if len(term_groups) > 0:
+            self.assertIsInstance(term_groups[0], TermGroup)
+            self.assertEqual(1, len(term_groups))
+
+    def test3_get_term_sets(self):
+        pass
+
+    def test4_search_term(self):
+        pass
+
+    def test5_create_list_tax_field(self):
         ssp_id = "f02be691-d551-462f-aaae-e1c89168cd0b"
         term_set_id = "b49f64b3-4722-4336-9a5c-56c326b344d4"
         text_field_id = "cd790052-00e3-4317-a090-365cd85795b6"
@@ -38,7 +50,7 @@ def test2_create_list_tax_field(self):
         self.assertIsNotNone(tax_field.resource_path)
         self.__class__.target_field = tax_field
 
-    def test3_get_tax_field(self):
+    def test5_get_tax_field(self):
         existing_field = self.__class__.target_field.get().execute_query()
         self.assertTrue(existing_field.properties.get('TypeAsString'), 'TaxonomyFieldType')
         self.assertIsInstance(existing_field, TaxonomyField)
@@ -52,7 +64,7 @@ def test3_get_tax_field(self):
         self.client.execute_batch()
         self.assertIsNotNone(text_field.internal_name)
 
-    def test4_delete_tax_field(self):
+    def test6_delete_tax_field(self):
         self.__class__.target_field.delete_object().execute_query()
 
         # text_field_id = self.__class__.target_field.properties.get('TextField')

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +from office365.runtime.client_object import ClientObject
++
++
 +class Term(ClientObject):
 +    pass