Source code for prody.utilities.settings

"""This module defines class for handling and storing package settings."""

import os

from .pathtools import pickle, unpickle, isWritable, USERHOME
import prody as pkg

try:
    input = raw_input
except NameError:
    pass

__all__ = ['PackageSettings', 'getPackagePath', 'setPackagePath']


class PackageSettings(object):

    """A class for managing package settings.  Settings are saved in user's
    home director.  When settings are changed by the users, the changes are
    automatically saved.  Settings are stored in a :class:`dict` instance.
    The dictionary is pickled in user's home directory for permanent storage.
    """

    def __init__(self, pkg, rcfile=None, logger=None):
        """*rcfile* is the filename for pickled settings dictionary, and by
        default is set to :file:`.pkgrc`."""

        self._package = pkg
        if rcfile is None:
            if USERHOME is not None:
                self._rcfile = os.path.join(USERHOME, '.' + pkg + 'rc')
            else:
                self._rcfile = None
        else:
            self._rcfile = rcfile

        self._logger = logger
        self._settings = {}

    def __getitem__(self, key):

        return self._settings[key]

    def __setitem__(self, key, value):

        self._settings[key] = value

    def __contains__(self, item):

        return item in self._settings

    def get(self, key, default=None):
        """Returns value corresponding to specified *key*, or *default* if *key*
        is not found."""

        return self._settings.get(key, default)

    def pop(self, key, default=None):
        """Remove specified *key* and return corresponding value.  If *key* is
        not found, *default* is returned."""

        return self._settings.pop(key, default)

    def update(self, *args, **kwargs):
        """Update settings dictionary. """

        for arg in args:
            self._settings.update(arg)
        if kwargs:
            self._settings.update(kwargs)

    def load(self):
        """Load settings by unpickling the settings dictionary."""

        if self._rcfile is not None and os.path.isfile(self._rcfile):
            try:
                settings = unpickle(self._rcfile)
            except Exception as err:
                if self._logger:
                    self._logger.warning("{0} configuration file '{1}' "
                                         "could not be loaded ({2})."
                                         .format(self._package, self._rcfile,
                                                 err))
            else:
                if isinstance(settings, dict):
                    self._settings.update(settings)

    def save(self, backup=False):
        """Save settings by pickling the settings dictionary."""

        if USERHOME is None:
            self._logger.warning("User home directory is not set, "
                                 "configuration data is not saved.")
        elif isWritable(USERHOME):
            try:
                pickle(self._settings, self._rcfile, backup=backup)
            except Exception as err:
                if self._logger:
                    self._logger.warning("{0} cannot write configuration "
                                         "file '{1}' ({2})."
                                         .format(self._package, self._rcfile,
                                                 err))
        elif self._logger:
            self._logger.warning("{0} cannot write configuration file to "
                                 "'{1}', user does not have write access."
                                 .format(self._package, USERHOME))


def setPackagePath(path):
    """Set package path."""

    if not os.path.isdir(path):
        try:
            os.mkdir(path)
        except Exception as err:
            pkg.LOGGER.warning('Failed to make folder "{0}": {1}'
                               .format(path, err.strerror))
            return False
    pkg.SETTINGS['package_path'] = path
    pkg.SETTINGS.save()
    return path


def getPackagePath():
    """Returns package path."""

    path = pkg.SETTINGS.get('package_path', None)

    update = False
    if path is None:
        pkg.LOGGER.warning('{0} package path is not yet set by the user.'
                           .format(pkg.SETTINGS._package))
        update = True
    elif not os.path.isdir(path):
        pkg.LOGGER.warning("{0} package path '{1}' does not exist."
                           .format(pkg.SETTINGS._package, path))
        update = True
    elif not os.access(path, os.W_OK):
        pkg.LOGGER.warning("User does not have write access to {0} package "
                           "path '{1}'.".format(pkg.SETTINGS._package, path))
        update = True
    if update:
        default = os.path.join(USERHOME, '.' + pkg.SETTINGS._package)
        path = input('Please specify a folder for storing {0} data '
                     '(press enter for "{1}"):'
                     .format(pkg.SETTINGS._package, default)) or default
        while not setPackagePath(path):
            path = input('Please specify a valid folder name with write '
                         'access:')
    return path