.. _f-magicclasscompress:

module ``ipythonhelper.magic_class_compress``
=============================================





.. inheritance-diagram:: pyquickhelper.ipythonhelper.magic_class_compress


Short summary
+++++++++++++

module ``pyquickhelper.ipythonhelper.magic_class_compress``

Magic command to handle files


:githublink:`%|py|6`




Classes
+++++++

+-----------------------------------------------------------------------------------------+-------------------------------------------+
| class                                                                                   | truncated documentation                   |
+=========================================================================================+===========================================+
| :class:`MagicCompress <pyquickhelper.ipythonhelper.magic_class_compress.MagicCompress>` | Defines magic commands to compress files. |
+-----------------------------------------------------------------------------------------+-------------------------------------------+




Functions
+++++++++

+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
| function                                                                                             | truncated documentation                                   |
+======================================================================================================+===========================================================+
| :func:`register_file_magics <pyquickhelper.ipythonhelper.magic_class_compress.register_file_magics>` | Registers magics function, can be called from a notebook. |
+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+




Properties
++++++++++

+----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| property                                                                                                             | truncated documentation                                                                                       |
+======================================================================================================================+===============================================================================================================+
| :meth:`Context <pyquickhelper.ipythonhelper.magic_class_compress.MagicCompress.Context>`                             | return the context or None                                                                                    |
+----------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`cross_validation_lock <pyquickhelper.ipythonhelper.magic_class_compress.MagicCompress.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                                  |
+==========================================================================================================+==========================================================+
| :meth:`compress_parser <pyquickhelper.ipythonhelper.magic_class_compress.MagicCompress.compress_parser>` | defines the way to parse the magic command ``%compress`` |
+----------------------------------------------------------------------------------------------------------+----------------------------------------------------------+




Methods
+++++++

+--------------------------------------------------------------------------------------------+-------------------------+
| method                                                                                     | truncated documentation |
+============================================================================================+=========================+
| :meth:`compress <pyquickhelper.ipythonhelper.magic_class_compress.MagicCompress.compress>` |                         |
+--------------------------------------------------------------------------------------------+-------------------------+


Documentation
+++++++++++++

.. automodule:: pyquickhelper.ipythonhelper.magic_class_compress
    :members:
    :special-members: __init__
    :show-inheritance: