data_types
any
lineage any
qualifier profile(s) -- n/a --
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).
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name AnyType
python_module_name kiara.data_types.included_core_types
full_name kiara.data_types.included_core_types.AnyType
Config class
python_class_name DataTypeConfig
python_module_name kiara.data_types
full_name kiara.data_types.DataTypeConfig
Value class
python_class_name object
python_module_name builtins
full_name object
bytes
lineage bytes
any
qualifier profile(s) -- n/a --
Documentation
An array of bytes.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name BytesType
python_module_name kiara.data_types.included_core_types
full_name kiara.data_types.included_core_types.BytesType
Config class
python_class_name DataTypeConfig
python_module_name kiara.data_types
full_name kiara.data_types.DataTypeConfig
Value class
python_class_name bytes
python_module_name builtins
full_name bytes
doc
lineage doc
internal_model
internal
qualifier profile(s) -- n/a --
Documentation
Documentation for an internal entity.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name DocumentationModelValueType
python_module_name kiara.data_types.included_core_types.internal
full_name kiara.data_types.included_core_types.internal.DocumentationModelValueType
Config class
python_class_name InternalModelTypeConfig
python_module_name kiara.data_types.included_core_types.internal
full_name kiara.data_types.included_core_types.internal.InternalModelTypeConfig
Value class
python_class_name DocumentationMetadataModel
python_module_name kiara.models.documentation
full_name kiara.models.documentation.DocumentationMetadataModel
file
lineage file
any
qualifier profile(s)
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"
}
}
Documentation
A file.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name FileValueType
python_module_name kiara.data_types.included_core_types.filesystem
full_name kiara.data_types.included_core_types.filesystem.FileValueType
Config class
python_class_name FileTypeConfig
python_module_name kiara.data_types.included_core_types.filesystem
full_name kiara.data_types.included_core_types.filesystem.FileTypeConfig
Value class
python_class_name FileModel
python_module_name kiara.models.filesystem
full_name kiara.models.filesystem.FileModel
file_bundle
lineage file_bundle
any
qualifier profile(s)
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"
}
}
Documentation
A bundle of files (like a folder, zip archive, etc.).
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name FileBundleValueType
python_module_name kiara.data_types.included_core_types.filesystem
full_name kiara.data_types.included_core_types.filesystem.FileBundleValueType
Config class
python_class_name FileTypeConfig
python_module_name kiara.data_types.included_core_types.filesystem
full_name kiara.data_types.included_core_types.filesystem.FileTypeConfig
Value class
python_class_name FileBundle
python_module_name kiara.models.filesystem
full_name kiara.models.filesystem.FileBundle
internal
lineage internal
qualifier profile(s) -- n/a --
Documentation
'A 'marker' base data type for data types that are (mainly) used internally in kiara..
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name InternalType
python_module_name kiara.data_types.included_core_types.internal
full_name kiara.data_types.included_core_types.internal.InternalType
Config class
python_class_name DataTypeConfig
python_module_name kiara.data_types
full_name kiara.data_types.DataTypeConfig
Value class
python_class_name object
python_module_name builtins
full_name object
internal_model
lineage internal_model
internal
qualifier profile(s) -- n/a --
Documentation
A value type that is used internally.
This type should not be used by user-facing modules and/or operations.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name InternalModelValueType
python_module_name kiara.data_types.included_core_types.internal
full_name kiara.data_types.included_core_types.internal.InternalModelValueType
Config class
python_class_name InternalModelTypeConfig
python_module_name kiara.data_types.included_core_types.internal
full_name kiara.data_types.included_core_types.internal.InternalModelTypeConfig
Value class
python_class_name KiaraModel
python_module_name kiara.models
full_name kiara.models.KiaraModel
none
lineage none
qualifier profile(s) -- n/a --
Documentation
Type indicating a 'None' value
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name NoneType
python_module_name kiara.data_types.included_core_types
full_name kiara.data_types.included_core_types.NoneType
Config class
python_class_name DataTypeConfig
python_module_name kiara.data_types
full_name kiara.data_types.DataTypeConfig
Value class
python_class_name SpecialValue
python_module_name kiara.defaults
full_name kiara.defaults.SpecialValue
internal
lineage internal
qualifier profile(s) -- n/a --
Documentation
'A 'marker' base data type for data types that are (mainly) used internally in kiara..
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name InternalType
python_module_name kiara.data_types.included_core_types.internal
full_name kiara.data_types.included_core_types.internal.InternalType
Config class
python_class_name DataTypeConfig
python_module_name kiara.data_types
full_name kiara.data_types.DataTypeConfig
Value class
python_class_name object
python_module_name builtins
full_name object
render_instruction
lineage render_instruction
internal
qualifier profile(s) -- n/a --
Documentation
A value type to contain information about how to render a value in a specific render scenario.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name RenderInstructionDataType
python_module_name kiara.data_types.included_core_types.internal.render_value
full_name kiara.data_types.included_core_types.internal.render_value.RenderInstructionDataType
Config class
python_class_name RenderInstructionTypeConfig
python_module_name kiara.data_types.included_core_types.internal.render_value
full_name kiara.data_types.included_core_types.internal.render_value.RenderInstructionTypeConfig
Value class
python_class_name RenderInstruction
python_module_name kiara.models.render_value
full_name kiara.models.render_value.RenderInstruction
lineage render_metadata
internal
qualifier profile(s) -- n/a --
Documentation
A value type to contain information about how to render a value in a specific render scenario.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name RenderMetadataDataType
python_module_name kiara.data_types.included_core_types.internal.render_value
full_name kiara.data_types.included_core_types.internal.render_value.RenderMetadataDataType
Config class
python_class_name DataTypeConfig
python_module_name kiara.data_types
full_name kiara.data_types.DataTypeConfig
Value class
python_class_name RenderMetadata
python_module_name kiara.models.render_value
full_name kiara.models.render_value.RenderMetadata
string
lineage string
any
qualifier profile(s) -- n/a --
Documentation
A string.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name StringType
python_module_name kiara.data_types.included_core_types
full_name kiara.data_types.included_core_types.StringType
Config class
python_class_name DataTypeConfig
python_module_name kiara.data_types
full_name kiara.data_types.DataTypeConfig
Value class
python_class_name str
python_module_name builtins
full_name str
terminal_renderable
lineage terminal_renderable
internal
qualifier profile(s) -- n/a --
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'.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo: https://github.com/DHARPA-Project/kiara
documentation: https://dharpa.org/kiara_documentation/
Python class
python_class_name TerminalRenderable
python_module_name kiara.data_types.included_core_types.internal
full_name kiara.data_types.included_core_types.internal.TerminalRenderable
Config class
python_class_name DataTypeConfig
python_module_name kiara.data_types
full_name kiara.data_types.DataTypeConfig
Value class
python_class_name object
python_module_name builtins
full_name object