defaults

Attributes

kiara_app_dirs = AppDirs('kiara', 'DHARPA') module-attribute

KIARA_MODULE_BASE_FOLDER = os.path.dirname(__file__) module-attribute

Marker to indicate the base folder for the kiara module.

KIARA_RESOURCES_FOLDER = os.path.join(KIARA_MODULE_BASE_FOLDER, 'resources') module-attribute

Default resources folder for this package.

KIARA_CONFIG_FILE_NAME = 'kiara.config' module-attribute

KIARA_DEV_CONFIG_FILE_NAME = 'dev.config' module-attribute

KIARA_MAIN_CONFIG_FILE = os.path.join(kiara_app_dirs.user_config_dir, KIARA_CONFIG_FILE_NAME) module-attribute

KIARA_DEV_CONFIG_FILE = os.path.join(kiara_app_dirs.user_config_dir, KIARA_DEV_CONFIG_FILE_NAME) module-attribute

KIARA_MAIN_CONTEXTS_PATH = os.path.join(kiara_app_dirs.user_config_dir, 'contexts') module-attribute

KIARA_DB_MIGRATIONS_CONFIG = os.path.join(KIARA_RESOURCES_FOLDER, 'database', 'alembic.ini') module-attribute

KIARA_DB_MIGRATIONS_FOLDER = os.path.join(KIARA_RESOURCES_FOLDER, 'database', 'kiara') module-attribute

USER_PIPELINES_FOLDER = os.path.join(kiara_app_dirs.user_config_dir, 'pipelines') module-attribute

MODULE_TYPE_KEY = 'module_type' module-attribute

The key to specify the type of a module.

STEP_ID_KEY = 'step_id' module-attribute

The key to specify the step id.

INVALID_VALUE_NAMES = ['kiara', 'callbacks'] module-attribute

List of reserved names, inputs/outputs can't use those.

DEFAULT_DATA_STORE_MARKER = 'default_data_store' module-attribute

Name for the default context data store.

DEFAULT_JOB_STORE_MARKER = 'default_job_store' module-attribute

Name for the default context job store.

DEFAULT_ALIAS_STORE_MARKER = 'default_alias_store' module-attribute

Name for the default context alias store.

DEFAULT_WORKFLOW_STORE_MARKER = 'default_workflow_store' module-attribute

Name for the default context workflow store.

METADATA_DESTINY_STORE_MARKER = 'metadata' module-attribute

Name for the default context destiny store.

PIPELINE_PARENT_MARKER = '__pipeline__' module-attribute

Marker string in the pipeline structure that indicates a parent pipeline element.

DEFAULT_EXCLUDE_DIRS = ['.git', '.tox', '.cache'] module-attribute

List of directory names to exclude by default when walking a folder recursively.

DEFAULT_EXCLUDE_FILES = ['.DS_Store'] module-attribute

List of file names to exclude by default when reading folders.

VALID_PIPELINE_FILE_EXTENSIONS = ['yaml', 'yml', 'json'] module-attribute

File extensions a kiara pipeline/workflow file can have.

MODULE_TYPE_NAME_KEY = 'module_type_name' module-attribute

The string for the module type name in a module configuration dict.

DEFAULT_PIPELINE_PARENT_ID = '__kiara__' module-attribute

Default parent id for pipeline objects that are not associated with a workflow.

DEFAULT_NO_DESC_VALUE = '-- n/a --' module-attribute

KIARA_MODULE_METADATA_ATTRIBUTE = 'KIARA_METADATA' module-attribute

KIARA_DEFAULT_ROOT_NODE_ID = '__self__' module-attribute

DEFAULT_PRETTY_PRINT_CONFIG = {'max_no_rows': 32, 'max_row_height': 1, 'max_cell_length': 80} module-attribute

NO_HASH_MARKER = '--no-hash--' module-attribute

Marker string to indicate no hash was calculated.

NO_VALUE_ID_MARKER = '--no-value-id--' module-attribute

Marker string to indicate no value id exists.

DEFAULT_TO_JSON_CONFIG: typing.Mapping[str, typing.Any] = {'indent': 2} module-attribute

COLOR_LIST = ['green', 'blue', 'bright_magenta', 'dark_red', 'gold3', 'cyan', 'orange1', 'light_yellow3', 'light_slate_grey', 'deep_pink4'] module-attribute

VOID_KIARA_ID = uuid.UUID('00000000-0000-0000-0000-000000000000') module-attribute

NOT_SET_VALUE_ID = uuid.UUID('00000000-0000-0000-0000-000000000001') module-attribute

NONE_VALUE_ID = uuid.UUID('00000000-0000-0000-0000-000000000002') module-attribute

NONE_STORE_ID = uuid.UUID('00000000-0000-0000-0000-000000000003') module-attribute

ORPHAN_PEDIGREE_OUTPUT_NAME = '__orphan__' module-attribute

NO_MODULE_TYPE = 'EXTERNAL_DATA' module-attribute

INVALID_HASH_MARKER = '' module-attribute

INVALID_SIZE_MARKER = -1 module-attribute

NO_SERIALIZATION_MARKER = '-- serialization not supported --' module-attribute

KIARA_ROOT_TYPE_NAME = '__kiara__' module-attribute

SERIALIZED_DATA_TYPE_NAME = 'serialized_data' module-attribute

LOAD_CONFIG_DATA_TYPE_NAME = 'load_config' module-attribute

