Skip to content
Snippets Groups Projects

Opt-in linkahead package to mypy type checking

Merged Henrik tom Wörden requested to merge f-role into dev
2 files
+ 10
5
Compare changes
  • Side-by-side
  • Inline

Files

+ 9
5
@@ -21,29 +21,33 @@
@@ -21,29 +21,33 @@
"""Convenience functions to retrieve a specific entity."""
"""Convenience functions to retrieve a specific entity."""
from typing import Union
from typing import Union, Optional
from ..common.models import Entity, execute_query
from ..common.models import Entity, execute_query
from .escape import escape_squoted_text
from .escape import escape_squoted_text
def get_entity_by_name(name: str) -> Entity:
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.
"""Return the result of a unique query that uses the name to find the correct entity.
Submits the query "FIND ENTITY WITH name='{name}'".
Submits the query "FIND ENTITY WITH name='{name}'".
"""
"""
name = escape_squoted_text(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
# type hint can be ignored, it's a unique query, so never Container or int
return execute_query(f"FIND ENTITY WITH name='{name}'", unique=True) # type: ignore
return execute_query(f"FIND {role} WITH name='{name}'", unique=True) # type: ignore
def get_entity_by_id(eid: Union[str, int]) -> Entity:
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.
"""Return the result of a unique query that uses the id to find the correct entity.
Submits the query "FIND ENTITY WITH id='{eid}'".
Submits the query "FIND ENTITY WITH id='{eid}'".
"""
"""
 
if role is None:
 
role = "ENTITY"
# type hint can be ignored, it's a unique query
# type hint can be ignored, it's a unique query
return execute_query(f"FIND ENTITY WITH id='{eid}'", unique=True) # type: ignore
return execute_query(f"FIND {role} WITH id='{eid}'", unique=True) # type: ignore
def get_entity_by_path(path: str) -> Entity:
def get_entity_by_path(path: str) -> Entity:
Loading