Stabilize support for Jupyter Notebooks#12878
Merged
AlexWaygood merged 3 commits intoruff-0.6from Aug 14, 2024
Merged
Conversation
T-256
reviewed
Aug 14, 2024
docs/configuration.md
Outdated
| `ruff format /path/to/notebook.ipynb` will always format `notebook.ipynb`. | ||
| Alternatively, passing the notebook file(s) to `ruff` on the command-line will always lint or format | ||
| the notebook. For example, `ruff check /path/to/notebook.ipynb` will always lint `notebook.ipynb`. | ||
| Similarly, `ruff format /path/to/notebook.ipynb` will always format `notebook.ipynb`. |
Contributor
There was a problem hiding this comment.
I think we won't need this section anymore. we can move this section to another place that applies for all file types not just .ipynb
e0128be to
80fb8e5
Compare
dhruvmanila
commented
Aug 14, 2024
Comment on lines
344
to
345
| To lint or format files with additional file extensions, use the [`extend-include`](settings.md#extend-include) setting. | ||
|
|
||
| === "pyproject.toml" | ||
|
|
||
| ```toml | ||
| [tool.ruff] | ||
| extend-include = ["*.ipynb"] | ||
| ``` | ||
|
|
||
| === "ruff.toml" | ||
|
|
||
| ```toml | ||
| extend-include = ["*.ipynb"] | ||
| ``` | ||
|
|
||
| You can also change the default selection using the [`include`](settings.md#include) setting. |
Member
Author
There was a problem hiding this comment.
Any suggestion on what can be use for this example? I'm worried that it might signal to the users that we support that file extension. Using *.ipynb was ok because we do support it. This is the reason I've removed this example.
Member
There was a problem hiding this comment.
extend-include has an example with .pyw files. Although I think the example isn't needed because we already link to extend-include which has an example.
Member
Author
There was a problem hiding this comment.
Yeah, I think not having an example here is fine.
Member
Author
|
There are couple more references in the docs that require updating which I'm doing right now. |
Contributor
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| Q000 | 539 | 539 | 0 | 0 | 0 |
| T201 | 151 | 151 | 0 | 0 | 0 |
| E501 | 74 | 74 | 0 | 0 | 0 |
| ANN001 | 62 | 62 | 0 | 0 | 0 |
| NPY002 | 32 | 32 | 0 | 0 | 0 |
| D103 | 25 | 25 | 0 | 0 | 0 |
| W293 | 23 | 23 | 0 | 0 | 0 |
| ANN201 | 22 | 22 | 0 | 0 | 0 |
| FBT003 | 17 | 17 | 0 | 0 | 0 |
| I001 | 12 | 12 | 0 | 0 | 0 |
| F401 | 12 | 12 | 0 | 0 | 0 |
| W291 | 11 | 11 | 0 | 0 | 0 |
| COM812 | 11 | 11 | 0 | 0 | 0 |
| E402 | 7 | 7 | 0 | 0 | 0 |
| PTH123 | 6 | 6 | 0 | 0 | 0 |
| C408 | 6 | 6 | 0 | 0 | 0 |
| F821 | 5 | 5 | 0 | 0 | 0 |
| ERA001 | 5 | 5 | 0 | 0 | 0 |
| ANN202 | 5 | 5 | 0 | 0 | 0 |
| E701 | 5 | 5 | 0 | 0 | 0 |
| PD011 | 4 | 4 | 0 | 0 | 0 |
| PD901 | 4 | 4 | 0 | 0 | 0 |
| PLR2004 | 4 | 4 | 0 | 0 | 0 |
| UP031 | 4 | 4 | 0 | 0 | 0 |
| B007 | 3 | 3 | 0 | 0 | 0 |
| T203 | 3 | 3 | 0 | 0 | 0 |
| SLF001 | 3 | 3 | 0 | 0 | 0 |
| RUF001 | 3 | 3 | 0 | 0 | 0 |
| PTH110 | 3 | 3 | 0 | 0 | 0 |
| E741 | 2 | 2 | 0 | 0 | 0 |
| PLR1736 | 2 | 2 | 0 | 0 | 0 |
| PLW2901 | 2 | 2 | 0 | 0 | 0 |
| I002 | 2 | 2 | 0 | 0 | 0 |
| PD002 | 2 | 2 | 0 | 0 | 0 |
| PLW0602 | 2 | 2 | 0 | 0 | 0 |
| ARG001 | 2 | 2 | 0 | 0 | 0 |
| E721 | 1 | 1 | 0 | 0 | 0 |
| B008 | 1 | 1 | 0 | 0 | 0 |
| TID253 | 1 | 1 | 0 | 0 | 0 |
| SIM115 | 1 | 1 | 0 | 0 | 0 |
| S301 | 1 | 1 | 0 | 0 | 0 |
| PLR0913 | 1 | 1 | 0 | 0 | 0 |
| BLE001 | 1 | 1 | 0 | 0 | 0 |
| RUF010 | 1 | 1 | 0 | 0 | 0 |
| PD008 | 1 | 1 | 0 | 0 | 0 |
| S113 | 1 | 1 | 0 | 0 | 0 |
| PTH111 | 1 | 1 | 0 | 0 | 0 |
| PTH202 | 1 | 1 | 0 | 0 | 0 |
| PTH102 | 1 | 1 | 0 | 0 | 0 |
| FBT001 | 1 | 1 | 0 | 0 | 0 |
| D400 | 1 | 1 | 0 | 0 | 0 |
| D415 | 1 | 1 | 0 | 0 | 0 |
| PTH107 | 1 | 1 | 0 | 0 | 0 |
| C405 | 1 | 1 | 0 | 0 | 0 |
| B018 | 1 | 1 | 0 | 0 | 0 |
| N803 | 1 | 1 | 0 | 0 | 0 |
| C901 | 1 | 1 | 0 | 0 | 0 |
| SIM910 | 1 | 1 | 0 | 0 | 0 |
| E711 | 1 | 1 | 0 | 0 | 0 |
| RUF005 | 1 | 1 | 0 | 0 | 0 |
| D205 | 1 | 1 | 0 | 0 | 0 |
| D212 | 1 | 1 | 0 | 0 | 0 |
| F841 | 1 | 1 | 0 | 0 | 0 |
| SIM108 | 1 | 1 | 0 | 0 | 0 |
| UP030 | 1 | 1 | 0 | 0 | 0 |
| UP032 | 1 | 1 | 0 | 0 | 0 |
| S506 | 1 | 1 | 0 | 0 | 0 |
| PLW0127 | 1 | 1 | 0 | 0 | 0 |
| PLW0128 | 1 | 1 | 0 | 0 | 0 |
| F811 | 1 | 1 | 0 | 0 | 0 |
Linter (preview)
✅ ecosystem check detected no linter changes.
e1f238f to
2915388
Compare
2915388 to
1d5be1c
Compare
Member
|
Can you rebase/re-run the ecosystem checks. The augmented assignment adds a lot of noise. |
MichaReiser
approved these changes
Aug 14, 2024
Comment on lines
344
to
345
| To lint or format files with additional file extensions, use the [`extend-include`](settings.md#extend-include) setting. | ||
|
|
||
| === "pyproject.toml" | ||
|
|
||
| ```toml | ||
| [tool.ruff] | ||
| extend-include = ["*.ipynb"] | ||
| ``` | ||
|
|
||
| === "ruff.toml" | ||
|
|
||
| ```toml | ||
| extend-include = ["*.ipynb"] | ||
| ``` | ||
|
|
||
| You can also change the default selection using the [`include`](settings.md#include) setting. |
Member
There was a problem hiding this comment.
extend-include has an example with .pyw files. Although I think the example isn't needed because we already link to extend-include which has an example.
Member
|
There are quiet a large number of violations and some violations seem less appropriate for notebooks (e.g. denying the use of |
Member
Author
It it up-to date with |
Member
|
Let's see if re-triggering the ecosystem checks help |
Member
Author
Oh, I see what the problem is. The |
Member
Author
|
@MichaReiser I've made some edits as per your suggestions. Thanks. I've also updated some rule documentation to reflect the different behavior for Jupyter Notebooks. |
5421453 to
600dcc7
Compare
MichaReiser
approved these changes
Aug 14, 2024
0369ce8 to
051d8bd
Compare
Member
|
@MichaReiser, I pushed a few small updates. Would you mind having another quick look? |
MichaReiser
reviewed
Aug 14, 2024
MichaReiser
approved these changes
Aug 14, 2024
Member
MichaReiser
left a comment
There was a problem hiding this comment.
Looks good except the options documentation is a bit of a stretch ;)
051d8bd to
b53746c
Compare
b53746c to
5a5a709
Compare
Merged
MichaReiser
pushed a commit
that referenced
this pull request
Aug 14, 2024
Co-authored-by: Alex Waygood <alex.waygood@gmail.com> Closes: #12456 Closes: astral-sh/ruff-vscode#546
MichaReiser
pushed a commit
that referenced
this pull request
Aug 14, 2024
Co-authored-by: Alex Waygood <alex.waygood@gmail.com> Closes: #12456 Closes: astral-sh/ruff-vscode#546
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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 stabilizes the support for Jupyter Notebooks and adds them to Ruff's default inclusion set.
Closes: #12456
Closes: astral-sh/ruff-vscode#546
Test Plan