Uranium
Application Framework
|
Central class to manage all setting providers. More...
Public Member Functions | |
def | __init__ (self, args, kwargs) |
def | addResourceType |
def | getResourceTypes (self) |
Returns all resource types. More... | |
def | getDefaultSaveProvider (self) |
def | addWrongContainerId |
This method adds the current id to the list of wrong containers that are skipped when looking for a container. | |
def | addProvider |
Adds a container provider to search through containers in. More... | |
def | findDefinitionContainers |
Find all DefinitionContainer objects matching certain criteria. More... | |
def | findDefinitionContainersMetadata |
Get the metadata of all definition containers matching certain criteria. More... | |
def | findInstanceContainers |
Find all InstanceContainer objects matching certain criteria. More... | |
def | findInstanceContainersMetadata |
Find the metadata of all instance containers matching certain criteria. More... | |
def | findContainerStacks |
Find all ContainerStack objects matching certain criteria. More... | |
def | findContainerStacksMetadata |
Find the metadata of all container stacks matching certain criteria. More... | |
def | findContainers |
Find all container objects matching certain criteria. More... | |
def | findContainersMetadata |
Find the metadata of all container objects matching certain criteria. More... | |
def | findDirtyContainers |
Specialized find function to find only the modified container objects that also match certain criteria. More... | |
def | getEmptyInstanceContainer (self) |
This is a small convenience to make it easier to support complex structures in ContainerStacks. More... | |
def | isReadOnly |
Returns whether a profile is read-only or not. More... | |
def | isLoaded |
Returns whether a container is completely loaded or not. More... | |
def | loadAllMetadata (self) |
Load the metadata of all available definition containers, instance containers and container stacks. More... | |
def | load (self) |
Load all available definition containers, instance containers and container stacks. More... | |
def | addContainer |
def | removeContainer |
def | renameContainer |
def | uniqueName |
Creates a new unique name for a container that doesn't exist yet. More... | |
def | addContainerType |
Add a container type that will be used to serialize/deserialize containers. More... | |
def | addContainerTypeByName |
Used to associate mime types with object to be created. More... | |
def | getMimeTypeForContainer |
Retrieve the mime type corresponding to a certain container type. More... | |
def | getContainerForMimeType (cls, mime_type) |
Get the container type corresponding to a certain mime type. More... | |
def | getContainerTypes (cls) |
Get all the registered container types. More... | |
def | saveContainer |
Save single dirty container. | |
def | saveDirtyContainers (self) |
Save all the dirty containers by calling the appropriate container providers. | |
def | getLockFilename (self) |
Get the lock filename including full path Dependent on when you call this function, Resources.getConfigStoragePath may return different paths. | |
def | getCacheLockFilename (self) |
Get the cache lock filename including full path. More... | |
def | lockFile (self) |
Contextmanager to create a lock file and remove it afterwards. More... | |
def | lockCache (self) |
Context manager to create a lock file for the cache directory and remove it afterwards. More... | |
def | getInstance (cls) |
Get the singleton instance for this class. More... | |
def | setApplication |
def | getApplication (cls) |
![]() | |
def | findContainers |
def | findDefinitionContainers |
def | getApplication (cls) |
def | getEmptyInstanceContainer (self) |
def | isReadOnly |
Public Attributes | |
metadata | |
source_provider | |
Static Public Attributes | |
containerAdded = Signal() | |
containerRemoved = Signal() | |
containerMetaDataChanged = Signal() | |
containerLoadComplete = Signal() | |
allMetadataLoaded = Signal() | |
dictionary | mime_type_map |
Central class to manage all setting providers.
This class aggregates all data from all container providers. If only the metadata is used, it requests the metadata lazily from the providers. If more than that is needed, the entire container is requested from the appropriate providers.
def UM.Settings.ContainerRegistry.ContainerRegistry.addContainerType | ( | cls, | |
container | |||
) |
Add a container type that will be used to serialize/deserialize containers.
container | An instance of the container type to add. |
def UM.Settings.ContainerRegistry.ContainerRegistry.addContainerTypeByName | ( | cls, | |
container_type | |||
) |
Used to associate mime types with object to be created.
container_type | ContainerStack or derivative |
type_name | |
mime_type |
def UM.Settings.ContainerRegistry.ContainerRegistry.addProvider | ( | self, | |
provider | |||
) |
Adds a container provider to search through containers in.
def UM.Settings.ContainerRegistry.ContainerRegistry.findContainers | ( | self, | |
ignore_case | |||
) |
Find all container objects matching certain criteria.
container_type | If provided, return only objects that are instances or subclasses of container_type. |
kwargs | dict A dictionary of keyword arguments containing keys and values that need to match the metadata of the container. An asterisk can be used to denote a wildcard. |
def UM.Settings.ContainerRegistry.ContainerRegistry.findContainersMetadata | ( | self, | |
ignore_case | |||
) |
Find the metadata of all container objects matching certain criteria.
container_type | If provided, return only objects that are instances or subclasses of container_type . |
kwargs | A dictionary of keyword arguments containing keys and values that need to match the metadata. An asterisk can be used to denote a wildcard. |
def UM.Settings.ContainerRegistry.ContainerRegistry.findContainerStacks | ( | self, | |
kwargs | |||
) |
Find all ContainerStack objects matching certain criteria.
kwargs | dict A dictionary of keyword arguments containing keys and values that need to match the metadata of the ContainerStack. An asterisk in the values can be used to denote a wildcard. |
def UM.Settings.ContainerRegistry.ContainerRegistry.findContainerStacksMetadata | ( | self, | |
kwargs | |||
) |
Find the metadata of all container stacks matching certain criteria.
kwargs | A dictionary of keyword arguments containing keys and values that need to match the metadata. An asterisk in the values can be used to denote a wildcard. |
def UM.Settings.ContainerRegistry.ContainerRegistry.findDefinitionContainers | ( | self, | |
kwargs | |||
) |
Find all DefinitionContainer objects matching certain criteria.
kwargs | dict A dictionary of keyword arguments containing keys and values that need to match the metadata of the DefinitionContainer. An asterisk in the values can be used to denote a wildcard. |
def UM.Settings.ContainerRegistry.ContainerRegistry.findDefinitionContainersMetadata | ( | self, | |
kwargs | |||
) |
Get the metadata of all definition containers matching certain criteria.
kwargs | A dictionary of keyword arguments containing keys and values that need to match the metadata. An asterisk in the values can be used to denote a wildcard. |
def UM.Settings.ContainerRegistry.ContainerRegistry.findDirtyContainers | ( | self, | |
ignore_case | |||
) |
Specialized find function to find only the modified container objects that also match certain criteria.
This is faster than the normal find methods since it won't ever load all containers, but only the modified ones. Since containers must be fully loaded before they are modified, you are guaranteed that any operations on the resulting containers will not trigger additional containers to load lazily.
kwargs | dict A dictionary of keyword arguments containing keys and values that need to match the metadata of the container. An asterisk can be used to denote a wildcard. |
ignore_case | Whether casing should be ignored when matching string values of metadata. |
def UM.Settings.ContainerRegistry.ContainerRegistry.findInstanceContainers | ( | self, | |
kwargs | |||
) |
Find all InstanceContainer objects matching certain criteria.
kwargs | dict A dictionary of keyword arguments containing keys and values that need to match the metadata of the InstanceContainer. An asterisk in the values can be used to denote a wildcard. |
def UM.Settings.ContainerRegistry.ContainerRegistry.findInstanceContainersMetadata | ( | self, | |
kwargs | |||
) |
Find the metadata of all instance containers matching certain criteria.
kwargs | A dictionary of keyword arguments containing keys and values that need to match the metadata. An asterisk in the values can be used to denote a wildcard. |
def UM.Settings.ContainerRegistry.ContainerRegistry.getCacheLockFilename | ( | self, | |
str | |||
) |
Get the cache lock filename including full path.
def UM.Settings.ContainerRegistry.ContainerRegistry.getContainerForMimeType | ( | cls, | |
mime_type | |||
) |
Get the container type corresponding to a certain mime type.
mime_type | The mime type to get the container type for. |
def UM.Settings.ContainerRegistry.ContainerRegistry.getContainerTypes | ( | cls | ) |
Get all the registered container types.
def UM.Settings.ContainerRegistry.ContainerRegistry.getEmptyInstanceContainer | ( | self, | |
InstanceContainer | |||
) |
This is a small convenience to make it easier to support complex structures in ContainerStacks.
def UM.Settings.ContainerRegistry.ContainerRegistry.getInstance | ( | cls, | |
ContainerRegistry | |||
) |
Get the singleton instance for this class.
def UM.Settings.ContainerRegistry.ContainerRegistry.getMimeTypeForContainer | ( | cls, | |
container_type | |||
) |
Retrieve the mime type corresponding to a certain container type.
container_type | The type of container to get the mime type for. |
def UM.Settings.ContainerRegistry.ContainerRegistry.getResourceTypes | ( | self, | |
Dict, | |||
str, | |||
int | |||
) |
Returns all resource types.
def UM.Settings.ContainerRegistry.ContainerRegistry.isLoaded | ( | self, | |
container_id | |||
) |
Returns whether a container is completely loaded or not.
If only its metadata is known, it is not yet completely loaded.
def UM.Settings.ContainerRegistry.ContainerRegistry.isReadOnly | ( | self, | |
container_id | |||
) |
Returns whether a profile is read-only or not.
Whether it is read-only depends on the source where the container is obtained from.
def UM.Settings.ContainerRegistry.ContainerRegistry.load | ( | self, | |
None | |||
) |
Load all available definition containers, instance containers and container stacks.
def UM.Settings.ContainerRegistry.ContainerRegistry.loadAllMetadata | ( | self, | |
None | |||
) |
Load the metadata of all available definition containers, instance containers and container stacks.
def UM.Settings.ContainerRegistry.ContainerRegistry.lockCache | ( | self, | |
LockFile | |||
) |
Context manager to create a lock file for the cache directory and remove it afterwards.
def UM.Settings.ContainerRegistry.ContainerRegistry.lockFile | ( | self, | |
LockFile | |||
) |
Contextmanager to create a lock file and remove it afterwards.
def UM.Settings.ContainerRegistry.ContainerRegistry.uniqueName | ( | self, | |
original | |||
) |
Creates a new unique name for a container that doesn't exist yet.
It tries if the original name you provide exists, and if it doesn't it'll add a " #1" or " #2" after the name to make it unique.
original | The original name that may not be unique. |
|
static |