Provides tools for interacting with AiiDA Groups.
An exception raised when a path does not have an associated group.
Initialize self. See help(type(self)) for accurate signature.
list of weak references to the object (if defined)
An exception raised when a path has multiple associated groups.
A class to provide label delimited access to groups.
See tests for usage examples.
Return whether a child exists for this key.
Compare equality of path and Group subclass to another GroupPath object.
Return a >= b. Computed by @total_ordering from (not a < b).
Return a child GroupPath, with a new path formed by appending path to the current path.
Return a > b. Computed by @total_ordering from (not a < b) and (a != b).
Instantiate the class.
path – The initial path of the group.
cls – The subclass of Group to operate on.
warn_invalid_child – Issue a warning, when iterating children, if a child path is invalid.
Iterate through all (direct) children of this path.
Return a <= b. Computed by @total_ordering from (a < b) or (a == b).
Return the number of children for this path.
Compare less-than operator of path and Group subclass to another GroupPath object.
Represent the instantiated class.
Validate the supplied path.
Return a GroupAttr instance, for attribute access to children.
Return the cls used to query for and instantiate a Group with.
Delete the concrete group associated with this path.
Return the delimiter used to split path into components.
Return the concrete group associated with this path.
Return the concrete group associated with this path or, create it, if it does not already exist.
Return all the UUID associated with this GroupPath.
and empty list, if no group associated with this label,
or can be multiple if cls was None
This is an efficient method for checking existence,
which does not require the (slow) loading of the ORM entity.
Return whether there is one or more concrete groups associated with this path.
Return the final component of the the path.
Return the parent path.
Return the path string.
Return a list of the path components.
Recursively iterate through all children of this path.
Recursively iterate through all nodes of this path and its children.
filters – filters to apply to the node query
node_class – return only nodes of a certain class (or list of classes)
query_batch – The size of the batches to ask the backend to batch results in subcollections.
You can optimize the speed of the query by tuning this parameter.
Be aware though that is only safe if no commit will take place during this transaction.
An exception to indicate that a path is not valid.
Provides functionality for managing large numbers of AiiDA Groups, via label delimitation.