_ensure_mapped()

Complexity

Conditions

5

Size

Total Lines

12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	5

1 Method

Rating	Name	Duplication	Size	Complexity
A	_instantiate()	0	8	3

"""Functions to interact with mapped classes and instances."""

import inspect
import logging
import warnings

from . import common, exceptions

log = logging.getLogger(__name__)


def create(class_or_instance, *args, overwrite=False):
    """Create a new mapped object."""
    instance = _instantiate(class_or_instance, *args)
    mapper = common.get_mapper(instance, expected=True)

    if mapper.auto_create:
        msg = "'create' is called automatically with 'auto_create' enabled"
        warnings.warn(msg)

    if mapper.exists and not overwrite:
        msg = "{!r} already exists".format(mapper.path)
        raise exceptions.DuplicateMappingError(msg)

    return save(instance)


def find(class_or_instance, *args, create=False):  # pylint: disable=redefined-outer-name
    """Find a matching mapped object or return None."""
    instance = _instantiate(class_or_instance, *args)
    mapper = common.get_mapper(instance, expected=True)

    if mapper.exists:
        return instance
    elif create:
        return save(instance)
    else:
        return None


def find_all(cls, **kwargs):
    """Return a list of all matching mapped objects."""
    log.debug((cls, kwargs))
    raise NotImplementedError


def load(instance):
    """Force the loading of a mapped object's file."""
    mapper = common.get_mapper(instance, expected=True)

    warnings.warn("'load' is called automatically")

    mapper.load()

    return instance


def save(instance):
    """Save a mapped object to file."""
    mapper = common.get_mapper(instance, expected=True)

    if mapper.auto_save:
        msg = "'save' is called automatically with 'auto_save' enabled"
        warnings.warn(msg)

    if mapper.deleted:
        msg = "{!r} was deleted".format(mapper.path)
        raise exceptions.DeletedFileError(msg)

    if not mapper.exists:
        mapper.create()

    mapper.save()

    return instance


def delete(instance):
    """Delete a mapped object's file."""
    mapper = common.get_mapper(instance, expected=True)

    mapper.delete()

    return None


def _instantiate(class_or_instance, *args):
    if inspect.isclass(class_or_instance):
        instance = class_or_instance(*args)
    else:
        assert not args
        instance = class_or_instance

    return instance