Bases:Magics

__init__(shell)

Create a configurable given a config config.

Parameters:

• config (Config) – If this is empty, default values are used. If config is aConfig instance, it will be used to configure theinstance.

• parent (Configurable instance,optional) – The parent Configurable instance of this object.

Notes

Subclasses of Configurable must call the__init__() method ofConfigurablebefore doing anything else and usingsuper():

classMyConfigurable(Configurable):def__init__(self,config=None):super(MyConfigurable,self).__init__(config=config)# Then any other code you need to finish initialization.

This ensures that instances will be configured properly.

autoindent(parameter_s='')

Toggle autoindent on/off (deprecated)

cpaste(parameter_s='')

Paste & execute a pre-formatted code block from clipboard.

You must terminate the block with ‘–’ (two minus-signs) or Ctrl-Dalone on the line. You can also provide your own sentinel with ‘%paste-s %%’ (‘%%’ is the new sentinel for this operation).

The block is dedented prior to execution to enable execution of methoddefinitions. ‘>’ and ‘+’ characters at the beginning of a line areignored, to allow pasting directly from e-mails, diff files anddoctests (the ‘…’ continuation prompt is also stripped). Theexecuted block is also assigned to variable named ‘pasted_block’ forlater editing with ‘%edit pasted_block’.

You can also pass a variable name as an argument, e.g. ‘%cpaste foo’.This assigns the pasted block to variable ‘foo’ as string, withoutdedenting or executing it (preceding >>> and + is still stripped)

‘%cpaste -r’ re-executes the block previously entered by cpaste.‘%cpaste -q’ suppresses any additional output messages.

Do not be alarmed by garbled output on Windows (it’s a readline bug).Just press enter and type – (and press enter again) and the blockwill be what was just pasted.

Shell escapes are not supported (yet).

See also

paste

automatically pull code from clipboard.

Examples

In [8]: %cpastePasting code; enter '--' alone on the line to stop.:>>> a = ["world!", "Hello"]:>>> print(" ".join(sorted(a))):--Hello world!

::

In [8]: %cpastePasting code; enter ‘–’ alone on the line to stop.:>>> %alias_magic t timeit:>>> %t -n1 pass:–Created%t as an alias for%timeit.Created%%t as an alias for%%timeit.354 ns ± 224 ns per loop (mean ± std. dev. of 7 runs, 1 loop each)

paste(parameter_s='')

Paste & execute a pre-formatted code block from clipboard.

The text is pulled directly from the clipboard without userintervention and printed back on the screen before execution (unlessthe -q flag is given to force quiet mode).

The block is dedented prior to execution to enable execution of methoddefinitions. ‘>’ and ‘+’ characters at the beginning of a line areignored, to allow pasting directly from e-mails, diff files anddoctests (the ‘…’ continuation prompt is also stripped). Theexecuted block is also assigned to variable named ‘pasted_block’ forlater editing with ‘%edit pasted_block’.

You can also pass a variable name as an argument, e.g. ‘%paste foo’.This assigns the pasted block to variable ‘foo’ as string, withoutexecuting it (preceding >>> and + is still stripped).

Options:

-r: re-executes the block previously entered by cpaste.

-q: quiet mode: do not echo the pasted text back to the terminal.

IPython statements (magics, shell escapes) are not supported (yet).

See also

cpaste

manually paste code into terminal until you mark its end.

rerun_pasted(name='pasted_block')

Rerun a previously pasted command.

store_or_execute(block,name,store_history=False)

Execute a block, or store it in a variable, per the user’s request.

Yield pasted lines until the user enters the given sentinel value.