Source code for colour_datasets.records

from __future__ import annotations

from colour.hints import Optional

from .configuration import Configuration, sandbox, use_sandbox
from .zenodo import Community, Record

__all__ = [
    "Configuration",
    "sandbox",
    "use_sandbox",
]
__all__ += [
    "Community",
    "Record",
]

_COMMUNITY: Optional[Community] = None
"""
Singleton instance of the *Zenodo* community that holds the datasets
information.
"""


def datasets() -> Community:
    """
    Singleton factory that returns *Zenodo* community that holds the datasets
    information.

    Returns
    -------
    :class:`colour_datasets.Community`
        Singleton instance of the *Zenodo* community.

    Examples
    --------
    # Doctests skip for Python 2.x compatibility.
    >>> datasets()["3245883"].title  # doctest: +SKIP
    'Camera Spectral Sensitivity Database - Jiang et al. (2013)'
    """

    global _COMMUNITY

    if _COMMUNITY is None:
        _COMMUNITY = Community.from_id(Configuration().community)

    return _COMMUNITY


__all__ += [
    "datasets",
]