type_name |
any |
The registered name for this item type. |
documentation |
'Any' type, the parent type for most other types.
This type acts as the parents for all (or at least most) non-internal value types. There are some generic operations
(like 'persist_value', or 'pretty_print') which are implemented for this type, so it's descendents have a fallback
option in case no subtype-specific operations are implemented for it. In general, it is not recommended to use the 'any'
type as module input or output, but it is possible. Values of type 'any' are not allowed to be persisted (at the moment,
this might or might not change).
|
Documentation for the item. |
authors |
|
Information about authorship for the item. |
context |
|
Generic properties of this item (description, tags, labels, references, ...). |
python_class |
python_class_name |
AnyType |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.AnyType |
The full class namespace. |
|
The python class that implements this module type. |
value_cls |
python_class_name |
object |
The name of the Python class. |
python_module_name |
builtins |
The name of the Python module this class lives in. |
full_name |
object |
The full class namespace. |
|
The python class of the value itself. |
data_type_config_cls |
python_class_name |
DataTypeConfig |
The name of the Python class. |
python_module_name |
kiara.data_types |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.DataTypeConfig |
The full class namespace. |
|
The python class holding the schema for configuring this type. |
lineage |
|
This types lineage. |
qualifier_profiles |
|
A map of qualifier profiles for this data types. |
supported_properties |
group_title |
Metadata models for type 'any' |
The group alias. |
item_infos |
metadata.python_class |
type_name |
python_class |
The registered name for this item type. |
documentation |
Python class and module information.
|
Documentation for the item. |
authors |
|
Information about authorship for the item. |
context |
|
Generic properties of this item (description, tags, labels, references, ...). |
python_class |
python_class_name |
PythonClassMetadata |
The name of the Python class. |
python_module_name |
kiara.models.values.value_metadata.included_metadata_types |
The name of the Python module this class lives in. |
full_name |
kiara.models.values.value_metadata.included_metadata_types.PythonClassMetadata |
The full class namespace. |
|
The python class that implements this module type. |
metadata_schema |
$defs |
PythonClass |
additionalProperties |
False |
description |
Python class and module information. |
properties |
python_class_name |
description |
The name of the Python class. |
title |
Python Class Name |
type |
string |
|
python_module_name |
description |
The name of the Python module this class lives in. |
title |
Python Module Name |
type |
string |
|
full_name |
description |
The full class namespace. |
title |
Full Name |
type |
string |
|
|
required |
-
python_class_name
-
python_module_name
-
full_name
|
title |
PythonClass |
type |
object |
|
|
additionalProperties |
False |
description |
Python class and module information. |
properties |
python_class |
$ref |
#/$defs/PythonClass |
description |
Details about the Python class that backs this value. |
|
|
required |
|
title |
PythonClassMetadata |
type |
object |
|
The (json) schema for this metadata value. |
|
|
The value metadata info instances for each type. |
type_name |
value_metadata |
|
|
The supported property types for this data type. |
type_name |
boolean |
The registered name for this item type. |
documentation |
A boolean.
|
Documentation for the item. |
authors |
|
Information about authorship for the item. |
context |
|
Generic properties of this item (description, tags, labels, references, ...). |
python_class |
python_class_name |
BooleanType |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.BooleanType |
The full class namespace. |
|
The python class that implements this module type. |
value_cls |
python_class_name |
bool |
The name of the Python class. |
python_module_name |
builtins |
The name of the Python module this class lives in. |
full_name |
bool |
The full class namespace. |
|
The python class of the value itself. |
data_type_config_cls |
python_class_name |
DataTypeConfig |
The name of the Python class. |
python_module_name |
kiara.data_types |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.DataTypeConfig |
The full class namespace. |
|
The python class holding the schema for configuring this type. |
lineage |
|
This types lineage. |
qualifier_profiles |
|
A map of qualifier profiles for this data types. |
supported_properties |
group_title |
Metadata models for type 'boolean' |
The group alias. |
item_infos |
|
The value metadata info instances for each type. |
type_name |
value_metadata |
|
|
The supported property types for this data type. |
type_name |
bytes |
The registered name for this item type. |
documentation |
An array of bytes.
|
Documentation for the item. |
authors |
|
Information about authorship for the item. |
context |
|
Generic properties of this item (description, tags, labels, references, ...). |
python_class |
python_class_name |
BytesType |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.BytesType |
The full class namespace. |
|
The python class that implements this module type. |
value_cls |
python_class_name |
bytes |
The name of the Python class. |
python_module_name |
builtins |
The name of the Python module this class lives in. |
full_name |
bytes |
The full class namespace. |
|
The python class of the value itself. |
data_type_config_cls |
python_class_name |
DataTypeConfig |
The name of the Python class. |
python_module_name |
kiara.data_types |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.DataTypeConfig |
The full class namespace. |
|
The python class holding the schema for configuring this type. |
lineage |
|
This types lineage. |
qualifier_profiles |
|
A map of qualifier profiles for this data types. |
supported_properties |
group_title |
Metadata models for type 'bytes' |
The group alias. |
item_infos |
|
The value metadata info instances for each type. |
type_name |
value_metadata |
|
|
The supported property types for this data type. |
type_name |
dict |
The registered name for this item type. |
documentation |
A dictionary.
In addition to the actual dictionary value, this value type comes also with an optional schema, describing the
dictionary. In case no schema was attached, a simple generic one is attached. This data type is backed by the
[DictModel][kiara_plugin.core_types.models.DictModel] class.
|
Documentation for the item. |
authors |
|
Information about authorship for the item. |
context |
|
Generic properties of this item (description, tags, labels, references, ...). |
python_class |
python_class_name |
DictValueType |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.DictValueType |
The full class namespace. |
|
The python class that implements this module type. |
value_cls |
python_class_name |
KiaraDict |
The name of the Python class. |
python_module_name |
kiara.models.data_types |
The name of the Python module this class lives in. |
full_name |
kiara.models.data_types.KiaraDict |
The full class namespace. |
|
The python class of the value itself. |
data_type_config_cls |
python_class_name |
DataTypeConfig |
The name of the Python class. |
python_module_name |
kiara.data_types |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.DataTypeConfig |
The full class namespace. |
|
The python class holding the schema for configuring this type. |
lineage |
|
This types lineage. |
qualifier_profiles |
|
A map of qualifier profiles for this data types. |
supported_properties |
group_title |
Metadata models for type 'dict' |
The group alias. |
item_infos |
|
The value metadata info instances for each type. |
type_name |
value_metadata |
|
|
The supported property types for this data type. |
type_name |
doc |
The registered name for this item type. |
documentation |
Documentation for an internal entity.
|
Documentation for the item. |
authors |
|
Information about authorship for the item. |
context |
|
Generic properties of this item (description, tags, labels, references, ...). |
python_class |
python_class_name |
DocumentationModelValueType |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types.internal |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.internal.DocumentationModelValueType |
The full class namespace. |
|
The python class that implements this module type. |
value_cls |
python_class_name |
DocumentationMetadataModel |
The name of the Python class. |
python_module_name |
kiara.models.documentation |
The name of the Python module this class lives in. |
full_name |
kiara.models.documentation.DocumentationMetadataModel |
The full class namespace. |
|
The python class of the value itself. |
data_type_config_cls |
python_class_name |
InternalModelTypeConfig |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types.internal |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.internal.InternalModelTypeConfig |
The full class namespace. |
|
The python class holding the schema for configuring this type. |
lineage |
-
doc
-
internal_model
-
internal
|
This types lineage. |
qualifier_profiles |
|
A map of qualifier profiles for this data types. |
supported_properties |
group_title |
Metadata models for type 'doc' |
The group alias. |
item_infos |
|
The value metadata info instances for each type. |
type_name |
value_metadata |
|
|
The supported property types for this data type. |
type_name |
file |
The registered name for this item type. |
documentation |
A file.
|
Documentation for the item. |
authors |
|
Information about authorship for the item. |
context |
|
Generic properties of this item (description, tags, labels, references, ...). |
python_class |
python_class_name |
FileValueType |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types.filesystem |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.filesystem.FileValueType |
The full class namespace. |
|
The python class that implements this module type. |
value_cls |
python_class_name |
KiaraFile |
The name of the Python class. |
python_module_name |
kiara.models.filesystem |
The name of the Python module this class lives in. |
full_name |
kiara.models.filesystem.KiaraFile |
The full class namespace. |
|
The python class of the value itself. |
data_type_config_cls |
python_class_name |
FileTypeConfig |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types.filesystem |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.filesystem.FileTypeConfig |
The full class namespace. |
|
The python class holding the schema for configuring this type. |
lineage |
|
This types lineage. |
qualifier_profiles |
csv_file |
type_name |
file |
type_config |
|
|
json_file |
type_name |
file |
type_config |
|
|
text_file |
type_name |
file |
type_config |
|
|
binary_file |
type_name |
file |
type_config |
|
|
|
A map of qualifier profiles for this data types. |
supported_properties |
group_title |
Metadata models for type 'file' |
The group alias. |
item_infos |
metadata.file |
type_name |
file |
The registered name for this item type. |
documentation |
File stats.
|
Documentation for the item. |
authors |
|
Information about authorship for the item. |
context |
|
Generic properties of this item (description, tags, labels, references, ...). |
python_class |
python_class_name |
FileMetadata |
The name of the Python class. |
python_module_name |
kiara.models.values.value_metadata.included_metadata_types |
The name of the Python module this class lives in. |
full_name |
kiara.models.values.value_metadata.included_metadata_types.FileMetadata |
The full class namespace. |
|
The python class that implements this module type. |
metadata_schema |
$defs |
KiaraFile |
additionalProperties |
False |
description |
Describes properties for the 'file' value type. |
properties |
mime_type |
description |
The mime type of the file. |
title |
Mime Type |
type |
string |
|
file_name |
default |
The name of the file. |
title |
File Name |
type |
string |
|
size |
description |
The size of the file. |
title |
Size |
type |
integer |
|
metadata |
additionalProperties |
True |
description |
Additional, unstructured, user-defined metadata. |
title |
Metadata |
type |
object |
|
metadata_schemas |
additionalProperties |
|
description |
The metadata schemas for each of the metadata values (if available). |
title |
Metadata Schemas |
type |
object |
|
|
required |
|
title |
KiaraFile |
type |
object |
|
|
additionalProperties |
False |
description |
File stats. |
properties |
file |
$ref |
#/$defs/KiaraFile |
description |
The file-specific metadata. |
|
|
required |
|
title |
FileMetadata |
type |
object |
|
The (json) schema for this metadata value. |
|
|
The value metadata info instances for each type. |
type_name |
value_metadata |
|
|
The supported property types for this data type. |
type_name |
file_bundle |
The registered name for this item type. |
documentation |
A bundle of files (like a folder, zip archive, etc.).
|
Documentation for the item. |
authors |
|
Information about authorship for the item. |
context |
|
Generic properties of this item (description, tags, labels, references, ...). |
python_class |
python_class_name |
FileBundleValueType |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types.filesystem |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.filesystem.FileBundleValueType |
The full class namespace. |
|
The python class that implements this module type. |
value_cls |
python_class_name |
KiaraFileBundle |
The name of the Python class. |
python_module_name |
kiara.models.filesystem |
The name of the Python module this class lives in. |
full_name |
kiara.models.filesystem.KiaraFileBundle |
The full class namespace. |
|
The python class of the value itself. |
data_type_config_cls |
python_class_name |
FileTypeConfig |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types.filesystem |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.filesystem.FileTypeConfig |
The full class namespace. |
|
The python class holding the schema for configuring this type. |
lineage |
|
This types lineage. |
qualifier_profiles |
csv_file_bundle |
type_name |
file_bundle |
type_config |
|
|
json_file_bundle |
type_name |
file_bundle |
type_config |
|
|
text_file_bundle |
type_name |
file_bundle |
type_config |
|
|
binary_file_bundle |
type_name |
file_bundle |
type_config |
|
|
|
A map of qualifier profiles for this data types. |
supported_properties |
group_title |
Metadata models for type 'file_bundle' |
The group alias. |
item_infos |
metadata.file_bundle |
type_name |
file_bundle |
The registered name for this item type. |
documentation |
File bundle stats.
|
Documentation for the item. |
authors |
|
Information about authorship for the item. |
context |
|
Generic properties of this item (description, tags, labels, references, ...). |
python_class |
python_class_name |
FileBundleMetadata |
The name of the Python class. |
python_module_name |
kiara.models.values.value_metadata.included_metadata_types |
The name of the Python module this class lives in. |
full_name |
kiara.models.values.value_metadata.included_metadata_types.FileBundleMetadata |
The full class namespace. |
|
The python class that implements this module type. |
metadata_schema |
$defs |
KiaraFile |
additionalProperties |
False |
description |
Describes properties for the 'file' value type. |
properties |
mime_type |
description |
The mime type of the file. |
title |
Mime Type |
type |
string |
|
file_name |
default |
The name of the file. |
title |
File Name |
type |
string |
|
size |
description |
The size of the file. |
title |
Size |
type |
integer |
|
metadata |
additionalProperties |
True |
description |
Additional, unstructured, user-defined metadata. |
title |
Metadata |
type |
object |
|
metadata_schemas |
additionalProperties |
|
description |
The metadata schemas for each of the metadata values (if available). |
title |
Metadata Schemas |
type |
object |
|
|
required |
|
title |
KiaraFile |
type |
object |
|
KiaraFileBundle |
additionalProperties |
False |
description |
Describes properties for the 'file_bundle' value type. |
properties |
bundle_name |
description |
The name of this bundle. |
title |
Bundle Name |
type |
string |
|
number_of_files |
description |
How many files are included in this bundle. |
title |
Number Of Files |
type |
integer |
|
included_files |
additionalProperties |
|
description |
A map of all the included files, incl. their properties. Uses the relative path of each file as key. |
title |
Included Files |
type |
object |
|
size |
description |
The size of all files in this folder, combined. |
title |
Size |
type |
integer |
|
metadata |
additionalProperties |
True |
description |
Additional, ustructured, user-defined metadata. |
title |
Metadata |
type |
object |
|
metadata_schemas |
additionalProperties |
|
description |
The metadata schemas for each metadata value (if available). |
title |
Metadata Schemas |
type |
object |
|
|
required |
-
bundle_name
-
number_of_files
-
included_files
-
size
|
title |
KiaraFileBundle |
type |
object |
|
|
additionalProperties |
False |
description |
File bundle stats. |
properties |
file_bundle |
$ref |
#/$defs/KiaraFileBundle |
description |
The file-specific metadata. |
|
|
required |
|
title |
FileBundleMetadata |
type |
object |
|
The (json) schema for this metadata value. |
|
|
The value metadata info instances for each type. |
type_name |
value_metadata |
|
|
The supported property types for this data type. |
type_name |
internal |
The registered name for this item type. |
documentation |
'A 'marker' base data type for data types that are (mainly) used internally in kiara..
|
Documentation for the item. |
authors |
|
Information about authorship for the item. |
context |
|
Generic properties of this item (description, tags, labels, references, ...). |
python_class |
python_class_name |
InternalType |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types.internal |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.internal.InternalType |
The full class namespace. |
|
The python class that implements this module type. |
value_cls |
python_class_name |
object |
The name of the Python class. |
python_module_name |
builtins |
The name of the Python module this class lives in. |
full_name |
object |
The full class namespace. |
|
The python class of the value itself. |
data_type_config_cls |
python_class_name |
DataTypeConfig |
The name of the Python class. |
python_module_name |
kiara.data_types |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.DataTypeConfig |
The full class namespace. |
|
The python class holding the schema for configuring this type. |
lineage |
|
This types lineage. |
qualifier_profiles |
|
A map of qualifier profiles for this data types. |
supported_properties |
group_title |
Metadata models for type 'internal' |
The group alias. |
item_infos |
|
The value metadata info instances for each type. |
type_name |
value_metadata |
|
|
The supported property types for this data type. |
type_name |
internal_model |
The registered name for this item type. |
documentation |
A value type that is used internally.
This type should not be used by user-facing modules and/or operations.
|
Documentation for the item. |
authors |
|
Information about authorship for the item. |
context |
|
Generic properties of this item (description, tags, labels, references, ...). |
python_class |
python_class_name |
InternalModelValueType |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types.internal |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.internal.InternalModelValueType |
The full class namespace. |
|
The python class that implements this module type. |
value_cls |
python_class_name |
KiaraModel |
The name of the Python class. |
python_module_name |
kiara.models |
The name of the Python module this class lives in. |
full_name |
kiara.models.KiaraModel |
The full class namespace. |
|
The python class of the value itself. |
data_type_config_cls |
python_class_name |
InternalModelTypeConfig |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types.internal |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.internal.InternalModelTypeConfig |
The full class namespace. |
|
The python class holding the schema for configuring this type. |
lineage |
|
This types lineage. |
qualifier_profiles |
|
A map of qualifier profiles for this data types. |
supported_properties |
group_title |
Metadata models for type 'internal_model' |
The group alias. |
item_infos |
|
The value metadata info instances for each type. |
type_name |
value_metadata |
|
|
The supported property types for this data type. |
type_name |
none |
The registered name for this item type. |
documentation |
Type indicating a 'None' value.
|
Documentation for the item. |
authors |
|
Information about authorship for the item. |
context |
|
Generic properties of this item (description, tags, labels, references, ...). |
python_class |
python_class_name |
NoneType |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.NoneType |
The full class namespace. |
|
The python class that implements this module type. |
value_cls |
python_class_name |
SpecialValue |
The name of the Python class. |
python_module_name |
kiara.defaults |
The name of the Python module this class lives in. |
full_name |
kiara.defaults.SpecialValue |
The full class namespace. |
|
The python class of the value itself. |
data_type_config_cls |
python_class_name |
DataTypeConfig |
The name of the Python class. |
python_module_name |
kiara.data_types |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.DataTypeConfig |
The full class namespace. |
|
The python class holding the schema for configuring this type. |
lineage |
|
This types lineage. |
qualifier_profiles |
|
A map of qualifier profiles for this data types. |
supported_properties |
group_title |
Metadata models for type 'none' |
The group alias. |
item_infos |
|
The value metadata info instances for each type. |
type_name |
value_metadata |
|
|
The supported property types for this data type. |
type_name |
internal |
The registered name for this item type. |
documentation |
'A 'marker' base data type for data types that are (mainly) used internally in kiara..
|
Documentation for the item. |
authors |
|
Information about authorship for the item. |
context |
|
Generic properties of this item (description, tags, labels, references, ...). |
python_class |
python_class_name |
InternalType |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types.internal |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.internal.InternalType |
The full class namespace. |
|
The python class that implements this module type. |
value_cls |
python_class_name |
object |
The name of the Python class. |
python_module_name |
builtins |
The name of the Python module this class lives in. |
full_name |
object |
The full class namespace. |
|
The python class of the value itself. |
data_type_config_cls |
python_class_name |
DataTypeConfig |
The name of the Python class. |
python_module_name |
kiara.data_types |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.DataTypeConfig |
The full class namespace. |
|
The python class holding the schema for configuring this type. |
lineage |
|
This types lineage. |
qualifier_profiles |
|
A map of qualifier profiles for this data types. |
supported_properties |
group_title |
Metadata models for type 'internal' |
The group alias. |
item_infos |
|
The value metadata info instances for each type. |
type_name |
value_metadata |
|
|
The supported property types for this data type. |
type_name |
render_scene |
The registered name for this item type. |
documentation |
A value type to contain information about how to render a value in a specific render scenario.
|
Documentation for the item. |
authors |
|
Information about authorship for the item. |
context |
|
Generic properties of this item (description, tags, labels, references, ...). |
python_class |
python_class_name |
RenderSceneDataType |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types.internal.render_value |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.internal.render_value.RenderSceneDataType |
The full class namespace. |
|
The python class that implements this module type. |
value_cls |
python_class_name |
RenderScene |
The name of the Python class. |
python_module_name |
kiara.models.rendering |
The name of the Python module this class lives in. |
full_name |
kiara.models.rendering.RenderScene |
The full class namespace. |
|
The python class of the value itself. |
data_type_config_cls |
python_class_name |
RenderSceneTypeConfig |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types.internal.render_value |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.internal.render_value.RenderSceneTypeConfig |
The full class namespace. |
|
The python class holding the schema for configuring this type. |
lineage |
|
This types lineage. |
qualifier_profiles |
|
A map of qualifier profiles for this data types. |
supported_properties |
group_title |
Metadata models for type 'render_scene' |
The group alias. |
item_infos |
|
The value metadata info instances for each type. |
type_name |
value_metadata |
|
|
The supported property types for this data type. |
type_name |
render_value_result |
The registered name for this item type. |
documentation |
A value type to contain information about how to render a value in a specific render scenario.
|
Documentation for the item. |
authors |
|
Information about authorship for the item. |
context |
|
Generic properties of this item (description, tags, labels, references, ...). |
python_class |
python_class_name |
RenderValueResultDataType |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types.internal.render_value |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.internal.render_value.RenderValueResultDataType |
The full class namespace. |
|
The python class that implements this module type. |
value_cls |
python_class_name |
RenderValueResult |
The name of the Python class. |
python_module_name |
kiara.models.rendering |
The name of the Python module this class lives in. |
full_name |
kiara.models.rendering.RenderValueResult |
The full class namespace. |
|
The python class of the value itself. |
data_type_config_cls |
python_class_name |
DataTypeConfig |
The name of the Python class. |
python_module_name |
kiara.data_types |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.DataTypeConfig |
The full class namespace. |
|
The python class holding the schema for configuring this type. |
lineage |
-
render_value_result
-
internal
|
This types lineage. |
qualifier_profiles |
|
A map of qualifier profiles for this data types. |
supported_properties |
group_title |
Metadata models for type 'render_value_result' |
The group alias. |
item_infos |
|
The value metadata info instances for each type. |
type_name |
value_metadata |
|
|
The supported property types for this data type. |
type_name |
string |
The registered name for this item type. |
documentation |
A string.
Can be configured to only allow a list of specific strings by using the allowed_strings configuration option.
|
Documentation for the item. |
authors |
|
Information about authorship for the item. |
context |
|
Generic properties of this item (description, tags, labels, references, ...). |
python_class |
python_class_name |
StringType |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.StringType |
The full class namespace. |
|
The python class that implements this module type. |
value_cls |
python_class_name |
str |
The name of the Python class. |
python_module_name |
builtins |
The name of the Python module this class lives in. |
full_name |
str |
The full class namespace. |
|
The python class of the value itself. |
data_type_config_cls |
python_class_name |
StringTypeConfig |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.StringTypeConfig |
The full class namespace. |
|
The python class holding the schema for configuring this type. |
lineage |
|
This types lineage. |
qualifier_profiles |
|
A map of qualifier profiles for this data types. |
supported_properties |
group_title |
Metadata models for type 'string' |
The group alias. |
item_infos |
|
The value metadata info instances for each type. |
type_name |
value_metadata |
|
|
The supported property types for this data type. |
type_name |
terminal_renderable |
The registered name for this item type. |
documentation |
A list of renderable objects, used in the 'rich' Python library, to print to the terminal or in Jupyter.
Internally, the result list items can be either a string, a 'rich.console.ConsoleRenderable', or a 'rich.console.RichCast'.
|
Documentation for the item. |
authors |
|
Information about authorship for the item. |
context |
|
Generic properties of this item (description, tags, labels, references, ...). |
python_class |
python_class_name |
TerminalRenderable |
The name of the Python class. |
python_module_name |
kiara.data_types.included_core_types.internal |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.included_core_types.internal.TerminalRenderable |
The full class namespace. |
|
The python class that implements this module type. |
value_cls |
python_class_name |
object |
The name of the Python class. |
python_module_name |
builtins |
The name of the Python module this class lives in. |
full_name |
object |
The full class namespace. |
|
The python class of the value itself. |
data_type_config_cls |
python_class_name |
DataTypeConfig |
The name of the Python class. |
python_module_name |
kiara.data_types |
The name of the Python module this class lives in. |
full_name |
kiara.data_types.DataTypeConfig |
The full class namespace. |
|
The python class holding the schema for configuring this type. |
lineage |
-
terminal_renderable
-
internal
|
This types lineage. |
qualifier_profiles |
|
A map of qualifier profiles for this data types. |
supported_properties |
group_title |
Metadata models for type 'terminal_renderable' |
The group alias. |
item_infos |
|
The value metadata info instances for each type. |
type_name |
value_metadata |
|
|
The supported property types for this data type. |