Source code for manager.component

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

"""
**component.py**

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

**Description:**
	This module defines the :class:`Component` class.

**Others:**

"""

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

#**********************************************************************************************************************
#***	Internal imports.
#**********************************************************************************************************************
import foundations.exceptions
import foundations.verbose

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

__all__ = ["LOGGER", "Component"]

LOGGER = foundations.verbose.installLogger()

#**********************************************************************************************************************
#***	Module classes and definitions.
#**********************************************************************************************************************
[docs]class Component(object): """ This class is the base class for **Manager** package Components. """ def __init__(self, name=None): """ .. Sphinx: Statements updated for auto-documentation purpose. :param name: Component name. ( String ) """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) # --- Setting class attributes. --- self.__name = None self.name = name self.__activated = False self.__initialized = False self.__deactivatable = True #****************************************************************************************************************** #*** Attributes properties. #****************************************************************************************************************** @property def name(self): """ This method is the property for **self.__name** attribute. :return: self.__name. ( String ) """ return self.__name @name.setter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(AssertionError) def name(self, value): """ This method is the setter method for **self.__name** attribute. :param value: Attribute value. ( String ) """ if value is not None: assert type(value) is unicode, "'{0}' attribute: '{1}' type is not 'unicode'!".format("name", value) self.__name = value @name.deleter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def name(self): """ This method is the deleter method for **self.__name** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "name"))
@property def activated(self): """ This method is the property for **self.__activated** attribute. :return: self.__activated. ( Boolean ) """ return self.__activated @activated.setter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(AssertionError) def activated(self, value): """ This method is the setter method for **self.__activated** attribute. :param value: Attribute value. ( Boolean ) """ if value is not None: assert type(value) is bool, "'{0}' attribute: '{1}' type is not 'bool'!".format("activated", value) self.__activated = value @activated.deleter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def activated(self): """ This method is the deleter method for **self.__activated** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "activated"))
@property def initialized(self): """ This method is the property for **self.__initialized** attribute. :return: self.__initialized. ( Boolean ) """ return self.__initialized @initialized.setter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(AssertionError) def initialized(self, value): """ This method is the setter method for **self.__initialized** attribute. :param value: Attribute value. ( Boolean ) """ if value is not None: assert type(value) is bool, "'{0}' attribute: '{1}' type is not 'bool'!".format("initialized", value) self.__initialized = value @initialized.deleter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def initialized(self): """ This method is the deleter method for **self.__initialized** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "initialized"))
@property def deactivatable(self): """ This method is the property for **self.__deactivatable** attribute. :return: self.__deactivatable. ( Boolean ) """ return self.__deactivatable @deactivatable.setter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(AssertionError) def deactivatable(self, value): """ This method is the setter method for **self.__deactivatable** attribute. :param value: Attribute value. ( Boolean ) """ if value is not None: assert type(value) is bool, "'{0}' attribute: '{1}' type is not 'bool'!".format("deactivatable", value) self.__deactivatable = value @deactivatable.deleter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def deactivatable(self): """ This method is the deleter method for **self.__deactivatable** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "deactivatable")) #****************************************************************************************************************** #*** Class methods. #****************************************************************************************************************** #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(NotImplementedError)
[docs] def activate(self): """ This method sets Component activation state. :return: Method success. ( Boolean ) """ raise NotImplementedError("{0} | '{1}' must be implemented by '{2}' subclasses!".format( self.__class__.__name__, self.activate.__name__, self.__class__.__name__)) #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(NotImplementedError)
[docs] def deactivate(self): """ This method unsets Component activation state. :return: Method success. ( Boolean ) """ raise NotImplementedError("{0} | '{1}' must be implemented by '{2}' subclasses!".format( self.__class__.__name__, self.deactivate.__name__, self.__class__.__name__)) #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(NotImplementedError)
[docs] def initialize(self): """ This method initializes the Component. """ raise NotImplementedError("{0} | '{1}' must be implemented by '{2}' subclasses!".format( self.__class__.__name__, self.deactivate.__name__, self.__class__.__name__)) #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(NotImplementedError)
[docs] def uninitialize(self): """ This method uninitializes the Component. """ raise NotImplementedError("{0} | '{1}' must be implemented by '{2}' subclasses!".format( self.__class__.__name__, self.deactivate.__name__, self.__class__.__name__))