Skip to content

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    desc…   Requ…   Def…     
                                      ──────────────────────────────────────    
                                       value   bytes   The     yes     --       
                                                       value           no       
                                                       to              def…     
                                                       de-s…           --       
                                                                                
                                                                                
                     Outputs                                                    
                                       field name   type         descripti…     
                                      ──────────────────────────────────────    
                                       python_ob…   python_ob…   The            
                                                                 de-serial…     
                                                                 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   desc…   Requ…   Defa…     
                                      ──────────────────────────────────────    
                                       value   file   The     yes     -- no     
                                                      value           defa…     
                                                      to              --        
                                                      de-s…                     
                                                                                
                                                                                
                     Outputs                                                    
                                       field name   type         descripti…     
                                      ──────────────────────────────────────    
                                       python_ob…   python_ob…   The            
                                                                 de-serial…     
                                                                 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    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       value   file…   The     yes    -- no     
                                                       value          defa…     
                                                       to             --        
                                                       de-s…                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name   type         descripti…     
                                      ──────────────────────────────────────    
                                       python_ob…   python_ob…   The            
                                                                 de-serial…     
                                                                 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   desc…   Requ…   Defa…     
                                      ──────────────────────────────────────    
                                       value   any    The     yes     -- no     
                                                      value           defa…     
                                                      obje…           --        
                                                      to                        
                                                      dese…                     
                                                      the                       
                                                      data                      
                                                      for.                      
                                                                                
                                                                                
                     Outputs                                                    
                                       field name   type         descripti…     
                                      ──────────────────────────────────────    
                                       python_ob…   python_ob…   The            
                                                                 deseriali…     
                                                                 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    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       value   inte…   The     yes    -- no     
                                                       value          defa…     
                                                       to             --        
                                                       de-s…                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name   type         descripti…     
                                      ──────────────────────────────────────    
                                       python_ob…   python_ob…   The            
                                                                 de-serial…     
                                                                 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    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       value   stri…   The     yes    -- no     
                                                       value          defa…     
                                                       to             --        
                                                       de-s…                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name   type         descripti…     
                                      ──────────────────────────────────────    
                                       python_ob…   python_ob…   The            
                                                                 de-serial…     
                                                                 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   desc…   Requ…   Defa…     
                                      ──────────────────────────────────────    
                                       value   any    The     yes     -- no     
                                                      value           defa…     
                                                      to              --        
                                                      de-s…                     
                                                                                
                                                                                
                     Outputs                                                    
                                       field name   type         descripti…     
                                      ──────────────────────────────────────    
                                       python_ob…   python_ob…   The            
                                                                 de-serial…     
                                                                 python         
                                                                 object         
                                                                 instance.      
                                                                                
                                                                                
                                                                                

extract.file.metadata.from.file

                                                                                
 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   desc…   Requ…   Defa…     
                                      ──────────────────────────────────────    
                                       value   file   The     yes     -- no     
                                                      file            defa…     
                                                      value           --        
                                                      to                        
                                                      extr…                     
                                                      meta…                     
                                                      from.                     
                                                                                
                                                                                
                     Outputs                                                    
                                       field name   type         descripti…     
                                      ──────────────────────────────────────    
                                       value_met…   value_met…   The            
                                                                 metadata.      
                                                                                
                                                                                
                                                                                

extract.file_bundle.metadata.from.file_bundle

                                                                                
 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    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       value   file…   The     yes    -- no     
                                                       file…          defa…     
                                                       value          --        
                                                       to                       
                                                       extr…                    
                                                       meta…                    
                                                       from.                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name   type         descripti…     
                                      ──────────────────────────────────────    
                                       value_met…   value_met…   The            
                                                                 metadata.      
                                                                                
                                                                                
                                                                                

