Functions
Find the folder of the brick by searching in the user bricks folder and the system bricks folder
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| brick_name | str |
Return type:
str |
return true if the provided folder is a brick. If the folder contains a settings.json and a src folder it is a brick
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| path | str |
Return type:
bool |
Return type:
List |
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| name | str |
Return type:
BrickModel |
Get the folder of the brick source code
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| brick_name | str |
Return type:
str |
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| name | str |
Return type:
str |
Get the parent brick folder of a file or folder path
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| path | str | Path to a file or folder |
Return type:
Optional |
Method to load a brick from path in python.
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| brick_name | str | _description_ | |
| brick_path | str | _description_ |
Clear the BrickModel table and log all the messages that were waiting on start
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| obj | Any | ||
| message | str |
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| obj | Any | ||
| message | str |
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| brick_name | str | ||
| message | str | ||
| status | Literal |
Log a message for the brick of the object. The message is save in DB so it can be viewed later
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| obj | Any | Obj that caused the message. the brick information will be retrieve form the obj type | |
| message | str | [description] | |
| status | Literal | [description] brickmessagestatus |
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| obj | Any | ||
| message | str |
Rename brick objects and delete brick from settings /!\ This method is not safe and should be used with caution
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| old_brick_name | str | ||
| new_brick_name | str |