CTRL + K
Stories
Apps
Agents
Bricks
Constellab Space LogoSpace
Login

gws_core

Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

Typing

Typing class. This class allows storing information on all the types of the models in the system.

:property type: The type of the related model. :type type: str :property super_type: The super type of the related model. :type super_type: str :property root_type: The root type of the related task. :type root_type: str

Attributes
brick: CharFieldbrick_version: CharFielddata: Dictdeprecated_message: CharFielddeprecated_since: CharFieldhide: BooleanFieldhuman_name: CharFieldmodel_type: CharFieldobject_sub_type: CharFieldobject_type: CharFieldrelated_model_typing_name: CharFieldshort_description: CharFieldstyle: TypingStyleunique_name: CharField
Functions
__init__

Initialize self. See help(type(self)) for accurate signature.

clone
coerce
_coerce : bool - True
delete_instance
recursive : bool - False
delete_nullable : bool - False
dependencies
search_nullable : bool - False
get_ancestors
Return type : List
get_id
get_model_type_doc

Return the python documentation of the model type

Return type : str
get_parent_typing
Return type : Optional
get_type
Return type : Optional
get_type_status
Return type : TypingStatus
is_alias
is_dirty
is_saved

Returns True if the model is saved in db, False otherwise

Return type : bool
refresh
Return type : ModelType
refresh_ancestors
save

Sets the data set force_insert to True to force creation of the object set skip_hook to True to skip the before insert or update hook

Return type : ModelType
to_dto
Return type : TypingDTO
to_full_dto
Return type : TypingFullDTO
to_ref_dto
Return type : TypingRefDTO
to_simple_dto
Return type : SimpleTypingDTO
unwrap
add_index @classmethod
fields : Any
after_all_tables_init @classmethod

Method call after all the table are inited

Useful when use DeferredForeignKey to create the foreign key manually latter

after_table_creation @classmethod

Method call after the table is created

Usefull to create the full text indexes

alias @classmethod
alias : Any
bind @classmethod
database : Any
bind_refs : bool - True
bind_backrefs : bool - True
_exclude : Any
bind_ctx @classmethod
database : Any
bind_refs : bool - True
bind_backrefs : bool - True
bulk_create @classmethod
model_list : Any
batch_size : Any
bulk_update @classmethod
model_list : Any
fields : Any
batch_size : Any
classname @classmethod

Returns the name of the class

slugify : bool - False
True to slugify the class name if True
snakefy : bool - False
True to snakefy the class name if True
replace_uppercase : bool - False
Replace upper cases by "-" if True
Return type : str
column_exists @classmethod

Returns True if the column exists in the table

column_name : str
The column name
Return type : bool
create @classmethod
query : Any
create_foreign_key_if_not_exist @classmethod

Create a foreign key for a Foreign key field only if the foreign key does not exists

field : ForeignKeyField
[description]
create_full_text_index @classmethod

Method to create a full text index

columns : List
[description]
index_name : str
create_table @classmethod

Create model table

delete @classmethod
delete_by_id @classmethod
pk : Any
drop_table @classmethod

Drop model table

execute_sql @classmethod

Execute a raw SQL query. Can use the [TABLE_NAME] to replace by the table name

query : str
The query to execute
filter @classmethod
dq_nodes : Any
filters : Any
foreign_key_exists @classmethod
column_name : str
Return type : bool
full_classname @classmethod

Returns the full name of the class

slugify : bool - False
Slugify the returned class name if True
snakefy : bool - False
Snakefy the returned class name if True
Return type : str
get @classmethod
query : Any
filters : Any
get_by_brick_and_object_type @classmethod
brick_name : str
Return type : List
get_by_brick_and_unique_name @classmethod
object_type : Literal
brick : str
unique_name : str
Return type : ModelSelect
get_by_id @classmethod
id : str
Return type : Optional
get_by_id_and_check @classmethod

Get by ID and throw 404 error if object not found

id : str
[description]
Return type : ModelType
get_by_ids @classmethod
ids : List
Return type : List
get_by_model_type @classmethod
model_type : Type
Return type : Typing
get_by_object_sub_type @classmethod
sub_type : str
Return type : List
get_by_object_type @classmethod

Return all the visible typing name of a type.

object_type : Literal
Return type : ModelSelect
get_by_object_type_and_name @classmethod

Return all the visible typing name of a type searched by name.

object_type : Literal
name : str
Return type : ModelSelect
get_by_type_and_brick @classmethod

Return all the visible typing name of a type.

object_type : Literal
brick_name : str
Return type : ModelSelect
get_by_typing_name @classmethod
typing_name : str
Return type : Typing
get_children_typings @classmethod

Retunr the list of typings that are a child class of the provided model_type

typing_type : Literal
base_type : Type
Return type : List
get_db @classmethod
Return type : DatabaseProxy
get_db_manager @classmethod

Returns the (current) DbManager of this model

Return type : Type
get_or_create @classmethod
get_or_none @classmethod
query : Any
filters : Any
get_table_name @classmethod

Returns the table name of this class

Return type : str
index @classmethod
fields : Any
index_exists @classmethod

Returns True if the index exists in the table

index_name : str
The index name
Return type : bool
inheritors @classmethod

Get all the classes that inherit this class

Return type : List
insert @classmethod
_Model__data : Any
insert : Any
insert_from @classmethod
query : Any
fields : Any
insert_many @classmethod
rows : Any
fields : Any
is_mysql_engine @classmethod
noop @classmethod
raw @classmethod
sql : Any
params : Any
replace @classmethod
_Model__data : Any
insert : Any
replace_many @classmethod
rows : Any
fields : Any
save_all @classmethod
select @classmethod
fields : Any
set_by_id @classmethod
key : Any
value : Any
table_exists @classmethod
truncate_table @classmethod
options : Any
type_is_register @classmethod
model_type : Type
Return type : bool
update @classmethod
_Model__data : Any
update : Any
validate_model @classmethod
copy @staticmethod
method : Any
typing_name_is_protocol @staticmethod
typing_name : str
Return type : bool