deephaven_enterprise.notebook
=============================

.. py:module:: deephaven_enterprise.notebook

.. autoapi-nested-parse::

   This module provides a way for users to modularize their Deephaven Web console notebooks and import and execute them
   as Python modules.





Package Contents
----------------

.. py:function:: exec_notebook(db, path, globals = None)

   Executes a Deephaven Web console notebook.

   :param db: Core+ Python Database object
   :type db: Database
   :param path: full path to Notebook, beginning with "/"
   :type path: str
   :param globals: the globals to use for execution of the notebook, if you want to have the variables
                   from your script session available use "globals()"
   :type globals: dict[str, Any]


.. py:function:: meta_import(db, root = 'notebook')

   Sets up a meta importer to enable using a Python import statement that references Deephaven Web console
   notebooks.

   For example, after calling 'meta_import(db, "notebook")'; you can then call 'import notebook.file' to make
   the "/file.py" in your Web File Explorer available as a Python module.

   Note: implicitly populated global objects like 'db', 'performance_overview', etc., in the main module are not
   automatically available in the imported module. You must explicitly import them or pass them as arguments to
   functions in the module. To import them, you can use the following:

       from deephaven_enterprise.database import db

       from deephaven_enterprise.performance_overview import performance_overview

   :param db: Core+ Python Database object
   :type db: Database
   :param root: the module name that prefixes all web notebooks, defaults to "notebook"
   :type root: str