diff --git a/papermill/cli.py b/papermill/cli.py index 0c1b54d0..36e5545a 100755 --- a/papermill/cli.py +++ b/papermill/cli.py @@ -76,7 +76,7 @@ def print_papermill_version(ctx, param, value): '--autosave-cell-every', default=30, type=int, - help='How often in seconds to autosave the notebook during long cell executions (0 to disable)', + help='How often in seconds to autosave the notebook during long cell executions (0 to disable). Forwarded to the execution engine.', ) @click.option( '--prepare-only/--prepare-execute', diff --git a/papermill/execute.py b/papermill/execute.py index eb76cc34..9f46a4bb 100644 --- a/papermill/execute.py +++ b/papermill/execute.py @@ -43,8 +43,6 @@ def execute_notebook( Name of execution engine to use request_save_on_cell_execute : bool, optional Request save notebook after each cell execution - autosave_cell_every : int, optional - How often in seconds to save in the middle of long cell executions prepare_only : bool, optional Flag to determine if execution should occur or not kernel_name : str, optional @@ -55,14 +53,21 @@ def execute_notebook( Flag for whether or not to show the progress bar. log_output : bool, optional Flag for whether or not to write notebook output to the configured logger + stdout_file : str or file-like, optional + File path or buffer used to write notebook stdout + stderr_file : str or file-like, optional + File path or buffer used to write notebook stderr start_timeout : int, optional Duration in seconds to wait for kernel start-up report_mode : bool, optional Flag for whether or not to hide input. cwd : str or Path, optional Working directory to use when executing the notebook - **kwargs - Arbitrary keyword arguments to pass to the notebook engine + **engine_kwargs + Arbitrary keyword arguments forwarded to the selected execution engine + (and underlying nbclient execution). Common options include + ``execution_timeout`` and ``autosave_cell_every``. Supported options + may vary by engine Returns -------