| Inheritence |
|
This is a pattern matching object that can be constructed from an attribute pattern. It can be used with the pdg.WorkItem.attribMatch function to find the list of matching work item attribute names.
The pattern uses the rules specified in the attribute pattern syntax section.
Methods
Static methods
isValidName(attrib_name)
→ bool
Returns True if the specified name is a valid attribute name, else returns
False.
makeValidName(attrib_name)
→ bool
Converts the specified string into a valid attribute name.
splitByAttribute(work_items, attrib_name)
→ tuple
Splits the work items in the input list by the specified attribute name. Returns a map of attribute values to the list of work items that have that value, as well as the list of work items that are missing the attribute and the list of unique values. The unique value list is sorted in ascending order of value.
The values for attrib_name on the work items do not all have to be the same type. All attribute values are converted to strings.
For example:
attribute = "wedgeindex" (value_map, missing, unique) = pdg.AttributePattern.splitByAttribute(node.work_items, attribute) print("Attribute {} has {} unique values".format(attribute, len(unique))) for work_item in missing: print("Work Item {} is missing attrib {}".format(attribute)) for entry in value_map: print("{} work items have value {}".format(len(value_map[entry]), entry))
splitByFloat(work_items, attrib_name)
→ tuple
Splits the input work items by the specified float attribute name.
This function is the same as splitByAttribute, but it will not convert attribute values to strings. Work items that have an attribute with the specified name, but a different type, will be considered as missing the attribute.
splitByInt(work_items, attrib_name)
→ tuple
Splits the input work items by the specified integer attribute name.
This function is the same as splitByAttribute, but it will not convert attribute values to strings. Work items that have an attribute with the specified name, but a different type, will be considered as missing the attribute.
splitByString(work_items, attrib_name)
→ tuple
Splits the input work items by the specified integer attribute name.
This function is the same as splitByAttribute, but it will not convert attribute values to strings. Work items that have an attribute with the specified name, but a different type, will be considered as missing the attribute.
Instance Methods
__init__(pattern)
Constructs a new pattern object from the specified string
contains(name, type)
→ bool
Returns True if the specified attribute name and type match the pattern,
else False. type should be a pdg.attribType.
Methods from pdg.BasePattern
errors
: str
Property
If the pattern is invalid, this string contains the parse errors.
isValid
: bool
Property
Set to True if the pattern is valid, else False.
pattern
: str
Property
The source string used to construct this pattern object.