annif.vocab.types

Complexity

Total Complexity

10

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	SubjectIndex.__getitem__()	0	3	1
A	SubjectIndex.languages()	0	4	1
A	SubjectCorpus.save_skos()	0	5	1
A	SubjectIndex.active()	0	5	1
A	SubjectIndex.by_label()	0	5	1
A	SubjectCorpus.languages()	0	6	1
A	SubjectIndex.by_uri()	0	5	1
A	SubjectCorpus.subjects()	0	5	1
A	SubjectIndex.__len__()	0	3	1
A	SubjectIndex.contains_uri()	0	3	1

"""Type declarations for vocabulary functionality"""

from __future__ import annotations

import abc
import collections

Subject = collections.namedtuple("Subject", "uri labels notation")


class SubjectCorpus(metaclass=abc.ABCMeta):
    """Abstract base class for subject corpora"""

    @property
    @abc.abstractmethod
    def subjects(self):
        """Iterate through the subject corpus, yielding Subject objects."""
        pass  # pragma: no cover

    @property
    @abc.abstractmethod
    def languages(self):
        """Provide a list of language codes supported by this subject
        corpus."""
        pass  # pragma: no cover

    @abc.abstractmethod
    def save_skos(self, path):
        """Save the contents of the subject corpus into a SKOS/Turtle
        file with the given path name."""
        pass  # pragma: no cover


class SubjectIndex(metaclass=abc.ABCMeta):
    """Base class for an index that remembers the associations between
    integer subject IDs and their URIs and labels."""

    @abc.abstractmethod
    def __len__(self) -> int:
        pass  # pragma: no cover

    @property
    @abc.abstractmethod
    def languages(self) -> list[str] | None:
        pass  # pragma: no cover

    @abc.abstractmethod
    def __getitem__(self, subject_id: int) -> Subject:
        pass  # pragma: no cover

    @abc.abstractmethod
    def contains_uri(self, uri: str) -> bool:
        pass  # pragma: no cover

    @abc.abstractmethod
    def by_uri(self, uri: str, warnings: bool = True) -> int | None:
        """return the subject ID of a subject by its URI, or None if not found.
        If warnings=True, log a warning message if the URI cannot be found."""
        pass  # pragma: no cover

    @abc.abstractmethod
    def by_label(self, label: str | None, language: str) -> int | None:
        """return the subject ID of a subject by its label in a given
        language"""
        pass  # pragma: no cover

    @abc.abstractmethod
    def active(self) -> list[tuple[int, Subject]]:
        """return a list of (subject_id, Subject) tuples of all subjects that
        are available for use"""
        pass  # pragma: no cover