Skip to content
Snippets Groups Projects

Helper for ListCorpusEntities

Merged Thibault Lavigne requested to merge helper-for-list-corpus-entities into master
All threads resolved!
2 files
+ 31
18
Compare changes
  • Side-by-side
  • Inline
Files
2
@@ -197,37 +197,32 @@ class EntityMixin(object):
def list_corpus_entities(
self,
corpus: Corpus,
name: str = None,
parent: str or Element = None,
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: For filter entities by part of their name (case-insensitive)
: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"
if name is not None:
assert name and isinstance(name, str), "name should be of type str"
query_params["name"] = name
if parent is not None:
assert (
parent
and isinstance(parent, str)
or parent
and isinstance(parent, Element)
), "parent should be of type str or Element"
query_params["parent"] = parent
if type(parent) == Element:
query_params["parent"] = parent.id
query_params["name"] = name
query_params["parent"] = parent
return self.api_client.paginate(
"ListCorpusEntities", id=corpus.id, **query_params
Loading