.. _f-magicclasscrypt:

module ``ipythonhelper.magic_class_crypt``
==========================================





.. inheritance-diagram:: pyquickhelper.ipythonhelper.magic_class_crypt


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

module ``pyquickhelper.ipythonhelper.magic_class_crypt``

Magic command to handle files


:githublink:`%|py|6`




Classes
+++++++

+--------------------------------------------------------------------------------+-----------------------------------------------------+
| class                                                                          | truncated documentation                             |
+================================================================================+=====================================================+
| :class:`MagicCrypt <pyquickhelper.ipythonhelper.magic_class_crypt.MagicCrypt>` | Defines magic commands to encrypt and decrypt file. |
+--------------------------------------------------------------------------------+-----------------------------------------------------+




Functions
+++++++++

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




Properties
++++++++++

+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| property                                                                                                       | truncated documentation                                                                                       |
+================================================================================================================+===============================================================================================================+
| :meth:`Context <pyquickhelper.ipythonhelper.magic_class_crypt.MagicCrypt.Context>`                             | return the context or None                                                                                    |
+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`cross_validation_lock <pyquickhelper.ipythonhelper.magic_class_crypt.MagicCrypt.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:`decrypt_file_parser <pyquickhelper.ipythonhelper.magic_class_crypt.MagicCrypt.decrypt_file_parser>`     | defines the way to parse the magic command ``%decrypt_file``                       |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
| :meth:`encrypt_file_parser <pyquickhelper.ipythonhelper.magic_class_crypt.MagicCrypt.encrypt_file_parser>`     | defines the way to parse the magic command ``%encrypt_file``                       |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
| :meth:`endecrypt_file_parser <pyquickhelper.ipythonhelper.magic_class_crypt.MagicCrypt.endecrypt_file_parser>` | defines the way to parse the magic command ``%encrypt_file`` and ``%decrypt_file`` |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+




Methods
+++++++

+----------------------------------------------------------------------------------------------+-------------------------+
| method                                                                                       | truncated documentation |
+==============================================================================================+=========================+
| :meth:`decrypt_file <pyquickhelper.ipythonhelper.magic_class_crypt.MagicCrypt.decrypt_file>` |                         |
+----------------------------------------------------------------------------------------------+-------------------------+
| :meth:`encrypt_file <pyquickhelper.ipythonhelper.magic_class_crypt.MagicCrypt.encrypt_file>` |                         |
+----------------------------------------------------------------------------------------------+-------------------------+


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

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