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.
Functions¶
function |
truncated documentation |
---|---|
Cleans cells when unittesting notebooks. |
|
Executes a list of notebooks. |
|
Returns a list of paths to add before running the notebooks, paths to pyquickhelper, … |
|
Returns the list of notebooks in a particular subfolder. |
Documentation¶
Some automation helpers to test notebooks and check they are still working fine.
- code_beatrix.automation.notebook_test_helper.clean_function_notebook(code)¶
Cleans cells when unittesting notebooks.
- Paramètres:
code – cell content
- Renvoie:
modified code
- code_beatrix.automation.notebook_test_helper.execute_notebooks(folder, notebooks, filter, clean_function=None, fLOG=<function noLOG>, deepfLOG=<function noLOG>)¶
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
- code_beatrix.automation.notebook_test_helper.get_additional_paths()¶
Returns a list of paths to add before running the notebooks, paths to pyquickhelper, …
- Renvoie:
list of paths
- code_beatrix.automation.notebook_test_helper.ls_notebooks(subfolder)¶
Returns the list of notebooks in a particular subfolder.
- Paramètres:
subfolder – subfolder (related to this module)
- Renvoie:
list of files