nteract/papermill

Issue with tracking the execution with cell descriptions

Open

#712 opened on Feb 8, 2023

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

I have added my cell descriptions as indicated in the documentation, but the only output I can see is: Executing SECONDCELL: 100% which is missing the cell description for the FIRSTCELL.

Issue: I think the issue is that the first cell description gets overwritten by the second cell description as there is no line feed.

My notebook code is as follows: Cell#1 #papermill_description=FIRSTCELL a=1 print("a=", a)

Cell#2 #papermill_description=SECONDCELL twice = a*2 print("twice:", twice)

My python script is as follows: import papermill as pm notebookfn = 'test.ipynb' outputfn = 'output.ipynb' pm.execute_notebook(notebookfn, outputfn)

Contributor guide

Research direction
Examine how papermill tracks and displays cell descriptions during execution. Look at the progress logging code to see if newline characters are missing, causing overwrite.
Tech stack
python
Domain
backend
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
PythonJupyter Notebooks
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75