PYDANTIC_USE_CONSTRUCT: bool = False module-attribute

STRICT_CHECKS: bool = False module-attribute

KIARA_HASH_FUNCTION = mmh3.hash module-attribute

ANY_TYPE_NAME = 'any' module-attribute

DEFAULT_ENV_HASH_KEY = 'default' module-attribute

LOAD_CONFIG_PLACEHOLDER = '__placeholder__' module-attribute

DATA_TYPE_CATEGORY_ID = 'metadata.type' module-attribute

DATA_TYPES_CATEGORY_ID = 'data_types' module-attribute

DATA_TYPE_CLASS_CATEGORY_ID = 'data_type_class' module-attribute

DATA_WRAP_CATEGORY_ID = 'instance.datawrap' module-attribute

UNOLOADABLE_DATA_CATEGORY_ID = 'instance.unloadable_data' module-attribute

VALUE_CATEGORY_ID = 'instance.value' module-attribute

VALUES_CATEGORY_ID = 'instance.values' module-attribute

VALUE_METADATA_CATEGORY_ID = 'instance.value_metadata' module-attribute

MODULE_CONFIG_SCHEMA_CATEGORY_ID = 'module_config_schema' module-attribute

MODULE_CONFIG_CATEGORY_ID = 'module_config' module-attribute

MODULE_CONFIG_METADATA_CATEGORY_ID = 'metadata.module_config' module-attribute

MODULE_TYPE_CATEGORY_ID = 'metadata.module' module-attribute

MODULE_TYPES_CATEGORY_ID = 'modules' module-attribute

BATCH_CONFIG_TYPE_CATEGORY_ID = 'instance.batch_config' module-attribute

PIPELINE_TYPE_CATEGORY_ID = 'metadata.pipeline' module-attribute

PIPELINE_TYPES_CATEGORY_ID = 'pipelines' module-attribute

PIPELINE_STEP_TYPE_CATEGORY_ID = 'instance.pipeline_step' module-attribute

PIPELINE_CONFIG_TYPE_CATEGORY_ID = 'instance.pipeline_config' module-attribute

PIPELINE_STRUCTURE_TYPE_CATEGORY_ID = 'instance.pipeline_structure' module-attribute

PIPELINE_STEP_DETAILS_CATEGORY_ID = 'instance.pipeline_step_details' module-attribute

OPERATION_TYPE_CATEGORY_ID = 'metadata.operation_type' module-attribute

OPERATION_TYPES_CATEGORY_ID = 'operation_types' module-attribute

OPERATIONS_CATEGORY_ID = 'operations' module-attribute

OPERATION_CATEOGORY_ID = 'instance.operation' module-attribute

OPERATION_CONFIG_CATEOGORY_ID = 'instance.operation_config' module-attribute

OPERATION_DETAILS_CATEOGORY_ID = 'instance.operation_details' module-attribute

OPERATION_INPUTS_SCHEMA_CATEOGORY_ID = 'instance.operation_input_schema' module-attribute

OPERATION_OUTPUTS_SCHEMA_CATEOGORY_ID = 'instance.operation_output_schema' module-attribute

ENVIRONMENT_TYPE_CATEGORY_ID = 'instance.environment' module-attribute

DOCUMENTATION_CATEGORY_ID = 'documentation' module-attribute

VALUE_SCHEMA_CATEGORY_ID = 'value_schema' module-attribute

JOB_CATEGORY_ID = 'instance.job' module-attribute

JOB_LOG_CATEGORY_ID = 'job_log' module-attribute

DESTINY_CATEGORY_ID = 'instance.destiny' module-attribute

CONTEXT_INFO_CATEGORY_ID = 'info.context' module-attribute

CONTEXT_METADATA_CATEOGORY_ID = 'metadata.context' module-attribute

AUTHORS_METADATA_CATEGORY_ID = 'metadata.authors' module-attribute

JOB_CONFIG_TYPE_CATEGORY_ID = 'instance.job' module-attribute

JOB_RECORD_TYPE_CATEGORY_ID = 'instance.job_record' module-attribute

VALUE_PEDIGREE_TYPE_CATEGORY_ID = 'instance.value_pedigree' module-attribute

FILE_MODEL_CATEOGORY_ID = 'instance.model.file' module-attribute

FILE_BUNDLE_MODEL_CATEOGORY_ID = 'instance.model.file_bundle' module-attribute

ARRAY_MODEL_CATEOGORY_ID = 'instance.model.array' module-attribute

TABLE_MODEL_CATEOGORY_ID = 'instance.model.table' module-attribute

DEFAULT_CONTEXT_NAME = 'default' module-attribute

SYMLINK_ISSUE_MSG = "Your operating system does not support symlinks, which is a requirement for kiara to work.\n\nYou can enable developer mode to fix this issue:\n\n- open 'Settings'\n- click 'Updates & Security'\n- click 'For developers'\n- make sure 'Developer Mode' is turned on\n- log out of your Windows session, and log back in again\n\nFor more information, please visit:\n- https://dharpa.org/kiara.documentation/latest/installation/#enable-developer-mode\n- https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development\n" module-attribute

Classes

SpecialValue

Bases: Enum

Source code in kiara/defaults.py

class SpecialValue(Enum):

    NOT_SET = "__not_set__"
    NO_VALUE = "__no_value__"

Attributes

NOT_SET = '__not_set__' class-attribute

NO_VALUE = '__no_value__' class-attribute