Contains a modular UI able to display quality assurance checks, run them and present their results. It should be easy to override and adjust it to suit additional needs
Epydoc: mrv.maya.ui.qa.QACheckLayout
Bases: mrv.maya.ui.RowLayout
Row Layout able to display a qa check and related information
| Note: | currently we make assumptions about the positions of the children in the RowLayout, thus you may only append new ones |
|---|
| Returns: | NameUI of the currently set parent |
|---|---|
| Raises RuntimeError: | |
| if no active parent was set | |
Add the given child UI item to our list of children
| Parameters: |
|
|---|---|
| Returns: | the newly added child, allowing contructs like button = layout.addChild( Button( ) ) |
| Returns: | item with separator added to it ( just once ) |
|---|---|
| Note: | operates best on strings |
| Parameters: |
|
| Returns: | basename of this path, ‘/hello/world’ -> ‘world’ |
|---|
S.capitalize() -> unicode
Return a capitalized version of S, i.e. make the first character have upper case.
S.center(width[, fillchar]) -> unicode
Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)
| Returns: | check we are operating upon |
|---|
Called if the checks fails with an error
| Parameters: |
|
|---|
| Returns: | stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent|subparent|mychild” ) |
|---|---|
| Raises KeyError: | |
| if a child with that name does not exist | |
| Returns: | children of this layout |
|---|
| Returns: | all child instances recursively |
|---|---|
| Note: | the order of children is lexically ordered at this time |
| Note: | this implementation is slow and should be overridden by more specialized subclasses |
Remove all event receivers for all events registered in this instance.
| Note: | This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance |
|---|
S.count(sub[, start[, end]]) -> int
Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.
S.decode([encoding[,errors]]) -> string or unicode
Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.
| Returns: | (x,y) tuple of x and y dimensions of the UI element |
|---|
S.encode([encoding[,errors]]) -> string or unicode
Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.
S.endswith(suffix[, start[, end]]) -> bool
Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.
| Returns: | True if this instance still exists in maya |
|---|
S.expandtabs([tabsize]) -> unicode
Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.
S.find(sub [,start [,end]]) -> int
Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.
Return -1 on failure.
S.index(sub [,start [,end]]) -> int
Like S.find() but raise ValueError when the substring is not found.
| Returns: | True if self is a part of other, and thus can be found in other |
|---|---|
| Note: | operates on strings only |
| Returns: | True if this path is the root of the DAG |
|---|
| Returns: | True other starts with self |
|---|---|
| Note: | operates on strings |
| Note: | we assume other has the same type as self, thus the same separator |
S.isalnum() -> bool
Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.
S.isalpha() -> bool
Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.
S.isdecimal() -> bool
Return True if there are only decimal characters in S, False otherwise.
S.isdigit() -> bool
Return True if all characters in S are digits and there is at least one character in S, False otherwise.
S.islower() -> bool
Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.
S.isnumeric() -> bool
Return True if there are only numeric characters in S, False otherwise.
S.isspace() -> bool
Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.
S.istitle() -> bool
Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.
S.isupper() -> bool
Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.
| Returns: | generator retrieving all parents up to the root |
|---|---|
| Parameter: | predicate – returns True for all x that you want to be returned |
S.join(iterable) -> unicode
Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.
| Returns: | list with our child instances |
|---|---|
| Parameter: | predicate – function returning True for each child to include in result, allows to easily filter children |
| Note: | it’s a copy, so you can freely act on the list |
| Note: | children will be returned in the order in which they have been added |
| Returns: | list of event ids that exist on our class |
|---|
S.ljust(width[, fillchar]) -> int
Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).
S.lower() -> unicode
Return a copy of the string S converted to lowercase.
S.lstrip([chars]) -> unicode
Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping
| Returns: | children of this layout |
|---|
| Returns: | children of this layout |
|---|
| Returns: | (x,y) tuple of x and y dimensions of the UI element |
|---|
| Returns: | True if this instance still exists in maya |
|---|
| Returns: | True if this instance still exists in maya |
|---|
| Returns: | popup menus attached to this control |
|---|
| Returns: | popup menus attached to this control |
|---|
| Returns: | parent instance of this ui element |
|---|
| Returns: | all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ] |
|---|
S.partition(sep) -> (head, sep, tail)
Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.
| Returns: | popup menus attached to this control |
|---|
Remove the given child from our list
| Returns: | True if the child was found and has been removed, False otherwise |
|---|
S.replace (old, new[, count]) -> unicode
Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.
S.rfind(sub [,start [,end]]) -> int
Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.
Return -1 on failure.
S.rindex(sub [,start [,end]]) -> int
Like S.rfind() but raise ValueError when the substring is not found.
S.rjust(width[, fillchar]) -> unicode
Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).
| Returns: | the root of the DAG - it has no further parents |
|---|
S.rpartition(sep) -> (head, sep, tail)
Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.
S.rsplit([sep [,maxsplit]]) -> list of strings
Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.
S.rstrip([chars]) -> unicode
Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping
| Returns: | instance which sent the event you are currently processing |
|---|---|
| Raises ValueError: | |
| if no event is currently in progress | |
Set this container active, such that newly created items will be children of this layout
| Returns: | self |
|---|---|
| Note: | always use the addChild function to add the children ! |
Set the parent ( layout ) of this layout active - newly created items will be children of the parent layout
| Returns: | self |
|---|---|
| Note: | can safely be called several times |
Setup ourselves to indicate the given check result
| Returns: | our adjusted iconTextButton Member |
|---|
| Returns: | shortname of the ui ( name without pipes ) |
|---|
S.split([sep [,maxsplit]]) -> list of strings
Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.
S.splitlines([keepends]) -> list of strings
Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.
S.startswith(prefix[, start[, end]]) -> bool
Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.
S.strip([chars]) -> unicode
Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping
| Returns: | True if this instance supports the interface of the given type |
|---|---|
| Parameter: | interface_type – Type of the interface you require this instance to support |
| Note: | Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work |
S.swapcase() -> unicode
Return a copy of S with uppercase characters converted to lowercase and vice versa.
S.title() -> unicode
Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.
S.translate(table) -> unicode
Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.
| Returns: | the python class able to create this class |
|---|---|
| Note: | The return value is NOT the type string, but a class |
If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.
Use this callback to register yourself from all your event senders, then call the base class method.
| Note: | This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya. |
|---|
S.upper() -> unicode
Return a copy of S converted to uppercase.
S.zfill(width) -> unicode
Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.
Epydoc: mrv.maya.ui.qa.QALayout
Bases: mrv.maya.ui.FormLayout, mrv.maya.ui.util.iItemSet
Layout able to dynamically display QAChecks, run them and display their result
Bases: object
defines the way a child is constrained, possibly to other children
| Todo: | proper constraint system, but could be complicated to make it really easy to use |
|---|
| Returns: | NameUI of the currently set parent |
|---|---|
| Raises RuntimeError: | |
| if no active parent was set | |
Add the given child UI item to our list of children
| Parameters: |
|
|---|---|
| Returns: | the newly added child, allowing contructs like button = layout.addChild( Button( ) ) |
| Returns: | item with separator added to it ( just once ) |
|---|---|
| Note: | operates best on strings |
| Parameters: |
|
| Returns: | basename of this path, ‘/hello/world’ -> ‘world’ |
|---|
S.capitalize() -> unicode
Return a capitalized version of S, i.e. make the first character have upper case.
S.center(width[, fillchar]) -> unicode
Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)
Called for the given event - it will find the UI element handling the call respective function on the UI instance
| Note: | find the check using predefined names as they server as unique-enough keys. This would possibly be faster, but might not make a difference after all |
|---|
| Returns: | list of checkLayouts representing our checks |
|---|
| Returns: | list of checks we are currently holding in our layout |
|---|
| Returns: | stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent|subparent|mychild” ) |
|---|---|
| Raises KeyError: | |
| if a child with that name does not exist | |
| Returns: | children of this layout |
|---|
| Returns: | all child instances recursively |
|---|---|
| Note: | the order of children is lexically ordered at this time |
| Note: | this implementation is slow and should be overridden by more specialized subclasses |
Remove all event receivers for all events registered in this instance.
| Note: | This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance |
|---|
S.count(sub[, start[, end]]) -> int
Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.
Create and return a layout displaying the given check instance
| Parameter: | kwargs – will be passed to checkui class’s initializer, allowing subclasses to easily adjust the paramter list |
|---|---|
| Note: | its using self.checkuicls to create the instance |
| Returns: | current check ids as defined by exsiting children. |
|---|---|
| Note: | additionally fills in the name_to_child_map |
S.decode([encoding[,errors]]) -> string or unicode
Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.
| Returns: | (x,y) tuple of x and y dimensions of the UI element |
|---|
S.encode([encoding[,errors]]) -> string or unicode
Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.
S.endswith(suffix[, start[, end]]) -> bool
Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.
| Returns: | True if this instance still exists in maya |
|---|
S.expandtabs([tabsize]) -> unicode
Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.
S.find(sub [,start [,end]]) -> int
Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.
Return -1 on failure.
S.index(sub [,start [,end]]) -> int
Like S.find() but raise ValueError when the substring is not found.
| Returns: | True if self is a part of other, and thus can be found in other |
|---|---|
| Note: | operates on strings only |
| Returns: | True if this path is the root of the DAG |
|---|
| Returns: | True other starts with self |
|---|---|
| Note: | operates on strings |
| Note: | we assume other has the same type as self, thus the same separator |
S.isalnum() -> bool
Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.
S.isalpha() -> bool
Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.
S.isdecimal() -> bool
Return True if there are only decimal characters in S, False otherwise.
S.isdigit() -> bool
Return True if all characters in S are digits and there is at least one character in S, False otherwise.
S.islower() -> bool
Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.
S.isnumeric() -> bool
Return True if there are only numeric characters in S, False otherwise.
S.isspace() -> bool
Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.
S.istitle() -> bool
Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.
S.isupper() -> bool
Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.
| Returns: | generator retrieving all parents up to the root |
|---|---|
| Parameter: | predicate – returns True for all x that you want to be returned |
S.join(iterable) -> unicode
Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.
| Returns: | list with our child instances |
|---|---|
| Parameter: | predicate – function returning True for each child to include in result, allows to easily filter children |
| Note: | it’s a copy, so you can freely act on the list |
| Note: | children will be returned in the order in which they have been added |
| Returns: | list of event ids that exist on our class |
|---|
S.ljust(width[, fillchar]) -> int
Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).
S.lower() -> unicode
Return a copy of the string S converted to lowercase.
S.lstrip([chars]) -> unicode
Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping
| Returns: | children of this layout |
|---|
| Returns: | children of this layout |
|---|
| Returns: | (x,y) tuple of x and y dimensions of the UI element |
|---|
| Returns: | True if this instance still exists in maya |
|---|
| Returns: | True if this instance still exists in maya |
|---|
| Returns: | popup menus attached to this control |
|---|
| Returns: | popup menus attached to this control |
|---|
| Returns: | parent instance of this ui element |
|---|
| Returns: | all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ] |
|---|
S.partition(sep) -> (head, sep, tail)
Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.
| Returns: | popup menus attached to this control |
|---|
Remove the given child from our list
| Returns: | True if the child was found and has been removed, False otherwise |
|---|
S.replace (old, new[, count]) -> unicode
Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.
S.rfind(sub [,start [,end]]) -> int
Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.
Return -1 on failure.
S.rindex(sub [,start [,end]]) -> int
Like S.rfind() but raise ValueError when the substring is not found.
S.rjust(width[, fillchar]) -> unicode
Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).
| Returns: | the root of the DAG - it has no further parents |
|---|
S.rpartition(sep) -> (head, sep, tail)
Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.
S.rsplit([sep [,maxsplit]]) -> list of strings
Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.
S.rstrip([chars]) -> unicode
Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping
Called once the Run-All button is pressed
| Parameter: | kwargs – will be passed to runChecks method of workflow |
|---|---|
| Note: | we assume all checks are from one workflow only as we do not sort them by workflow |
| Note: | currently we only run in query mode as sort of safety measure - check and fix on all might be too much and lead to unexpected results |
| Returns: | instance which sent the event you are currently processing |
|---|---|
| Raises ValueError: | |
| if no event is currently in progress | |
Set this container active, such that newly created items will be children of this layout
| Returns: | self |
|---|---|
| Note: | always use the addChild function to add the children ! |
Set the checks this layout should display
| Parameter: | checks – iterable of qa checks as retrieved by checks |
|---|---|
| Raises ValueErorr: | |
| if one check is from a different workflow and there is a run_all button | |
Set the UI to display items identified by the given item_ids
| Parameters: |
|
|---|---|
| Note: | you are responsible for generating a list of item_ids and call this method to trigger the update |
| Returns: | tuple( SetOfDeletedItemIds, SetOfCreatedItemIds ) |
Set the parent ( layout ) of this layout active - newly created items will be children of the parent layout
| Returns: | self |
|---|---|
| Note: | can safely be called several times |
Apply the given setup to the form layout, specified using kwargs
| Parameter: | kwargs – arguments you would set use to setup the form layout |
|---|
| Returns: | shortname of the ui ( name without pipes ) |
|---|
S.split([sep [,maxsplit]]) -> list of strings
Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.
S.splitlines([keepends]) -> list of strings
Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.
S.startswith(prefix[, start[, end]]) -> bool
Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.
S.strip([chars]) -> unicode
Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping
| Returns: | True if this instance supports the interface of the given type |
|---|---|
| Parameter: | interface_type – Type of the interface you require this instance to support |
| Note: | Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work |
S.swapcase() -> unicode
Return a copy of S with uppercase characters converted to lowercase and vice versa.
S.title() -> unicode
Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.
S.translate(table) -> unicode
Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.
| Returns: | the python class able to create this class |
|---|---|
| Note: | The return value is NOT the type string, but a class |
If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.
Use this callback to register yourself from all your event senders, then call the base class method.
| Note: | This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya. |
|---|
S.upper() -> unicode
Return a copy of S converted to uppercase.
S.zfill(width) -> unicode
Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.
Bases: mrv.automation.workflow.Workflow, mrv.util.EventSender
Represents a workflow of QAProcessBase instances and allows to query them more conveniently
Bases: networkx.classes.digraph.DiGraph
Simple wrapper storing a call graph, keeping the root at which the call started
| Note: | this class is specialized to be used by workflows, its not general for that purpose |
|---|
| Returns: | root at which the call started |
|---|
| Returns: | length of the callstack |
|---|
End the call start started previously
| Parameter: | result – the result of the call |
|---|
| Returns: | flattened version of graph as list of ProcessData edges in call order , having the root as last element of the list |
|---|---|
| Parameters: |
|
Bases: object
Allows to store additional information with each process called during the workflow
| Returns: | time to process the call |
|---|
| Returns: | result stored in this instance, or None if it is not present or not alive |
|---|
Set the given result
| Note: | uses weak references as the tracking structure should not cause a possible mutation of the program flow ( as instances stay alive although code expects it to be deleted |
|---|
| Returns: | item with separator added to it ( just once ) |
|---|---|
| Note: | operates best on strings |
| Parameters: |
|
| Returns: | basename of this path, ‘/hello/world’ -> ‘world’ |
|---|
| Returns: | current callgraph instance |
|---|---|
| Note: | its strictly read-only and may not be changed |
| Returns: | list of intermediate children of path, [ child1 , child2 ] |
|---|---|
| Parameter: | predicate – return True to include x in result |
| Note: | the child objects returned are supposed to be valid paths, not just relative paths |
| Returns: | list of all children of path, [ child1 , child2 ] |
|---|---|
| Parameters: |
|
| Note: | the child objects returned are supposed to be valid paths, not just relative paths |
Remove all event receivers for all events registered in this instance.
| Note: | This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance |
|---|
Connect this plug to destinationshell such that destinationshell is an input plug for our output
| Parameters: |
|
|---|---|
| Returns: | self on success, allows chained connections |
| Raises PlugAlreadyConnected: | |
if destinationshell is connected and force is False |
|
| Raises PlugIncompatible: | |
if destinationshell does not appear to be compatible to this one |
|
Copy the values of ourselves onto the given instance which must be an instance of our class to be compatible. Only the common classes will be copied to instance
| Returns: | altered instance |
|---|---|
| Note: | instance will be altered during the process |
Create a report instance that describes how the previous target was made
| Parameter: | reportType – Report to populate with information - it must be a Plan based class that can be instantiated and populated with call information. A report analyses the call dependency graph generated during dg evaluation and presents it. |
|---|---|
| Returns: | report instance whose makeReport method can be called to retrieve it |
Implements a c-style copy constructor by creating a new instance of self and applying the copyFrom methods from base to all classes implementing the copyfrom method. Thus we will call the method directly on the class
| Parameters: |
|
|---|
As listChecks, but allows you do define the processes to use
| Parameter: | predicate – func( p ) for plug p returns True for it to be included in the result |
|---|
| Returns: | True if the node is in this graph, false otherwise |
|---|
| Returns: | the connected input plug of plugshell or None if there is no such connection |
|---|---|
| Note: | input plugs have on plug at most, output plugs can have more than one connected plug |
| Returns: | True if self is a part of other, and thus can be found in other |
|---|---|
| Note: | operates on strings only |
| Returns: | True if this path is the root of the DAG |
|---|
| Returns: | True other starts with self |
|---|---|
| Note: | operates on strings |
| Note: | we assume other has the same type as self, thus the same separator |
| Returns: | generator returning all nodes that are connected in this graph, in no particular order. For an ordered itereration, use iterShells. |
|---|---|
| Parameter: | predicate – if True for node, it will be returned |
| Returns: | generator returning all nodes in this graph |
|---|---|
| Parameter: | predicate – if True for node, it will be returned |
| Note: | there is no particular order |
| Returns: | generator retrieving all parents up to the root |
|---|---|
| Parameter: | predicate – returns True for all x that you want to be returned |
List all checks as supported by QAProcessBase es in this QA Workflow
| Parameter: | predicate – include check c in result if func( c ) returns True |
|---|
| Returns: | list of event ids that exist on our class |
|---|
| Returns: | list( Process, ... ) list of QA Processes known to this QA Workflow |
|---|---|
| Parameter: | predicate – include process p in result if func( p ) returns True |
| Returns: | list of tuple( shell, DirtyReport|None ) If a process ( shell.node ) is dirty, a dirty report will be given explaining why the process is dirty and needs an update |
|---|---|
| Parameters: |
|
| Parameter: | target – target to make - can be class or instance |
|---|---|
| Returns: | result when producing the target |
batch module compatible method allowing to make mutliple targets at once
| Parameters: |
|
|---|
| Returns: | instance of a node according to the given node id |
|---|---|
| Raises NameError: | |
| if no such node exists in graph | |
| Returns: | immutable copy of the nodes used in the graph |
|---|
| Returns: | number of nodes in the graph |
|---|
| Returns: | a list of plugs being the destination of the connection to plugshell |
|---|---|
| Parameter: | predicate – plug will only be returned if predicate is true for it - shells will be passed in |
| Returns: | parent of this path, ‘/hello/world’ -> ‘/hello’ or None if this path is the dag’s root |
|---|
| Returns: | all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ] |
|---|
| Returns: | the root of the DAG - it has no further parents |
|---|
Run the given checks in the given mode and return their results
| Parameters: |
|
|---|---|
| Returns: | list( tuple( QACheckShell, QACheckResult ), ... ) list of pairs of QACheckShells and the check’s result. The test result will be empty if the test did not run or failed with an exception |
| Note: | Sends the following events: e_preCheck , e_postCheck, e_checkError e_checkError may set the abort_on_error variable to True to cause the operation not to proceed with other checks |
| Returns: | instance which sent the event you are currently processing |
|---|---|
| Raises ValueError: | |
| if no event is currently in progress | |
| Returns: | True if this instance supports the interface of the given type |
|---|---|
| Parameter: | interface_type – Type of the interface you require this instance to support |
| Note: | Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work |
| Returns: | int range(0,255) indicating how well a target can be made 0 means not at all, 255 means perfect. Return value is tuple ( rate, PlugShell ), containing the process and plug with the highest rating or None if rate is 0 Walk the dependency graph such that leaf nodes have higher ratings than non-leaf nodes |
|---|---|
| Note: | you can use the process.ProcessBase enumeration for comparison |
| Returns: | list of all supported target type |
|---|---|
| Note: | this method is for informational purposes only |
Bases: object
chain(*iterables) –> chain object
Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.
chain.from_iterable(iterable) –> chain object
Alternate chain() contructor taking a single iterable argument that evaluates lazily.