extract.python_class.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   desc…   Requ…   Defa…     
                                      ──────────────────────────────────────    
                                       value   any    The     yes     -- no     
                                                      any             defa…     
                                                      value           --        
                                                      to                        
                                                      extr…                     
                                                      meta…                     
                                                      from.                     
                                                                                
                                                                                
                     Outputs                                                    
                                       field name   type         descripti…     
                                      ──────────────────────────────────────    
                                       value_met…   value_met…   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    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       path    stri…   The     yes    -- no     
                                                       local          defa…     
                                                       path           --        
                                                       to                       
                                                       the                      
                                                       file.                    
                                                                                
                                                                                
                     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    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       path    stri…   The     yes    -- no     
                                                       local          defa…     
                                                       path           --        
                                                       of                       
                                                       the                      
                                                       fold…                    
                                                       to                       
                                                       impo…                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name   type         descripti…     
                                      ──────────────────────────────────────    
                                       file_bund…   file_bund…   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    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       value   any     The     yes    -- no     
                                                       value          defa…     
                                                       to             --        
                                                       pers…                    
                                       rend…   stri…   The     yes    -- no     
                                                       rend…          defa…     
                                                       targ…          --        
                                                       of                       
                                                       rend…                    
                                                       outp…                    
                                       rend…   dict    A       no     -- no     
                                                       value          defa…     
                                                       type           --        
                                                       spec…                    
                                                       conf…                    
                                                       for                      
                                                       how                      
                                                       to                       
                                                       rend…                    
                                                       the                      
                                                       data.                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name      type   description       
                                      ──────────────────────────────────────    
                                       rendered_val…   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    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       value   any     The     yes    -- no     
                                                       value          defa…     
                                                       to             --        
                                                       pers…                    
                                       rend…   stri…   The     yes    -- no     
                                                       rend…          defa…     
                                                       targ…          --        
                                                       of                       
                                                       rend…                    
                                                       outp…                    
                                       rend…   dict    A       no     -- no     
                                                       value          defa…     
                                                       type           --        
                                                       spec…                    
                                                       conf…                    
                                                       for                      
                                                       how                      
                                                       to                       
                                                       rend…                    
                                                       the                      
                                                       data.                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name      type   description       
                                      ──────────────────────────────────────    
                                       rendered_val…   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    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       value   any     The     yes    -- no     
                                                       value          defa…     
                                                       to             --        
                                                       pers…                    
                                       rend…   stri…   The     yes    -- no     
                                                       rend…          defa…     
                                                       targ…          --        
                                                       of                       
                                                       rend…                    
                                                       outp…                    
                                       rend…   dict    A       no     -- no     
                                                       value          defa…     
                                                       type           --        
                                                       spec…                    
                                                       conf…                    
                                                       for                      
                                                       how                      
                                                       to                       
                                                       rend…                    
                                                       the                      
                                                       data.                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name      type   description       
                                      ──────────────────────────────────────    
                                       rendered_val…   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    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       value   any     The     yes    -- no     
                                                       value          defa…     
                                                       to             --        
                                                       pers…                    
                                       rend…   stri…   The     yes    -- no     
                                                       rend…          defa…     
                                                       targ…          --        
                                                       of                       
                                                       rend…                    
                                                       outp…                    
                                       rend…   dict    A       no     -- no     
                                                       value          defa…     
                                                       type           --        
                                                       spec…                    
                                                       conf…                    
                                                       for                      
                                                       how                      
                                                       to                       
                                                       rend…                    
                                                       the                      
                                                       data.                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name      type   description       
                                      ──────────────────────────────────────    
                                       rendered_val…   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    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       value   any     The     yes    -- no     
                                                       value          defa…     
                                                       to             --        
                                                       pers…                    
                                       rend…   stri…   The     yes    -- no     
                                                       rend…          defa…     
                                                       targ…          --        
                                                       of                       
                                                       rend…                    
                                                       outp…                    
                                       rend…   dict    A       no     -- no     
                                                       value          defa…     
                                                       type           --        
                                                       spec…                    
                                                       conf…                    
                                                       for                      
                                                       how                      
                                                       to                       
                                                       rend…                    
                                                       the                      
                                                       data.                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name      type   description       
                                      ──────────────────────────────────────    
                                       rendered_val…   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    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       value   any     The     yes    -- no     
                                                       value          defa…     
                                                       to             --        
                                                       pers…                    
                                       rend…   stri…   The     yes    -- no     
                                                       rend…          defa…     
                                                       targ…          --        
                                                       of                       
                                                       rend…                    
                                                       outp…                    
                                       rend…   dict    A       no     -- no     
                                                       value          defa…     
                                                       type           --        
                                                       spec…                    
                                                       conf…                    
                                                       for                      
                                                       how                      
                                                       to                       
                                                       rend…                    
                                                       the                      
                                                       data.                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name      type   description       
                                      ──────────────────────────────────────    
                                       rendered_val…   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    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       value   any     The     yes    -- no     
                                                       value          defa…     
                                                       to             --        
                                                       pers…                    
                                       rend…   stri…   The     yes    -- no     
                                                       rend…          defa…     
                                                       targ…          --        
                                                       of                       
                                                       rend…                    
                                                       outp…                    
                                       rend…   dict    A       no     -- no     
                                                       value          defa…     
                                                       type           --        
                                                       spec…                    
                                                       conf…                    
                                                       for                      
                                                       how                      
                                                       to                       
                                                       rend…                    
                                                       the                      
                                                       data.                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name      type   description       
                                      ──────────────────────────────────────    
                                       rendered_val…   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    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       value   any     The     yes    -- no     
                                                       value          defa…     
                                                       to             --        
                                                       pers…                    
                                       rend…   stri…   The     yes    -- no     
                                                       rend…          defa…     
                                                       targ…          --        
                                                       of                       
                                                       rend…                    
                                                       outp…                    
                                       rend…   dict    A       no     -- no     
                                                       value          defa…     
                                                       type           --        
                                                       spec…                    
                                                       conf…                    
                                                       for                      
                                                       how                      
                                                       to                       
                                                       rend…                    
                                                       the                      
                                                       data.                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name      type   description       
                                      ──────────────────────────────────────    
                                       rendered_val…   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    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       value   any     The     yes    -- no     
                                                       value          defa…     
                                                       to             --        
                                                       pers…                    
                                       rend…   stri…   The     yes    -- no     
                                                       rend…          defa…     
                                                       targ…          --        
                                                       of                       
                                                       rend…                    
                                                       outp…                    
                                       rend…   dict    A       no     -- no     
                                                       value          defa…     
                                                       type           --        
                                                       spec…                    
                                                       conf…                    
                                                       for                      
                                                       how                      
                                                       to                       
                                                       rend…                    
                                                       the                      
                                                       data.                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name      type   description       
                                      ──────────────────────────────────────    
                                       rendered_val…   any    The rendered      
                                                              value.            
                                                                                
                                                                                
                                                                                

