module td_2a.custom_magics

Short summary

module ensae_teaching_cs.td_2a.custom_magics

An example of a custom magic for IPython.

source on GitHub

Classes

class	truncated documentation
CustomMagics

Functions

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

Properties

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

Methods

method	truncated documentation
ENSAE	This command can be activated by typing
ENSAEb	This command can be activated by typing
ENSAEl	This command can be activated by typing

Documentation

An example of a custom magic for IPython.

source on GitHub

class ensae_teaching_cs.td_2a.custom_magics.CustomMagics(**kwargs: Any)

Bases : Magics

Create a configurable given a config config.

Parameters

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.

Notes

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.

ENSAE(line, cell=None)

This command can be activated by typing:

%ENSAE

Or:

%%ENSAE

source on GitHub

ENSAEb(line, cell)

This command can be activated by typing:

%%ENSAEb

source on GitHub

ENSAEl(line)

This command can be activated by typing:

%ENSAEl

source on GitHub

_all_trait_default_generators: Dict[str, Any] = {'config': <bound method TraitType.default of <traitlets.traitlets.Instance object>>, 'parent': <bound method TraitType.default of <traitlets.traitlets.Instance object>>}

_cross_validation_lock: bool

_descriptors = [<traitlets.traitlets.ObserveHandler object>, <traitlets.traitlets.Instance object>, <traitlets.traitlets.Instance object>]

_instance_inits = [<bound method ObserveHandler.instance_init of <traitlets.traitlets.ObserveHandler object>>, <bound method Instance.instance_init of <traitlets.traitlets.Instance object>>, <bound method Instance.instance_init of <traitlets.traitlets.Instance object>>]

_static_immutable_initial_values: Dict[str, Any] = {'parent': None}

_trait_default_generators = {}

_trait_notifiers: Dict[str, Any]

_trait_validators: Dict[str, Any]

_trait_values: Dict[str, Any]

_traits: Dict[str, Any] = {'config': <traitlets.traitlets.Instance object>, 'parent': <traitlets.traitlets.Instance object>}

ensae_teaching_cs.td_2a.custom_magics.load_ipython_extension(ip)

Registers magics function, can be called from a notebook.

source on GitHub