module ipythonhelper.magic_class_compress

Short summary

module pyquickhelper.ipythonhelper.magic_class_compress

Magic command to handle files

source on GitHub

Classes

class	truncated documentation
MagicCompress	Defines magic commands to compress files.

Functions

function	truncated documentation
register_file_magics	Registers 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
compress_parser	defines the way to parse the magic command %compress

Methods

method	truncated documentation
compress

Documentation

Magic command to handle files

source on GitHub

class pyquickhelper.ipythonhelper.magic_class_compress.MagicCompress(**kwargs: Any)

Bases: MagicClassWithHelpers

Defines magic commands to compress 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>}

compress(line)

%compress

It compresses a list of files, it returns the number of compressed files:

from pyquickhelper import zip_files, gzip_files, zip7_files
if format == "zip":
    zip_files(dest, files)
elif format == "gzip":
    gzip_files(dest, files)
elif format == "7z":
    zip7_files(dest, files)
else:
    raise ValueError("unexpected format: " + format)

source on GitHub

static compress_parser()

defines the way to parse the magic command %compress

source on GitHub

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

Registers magics function, can be called from a notebook.

Parameters:

ip – from get_ipython()

source on GitHub