Cauldron: Documentation

Gallery Documentation

Gallery Documentation

Browse Topics

Hide Topics

Documentation

Documentation

Introduction Notebook Display Shared Variables

Introduction Notebook Display Shared Variables

Introduction UI Containers Kernel Containers UI + Kernel Containers

Introduction UI Containers Kernel Containers UI + Kernel Containers

Step Tests with unittest Step Tests with pytest

Step Tests with unittest Step Tests with pytest

Introduction Parallelism (SIMD)

Introduction Parallelism (SIMD)

API Reference

API Reference

get_environment_info refresh run_project run_server run_shell shared

get_environment_info refresh run_project run_server run_shell shared

bokeh code_block elapsed head header html image inspect jinja json latex listing list_grid markdown plotly pyplot status svg table tail text whitespace

bokeh code_block elapsed head header html image inspect jinja json latex listing list_grid markdown plotly pyplot status svg table tail text whitespace

breathe render_to_console stop visible write_to_console

breathe render_to_console stop visible write_to_console

create_test_fixture StepTestRunResult StepTestCase CauldronTest

create_test_fixture StepTestRunResult StepTestCase CauldronTest

def

inspect

cauldron.display.inspect()

Inspects the data and structure of the source dictionary object and adds the results to the display for viewing.

source

dict

A dictionary object to be inspected.

Basic Usage

01
02
03
04
05
06
07
08
09
10
import cauldron as cd

data = dict(
    a={'x': 1, 'y': 2, 'z': 3},
    b={'x': True, 'y': False, 'z': True},
    c={'x': 'Hello', 'y': 'World', 'z': 'Foo'}
)

# Add to the display
cd.display.inspect(data)

Copyright © 2016-2020 Scott Ernst