yamlmagic

an IPython magic for capturing data in YAML into a running IPython kernel.

Install

From the command line (or with ! in a notebook cell):

pip install yamlmagic

Enable

Ad-hoc

In the notebook, you can use the %load_ext or %reload_ext line magic.



In [1]:

    
%reload_ext yamlmagic

Configuration

In your profile's ipython_kernel_config.py, you can add the following line to automatically load yamlmagic into all your running kernels:

c.InteractiveShellApp.extensions = ['yaml_magic']

Use

The %%yaml cell magic will either act as simple parser:



In [2]:

    
%%yaml
a_toplevel_key: 1









    














    Out[2]:





{'a_toplevel_key': 1}

which can be accessed by the special last result variable _:



In [3]:

    
_









    Out[3]:





{'a_toplevel_key': 1}

Or will update a named variable with the parsed document:



In [4]:

    
%%yaml x
- a: 1
  b: 2



In [5]:

    
x









    Out[5]:





[{'a': 1, 'b': 2}]

By default, yaml.SafeLoader will be used, which won't allow the powerful but dangerous (and unportable) !python/ tags. If you'd like to use them, provide the -l (or --loader) argument with a BaseLoader subclass available via a local variable...



In [6]:

    
from yaml import Loader
class FooLoader(Loader):
    # some special things you have built
    pass



In [7]:

    
%%yaml --loader FooLoader
- a: !!python/float 1
  b: !!python/float 2









    














    Out[7]:





[{'a': 1.0, 'b': 2.0}]

...or dotted-notation path to a loader:



In [8]:

    
%%yaml --loader yaml.Loader
- a: !!python/float 1
  b: !!python/float 2









    














    Out[8]:





[{'a': 1.0, 'b': 2.0}]

Contribute

Issues and pull requests welcome!

License

yamlmagic is released as free software under the BSD 3-Clause license.

Thank

@tonyfast for asking for this
@robclewley for documentation-shaming a gist into a module