operations

create.file.from.bytes

Documentation	Import a file from a byte array.
Inputs	field name type description required default bytes bytes The bytes array to import. yes file_name string The name of the file. yes
Outputs	field name type description required default file file The loaded files. yes

deserialize.bytes.as.python_object

Documentation	-- n/a --
Inputs	field name type description required default bytes bytes The value object. yes deserialization_config any Serialization-format specific configuration. no
Outputs	field name type description required default python_object python_object The deserialized python object instance. yes

deserialize.file.as.python_object

Documentation	-- n/a --
Inputs	field name type description required default file file The value object. yes deserialization_config any Serialization-format specific configuration. no
Outputs	field name type description required default python_object python_object The deserialized python object instance. yes

deserialize.file_bundle.as.python_object

Documentation	-- n/a --
Inputs	field name type description required default file_bundle file_bundle The value object. yes deserialization_config any Serialization-format specific configuration. no
Outputs	field name type description required default python_object python_object The deserialized python object instance. yes

deserialize.from_json

Documentation	-- n/a --
Inputs	field name type description required default value any The value object to deserialize the data for. yes
Outputs	field name type description required default python_object python_object The deserialized python object. yes

deserialize.internal_model.as.python_object

Documentation	-- n/a --
Inputs	field name type description required default internal_model internal_model The value object. yes deserialization_config any Serialization-format specific configuration. no
Outputs	field name type description required default python_object python_object The deserialized python object instance. yes

deserialize.string.as.python_object

Documentation	-- n/a --
Inputs	field name type description required default string string The value object. yes deserialization_config any Serialization-format specific configuration. no
Outputs	field name type description required default python_object python_object The deserialized python object instance. yes

deserialize.value

Documentation	-- n/a --
Inputs	field name type description required default any any The value object. yes deserialization_config any Serialization-format specific configuration. no
Outputs	field name type description required default python_object python_object The deserialized python object instance. yes

export.file.as.file

Documentation	-- n/a --
Inputs	field name type description required default file file A value of type 'file'. yes base_path string The directory to export the file(s) to. no name string The (base) name of the exported file(s). no export_metadata boolean Whether to also export the value metadata. no False
Outputs	field name type description required default export_details dict Details about the exported files/folders. yes

extract.file.metadata.from.file

Documentation	Extract 'file' metadata for value type 'file'.
Inputs	field name type description required default value file A value of type 'file' yes
Outputs	field name type description required default value_metadata internal_model The metadata for the provided value. yes

extract.file_bundle.metadata.from.file_bundle

Documentation	Extract 'file_bundle' metadata for value type 'file_bundle'.
Inputs	field name type description required default value file_bundle A value of type 'file_bundle' yes
Outputs	field name type description required default value_metadata internal_model The metadata for the provided value. yes

extract.kiara_model_list.metadata.from.kiara_model_list

Documentation	Extract 'kiara_model_list' metadata for value type 'kiara_model_list'.
Inputs	field name type description required default value kiara_model_list A value of type 'kiara_model_list' yes
Outputs	field name type description required default value_metadata internal_model The metadata for the provided value. yes

extract.kiara_model_schema.metadata.from.kiara_model

Documentation	Extract 'kiara_model_schema' metadata for value type 'kiara_model'.
Inputs	field name type description required default value kiara_model A value of type 'kiara_model' yes
Outputs	field name type description required default value_metadata internal_model The metadata for the provided value. yes

extract.kiara_model_schema.metadata.from.kiara_model_list

Documentation	Extract 'kiara_model_schema' metadata for value type 'kiara_model_list'.
Inputs	field name type description required default value kiara_model_list A value of type 'kiara_model_list' yes
Outputs	field name type description required default value_metadata internal_model The metadata for the provided value. yes

extract.python_class.metadata

Documentation	Extract 'python_class' metadata for value type 'any'.
Inputs	field name type description required default value any A value of type 'any' yes
Outputs	field name type description required default value_metadata internal_model The metadata for the provided value. yes

file_bundle.pick.file

Documentation	Pick a single file from a file_bundle value.
Inputs	field name type description required default file_bundle file_bundle The file bundle. yes path string The relative path of the file to pick. yes
Outputs	field name type description required default file file The file. yes

