linkahead.utils.get_entity module

Convenience functions to retrieve a specific entity.

linkahead.utils.get_entity.get_entity_by_id(eid: str | int, role: str | None = None) Entity

Return the result of a unique query that uses the id to find the correct entity.

Submits the query “FIND ENTITY WITH id=’{eid}’”.

linkahead.utils.get_entity.get_entity_by_name(name: str, role: str | None = None) Entity

Return the result of a unique query that uses the name to find the correct entity.

Submits the query “FIND ENTITY WITH name=’{name}’”.

linkahead.utils.get_entity.get_entity_by_path(path: str) Entity

Return the result of a unique query that uses the path to find the correct file.

Submits the query “FIND FILE WHICH IS STORED AT ‘{path}’”.