operations
deserialize.bytes.as.python_object
Documentation
-- n/a --
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/
Operation details
Documentation -- n/a --
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value bytes The value to de-serialize. yes -- no default --
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
python_object python_object The de-serialized python object instance.
deserialize.file.as.python_object
Documentation
-- n/a --
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/
Operation details
Documentation -- n/a --
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value file The value to de-serialize. yes -- no default --
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
python_object python_object The de-serialized python object instance.
deserialize.file_bundle.as.python_object
Documentation
-- n/a --
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/
Operation details
Documentation -- n/a --
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value file_bundle The value to de-serialize. yes -- no default --
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
python_object python_object The de-serialized python object instance.
deserialize.from_json
Documentation
-- n/a --
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/
Operation details
Documentation -- n/a --
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value any The value object to deserialize the data for. yes -- no default --
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
python_object python_object The deserialized python object.
deserialize.internal_model.as.python_object
Documentation
-- n/a --
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/
Operation details
Documentation -- n/a --
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value internal_model The value to de-serialize. yes -- no default --
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
python_object python_object The de-serialized python object instance.
deserialize.string.as.python_object
Documentation
-- n/a --
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/
Operation details
Documentation -- n/a --
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value string The value to de-serialize. yes -- no default --
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
python_object python_object The de-serialized python object instance.
deserialize.value
Documentation
-- n/a --
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/
Operation details
Documentation -- n/a --
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value any The value to de-serialize. yes -- no default --
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
python_object python_object The de-serialized python object instance.
Documentation
Extract 'file' metadata for value type '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/
Operation details
Documentation Extract 'file' metadata for value type 'file'.
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value file The file value to extract metadata from. yes -- no default --
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
value_metadata value_metadata The metadata.
Documentation
Extract 'file_bundle' metadata for value type 'file_bundle'.
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/
Operation details
Documentation Extract 'file_bundle' metadata for value type 'file_bundle'.
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value file_bundle The file_bundle value to extract yes -- no default --
metadata from.
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
value_metadata value_metadata The metadata.
Documentation
Extract 'python_class' metadata for value type 'any'.
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/
Operation details
Documentation Extract 'python_class' metadata for value type 'any'.
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value any The any value to extract metadata from. yes -- no default --
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
value_metadata value_metadata The metadata.
import.file
Documentation
Import a file from the local filesystem.
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/
Operation details
Documentation Import a file from the local filesystem.
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
path string The local path to the file. yes -- no default --
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
file file The loaded files.
import.file_bundle
Documentation
Import a folder (file_bundle) from the local filesystem.
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/
Operation details
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 -- no default --
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
file_bundle file_bundle The imported file bundle.
pretty_print.as.string
Documentation
Pretty print a any value as 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/
Operation details
Documentation Pretty print a any value as a string.
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value any The value to persist. yes -- no default --
render_type string The render target/type of render output. yes -- no default --
render_config dict A value type specific configuration for no -- no default --
how to render the data.
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
rendered_value any The rendered value.
pretty_print.bytes.as.string
Documentation
Pretty print a bytes value as 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/
Operation details
Documentation Pretty print a bytes value as a string.
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value any The value to persist. yes -- no default --
render_type string The render target/type of render output. yes -- no default --
render_config dict A value type specific configuration for no -- no default --
how to render the data.
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
rendered_value any The rendered value.
pretty_print.doc.as.terminal_renderable
Documentation
Pretty print a doc value as a terminal_renderable.
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/
Operation details
Documentation Pretty print a doc value as a terminal_renderable.
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value any The value to persist. yes -- no default --
render_type string The render target/type of render output. yes -- no default --
render_config dict A value type specific configuration for no -- no default --
how to render the data.
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
rendered_value any The rendered value.
pretty_print.file.as.terminal_renderable
Documentation
Pretty print a file value as a terminal_renderable.
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/
Operation details
Documentation Pretty print a file value as a terminal_renderable.
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value any The value to persist. yes -- no default --
render_type string The render target/type of render output. yes -- no default --
render_config dict A value type specific configuration for no -- no default --
how to render the data.
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
rendered_value any The rendered value.
pretty_print.file_bundle.as.terminal_renderable
Documentation
Pretty print a file_bundle value as a terminal_renderable.
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/
Operation details
Documentation Pretty print a file_bundle value as a terminal_renderable.
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value any The value to persist. yes -- no default --
render_type string The render target/type of render output. yes -- no default --
render_config dict A value type specific configuration for no -- no default --
how to render the data.
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
rendered_value any The rendered value.
pretty_print.internal.as.string
Documentation
Pretty print a internal value as 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/
Operation details
Documentation Pretty print a internal value as a string.
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value any The value to persist. yes -- no default --
render_type string The render target/type of render output. yes -- no default --
render_config dict A value type specific configuration for no -- no default --
how to render the data.
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
rendered_value any The rendered value.
pretty_print.internal_model.as.terminal_renderable
Documentation
Pretty print a internal_model value as a terminal_renderable.
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/
Operation details
Documentation Pretty print a internal_model value as a terminal_renderable.
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value any The value to persist. yes -- no default --
render_type string The render target/type of render output. yes -- no default --
render_config dict A value type specific configuration for no -- no default --
how to render the data.
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
rendered_value any The rendered value.
pretty_print.none.as.string
Documentation
Pretty print a none value as 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/
Operation details
Documentation Pretty print a none value as a string.
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value any The value to persist. yes -- no default --
render_type string The render target/type of render output. yes -- no default --
render_config dict A value type specific configuration for no -- no default --
how to render the data.
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
rendered_value any The rendered value.
pretty_print.python_object.as.terminal_renderable
Documentation
Pretty print a python_object value as a terminal_renderable.
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/
Operation details
Documentation Pretty print a python_object value as a terminal_renderable.
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value any The value to persist. yes -- no default --
render_type string The render target/type of render output. yes -- no default --
render_config dict A value type specific configuration for no -- no default --
how to render the data.
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
rendered_value any The rendered value.
pretty_print.render_instruction.as.terminal_renderable
Documentation
Pretty print a render_instruction value as a terminal_renderable.
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/
Operation details
Documentation Pretty print a render_instruction value as a terminal_renderable.
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value any The value to persist. yes -- no default --
render_type string The render target/type of render output. yes -- no default --
render_config dict A value type specific configuration for no -- no default --
how to render the data.
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
rendered_value any The rendered value.
Documentation
Pretty print a render_metadata value as a terminal_renderable.
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/
Operation details
Documentation Pretty print a render_metadata value as a terminal_renderable.
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value any The value to persist. yes -- no default --
render_type string The render target/type of render output. yes -- no default --
render_config dict A value type specific configuration for no -- no default --
how to render the data.
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
rendered_value any The rendered value.
pretty_print.string.as.string
Documentation
Pretty print a string value as 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/
Operation details
Documentation Pretty print a string value as a string.
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value any The value to persist. yes -- no default --
render_type string The render target/type of render output. yes -- no default --
render_config dict A value type specific configuration for no -- no default --
how to render the data.
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
rendered_value any The rendered value.
pretty_print.terminal_renderable.as.terminal_renderable
Documentation
Pretty print a terminal_renderable value as a terminal_renderable.
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/
Operation details
Documentation Pretty print a terminal_renderable value as a terminal_renderable.
Inputs
field name type description Required Default
──────────────────────────────────────────────────────────────────────────────────────────────────
value any The value to persist. yes -- no default --
render_type string The render target/type of render output. yes -- no default --
render_config dict A value type specific configuration for no -- no default --
how to render the data.
Outputs
field name type description
──────────────────────────────────────────────────────────────────────────────────────────────────
rendered_value any The rendered value.