file_bundle.pick.sub_folder

Documentation	Pick a sub-folder from a file_bundle, resulting in a new file_bundle.
Inputs	field name type description required default file_bundle file_bundle The file bundle. yes sub_path string The relative path of the sub-folder to pick. yes
Outputs	field name type description required default file_bundle file_bundle The picked (sub-)file_bundle. yes

import.local.file

Documentation	Import a file from the local filesystem.
Inputs	field name type description required default path string The local path to the file (absolute, or relative to current directory. yes
Outputs	field name type description required default file file The loaded files. yes

import.local.file_bundle

Documentation	Import a folder (file_bundle) from the local filesystem.
Inputs	field name type description required default path string The local path of the folder to import. yes
Outputs	field name type description required default file_bundle file_bundle The imported file bundle. yes

pretty_print.as.string

Documentation	Pretty print a any value as a string.
Inputs	field name type description required default value any The value to render. no render_config any Value type dependent render configuration. no
Outputs	field name type description required default rendered_value string The rendered value. yes

pretty_print.as.terminal_renderable

Documentation	Pretty print a any value as a terminal_renderable.
Inputs	field name type description required default value any The value to render. no render_config any Value type dependent render configuration. no
Outputs	field name type description required default rendered_value terminal_renderable The rendered value. yes

pretty_print.internal.as.string

Documentation	Pretty print a internal value as a string.
Inputs	field name type description required default value internal The value to render. no render_config any Value type dependent render configuration. no
Outputs	field name type description required default rendered_value string The rendered value. yes

pretty_print.internal.as.terminal_renderable

Documentation	Pretty print a internal value as a terminal_renderable.
Inputs	field name type description required default value internal The value to render. no render_config any Value type dependent render configuration. no
Outputs	field name type description required default rendered_value terminal_renderable The rendered value. yes

pretty_print.none.as.string

Documentation	Pretty print a none value as a string.
Inputs	field name type description required default value none The value to render. no render_config any Value type dependent render configuration. no
Outputs	field name type description required default rendered_value string The rendered value. yes

pretty_print.none.as.terminal_renderable

Documentation	Pretty print a none value as a terminal_renderable.
Inputs	field name type description required default value none The value to render. no render_config any Value type dependent render configuration. no
Outputs	field name type description required default rendered_value terminal_renderable The rendered value. yes

pretty_print.string.as.bytes

Documentation	Pretty print a string value as a bytes.
Inputs	field name type description required default value string The value to render. no render_config any Value type dependent render configuration. no
Outputs	field name type description required default rendered_value bytes The rendered value. yes

render.as.string

Documentation	Render a 'any' value as a string.
Inputs	field name type description required default value any The value to render. yes render_config dict Instructions/config on how (or what) to render the provided value. no {}
Outputs	field name type description required default render_value_result render_value_result The rendered value, incl. some metadata. yes

render.as.terminal_renderable

Documentation	Render a 'any' value as a terminal_renderable.
Inputs	field name type description required default value any The value to render. yes render_config dict Instructions/config on how (or what) to render the provided value. no {}
Outputs	field name type description required default render_value_result render_value_result The rendered value, incl. some metadata. yes

render.dict.as.terminal_renderable

Documentation	Render a 'dict' value as a terminal_renderable.
Inputs	field name type description required default value dict The value to render. yes render_config dict Instructions/config on how (or what) to render the provided value. no {}
Outputs	field name type description required default render_value_result render_value_result The rendered value, incl. some metadata. yes

render.internal.as.string

Documentation	Render a 'internal' value as a string.
Inputs	field name type description required default value internal The value to render. yes render_config dict Instructions/config on how (or what) to render the provided value. no {}
Outputs	field name type description required default render_value_result render_value_result The rendered value, incl. some metadata. yes

render.internal.as.terminal_renderable

Documentation	Render a 'internal' value as a terminal_renderable.
Inputs	field name type description required default value internal The value to render. yes render_config dict Instructions/config on how (or what) to render the provided value. no {}
Outputs	field name type description required default render_value_result render_value_result The rendered value, incl. some metadata. yes