module automation.notebook_test_helper

Short summary

module code_beatrix.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, …
ls_notebooks Returns the list of notebooks in a particular subfolder.

Documentation

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

source on GitHub

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

Cleans cells when unittesting notebooks.

Paramètres:code – cell content
Renvoie:modified code

source on GitHub

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

Executes a list of notebooks.

Paramètres:
  • 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
Renvoie:

dictionary { notebook_file: (isSuccess, outout) }

The signature of function filter is:

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

source on GitHub

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

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

Renvoie:list of paths

source on GitHub

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

Returns the list of notebooks in a particular subfolder.

Paramètres:subfolder – subfolder (related to this module)
Renvoie:list of files

source on GitHub