.. _f-magicscratch:

module ``ipythonhelper.magic_scratch``
======================================





.. inheritance-diagram:: code_beatrix.ipythonhelper.magic_scratch


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

module ``code_beatrix.ipythonhelper.magic_scratch``

Magic command to handle files


:githublink:`%|py|6`




Classes
+++++++

+-------------------------------------------------------------------------------+--------------------------------------------------------+
| class                                                                         | truncated documentation                                |
+===============================================================================+========================================================+
| :class:`MagicScratch <code_beatrix.ipythonhelper.magic_scratch.MagicScratch>` | Defines magic commands to list the content of a folder |
+-------------------------------------------------------------------------------+--------------------------------------------------------+




Functions
+++++++++

+----------------------------------------------------------------------------------------------------+---------------------------------------------------------+
| function                                                                                           | truncated documentation                                 |
+====================================================================================================+=========================================================+
| :func:`register_scratch_magics <code_beatrix.ipythonhelper.magic_scratch.register_scratch_magics>` | register magics function, can be called from a notebook |
+----------------------------------------------------------------------------------------------------+---------------------------------------------------------+




Properties
++++++++++

+-------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| property                                                                                                    | truncated documentation                                                                                       |
+=============================================================================================================+===============================================================================================================+
| :meth:`Context <code_beatrix.ipythonhelper.magic_scratch.MagicScratch.Context>`                             | return the context or None                                                                                    |
+-------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`cross_validation_lock <code_beatrix.ipythonhelper.magic_scratch.MagicScratch.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:`snap_parser <code_beatrix.ipythonhelper.magic_scratch.MagicScratch.snap_parser>` | defines the way to parse the magic command ``%snap`` |
+-----------------------------------------------------------------------------------------+------------------------------------------------------+




Methods
+++++++

+---------------------------------------------------------------------------+--------------------------------------------------------------------------+
| method                                                                    | truncated documentation                                                  |
+===========================================================================+==========================================================================+
| :meth:`snap <code_beatrix.ipythonhelper.magic_scratch.MagicScratch.snap>` | Defines ``%snap`` which inserts a :epkg:`snap` window inside a notebook. |
+---------------------------------------------------------------------------+--------------------------------------------------------------------------+


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

.. automodule:: code_beatrix.ipythonhelper.magic_scratch
    :members:
    :special-members: __init__
    :show-inheritance: