Source code for umbra.managers.patchesManager

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""
**patchesManager.py**

**Platform:**
	Windows, Linux, Mac Os X.

**Description:**
	Defines the :class:`PatchesManager` and :class:`Patches` classes.

**Others:**

"""

#**********************************************************************************************************************
#***	Future imports.
#**********************************************************************************************************************
from __future__ import unicode_literals

#**********************************************************************************************************************
#***	External imports.
#**********************************************************************************************************************
import os
import sys

#**********************************************************************************************************************
#***	Internal imports.
#**********************************************************************************************************************
import foundations.common
import foundations.dataStructures
import foundations.exceptions
import foundations.strings
import foundations.verbose
import foundations.walkers
import umbra.exceptions
from foundations.io import File

#**********************************************************************************************************************
#***	Module attributes.
#**********************************************************************************************************************
__author__ = "Thomas Mansencal"
__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal"
__license__ = "GPL V3.0 - http://www.gnu.org/licenses/"
__maintainer__ = "Thomas Mansencal"
__email__ = "thomas.mansencal@gmail.com"
__status__ = "Production"

__all__ = ["LOGGER", "Patch", "PatchesManager"]

LOGGER = foundations.verbose.installLogger()

#**********************************************************************************************************************
#***	Module classes and definitions.
#**********************************************************************************************************************
[docs]class Patch(foundations.dataStructures.Structure): """ Defines a storage object for :class:`PatchesManager` class patch. """ def __init__(self, **kwargs): """ Initializes the class. :param \*\*kwargs: name, path, module, apply, uid. :type \*\*kwargs: dict """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) foundations.dataStructures.Structure.__init__(self, **kwargs)
[docs]class PatchesManager(object): """ Defines the Application patches manager. """ def __init__(self, historyFile=None, paths=None, extension="py"): """ Initializes the class. :param historyFile: Patches history file. :type historyFile: unicode :param paths: Patches paths. :type paths: tuple or list :param extension: Patches extension. :type extension: unicode """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) # --- Setting class attributes. --- self.__historyFile = None self.historyFile = historyFile self.__paths = None self.paths = paths self.__extension = None self.extension = extension if foundations.common.pathExists(self.__historyFile) is False: open(self.__historyFile, "w").close() self.__patches = {} #****************************************************************************************************************** #*** Attributes properties. #****************************************************************************************************************** @property def historyFile(self): """ Property for **self.__historyFile** attribute. :return: self.__historyFile. :rtype: unicode """ return self.__historyFile @historyFile.setter # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(AssertionError) def historyFile(self, value): """ Setter for **self.__historyFile** attribute. :param value: Attribute value. :type value: unicode """ if value is not None: assert type(value) is unicode, "'{0}' attribute: '{1}' type is not 'unicode'!".format( "historyFile", value) self.__historyFile = value @historyFile.deleter # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def historyFile(self): """ Deleter for **self.__historyFile** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "historyFile"))
@property def paths(self): """ Property for **self.__paths** attribute. :return: self.__paths. :rtype: tuple or list """ return self.__paths @paths.setter # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(AssertionError) def paths(self, value): """ Setter for **self.__paths** attribute. :param value: Attribute value. :type value: tuple or list """ if value is not None: assert type(value) in (tuple, list), "'{0}' attribute: '{1}' type is not 'tuple' or 'list'!".format( "paths", value) for element in value: assert type(element) is unicode, "'{0}' attribute: '{1}' type is not 'unicode'!".format( "paths", element) assert os.path.exists(element), "'{0}' attribute: '{1}' directory doesn't exists!".format("paths", element) self.__paths = value @paths.deleter # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def paths(self): """ Deleter for **self.__paths** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "paths"))
@property def extension(self): """ Property for **self.__extension** attribute. :return: self.__extension. :rtype: unicode """ return self.__extension @extension.setter # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(AssertionError) def extension(self, value): """ Setter for **self.__extension** attribute. :param value: Attribute value. :type value: unicode """ if value is not None: assert type(value) is unicode, "'{0}' attribute: '{1}' type is not 'unicode'!".format( "extension", value) self.__extension = value @extension.deleter # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def extension(self): """ Deleter for **self.__extension** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "extension"))
@property def patches(self): """ Property for **self.__patches** attribute. :return: self.__patches. :rtype: dict """ return self.__patches @patches.setter # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def patches(self, value): """ Setter for **self.__patches** attribute. :param value: Attribute value. :type value: dict """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "patches")) @patches.deleter # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def patches(self): """ Deleter for **self.__patches** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "patches")) #****************************************************************************************************************** #*** Class methods. #******************************************************************************************************************
def __getitem__(self, patch): """ Reimplements the :meth:`object.__getitem__` method. :param patch: Patch name. :type patch: unicode :return: Patch. :rtype: Patch """ return self.__patches.__getitem__(patch) def __setitem__(self, name, path): """ Reimplements the :meth:`object.__setitem__` method. :param name: Patch name. :type name: unicode :param path: Patch path. :type path: unicode """ self.registerPatch(name, path) def __iter__(self): """ Reimplements the :meth:`object.__iter__` method. :return: Patchs iterator. :rtype: object """ return self.__patches.iteritems() def __contains__(self, patch): """ Reimplements the :meth:`object.__contains__` method. :param patch: Patch name. :type patch: unicode :return: Patch existence. :rtype: bool """ return patch in self.__patches def __len__(self): """ Reimplements the :meth:`object.__len__` method. :return: Patchs count. :rtype: int """ return len(self.__patches)
[docs] def get(self, patch, default=None): """ Returns given patch value. :param patch: Patch name. :type patch: unicode :param default: Default value if patch is not found. :type default: object :return: Action. :rtype: QAction """ try: return self.__getitem__(patch) except KeyError as error: return default
[docs] def listPatches(self): """ Returns the registered patches. :return: Patches list. :rtype: list """ return sorted(self.__patches.keys())
[docs] def isPatchRegistered(self, patch): """ Returns if the given patch is registered. :param patch: Patch. :type patch: unicode :return: Is patch registered. :rtype: bool """ return patch in self # Oncilla: Statement commented by auto-documentation process: # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(umbra.exceptions.PatchInterfaceError)
[docs] def registerPatch(self, name, path): """ Registers given patch. :param name: Patch name. :type name: unicode :param path: Patch path. :type path: unicode :return: Method success. :rtype: bool """ patch = foundations.strings.getSplitextBasename(path) LOGGER.debug("> Current patch: '{0}'.".format(patch)) directory = os.path.dirname(path) not directory in sys.path and sys.path.append(directory) module = __import__(patch) if hasattr(module, "apply") and hasattr(module, "UID"): self.__patches[name] = Patch(name=name, path=path, module=module, apply=getattr(module, "apply"), uid=getattr(module, "UID")) else: raise umbra.exceptions.PatchInterfaceError( "{0} | '{1}' is not a valid patch and has been rejected!".format(self.__class__.__name__, patch)) return True # Oncilla: Statement commented by auto-documentation process: # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(umbra.exceptions.PatchRegistrationError)
[docs] def registerPatches(self): """ Registers the patches. :return: Method success. :rtype: bool """ if not self.__paths: return False unregisteredPatches = [] for path in self.paths: for file in foundations.walkers.filesWalker(path, ("\.{0}$".format(self.__extension),), ("\._",)): name = foundations.strings.getSplitextBasename(file) if not self.registerPatch(name, file): unregisteredPatches.append(name) if not unregisteredPatches: return True else: raise umbra.exceptions.PatchRegistrationError( "{0} | '{1}' patches failed to register!".format(self.__class__.__name__, ", ".join(unregisteredPatches))) # Oncilla: Statement commented by auto-documentation process: # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(umbra.exceptions.PatchApplyError)
[docs] def applyPatch(self, patch): """ Applies given patch. :param patch: Patch. :type patch: Patch :return: Method success. :rtype: bool """ historyFile = File(self.__historyFile) patchesHistory = historyFile.cache() and [line.strip() for line in historyFile.content] or [] if patch.uid not in patchesHistory: LOGGER.debug("> Applying '{0}' patch!".format(patch.name)) if patch.apply(): historyFile.content = ["{0}\n".format(patch.uid)] historyFile.append() else: raise umbra.exceptions.PatchApplyError("{0} | '{1}' patch failed to apply!".format( self.__class__.__name__, patch.path)) else: LOGGER.debug("> '{0}' patch is already applied!".format(patch.name)) return True
[docs] def applyPatches(self): """ Applies the patches. :return: Method success. :rtype: bool """ success = True for name, patch in sorted(self): success = self.applyPatch(patch) return success
[docs] def getPatchFromUid(self, uid): """ Returns the patch with given uid. :param uid: Patch uid. :type uid: unicode :return: Patch. :rtype: Patch """ for name, patch in self: if patch.uid == uid: return patch