Source code for betty.jinja2.test

"""
Provide Betty's default Jinja2 tests.
"""
from __future__ import annotations

from typing import Any, TypeVar

from betty.json.linked_data import LinkedDataDumpable
from betty.locale import DateRange
from betty.model import Entity, GeneratedEntityId, UserFacingEntity, get_entity_type
from betty.model.ancestry import HasLinks, HasFiles, Subject, Witness, is_private, is_public, Event
from betty.model.event_type import StartOfLifeEventType, EndOfLifeEventType

T = TypeVar('T')



[docs]
def test_linked_data_dumpable(value: Any) -> bool:
    """
    Test if a value can be dumped to Linked Data.
    """
    return isinstance(value, LinkedDataDumpable)




[docs]
def test_entity(value: Any, entity_type_name: str | None = None) -> bool:
    """
    Test if a value is an entity.

    :param entity_type_name: If given, additionally ensure the value is an entity of this type.
    """
    cls = get_entity_type(entity_type_name) if entity_type_name else Entity
    return isinstance(value, cls)




[docs]
def test_user_facing_entity(value: Any) -> bool:
    """
    Test if a value is an entity of a user-facing type.
    """
    return isinstance(value, UserFacingEntity)




[docs]
def test_has_links(value: Any) -> bool:
    """
    Test if a value has external links associated with it.
    """
    return isinstance(value, HasLinks)




[docs]
def test_has_files(value: Any) -> bool:
    """
    Test if a value has file entities associated with it.
    """
    return isinstance(value, HasFiles)




[docs]
def test_has_generated_entity_id(value: Any) -> bool:
    """
    Test if a value is a generated entity ID, or if it is an entity and has a generated entity ID.
    """
    if isinstance(value, GeneratedEntityId):
        return True
    if isinstance(value, Entity):
        return isinstance(value.id, GeneratedEntityId)
    return False




[docs]
def test_subject_role(value: Any) -> bool:
    """
    Test if a presence role is that of Subject.
    """
    return isinstance(value, Subject)




[docs]
def test_witness_role(value: Any) -> bool:
    """
    Test if a presence role is that of Witness.
    """
    return isinstance(value, Witness)




[docs]
def test_date_range(value: Any) -> bool:
    """
    Test if a value is a date range.
    """
    return isinstance(value, DateRange)




[docs]
def test_start_of_life_event(event: Event) -> bool:
    """
    Test if an event is a start-of-life event.
    """
    return issubclass(event.event_type, StartOfLifeEventType)




[docs]
def test_end_of_life_event(event: Event) -> bool:
    """
    Test if an event is an end-of-life event.
    """
    return issubclass(event.event_type, EndOfLifeEventType)



TESTS = {
    'date_range': test_date_range,
    'end_of_life_event': test_end_of_life_event,
    'entity': test_entity,
    'has_files': test_has_files,
    'has_generated_entity_id': test_has_generated_entity_id,
    'has_links': test_has_links,
    'linked_data_dumpable': test_linked_data_dumpable,
    'private': is_private,
    'public': is_public,
    'start_of_life_event': test_start_of_life_event,
    'subject_role': test_subject_role,
    'user_facing_entity': test_user_facing_entity,
    'witness_role': test_witness_role,
}