mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-03 18:28:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Experimental release for Jupyter notebook integration (#5363)

Browse source 
## Summary

Experimental release for Jupyter Notebook integration.

Currently, this requires a user to explicitly opt-in using the
[include](https://beta.ruff.rs/docs/settings/#include) configuration:

```toml
[tool.ruff]
include = ["*.py", "*.pyi", "**/pyproject.toml", "*.ipynb"]
```

Or, a user can pass in the file directly:

```sh
ruff check path/to/notebook.ipynb
```

For known limitations, please refer #5188 

## Test Plan

Following command should work without the `--all-features` flag:

```sh
cargo dev round-trip /path/to/notebook.ipynb
```

Following command should work with the above config file along with
`select = ["ALL"]`:

```sh
cargo run --bin ruff -- check --no-cache --config=../test-repos/openai-cookbook/pyproject.toml --fix ../test-repos/openai-cookbook/
```

Passing the Jupyter notebook directly:

```sh
cargo run --bin ruff -- check --no-cache --isolated --select=ALL --fix ../test-repos/openai-cookbook/examples/Classification_using_embeddings.ipynb
```
This commit is contained in:
Dhruv Manilawala 2023-06-26 21:22:42 +05:30 • committed by GitHub
parent fa1b85b3da
commit 2fc38d81e6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 21 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

3
crates/ruff_dev/src/round_trip.rs
View file

@ -8,6 +8,7 @@ use anyhow::Result;
use ruff::jupyter;
use ruff::round_trip;
use ruff_python_stdlib::path::is_jupyter_notebook;
#[derive(clap::Args)]
pub(crate) struct Args {
@ -18,7 +19,7 @@ pub(crate) struct Args {
pub(crate) fn main(args: &Args) -> Result<()> {
let path = args.file.as_path();
if jupyter::is_jupyter_notebook(path) {
if is_jupyter_notebook(path) {
println!("{}", jupyter::round_trip(path)?);
} else {
let contents = fs::read_to_string(&args.file)?;