Mixins._SpecialImportRegistry Class Reference

Inheritance diagram for Mixins._SpecialImportRegistry:

Public Member Functions
def	__init__ (self)
def	getSpecialImports (self)
def	registerSpecialImportForType (self, cls, impStatement)
def	registerUse (self, obj)

Private Member Functions
def	_reset (self)

Private Attributes
	_registry

Detailed Description

This class collects special import statements of configuration types

Definition at line 25 of file Mixins.py.

Constructor & Destructor Documentation

__init__()

def Mixins._SpecialImportRegistry.__init__

(

self

)

Definition at line 27 of file Mixins.py.

    def __init__(self):
        self._registry = {}
 

Member Function Documentation

_reset()

def Mixins._SpecialImportRegistry._reset (   self )

private

Definition at line 30 of file Mixins.py.

    def _reset(self):
        for lst in six.itervalues(self._registry):
            lst[1] = False
 

References Mixins._SpecialImportRegistry._registry.

getSpecialImports()

def Mixins._SpecialImportRegistry.getSpecialImports

(

self

)

Definition at line 47 of file Mixins.py.

    def getSpecialImports(self):
        coll = set()
        for (imp, used) in six.itervalues(self._registry):
            if used:
                coll.add(imp)
        return sorted(coll)
 

References Mixins._SpecialImportRegistry._registry.

registerSpecialImportForType()

def Mixins._SpecialImportRegistry.registerSpecialImportForType	(		self,
			cls,
			impStatement
	)

Definition at line 34 of file Mixins.py.

    def registerSpecialImportForType(self, cls, impStatement):
        className = cls.__name__
        if className in self._registry:
            raise RuntimeError("Error: the configuration type '%s' already has an import statement registered '%s'" % (className, self._registry[className][0]))
        self._registry[className] = [impStatement, False]
 

References Types._Untracked.__name__, and Mixins._SpecialImportRegistry._registry.

registerUse()

def Mixins._SpecialImportRegistry.registerUse	(		self,
			obj
	)

Definition at line 40 of file Mixins.py.

    def registerUse(self, obj):
        className = obj.__class__.__name__
        try:
            self._registry[className][1] = True
        except KeyError:
            pass
 

References Mixins._SpecialImportRegistry._registry.

Member Data Documentation

_registry

Mixins._SpecialImportRegistry._registry

private

Definition at line 28 of file Mixins.py.

Referenced by Mixins._SpecialImportRegistry._reset(), Mixins._SpecialImportRegistry.getSpecialImports(), Mixins._SpecialImportRegistry.registerSpecialImportForType(), and Mixins._SpecialImportRegistry.registerUse().