Back to bricks list
Introduction Getting Started
Architecture
Technical Documentation
Other Classes
AbstractDbManager AgentFactory AudioView AuthService BadRequestException BarPlotView Base BaseEnvShell BaseHTTPException BaseModelDTO BaseTestCase BaseTestCaseLight BashCodeParam BoolParam BoolRField BoolValidator BoxPlotView BrickMigration BrickService CheckBeforeTaskResult CommunityService Compress CondaShellProxy Config ConfigParams Connector ConnectorPartSpec ConnectorSpec ConverterRunner Credentials CredentialsDataBasic CredentialsDataLab CredentialsDataOther CredentialsDataS3 CredentialsParam CredentialsType CurrentUserService Dashboard DashboardType DataframeAggregatorHelper DataframeDataFilterHelper DataframeFilterHelper DataFrameRField DataframeScalerHelper datetime DateTimeUTC DbConfig DictRField DictValidator DispatchedMessage DynamicInputs DynamicOutputs EntityNavigator EntityNavigatorService EntityTag EntityType Enum ExceptionHandler ExceptionResponse ExpressionBuilder ExternalApiService FileDownloader FileHelper FileRField FloatParam FloatRField FloatValidator ForbiddenException FrontService FrontTheme FSNodeModel FsNodeService GwsCorePackages GWSException GzipCompress HeatmapView HistogramView ImageView InPort Inputs InputSpec InputSpecs InterfaceSpec IntParam IntRField IntValidator IO IOface Job JsonCodeParam JSONField JSONView JuliaCodeParam KVStore LazyViewParam LinePlot2DView ListParam ListRField ListValidator Logger MailService MambaShellProxy MessageDispatcher MessageLevel MessageObserver Model ModelService Monitor MonitorService MultiViews NetworkView Note Notebook NoteParam NoteSearchBuilder NoteService NoteTemplate NoteTemplateParam NoteTemplateService NotFoundException NumericHelper NumericParam NumericValidator OpenAiChat OpenAiChatMessage OpenAiChatParam OpenAiHelper OutPort Outputs OutputSpec OutputSpecs PackageHelper Paginator ParamSet ParamSpec PerlCodeParam PipShellProxy PlotlyRField PlotlyView PoolDb Port PrimitiveRField Process ProcessFactory ProcessModel ProcessProxy ProcessSpec ProgressBar ProgressBarMessageObserver ProgressBarService ProtocolModel ProtocolProxy ProtocolService ProtocolTyping PythonCodeParam Queue QueueService RCodeParam Requests ResourceDownloaderBase ResourceModel ResourceOrigin ResourceRField ResourceSearchBuilder ResourceService ResourceTransfertService ResourceTyping RField RichText RichTextBlock RichTextBlockModificationDTO RichTextBlockModificationWithUserDTO RichTextBlockType RichTextDTO RichTextFigureData RichTextFileData RichTextFormulaData RichTextListData RichTextListItem RichTextModificationDifferenceDTO RichTextModificationsDTO RichTextModificationType RichTextNoteResourceViewData RichTextObjectType RichTextParagraphData RichTextParagraphHeaderData RichTextParagraphHeaderLevel RichTextParagraphListData RichTextParagraphListItemData RichTextParagraphText RichTextResourceViewData RichTextTimestampData RichTextUserDTO RichTextVariableData RichTextView RichTextViewFileData S3Bucket ScatterPlot2DView Scenario ScenarioCreationType ScenarioProcessStatus ScenarioProxy ScenarioRunService ScenarioSaveDTO ScenarioSearchBuilder ScenarioService ScenarioStatus ScenarioTemplate ScenarioTemplateFactory ScenarioTransfertService SearchBuilder SerializableObjectJson SerializableRField Settings ShellProxy SimpleTextView SpaceFolder SqlMigrator StackedBarPlotView StreamlitApp StreamlitAppManager StreamlitProcess StringHelper StrParam StrRField StrValidator SysProc TableAnnotatorHelper TableColumnSelector TableColumnTagToRowExtractor TableColumnTagUnfolder TableConcatHelper TableHeaderInfo TableOperationHelper TableRowSelector TableRowTagToColumnExtractor TableRowTagUnfolder TableScalerHelper TableTagAggregatorHelper TableUnfolderHelper TableView TabularView Tag TagHelper TagKeyModel TagService TagsParam TagValueModel TarCompress TarGzCompress TaskFileDownloader TaskHelper TaskInputs TaskModel TaskProxy TaskRunner TaskService TaskTyping TechnicalInfo TextParam TextView TextViewData Typing TypingDeprecated TypingIconColor TypingIconType TypingManager TypingStyle UnauthorizedException URLValidator User UserCredentialsDTO UserGroup UserService Utils UUIDRField Validator VennDiagramView Version View ViewTester ViewType YamlCodeParam ZipCompress
Version