pretty_print.render_instruction.as.string

                                                                                
 Documentation                                                                  
                     Pretty print a render_instruction 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 render_instruction value    
                                     as a string.                               
                                                                                
                     Inputs                                                     
                                       field                                    
                                       name    type    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       value   any     The     yes    -- no     
                                                       value          defa…     
                                                       to             --        
                                                       pers…                    
                                       rend…   stri…   The     yes    -- no     
                                                       rend…          defa…     
                                                       targ…          --        
                                                       of                       
                                                       rend…                    
                                                       outp…                    
                                       rend…   dict    A       no     -- no     
                                                       value          defa…     
                                                       type           --        
                                                       spec…                    
                                                       conf…                    
                                                       for                      
                                                       how                      
                                                       to                       
                                                       rend…                    
                                                       the                      
                                                       data.                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name      type   description       
                                      ──────────────────────────────────────    
                                       rendered_val…   any    The rendered      
                                                              value.            
                                                                                
                                                                                
                                                                                

pretty_print.render_metadata.as.string

                                                                                
 Documentation                                                                  
                     Pretty print a render_metadata 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 render_metadata value as    
                                     a string.                                  
                                                                                
                     Inputs                                                     
                                       field                                    
                                       name    type    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       value   any     The     yes    -- no     
                                                       value          defa…     
                                                       to             --        
                                                       pers…                    
                                       rend…   stri…   The     yes    -- no     
                                                       rend…          defa…     
                                                       targ…          --        
                                                       of                       
                                                       rend…                    
                                                       outp…                    
                                       rend…   dict    A       no     -- no     
                                                       value          defa…     
                                                       type           --        
                                                       spec…                    
                                                       conf…                    
                                                       for                      
                                                       how                      
                                                       to                       
                                                       rend…                    
                                                       the                      
                                                       data.                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name      type   description       
                                      ──────────────────────────────────────    
                                       rendered_val…   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    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       value   any     The     yes    -- no     
                                                       value          defa…     
                                                       to             --        
                                                       pers…                    
                                       rend…   stri…   The     yes    -- no     
                                                       rend…          defa…     
                                                       targ…          --        
                                                       of                       
                                                       rend…                    
                                                       outp…                    
                                       rend…   dict    A       no     -- no     
                                                       value          defa…     
                                                       type           --        
                                                       spec…                    
                                                       conf…                    
                                                       for                      
                                                       how                      
                                                       to                       
                                                       rend…                    
                                                       the                      
                                                       data.                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name      type   description       
                                      ──────────────────────────────────────    
                                       rendered_val…   any    The rendered      
                                                              value.            
                                                                                
                                                                                
                                                                                

pretty_print.terminal_renderable.as.string

                                                                                
 Documentation                                                                  
                     Pretty print a terminal_renderable 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 terminal_renderable value   
                                     as a string.                               
                                                                                
                     Inputs                                                     
                                       field                                    
                                       name    type    desc…   Req…   Defa…     
                                      ──────────────────────────────────────    
                                       value   any     The     yes    -- no     
                                                       value          defa…     
                                                       to             --        
                                                       pers…                    
                                       rend…   stri…   The     yes    -- no     
                                                       rend…          defa…     
                                                       targ…          --        
                                                       of                       
                                                       rend…                    
                                                       outp…                    
                                       rend…   dict    A       no     -- no     
                                                       value          defa…     
                                                       type           --        
                                                       spec…                    
                                                       conf…                    
                                                       for                      
                                                       how                      
                                                       to                       
                                                       rend…                    
                                                       the                      
                                                       data.                    
                                                                                
                                                                                
                     Outputs                                                    
                                       field name      type   description       
                                      ──────────────────────────────────────    
                                       rendered_val…   any    The rendered      
                                                              value.