nteract/papermill

NaN in output JSON

Open

#630 opened on Sep 16, 2021

View on GitHubContributor guide
 (2 comments) (1 reaction) (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

When passing nan as a parameter for a notebook, even a simple one with only one cell with

print(parameter)

we get an output notebook with:

"metadata": {
  ...,
  "papermill": {
   "default_parameters": {},
   "duration": 1.086503,
   "end_time": "2021-09-16T08:05:29.914692",
   "environment_variables": {},
   "exception": null,
   "input_path": "test.ipynb",
   "output_path": "output.ipynb",
   "parameters": {
    "parameter": NaN
   },
  ...,
  }
 },

The problem is that NaN is not a valid JSON keyword, so when I try to open the .ipynb with Jupyter or any other notebooks interpreter, I get: Unable to open 'output.ipynb': Unexpected token N in JSON at position 2215.

Contributor guide

Research direction
Identify where NaN values enter the output JSON and ensure proper serialization by converting NaN to null or using a custom JSON encoder.
Tech stack
python
Domain
databackend
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
PythonJSON
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70