Exclusion set
ExclusionSet class for managing excluded step paths.
References
NONE
ExclusionSet
Bases: BaseModel
Simple set of excluded step paths.
This class manages a collection of step paths that should be excluded from execution. It provides methods to check if paths are excluded and to extract child exclusions for hierarchical step structures.
Attributes:
| Name | Type | Description |
|---|---|---|
excluded_paths |
set[str]
|
The set of excluded step paths. |
from_list(paths)
classmethod
Create exclusion set from list of paths.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
paths |
list[str]
|
List of dot-notation paths to exclude. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
ExclusionSet |
ExclusionSet
|
New exclusion set containing the provided paths. |
get_child_exclusions(parent_path)
Get exclusions for children of a parent path.
This method extracts all exclusions that apply to children of the specified parent path. For example, if the exclusion set contains "parent.child1" and "parent.child2.grandchild", calling this method with "parent" will return an ExclusionSet containing "child1" and "child2.grandchild".
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
parent_path |
str
|
The parent path to get child exclusions for. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
ExclusionSet |
ExclusionSet
|
New exclusion set containing only child exclusions. |
is_excluded(path)
Check if a path is excluded.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path |
str
|
The step path to check for exclusion. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
bool |
bool
|
True if the path is excluded, False otherwise. |