Source code for jacquard.directory.base

"""Base class for directory implementations."""

import abc
import collections

UserEntry = collections.namedtuple('UserEntry', 'id join_date tags')

UserEntry.__doc__ = """
Description of attributes of a single user.

Internally this is a `collections.namedtuple`.
"""

UserEntry.id.__doc__ = """String user ID."""
UserEntry.join_date.__doc__ = \
    """Date at which the user is considered to have joined."""
UserEntry.tags.__doc__ = \
    """Container of tags which apply to this user, defined by the directory."""


class Directory(metaclass=abc.ABCMeta):
    """User directory."""

    @abc.abstractmethod
    def __init__(self, **kwargs):
        """
        Standard constructor.

        Keyword arguments are taken from the `directory` section of config
        files, and appear as strings. Useful for specifying connection URLs
        etc.
        """
        raise NotImplementedError

    @classmethod
    def from_configuration(cls, config, options):
        """
        Construct from a Config object, and a dictionary of options.

        By default this does not use the `config` and just defers to
        `__init__` passing the options as kwargs.
        """
        return cls(**options)

    @abc.abstractmethod
    def lookup(self, user_id):
        """
        Look up user by ID.

        For missing users this must return None, otherwise it must return a
        corresponding `UserEntry`.
        """
        raise NotImplementedError