module ipythonhelper.magic_class_diff

Short summary

module pyquickhelper.ipythonhelper.magic_class_diff

Magic command to handle files

source on GitHub

Classes

class	truncated documentation
MagicDiff	Defines magic commands to visualize differences between files.

Functions

function	truncated documentation
register_file_magics	Register magics function, 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
codediff_parser	Defines the way to parse the magic command %codediff.
strdiff_parser	Defines the way to parse the magic command %strdiff.
textdiff_parser	Defines the way to parse the magic command %textdiff.

Methods

method	truncated documentation
codediff
difftext	Defines %difftext which calls textdiff. …
strdiff
textdiff

Documentation

Magic command to handle files

source on GitHub

class pyquickhelper.ipythonhelper.magic_class_diff.MagicDiff(**kwargs: Any)

Bases: MagicClassWithHelpers

Defines magic commands to visualize differences between files.

source on GitHub

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.

_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>}

codediff(line)

%codediff

It displays differences between two strings assuming they contains multiple lines. The magic command is equivalent to:

from IPython.core.display import display_html
from pyquickhelper.texthelper.edit_text_diff (
    import edit_distance_text, diff2html)
_, aligned, final = edit_distance_text(
    args.c1, args.c2, threshold=args.threshold,
    verbose=args.verbose)
ht = diff2html(args.c1, args.c2, aligned, final)
display_html(ht)

source on GitHub

static codediff_parser()

Defines the way to parse the magic command %codediff.

source on GitHub

difftext(line)

Defines %difftext which calls textdiff. but should be easier to remember

source on GitHub

strdiff(line)

%strdiff

It displays differences between two strings assuming they contains multiple lines. The magic command is equivalent to:

from IPython.core.display import display_html
from pyquickhelper.texthelper.text_diff import html_diffs
html = html_diffs(<s1>, <s2>)
display_html(html)

source on GitHub

static strdiff_parser()

Defines the way to parse the magic command %strdiff.

source on GitHub

textdiff(line)

%textdiff

It displays differences between two text files, two strings, two urls, it is based on create_visual_diff_through_html_files. Check blog post Visualize differences between two files in a notebook to see an example. See also A magic command to visualize differences between two files in a notebook. The magic command is equivalent to:

from IPython.core.display import display_html, display_javascript
from pyquickhelper import docstring2html, create_visual_diff_through_html_files
html, js = create_visual_diff_through_html_files(<f1>, <f2>,
                encoding=<encoding>, notebook=True,
                context_size=None if <context> in [None, ""] else int(<context>),
                inline_view=<inline>)
display_html(html)
display_javascript(js)

source on GitHub

static textdiff_parser()

Defines the way to parse the magic command %textdiff.

source on GitHub

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

Register magics function, can be called from a notebook.

Parameters:

ip – from get_ipython()

source on GitHub