nteract/papermill

Injecting `pm` parameters breaks.

Open

#640 opened on Nov 8, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (402 forks)batch import
bughelp wanted

Repository metrics

Stars
 (5,381 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

🐛 Bug

This works nicely for injecting params into the output_path (output name).

papermill template.ipynb analysis_{PARAM}.ipynb -p PARAM test_stuff

however, using pm['run_uuid'] breaks as does pm["run_uuid"] and pm[run_uuid]. It seems that python doesn't allow access to the pm object values in the "".format() syntax.

papermill template.ipynb analysis_{pm['run_uuid']}.ipynb

using pm alone works and prints the entire pm dict in the notebook output name, but it very messy!

See here for more info: https://github.com/nteract/papermill/pull/343

Contributor guide

Research direction
Inspect how papermill parses the output path template and passes the `pm` dictionary to Python's string formatting. Trace the code path from the CLI argument to the notebook execution.
Tech stack
python
Domain
cli
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75