.. _f-magicnotebook:

module ``notebookhelper.magic_notebook``
========================================





.. inheritance-diagram:: pyensae.notebookhelper.magic_notebook


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

module ``pyensae.notebookhelper.magic_notebook``

Magic command to help within notebooks


:githublink:`%|py|6`




Classes
+++++++

+------------------------------------------------------------------------------+-----------------------------------------------+
| class                                                                        | truncated documentation                       |
+==============================================================================+===============================================+
| :class:`MagicNotebook <pyensae.notebookhelper.magic_notebook.MagicNotebook>` | Defines magic commands to help with notebooks |
+------------------------------------------------------------------------------+-----------------------------------------------+




Functions
+++++++++

+---------------------------------------------------------------------------------------------------+---------------------------------------------------------+
| function                                                                                          | truncated documentation                                 |
+===================================================================================================+=========================================================+
| :func:`register_notebook_magics <pyensae.notebookhelper.magic_notebook.register_notebook_magics>` | register magics function, can be called from a notebook |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------+




Properties
++++++++++

+-----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| property                                                                                                  | truncated documentation                                                                                       |
+===========================================================================================================+===============================================================================================================+
| :meth:`Context <pyensae.notebookhelper.magic_notebook.MagicNotebook.Context>`                             | return the context or None                                                                                    |
+-----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`cross_validation_lock <pyensae.notebookhelper.magic_notebook.MagicNotebook.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:`jsdf_parser <pyensae.notebookhelper.magic_notebook.MagicNotebook.jsdf_parser>`       | defines the way to parse the magic command ``%jsdf``    |
+---------------------------------------------------------------------------------------------+---------------------------------------------------------+
| :meth:`nb_menu_parser <pyensae.notebookhelper.magic_notebook.MagicNotebook.nb_menu_parser>` | defines the way to parse the magic command ``%nb_menu`` |
+---------------------------------------------------------------------------------------------+---------------------------------------------------------+




Methods
+++++++

+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| method                                                                        | truncated documentation                                                                      |
+===============================================================================+==============================================================================================+
| :meth:`jsdf <pyensae.notebookhelper.magic_notebook.MagicNotebook.jsdf>`       | defines ``%jsdf`` which displays a pandas dataframe into a notebook using qgrid (javascript) |
+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| :meth:`nb_menu <pyensae.notebookhelper.magic_notebook.MagicNotebook.nb_menu>` | defines ``%nb_menu`` which displays a menu                                                   |
+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+


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

.. automodule:: pyensae.notebookhelper.magic_notebook
    :members:
    :special-members: __init__
    :show-inheritance: