Summary

Package content¶

data_types¶

any: 'Any' type, the parent type for most other types.
bytes: An array of bytes.
doc: Documentation for an internal entity.
file: A file.
file_bundle: A bundle of files (like a folder, zip archive, etc.).
internal: 'A 'marker' base data type for data types that are (mainly) used internally in kiara..
internal_model: A value type that is used internally.
none: Type indicating a 'None' value
[python_object][kiara_info.data_types.python_object]: A 'plain' Python object.
render_instruction: A value type to contain information about how to render a value in a specific render scenario.
render_metadata: A value type to contain information about how to render a value in a specific render scenario.
string: A string.
terminal_renderable: A list of renderable objects, used in the 'rich' Python library, to print to the terminal or in Jupyter.

module_types¶

deserialize.file: Deserialize data to a 'file' value instance.
deserialize.file_bundle: Deserialize data to a 'file' value instance.
deserialize.from_json: -- n/a --
import.file: Import a file from the local filesystem.
import.file_bundle: Import a folder (file_bundle) from the local filesystem.
load.bytes: -- n/a --
load.internal_model: -- n/a --
load.string: -- n/a --
pipeline: -- n/a --
pretty_print.any.value: -- n/a --
pretty_print.value: -- n/a --
render.value: -- n/a --
unpickle.value: -- n/a --
value.extract_metadata: Base class to use when writing a module to extract metadata from a file.

kiara_model_types¶

metadata.authors: -- n/a --
metadata.context: -- n/a --
metadata.documentation: -- n/a --
instance.wrapped_python_class: Python class and module information.
metadata.kiara_module_class: -- n/a --
info.kiara_model: -- n/a --
info.kiara_module_type: -- n/a --
info.archive_type: -- n/a --
info.operation_type: -- n/a --
info.data_type: -- n/a --
info.metadata_type: -- n/a --
archive_info: -- n/a --
info.operation: -- n/a --
info.pipeline: -- n/a --
info.kiara_models: -- n/a --
info.module_types: -- n/a --
info.archive_types: -- n/a --
info.operation_types: -- n/a --
info.data_types: -- n/a --
info.metadata_types: -- n/a --
info.archives: -- n/a --
info.operations: -- n/a --
instance.value_schema: The schema of a value.
instance.module_config: Base class that describes the configuration a [KiaraModule][kiara.module.KiaraModule] class accepts.
instance.module_config.pipeline: A class to hold the configuration for a [PipelineModule][kiara.pipeline.module.PipelineModule].
metadata.module_config: -- n/a --
instance.manifest: A class to hold the type and configuration for a module instance.
instance.manifest_with_inputs: -- n/a --
instance.value_pedigree: -- n/a --
instance.job_config: -- n/a --
instance.job_record: -- n/a --
instance.pipeline_step: A step within a pipeline-structure, includes information about it's connection(s) and other metadata.
instance.operation: -- n/a --
instance.destiny: A destiny is basically a link to a potential future transformation result involving one or several values as input.
metadata.serialized_data: -- n/a --
instance.serialization_result: -- n/a --
instance.persisted_data: -- n/a --
instance.value_details: A wrapper class that manages and retieves value data and its details.
instance.value: -- n/a --
info.value: -- n/a --
instance.unloadable_data: A special 'marker' model, indicating that the data of value can't be loaded.
instance.value_map.readonly: -- n/a --
instance.value_map.writeable: -- n/a --
instance.value_map.aliases: -- n/a --
info.runtime.kiara_types: -- n/a --
info.runtime.os: Manages information about the OS this kiara instance is running in.
info.runtime.python: -- n/a --
info.runtime.kiara_plugins: -- n/a --
context_summary: -- n/a --
instance.execution_context: -- n/a --
instance.active_job: -- n/a --
instance.operation_details: -- n/a --
instance.operation_details.base: -- n/a --
instance.operation_config.manifest: -- n/a --
instance.operation_config.pipeline: -- n/a --
render_metadata: -- n/a --
metadata.python_class: Python class and module information.
metadata.file: File stats.
metadata.file_bundle: File bundle stats.
instance.workflow: -- n/a --
instance.data.file: Describes properties for the 'file' value type.
instance.data.file_bundle: Describes properties for the 'file_bundle' value type.
instance.pipeline_structure: An object that holds one or several steps, and describes the connections between them.

operation_types¶

create_from: -- n/a --
custom_module: -- n/a --
deserialize: An operation that takes a value, and serializes it into the format suitable to the [serialized_value][kiara.data_types.included_core_types.SeriailzedValue] value type.
export_as: -- n/a --
extract_metadata: An operation that extracts metadata of a specific type from value data.
pipeline: -- n/a --
pretty_print: An operation that takes a value, and renders into a format that can be printed for output..
render_value: An operation that renders a value.

operations¶

deserialize.bytes.as.python_object: -- n/a --
deserialize.file.as.python_object: -- n/a --
deserialize.file_bundle.as.python_object: -- n/a --
deserialize.from_json: -- n/a --
deserialize.internal_model.as.python_object: -- n/a --
deserialize.string.as.python_object: -- n/a --
deserialize.value: -- n/a --
extract.file.metadata.from.file: Extract 'file' metadata for value type 'file'.
extract.file_bundle.metadata.from.file_bundle: Extract 'file_bundle' metadata for value type 'file_bundle'.
extract.python_class.metadata: Extract 'python_class' metadata for value type 'any'.
import.file: Import a file from the local filesystem.
import.file_bundle: Import a folder (file_bundle) from the local filesystem.
pretty_print.as.string: Pretty print a any value as a string.
pretty_print.bytes.as.string: Pretty print a bytes value as a string.
pretty_print.doc.as.terminal_renderable: Pretty print a doc value as a terminal_renderable.
pretty_print.file.as.terminal_renderable: Pretty print a file value as a terminal_renderable.
pretty_print.file_bundle.as.terminal_renderable: Pretty print a file_bundle value as a terminal_renderable.
pretty_print.internal.as.string: Pretty print a internal value as a string.
pretty_print.internal_model.as.terminal_renderable: Pretty print a internal_model value as a terminal_renderable.
pretty_print.none.as.string: Pretty print a none value as a string.
pretty_print.python_object.as.terminal_renderable: Pretty print a python_object value as a terminal_renderable.
pretty_print.render_instruction.as.string: Pretty print a render_instruction value as a string.
pretty_print.render_metadata.as.string: Pretty print a render_metadata value as a string.
pretty_print.string.as.string: Pretty print a string value as a string.
pretty_print.terminal_renderable.as.string: Pretty print a terminal_renderable value as a string.