module automation.notebook_test_helper

Short summary

module ensae_projects.automation.notebook_test_helper

Some automation helpers to test notebooks and check they are still working fine.

source on GitHub

Functions

function truncated documentation
clean_function_notebook Cleans cells when unittesting notebooks.
execute_notebooks Executes a list of notebooks.
get_additional_paths Returns a list of paths to add before running the notebooks, paths to pyquickhelper, pyensae.
ls_notebooks Lists the notebooks in a particular subfolder.

Documentation

Some automation helpers to test notebooks and check they are still working fine.

source on GitHub

ensae_projects.automation.notebook_test_helper.clean_function_notebook(code)[source]

Cleans cells when unittesting notebooks.

Parameters:code – cell content
Returns:modified code

source on GitHub

ensae_projects.automation.notebook_test_helper.execute_notebooks(folder, notebooks, filter, clean_function=None, fLOG=<function noLOG>, deepfLOG=<function noLOG>, valid_cell=None)[source]

Executes a list of notebooks.

Parameters:
  • folder – folder
  • notebooks – list of notebooks
  • filter – function which validate the notebooks
  • clean_function – cleaning function to apply to the code before running it
  • fLOG – logging function
  • deepfLOG – logging function used to run the notebook
  • valid_cell – to disable the execution of a cell
Returns:

dictionary tuple (statistics, { notebook_file: (isSuccess, outout) })

The signature of function filter is:

def filter( i, filename) : return True or False

source on GitHub

ensae_projects.automation.notebook_test_helper.get_additional_paths()[source]

Returns a list of paths to add before running the notebooks, paths to pyquickhelper, pyensae.

Returns:list of paths

source on GitHub

ensae_projects.automation.notebook_test_helper.ls_notebooks(subfolder)[source]

Lists the notebooks in a particular subfolder.

Parameters:subfolder – subfolder (related to this module)
Returns:list of files

source on GitHub