Enable formatting for Jupyter notebooks #7749
Merged
+419
−161
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
charliermarsh
commented
Oct 1, 2023
charliermarsh
force-pushed
the
charlie/format-jupyter
branch
6 times, most recently
from
2068ea6 to
21f58ab
Compare
charliermarsh
commented
Oct 2, 2023
| @@ -487,80 +508,3 @@ pub(crate) fn lint_stdin( | |||
| notebook_indexes, | |||
| }) | |||
| } | |||
|
|
|||
| #[derive(Debug)] | |||
| pub(crate) struct LintSource(pub(crate) SourceKind); | |||
There was a problem hiding this comment.
I removed this, and moved the logic into SourceKind, so that it can be used for formatting too.
charliermarsh
force-pushed
the
charlie/format-jupyter
branch
2 times, most recently
from
c59207d to
8bcc8db
Compare
PR Check ResultsEcosystem✅ ecosystem check detected no changes. |
konstin
approved these changes
Oct 2, 2023
| return Ok(None); | ||
| } | ||
|
|
||
| let mut output = String::with_capacity(notebook.source_code().len()); |
There was a problem hiding this comment.
We can avoid the allocation here by only reserving once we see the first formatted cell
charliermarsh
force-pushed
the
charlie/write
branch
from
f49f550 to
b55fc0a
Compare
charliermarsh
force-pushed
the
charlie/format-jupyter
branch
from
8bcc8db to
d97d454
Compare
26 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR enables
ruff formatto format Jupyter notebooks.Most of the work is contained in a new
format_sourcemethod that formats a genericSourceKind, then returnsSome(transformed)if the source required formatting, orNoneotherwise.Closes #7598.
Test Plan
Ran
cat foo.py | cargo run -p ruff_cli -- format --stdin-filename Untitled.ipynb; verified that the console showed a reasonable error:warning: Failed to read notebook Untitled.ipynb: Expected a Jupyter Notebook, which must be internally stored as JSON, but this file isn't valid JSON: EOF while parsing a value at line 1 column 0Ran
cat Untitled.ipynb | cargo run -p ruff_cli -- format --stdin-filename Untitled.ipynb; verified that the JSON output contained formatted source code.