Utils

Functions
GET_MODEL_TYPE - @classmethod

Get the type of a registered model using its litteral type

Parameters:
NameTypeDefault valueDescription
type_strstr
Return type:
Optional
MODEL_TYPE_EXISTS - @classmethod
Parameters:
NameTypeDefault valueDescription
type_strstr
Return type:
bool
STRINGIFY_TYPE - @classmethod
Parameters:
NameTypeDefault valueDescription
type_Type
include_modulebool False
ASSERT_JSON_EQUALS - @staticmethod

Assert a json with possibility to ignore key

Parameters:
NameTypeDefault valueDescription
json_1Union
json_2Union
ignore_keysList
GENERATE_UNIQUE_STR_FOR_LIST - @staticmethod

Generate a unique str for a list of str. Append _1, _2... at the end if the str is already in the list

Parameters:
NameTypeDefault valueDescription
list_List
str_str
Return type:
str
GET_ALL_SUBCLASSES - @staticmethod

Return all the subclasses type of a class, it does not include the main class

Parameters:
NameTypeDefault valueDescription
class_Type Class to retrieve the subclasses
Return type:
Set
GET_LITERAL_VALUES - @staticmethod

Return the list of literal values

Parameters:
NameTypeDefault valueDescription
literal_typeAny
Return type:
List
GET_PARENT_CLASSES - @staticmethod

Return a list of parent class of class_ arg (containing class_).

Parameters:
NameTypeDefault valueDescription
class_Type [description]
max_parentType If provided, doesn't return parent of max_parent class, defaults to none , optional
Return type:
List
IS_JSON - @staticmethod

Check if an object is a json. Ok is type is primitive or a list or a dict containing list dict or primitive...

Parameters:
NameTypeDefault valueDescription
objAny
Return type:
bool
IS_PRIMITIVE - @staticmethod

Check if an object is a primitive type

Parameters:
NameTypeDefault valueDescription
objAny
Return type:
bool
ISSUBCLASS - @staticmethod

issubclass safe that check the input is a class and avoid exception

Parameters:
NameTypeDefault valueDescription
_Utils__clstype
_Utils__class_or_tupleUnion
Return type:
bool
JSON_ARE_EQUALS - @staticmethod

Check if two json are equals

Parameters:
NameTypeDefault valueDescription
json1Any
json2Any
Return type:
bool
JSON_EQUALS - @staticmethod

Assert a json with possibility to ignore key

Parameters:
NameTypeDefault valueDescription
json_1Union
json_2Union
ignore_keysList
Return type:
bool
RENAME_DUPLICATE_IN_STR_LIST - @staticmethod

Rename all duplicated element in a list of str with _1, _2... at the end

Parameters:
NameTypeDefault valueDescription
list_List
Return type:
List
SORT_DICT_BY_KEY - @staticmethod
Parameters:
NameTypeDefault valueDescription
json_dictAny
VALUE_IS_IN_LITERAL - @staticmethod

Check wheter a value in in a listeral list

Parameters:
NameTypeDefault valueDescription
valueAny
literal_typeAny
Return type:
bool
WALK_DIR - @staticmethod
Parameters:
NameTypeDefault valueDescription
pathAny
Return type:
Tuple