mirror of https://github.com/astral-sh/ruff
cb4f086cbf
## Summary
Add roundtrip support for Jupyter notebook.
1. Read the notebook
2. Extract out the source code content
3. Use it to update the notebook itself (should be exactly the same [^1])
4. Serialize into JSON and print it to stdout
## Test Plan
`cargo run --all-features --bin ruff_dev --package ruff_dev --
round-trip <path/to/notebook.ipynb>`
<details><summary>Example output:</summary>
<p>
```
{
"cells": [
{
"cell_type": "markdown",
"id": "f3c286e9-fa52-4440-816f-4449232f199a",
"metadata": {},
"source": [
"# Ruff Test"
]
},
{
"cell_type": "markdown",
"id": "a2b7bc6c-778a-4b07-86ae-dde5a2d9511e",
"metadata": {},
"source": [
"Markdown block before the first import"
]
},
{
"cell_type": "code",
"id": "5e3ef98e-224c-450a-80e6-be442ad50907",
"metadata": {
"tags": []
},
"source": "",
"execution_count": 1,
"outputs": []
},
{
"cell_type": "code",
"id": "6bced3f8-e0a4-450c-ae7c-f60ad5671ee9",
"metadata": {},
"source": "import contextlib\n\nwith contextlib.suppress(ValueError):\n print()\n",
"outputs": []
},
{
"cell_type": "code",
"id": "d7102cfd-5bb5-4f5b-a3b8-07a7b8cca34c",
"metadata": {},
"source": "import random\n\nrandom.randint(10, 20)",
"outputs": []
},
{
"cell_type": "code",
"id": "88471d1c-7429-4967-898f-b0088fcb4c53",
"metadata": {},
"source": "foo = 1\nif foo < 2:\n msg = f\"Invalid foo: {foo}\"\n raise ValueError(msg)",
"outputs": []
}
],
"metadata": {
"kernelspec": {
"display_name": "Python (ruff-playground)",
"name": "ruff-playground",
"language": "python"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"pygments_lexer": "ipython3",
"nbconvert_exporter": "python",
"version": "3.11.3"
}
},
"nbformat": 4,
"nbformat_minor": 5
}
```
</p>
</details>
[^1]: The type in JSON might be different (https://github.com/astral-sh/ruff/pull/4665#discussion_r1212663495)
Part of #1218
|
||
|---|---|---|
| .. | ||
| generate_all.rs | ||
| generate_cli_help.rs | ||
| generate_docs.rs | ||
| generate_json_schema.rs | ||
| generate_options.rs | ||
| generate_rules_table.rs | ||
| main.rs | ||
| print_ast.rs | ||
| print_cst.rs | ||
| print_tokens.rs | ||
| round_trip.rs | ||