module ipythonhelper.magic_class_example

Short summary

module pyquickhelper.ipythonhelper.magic_class_example

Example of a class which defines magic commands.

source on GitHub

Classes

class	truncated documentation
MagicClassExample

Functions

function	truncated documentation
register_file_magics	Registers magics functions, can be called from a notebook.

Properties

property	truncated documentation
Context	return the context or None
cross_validation_lock	A contextmanager for running a block with our cross validation lock set to True. At the end of the block, …

Static Methods

staticmethod	truncated documentation
htmlhelp_parser	Defines the way to parse the magic command %htmlhelp.

Methods

method	truncated documentation
htmlhelp	Defines %htmlhelp, it displays the help for an object in HTML.

Documentation

Example of a class which defines magic commands.

source on GitHub

class pyquickhelper.ipythonhelper.magic_class_example.MagicClassExample(**kwargs: Any)

Bases: MagicClassWithHelpers

Define a magic command

This class is an example of how a magic commands can be defined with parameters as if it was a regular command in a terminal. The class MagicClassExample defines magic command htmlhelp and the associated parser. Function load_ipython_extension register the magic command through %load_ext pyquickhelper. The magic command can be unit tested with:

mg = MagicClassExample()
mg.add_context(context={"MagicClassExample": MagicClassExample})
cmd = "MagicClassExample -f text"
res = mg.htmlhelp(cmd)
assert "NB(example of a magic command)"

source on GitHub

Create a configurable given a config config.

configConfig

If this is empty, default values are used. If config is a Config instance, it will be used to configure the instance.

parentConfigurable instance, optional

The parent Configurable instance of this object.

Subclasses of Configurable must call the __init__() method of Configurable before doing anything else and using super():

class MyConfigurable(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.

_cross_validation_lock: bool

_trait_default_generators = {}

_trait_notifiers: Dict[str, Any]

_trait_validators: Dict[str, Any]

_trait_values: Dict[str, Any]

htmlhelp(line)

Defines %htmlhelp, it displays the help for an object in HTML.

%htmlhelp

Magic command htmlhelp convert docstring (RST) into HTML format for a better display in a notebook. It is equivalent to the code:

from pyquickhelper.helpgen import docstring2html
obj = <function or object>
docstring2html(obj, format="html")

See function docstring2html.

source on GitHub

static htmlhelp_parser()

Defines the way to parse the magic command %htmlhelp.

source on GitHub

pyquickhelper.ipythonhelper.magic_class_example.register_file_magics(ip=None)

Registers magics functions, can be called from a notebook.

Parameters

ip – from get_ipython()

source on GitHub