<filename>modules/event.py<gh_stars>1-10
"""The module for the Event class.

Classes:
    Event
"""
from __future__ import annotations

from typing import List, Optional, TypedDict

from rdflib import RDFS, URIRef

from modules.date import Date
from modules.nampi_graph import Nampi_graph
from modules.nampi_ns import Nampi_ns
from modules.nampi_type import Nampi_type
from modules.person import Person
from modules.place import Place
from modules.resource import Resource


class Event(Resource):
    """An event RDF resource."""

    date: Optional[Date] = None
    main_person: Person
    place: Optional[Place] = None

    class Person_definition(TypedDict, total=False):
        person: Person
        relationship: URIRef

    def add_comment(self, comment: str):
        """Add a comment to the event

        Parameters:
            comment: The comment to add.
        """
        self.add_relationship(RDFS.comment, self._graph.string_literal(comment))

    def add_text(self, text: str, lang: str):
        """ "Add a text to the event

        Parameters:
            text: The text to add.
        """
        self.add_relationship(
            Nampi_type.Core.has_text, self._graph.string_literal(text, lang)
        )

    def __init__(
        self,
        graph: Nampi_graph,
        main_person: Person,
        main_person_relationship: Optional[URIRef] = None,
        label: str = "Event",
        event_type: Optional[URIRef] = None,
        place: Optional[Place] = None,
        exact_date: Optional[str] = None,
        earliest_date: Optional[str] = None,
        latest_date: Optional[str] = None,
        other_participants: Optional[List[Person_definition]] = None,
    ):
        """Initialize the class.

        Parameters:
            graph: The RDF graph the person belongs to.
            tables: The data tables.
            event_type: The type URI of the event.
            main_person: The main person of the event.
            main_person_relationship: The main person relationship type reference.
            label: The event label.
            place: The event place.
            exact_date: An optional string in the format of YYYY-MM-DD that represents the exact date.
            earliest_date: An optional string in the format of YYYY-MM-DD that represents the earliest possible date.
            latest_date: An optional string in the format of YYYY-MM-DD that represents the latest possible date.
            other_participants: An optional list with other participants and their and relationship type in the event.
        """
        super().__init__(
            graph,
            event_type if event_type else Nampi_type.Core.event,
            Nampi_ns.event,
            label,
            distinct=True,
        )
        self.main_person = main_person

        if main_person_relationship:
            self.add_relationship(main_person_relationship, main_person)

        if place:
            self.place = place
            self.add_relationship(Nampi_type.Core.takes_place_at, place)

        if exact_date or earliest_date or latest_date:
            if exact_date:
                self.add_relationship(
                    Nampi_type.Core.takes_place_on, Date(graph, exact_date)
                )
            else:
                if earliest_date:
                    self.add_relationship(
                        Nampi_type.Core.takes_place_not_earlier_than,
                        Date(graph, earliest_date),
                    )
                if latest_date:
                    self.add_relationship(
                        Nampi_type.Core.takes_place_not_later_than,
                        Date(graph, latest_date),
                    )

        if other_participants:
            for participant_def in other_participants:
                participant = (
                    participant_def["person"] if "person" in participant_def else None
                )
                if not participant:
                    continue
                relationship_type = (
                    participant_def["relationship"]
                    if "relationship" in participant_def
                    else Nampi_type.Core.has_other_participant
                )
                assert isinstance(relationship_type, URIRef)
                self.add_relationship(relationship_type, participant)

<filename>modules/event.py<gh_stars>1-10
"""The module for the Event class.

Classes:
    Event
"""
from __future__ import annotations

from typing import List, Optional, TypedDict

from rdflib import RDFS, URIRef

from modules.date import Date
from modules.nampi_graph import Nampi_graph
from modules.nampi_ns import Nampi_ns
from modules.nampi_type import Nampi_type
from modules.person import Person
from modules.place import Place
from modules.resource import Resource


class Event(Resource):
    """An event RDF resource."""

    date: Optional[Date] = None
    main_person: Person
    place: Optional[Place] = None

    class Person_definition(TypedDict, total=False):
        person: Person
        relationship: URIRef

    def add_comment(self, comment: str):
        """Add a comment to the event

        Parameters:
            comment: The comment to add.
        """
        self.add_relationship(RDFS.comment, self._graph.string_literal(comment))

    def add_text(self, text: str, lang: str):
        """ "Add a text to the event

        Parameters:
            text: The text to add.
        """
        self.add_relationship(
            Nampi_type.Core.has_text, self._graph.string_literal(text, lang)
        )

    def __init__(
        self,
        graph: Nampi_graph,
        main_person: Person,
        main_person_relationship: Optional[URIRef] = None,
        label: str = "Event",
        event_type: Optional[URIRef] = None,
        place: Optional[Place] = None,
        exact_date: Optional[str] = None,
        earliest_date: Optional[str] = None,
        latest_date: Optional[str] = None,
        other_participants: Optional[List[Person_definition]] = None,
    ):
        """Initialize the class.

        Parameters:
            graph: The RDF graph the person belongs to.
            tables: The data tables.
            event_type: The type URI of the event.
            main_person: The main person of the event.
            main_person_relationship: The main person relationship type reference.
            label: The event label.
            place: The event place.
            exact_date: An optional string in the format of YYYY-MM-DD that represents the exact date.
            earliest_date: An optional string in the format of YYYY-MM-DD that represents the earliest possible date.
            latest_date: An optional string in the format of YYYY-MM-DD that represents the latest possible date.
            other_participants: An optional list with other participants and their and relationship type in the event.
        """
        super().__init__(
            graph,
            event_type if event_type else Nampi_type.Core.event,
            Nampi_ns.event,
            label,
            distinct=True,
        )
        self.main_person = main_person

        if main_person_relationship:
            self.add_relationship(main_person_relationship, main_person)

        if place:
            self.place = place
            self.add_relationship(Nampi_type.Core.takes_place_at, place)

        if exact_date or earliest_date or latest_date:
            if exact_date:
                self.add_relationship(
                    Nampi_type.Core.takes_place_on, Date(graph, exact_date)
                )
            else:
                if earliest_date:
                    self.add_relationship(
                        Nampi_type.Core.takes_place_not_earlier_than,
                        Date(graph, earliest_date),
                    )
                if latest_date:
                    self.add_relationship(
                        Nampi_type.Core.takes_place_not_later_than,
                        Date(graph, latest_date),
                    )

        if other_participants:
            for participant_def in other_participants:
                participant = (
                    participant_def["person"] if "person" in participant_def else None
                )
                if not participant:
                    continue
                relationship_type = (
                    participant_def["relationship"]
                    if "relationship" in participant_def
                    else Nampi_type.Core.has_other_participant
                )
                assert isinstance(relationship_type, URIRef)
                self.add_relationship(relationship_type, participant)

The module for the Event class.  Classes:     Event An event RDF resource. Add a comment to the event          Parameters:             comment: The comment to add. "Add a text to the event          Parameters:             text: The text to add. Initialize the class.          Parameters:             graph: The RDF graph the person belongs to.             tables: The data tables.             event_type: The type URI of the event.             main_person: The main person of the event.             main_person_relationship: The main person relationship type reference.             label: The event label.             place: The event place.             exact_date: An optional string in the format of YYYY-MM-DD that represents the exact date.             earliest_date: An optional string in the format of YYYY-MM-DD that represents the earliest possible date.             latest_date: An optional string in the format of YYYY-MM-DD that represents the latest possible date.             other_participants: An optional list with other participants and their and relationship type in the event.