data_types

any

type_name	any	The registered name for this item type.
documentation	description 'Any' type, the parent type for most other types. Short description of the item. doc 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). Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	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	any	This types lineage.
qualifier_profiles		A map of qualifier profiles for this data types.

boolean

type_name	boolean	The registered name for this item type.
documentation	description A boolean. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	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	boolean any	This types lineage.
qualifier_profiles		A map of qualifier profiles for this data types.

bytes

type_name	bytes	The registered name for this item type.
documentation	description An array of bytes. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	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	bytes any	This types lineage.
qualifier_profiles		A map of qualifier profiles for this data types.

dict

type_name	dict	The registered name for this item type.
documentation	description A dictionary. Short description of the item. doc 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. Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	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	dict any	This types lineage.
qualifier_profiles		A map of qualifier profiles for this data types.

doc

type_name	doc	The registered name for this item type.
documentation	description Documentation for an internal entity. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	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.

file

type_name	file	The registered name for this item type.
documentation	description A file. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	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	file any	This types lineage.
qualifier_profiles	csv_file type_name file type_config content_type csv json_file type_name file type_config content_type json text_file type_name file type_config content_type text binary_file type_name file type_config content_type binary	A map of qualifier profiles for this data types.

file_bundle

type_name	file_bundle	The registered name for this item type.
documentation	description A bundle of files (like a folder, zip archive, etc.). Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	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	file_bundle any	This types lineage.
qualifier_profiles	csv_file_bundle type_name file_bundle type_config content_type csv json_file_bundle type_name file_bundle type_config content_type json text_file_bundle type_name file_bundle type_config content_type text binary_file_bundle type_name file_bundle type_config content_type binary	A map of qualifier profiles for this data types.

internal

type_name	internal	The registered name for this item type.
documentation	description 'A 'marker' base data type for data types that are (mainly) used internally in kiara.. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	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	internal	This types lineage.
qualifier_profiles		A map of qualifier profiles for this data types.

internal_model

type_name	internal_model	The registered name for this item type.
documentation	description A value type that is used internally. Short description of the item. doc This type should not be used by user-facing modules and/or operations. Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	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	internal_model internal	This types lineage.
qualifier_profiles		A map of qualifier profiles for this data types.

none

type_name	none	The registered name for this item type.
documentation	description Type indicating a 'None' value. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	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	none	This types lineage.
qualifier_profiles		A map of qualifier profiles for this data types.

internal

type_name	internal	The registered name for this item type.
documentation	description 'A 'marker' base data type for data types that are (mainly) used internally in kiara.. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	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	internal	This types lineage.
qualifier_profiles		A map of qualifier profiles for this data types.

render_scene

type_name	render_scene	The registered name for this item type.
documentation	description A value type to contain information about how to render a value in a specific render scenario. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	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	render_scene internal	This types lineage.
qualifier_profiles		A map of qualifier profiles for this data types.

render_value_result

type_name	render_value_result	The registered name for this item type.
documentation	description A value type to contain information about how to render a value in a specific render scenario. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	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.

string

type_name	string	The registered name for this item type.
documentation	description A string. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	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	string any	This types lineage.
qualifier_profiles		A map of qualifier profiles for this data types.

terminal_renderable

type_name	terminal_renderable	The registered name for this item type.
documentation	description A list of renderable objects, used in the 'rich' Python library, to print to the terminal or in Jupyter. Short description of the item. doc Internally, the result list items can be either a string, a 'rich.console.ConsoleRenderable', or a 'rich.console.RichCast'. Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	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.