Helper for ListCorpusEntities

Closes #131 (closed)

Requires !209 (merged)

arkindex_worker/worker/entity.py

@@ -8,7 +8,7 @@ from peewee import IntegrityError
 
 from arkindex_worker import logger
 from arkindex_worker.cache import CachedElement, CachedEntity, CachedTranscriptionEntity
-from arkindex_worker.models import Element, Transcription
+from arkindex_worker.models import Corpus, Element, Transcription
 
 
 class EntityType(Enum):
@@ -193,3 +193,37 @@ class EntityMixin(object):
         return self.api_client.paginate(
             "ListTranscriptionEntities", id=transcription.id, **query_params
         )
+
+    def list_corpus_entities(
+        self,
+        corpus: Corpus,
+        name: str,
+        parent: str,
+    ):
+        """
+        List all entities in a corpus
+        This method does not support cache
+
+        :param corpus Corpus: The corpus that contains the entities to list.
+        :param name str: uuid for filter entities by part of their name (case-insensitive)
+        :param parent str: uuid for restrict entities to those linked to all transcriptions of an element and all its descendants. Note that links to metadata are ignored.
+        """
+        query_params = {}
+        assert corpus and isinstance(
+            corpus, Corpus
+        ), "corpus shouldn't be null and should be a Corpus"
+
+        assert name and isinstance(
+            name, str
+        ), "name shouldn't be null and should be of type str"
+
+        assert parent and isinstance(
+            parent, str
+        ), "parent shouldn't be null and should be of type str"
+
+        query_params["name"] = name
+        query_params["parent"] = parent
+
+        return self.api_client.paginate(
+            "ListCorpusEntities", id=corpus.id, **query_params
+        )