gws_core

Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

BrickService

Functions
find_brick_folder @classmethod

Find the folder of the brick by searching in the user bricks folder and the system bricks folder

brick_name : str
Return type : str
folder_is_brick @classmethod

return true if the provided folder is a brick. If the folder contains a settings.json and a src folder it is a brick

path : str
Return type : bool
get_all_brick_models @classmethod
Return type : List
get_brick_model @classmethod
name : str
Return type : BrickModel
get_brick_src_folder @classmethod

Get the folder of the brick source code

brick_name : str
Return type : str
get_brick_version @classmethod
name : str
Return type : str
get_parent_brick_folder @classmethod

Get the parent brick folder of a file or folder path

path : str
path to a file or folder
Return type : Optional
import_all_bricks_in_python @classmethod
import_brick_in_python @classmethod

Method to load a brick from path in python.

brick_name : str
_description_
brick_path : str
_description_
init @classmethod

Clear the BrickModel table and log all the messages that were waiting on start

log_brick_error @classmethod
obj : Any
message : str
log_brick_info @classmethod
obj : Any
message : str
log_brick_message @classmethod
brick_name : str
message : str
status : Literal
log_brick_message_from_obj @classmethod

Log a message for the brick of the object. The message is save in DB so it can be viewed later

obj : Any
obj that caused the message. The brick information will be retrieve form the obj type
message : str
[description]
status : Literal
[description]
log_brick_warning @classmethod
obj : Any
message : str
rename_brick @classmethod

Rename brick objects and delete brick from settings /!\ This method is not safe and should be used with caution

old_brick_name : str
new_brick_name : str