Skip to content
Snippets Groups Projects
Select Git revision
  • df3264981ff5449434028b73ab22c5d15aac5106
  • main default protected
  • dev
  • f-docs-pylib
  • f-parse-value
  • f-compare
  • f-string-ids
  • f-217-set-special-property
  • f-filesystem-import
  • f-filesystem-link
  • f-filesystem-directory
  • f-filesystem-core
  • f-filesystem-cleanup
  • f-check-merge-entities
  • f-compare-enid
  • f-select-subproperties
  • v0.18.0
  • v0.17.0
  • v0.16.0
  • v0.15.1
  • v0.15.0
  • v0.14.0
  • v0.13.2
  • v0.13.1
  • v0.13.0
  • linkahead-rename-step-2
  • linkahead-rename-step-1
  • v0.12.0
  • v0.11.2
  • v0.11.1
  • v0.11.0
  • v0.10.0
  • v0.9.0
  • v0.8.0
  • v0.7.4
  • v0.7.3
36 results

get_entity.py

Blame
  • Code owners
    Assign users and groups as approvers for specific file changes. Learn more.
    get_entity.py 2.25 KiB
    # -*- coding: utf-8 -*-
    #
    # This file is a part of the LinkAhead Project.
    #
    # Copyright (C) 2023 Henrik tom Wörden <h.tomwoerden@indiscale.com>
    # Copyright (C) 2023 IndiScale GmbH <info@indiscale.com>
    #
    # This program is free software: you can redistribute it and/or modify
    # it under the terms of the GNU Affero General Public License as
    # published by the Free Software Foundation, either version 3 of the
    # License, or (at your option) any later version.
    #
    # This program is distributed in the hope that it will be useful,
    # but WITHOUT ANY WARRANTY; without even the implied warranty of
    # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    # GNU Affero General Public License for more details.
    #
    # You should have received a copy of the GNU Affero General Public License
    # along with this program. If not, see <https://www.gnu.org/licenses/>.
    #
    
    """Convenience functions to retrieve a specific entity."""
    
    from typing import Union, Optional
    
    from ..common.models import Entity, execute_query
    from .escape import escape_squoted_text
    
    
    def get_entity_by_name(name: str, role: Optional[str] = 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}'".
        """
        name = escape_squoted_text(name)
        if role is None:
            role = "ENTITY"
        # type hint can be ignored, it's a unique query, so never Container or int
        return execute_query(f"FIND {role} WITH name='{name}'", unique=True)  # type: ignore
    
    
    def get_entity_by_id(eid: Union[str, int], role: Optional[str] = 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}'".
        """
        if role is None:
            role = "ENTITY"
        # type hint can be ignored, it's a unique query
        return execute_query(f"FIND {role} WITH id='{eid}'", unique=True)  # type: ignore
    
    
    def 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}'".
        """
        # type hint can be ignored, it's a unique query
        return execute_query(f"FIND FILE WHICH IS STORED AT '{path}'", unique=True)  # type: ignore