Uranium
Application Framework
|
Wrapper class to perform a search for a certain set of containers. More...
Public Member Functions | |
None | __init__ (self, "ContainerRegistry" registry, *ignore_case=False, **Any kwargs) |
Constructor. More... | |
Optional[type] | getContainerType (self) |
Get the class of the containers that this query should find, if any. More... | |
Optional[List[Dict[str, Any]]] | getResult (self) |
Retrieve the result of this query. More... | |
bool | isIdOnly (self) |
Check to see if this is a very simple query that looks up a single container by ID. More... | |
None | execute (self, Optional[List[Any]] candidates=None) |
Execute the actual query. More... | |
def | __str__ (self) |
Human-readable string representation for debugging. | |
Static Public Attributes | |
dictionary | cache = {} |
OPTIONS_REGEX = re.compile("^\\[[a-zA-Z0-9-_\\+\\. ]+(\\|[a-zA-Z0-9-_\\+\\. ]+)*\\]$") | |
Wrapper class to perform a search for a certain set of containers.
This class is primarily intended to be used internally by ContainerRegistry::findContainers. It is used to perform the actual searching for containers and cache the results.
None UM.Settings.ContainerQuery.ContainerQuery.__init__ | ( | self, | |
"ContainerRegistry" | registry, | ||
* | ignore_case = False , |
||
**Any | kwargs | ||
) |
Constructor.
registry | The ContainerRegistry instance this query operates on. |
container_type | A specific container class that should be filtered for. |
ignore_case | Whether or not the query should be case sensitive. |
kwargs | A dict of key, value pairs that should be searched for. |
None UM.Settings.ContainerQuery.ContainerQuery.execute | ( | self, | |
Optional[List[Any]] | candidates = None |
||
) |
Execute the actual query.
This will search the container metadata of the ContainerRegistry based on the arguments provided to this class' constructor. After it is done, the result can be retrieved with getResult().
Optional[type] UM.Settings.ContainerQuery.ContainerQuery.getContainerType | ( | self | ) |
Get the class of the containers that this query should find, if any.
If the query doesn't filter on container type, None
is returned.
Optional[List[Dict[str, Any]]] UM.Settings.ContainerQuery.ContainerQuery.getResult | ( | self | ) |
Retrieve the result of this query.
bool UM.Settings.ContainerQuery.ContainerQuery.isIdOnly | ( | self | ) |
Check to see if this is a very simple query that looks up a single container by ID.