Resource set
A set of resources
Resource to manage a set of resources. By default the sytem create a new resource for each resource in the set when saving the set
Views
Attributes
name: strstyle: TypingStyletags: TagListtechnical_info: TechnicalInfoDictuid: strFunctions
Constructor, please do not overwrite this method, use the init method instead Leave the constructor without parameters.
Add a resource to the set
can be retrieve by calling the get_resource method with the name. If not provided, the resource name is used Otherwise it doesn't create a new resource but references it. In this case the resource must be an input of the task that created the ResourceSet and the resource must have been saved before, defaults to True
| Name | Type | Default value | Description |
|---|---|---|---|
| resource | Resource | Resource to add | |
| unique_name | str | Name used to store the resource in the dict. it must be unique. the resource | |
| create_new_resource | bool | True | If true, a new resource is created when saving the resource. , optional |
Add technical information on the resource. Technical info are useful to set additional information on the resource.
| Name | Type | Default value | Description |
|---|---|---|---|
| technical_info | TechnicalInfo | Technical information to add (key, value) |
You can redefine this method to define custom logic to check this resource. If there is a problem with the resource, return a string that define the error, otherwise return None This method is called on output resources of a task. If there is an error returned, the task will be set to error and next proceses will not be run. It is also call when uploading a resource (usually for files or folder), if there is an error returned, the resource will not be uploaded
Optional |
Clear the resources
Clone the resource to create a new instance with a new id. It copies the RFields.
ResourceType |
You can redefine this method to set a name of the resource. When saving the resource the name will be saved automatically This can be useful to distinguish this resource from another one or to search for the resource
str |
Return the resource with the given name
:raises Exception: if the resource with the given name is not found
| Name | Type | Default value | Description |
|---|---|---|---|
| resource_name | str | Name of the resource |
Resource |
Return the resource model ids of the sub resources
Set |
Return the resource models of the sub resources list
List[ResourceModel] |
Return the resource with the given name or None if not found
| Name | Type | Default value | Description |
|---|---|---|---|
| resource_name | str | Name of the resource |
gws_core.resource.resource.Resource | None |
Return the sub resources as a dict
Dict |
Return the sub resources as a set
Set |
Get the technical information of the resource
| Name | Type | Default value | Description |
|---|---|---|---|
| key | str | Key of the technical information |
TechnicalInfo |
Return true if the resource with the given id is in the resource list
| Name | Type | Default value | Description |
|---|---|---|---|
| resource_model_id | str | Id of the resourcemodel |
bool |
This can be overwritten to perform custom initialization of the resource. This method is called after the init (constructor) of the resource. The values of RFields are set when this method is called.
Replace current resources by the resources in the dict
| Name | Type | Default value | Description |
|---|---|---|---|
| resources | Dict | Dict where key is the resource model id and value is the resource [str, resource] |
Return true if the resource with the given name exists in the dict
| Name | Type | Default value | Description |
|---|---|---|---|
| resource_name | str | Name of the resource |
Resource |
Returns the name of the class
| Name | Type | Default value | Description |
|---|---|---|---|
| slugify | bool | False | True to slugify the class name if true, defaults to false , optional |
| snakefy | bool | False | True to snakefy the class name if true, defaults to false , optional |
| replace_uppercase | bool | False | Replace upper cases by "-" if true, defaults to false , optional |
str |
Copy the style of the resource with the possibility to override some properties. Useful when settings the style for a task based on the resource style.
| Name | Type | Default value | Description |
|---|---|---|---|
| icon_technical_name | str | Technical name of the icon if provided, the icon_type must also be provided, defaults to none , optional | |
| icon_type | TypingIconType | Type of the icon if provided, the icon_technical_name must also be provided, defaults to none , optional | |
| background_color | str | Background color, defaults to none , optional | |
| icon_color | TypingIconColor | Icon color, defaults to none , optional |
TypingStyle |
| Name | Type | Default value | Description |
|---|---|---|---|
| decorator_name | Any |
Returns the full name of the class
| Name | Type | Default value | Description |
|---|---|---|---|
| slugify | bool | False | Slugify the returned class name if true, defaults to false , optional |
| snakefy | bool | False | Snakefy the returned class name if true, defaults to false `` |
str |
Get all the classes that inherit this class
List |
Returns the list of the methods
List |
Returns the module name of the class
str |
Retrieves the property names
| Name | Type | Default value | Description |
|---|---|---|---|
| instance | type | The s of the properties to retrieve. set `none` to retrieve all. `type` or `union[type]` | |
| exclude | type |
List |