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

StringHelper

Helper to manipulate strings

Functions
GENERATE_UUID - @classmethod
Return type:
str
CAMEL_CASE_TO_SENTENCE - @staticmethod

Convert a camel case to sentence like Ex 'TestClass2Build' -> 'Test class2 build'

Parameters:
NameTypeDefault valueDescription
namestr [description]
Return type:
str
GENERATE_RANDOM_CHARS - @staticmethod
Parameters:
NameTypeDefault valueDescription
sizeint 6
charsstr ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789
Return type:
str
GET_ENUM_VALUES - @staticmethod

Get all the values of an enum

Parameters:
NameTypeDefault valueDescription
enum_classType
Return type:
list
IS_ALPHANUMERIC - @staticmethod

Check if a string is alphanumeric with underscore

Parameters:
NameTypeDefault valueDescription
str_str
Return type:
bool
REMOVE_WHITESPACES - @staticmethod

Remove all whitespace of a string

Parameters:
NameTypeDefault valueDescription
str_str
Return type:
str
REPLACE_ACCENT_WITH_LETTER - @staticmethod

Replace accent with letter

Parameters:
NameTypeDefault valueDescription
str_str
Return type:
str
SLUGIFY - @staticmethod

Returns the slugified text

Parameters:
NameTypeDefault valueDescription
textstr Text to slugify ``
snakefybool False Snakefy the text if true (i.e. uses undescores instead of dashes to separate text words), defaults to false ``
to_lowerbool True True to lower all characters, false otherwise ``
Return type:
str
SNAKE_CASE_TO_SENTENCE - @staticmethod

Convert a snake case to sentence like Ex 'test_class2_build' -> 'Test class2 build'

Parameters:
NameTypeDefault valueDescription
namestr
Return type:
str
TO_ENUM - @staticmethod

Convert a string to an enum value

Parameters:
NameTypeDefault valueDescription
enum_classType
str_valuestr
Return type:
Any
TO_PASCAL_CASE - @staticmethod

Convert a text to pascal case Ex 'test_class2_build' -> 'TestClass2Build'

Parameters:
NameTypeDefault valueDescription
textstr
Return type:
str
TO_SNAKE_CASE - @staticmethod

Convert a text to snake case Ex 'TestClass2Build' -> 'test_class2_build'

Parameters:
NameTypeDefault valueDescription
textstr
Return type:
str