Folders
Folders are used to organize experiments and other folders in CellEngine.
Properties
Properties are the snake_case equivalent of those documented on the CellEngine API unless otherwise noted.
Methods
cellengine.resources.folder.Folder
A class representing a CellEngine folder.
created: datetime
property
The date on which the folder was created.
creator: Dict[str, Any]
property
deleted: Union[datetime, None]
property
writable
If the folder is soft-deleted, the date on which it was soft-deleted.
id: str
property
Alias for _id.
name: str
property
writable
path: List[str]
property
writable
The list of IDs of parent folders.
permissions: List[Dict[str, Any]]
property
create(name, path=[])
staticmethod
Creates a folder.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
Name of the folder |
required |
path
|
str[]
|
Optional path to create the folder in. Defaults to [] (root-level). |
[]
|
Returns:
| Type | Description |
|---|---|
Folder
|
The newly created Folder. |
delete()
Marks the folder as deleted.
Deleted folders are permanently deleted after approximately 7 days. Until then, deleted folders can be recovered.
get(_id=None, name=None)
classmethod
Get a Folder by name or ID. Either name or _id must be specified.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
_id
|
optional
|
ID of the folder. |
None
|
name
|
optional
|
Name of the folder. |
None
|
undelete()
Clears a scheduled deletion.
update()
Save changes to this Folder to CellEngine.