Package mrv :: Package automation :: Module qa :: Class QAProcessBase
[hide private]
[frames] | no frames]

Class QAProcessBase

source code

         object --+                
                  |                
interface.Interface --+            
                      |            
interface.iDuplicatable --+        
                          |        
               dge.NodeBase --+    
                              |    
            process.ProcessBase --+
                                  |
                                 QAProcessBase

Quality Assurance Process including a specialized QA interface
Nested Classes [hide private]

Inherited from dge.NodeBase: __metaclass__, shellcls

Instance Methods [hide private]

Inherited from interface.iDuplicatable: copyTo, copyToOther, duplicate

Inherited from interface.Interface: supports

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

    Interface
 
assureQuality(self, check, mode, *args, **kwargs)
Called when the test identified by plug should be handled
source code
 
listChecks(self, **kwargs)
Returns: list( QACheck, ...
source code
 
evaluateState(self, plug, mode, *args, **kwargs)
Prepares the call to the actual quality check implemenetation and assuring test identified by plug can actually be run in the given mode
source code

Inherited from process.ProcessBase: compute

    iDuplicatable Interface

Inherited from process.ProcessBase: copyFrom, createInstance

    Query

Inherited from process.ProcessBase: supportedTargetTypes, targetRating

    Base

Inherited from process.ProcessBase: prepareProcess, workflow

Inherited from dge.NodeBase: clearCache, connections, inputPlugs, outputPlugs, plugs, toShell, toShells

    Overridden from Object

Inherited from process.ProcessBase: __init__

Inherited from dge.NodeBase: __del__, __str__

    ID Handling

Inherited from dge.NodeBase: id, setID

Class Methods [hide private]
    Base

Inherited from dge.NodeBase: filterCompatiblePlugs, inputPlugsStatic, outputPlugsStatic, plugsStatic

Class Variables [hide private]
  eMode = (query, fix)

Inherited from process.ProcessBase: dirty_check, is_state, kGood, kNo, kPerfect, noun, target_state, verb

    Configuration
  track_compute_calls = False
hash(x)
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

assureQuality(self, check, mode, *args, **kwargs)

source code 
Called when the test identified by plug should be handled
Parameters:
  • check - QACheck to be checked for issues
  • mode - mode of the computation, see QAProcessBase.eMode
Returns:
QACheckResult instance keeping information about the outcome of the test

listChecks(self, **kwargs)

source code 
Parameters:
Returns:
list( QACheck, ... ) list of our checks

evaluateState(self, plug, mode, *args, **kwargs)

source code 
Prepares the call to the actual quality check implemenetation and assuring test identified by plug can actually be run in the given mode
Parameters:
  • plug - plug that triggered the computation - use it to compare against your classes plugs to see which output is required and return a result suitable to be stored in plug
  • mode - bit flags as follows:

    is_state:

    your return value represents the current state of the process - your output will represent what actually is present. You may not alter the state of your environment, thus this operation is strictly read-only. According to your output, when called you need to setup a certain state and return the results according to that state. This flag means you are requrested to return everything that is right according to the state you shall create. If this state is disabled, you should not return the current state, but behave according to the other ones.

    target_state:

    your return value must represent the 'should' state - thus you must assure that the environment is left in a state that matches your plug state - the result of that operation will be returned. Usually, but not necessarily, the is_state is also requested so that the output represents the complete new is_state ( the new state after you changed the environment to match the plug_state )

    dirty_check:

    Always comes in conjunction with is_state. You are required to return the is_state but raise a DirtyException if your inputs would require you to adjust the environment to deliver the plug state. If the is_state if the environment is the plug_state as there is nothing to do for you, do not raise and simply return your output.

    The call takes place as there is no cache for plugType.

Returns:
an instance suitable to be stored in the given plug
Overrides: process.ProcessBase.evaluateState