CoreSection class

Bases: UniqueSection

Configuration parameters for running the Orchestrator service.

Attributes

core_version property

core_version: str

The version of the Taipy core library.

force property writable

force: bool

If True, force the run of a user application.

If the configuration of the application current version has some conflicts with the configuration of the last run application, Taipy will exit. If the force attribute is set to True, Taipy will run even if there are some conflicts.

id instance-attribute

id: str = _validate_id(id)

A valid python identifier that uniquely identifies the section.

mode property writable

mode: str

The operating mode of Taipy.

Taipy applications are versioned. The versioning system is used to manage the different versions of the user application. Depending on the operating mode, Taipy will behave differently when a version of the application runs. Three modes are available: "development", "experiment", and "production". Please refer to the Versioning management documentation page for more details.

By default, Taipy runs in "development" mode.

properties property writable

properties

A dictionary of additional properties.

read_entity_retry property writable

read_entity_retry: int

Number of retries to read an entity from the repository before return failure.

The default value is 3.

repository_properties property writable

repository_properties: Dict[str, Union[str, int]]

A dictionary of additional properties to be used by the repository.

repository_type property writable

repository_type: str

Type of the repository to be used to store Taipy data.

The default value is "filesystem".

root_folder property writable

root_folder: str

Path of the base folder for the taipy application.

The default value is "./taipy/".

storage_folder property writable

storage_folder: str

Folder name used to store user data.

The default value is "user_data/".

It is used in conjunction with the root_folder attribute. That means the storage path is (The default path is "./taipy/user_data/").

taipy_storage_folder property writable

taipy_storage_folder: str

Folder name used to store internal Taipy data.

The default value is ".taipy/".

version_number property writable

version_number: str

The identifier of the user application version.

Please refer to the Versioning management documentation page for more details.

Methods

default_config() classmethod

default_config() -> CoreSection

Return a core section with all the default values.

Returns:

Type	Description
CoreSection	The default core section.