mirror of
https://github.com/astral-sh/ruff.git
synced 2025-08-25 21:05:31 +00:00
58f5f27dc3
## Summary
This PR adds a higher-level enum (`SourceType`) around `PySourceType` to
allow us to use the same detection path to handle TOML files. Right now,
we have ad hoc `is_pyproject_toml` checks littered around, and some
codepaths are omitting that logic altogether (like `add_noqa`). Instead,
we should always be required to check the source type and handle TOML
files as appropriate.
This PR will also help with our pre-commit capabilities. If we add
`toml` to pre-commit (to support `pyproject.toml`), pre-commit will
start to pass _other_ files to Ruff (along with `poetry.lock` and
`Pipfile` -- see
[identify](b59996304f/identify/extensions.py (L355))).
By detecting those files and handling those cases, we avoid attempting
to parse them as Python files, which would lead to pre-commit errors.
(We tried to add `toml` to pre-commit here
(https://github.com/astral-sh/ruff-pre-commit/pull/44), but had to
revert here (https://github.com/astral-sh/ruff-pre-commit/pull/45) as it
led to the pre-commit hook attempting to parse `poetry.lock` files as
Python files.)
33 lines
950 B
Rust
33 lines
950 B
Rust
use std::path::Path;
|
|
|
|
/// Return `true` if the [`Path`] is named `pyproject.toml`.
|
|
pub fn is_pyproject_toml(path: &Path) -> bool {
|
|
path.file_name()
|
|
.is_some_and(|name| name == "pyproject.toml")
|
|
}
|
|
|
|
/// Return `true` if the [`Path`] appears to be that of a Python interface definition file (`.pyi`).
|
|
pub fn is_python_stub_file(path: &Path) -> bool {
|
|
path.extension().is_some_and(|ext| ext == "pyi")
|
|
}
|
|
|
|
/// Return `true` if the [`Path`] appears to be that of a Jupyter notebook (`.ipynb`).
|
|
pub fn is_jupyter_notebook(path: &Path) -> bool {
|
|
path.extension().is_some_and(|ext| ext == "ipynb")
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use std::path::Path;
|
|
|
|
use crate::path::is_jupyter_notebook;
|
|
|
|
#[test]
|
|
fn test_is_jupyter_notebook() {
|
|
let path = Path::new("foo/bar/baz.ipynb");
|
|
assert!(is_jupyter_notebook(path));
|
|
|
|
let path = Path::new("foo/bar/baz.py");
|
|
assert!(!is_jupyter_notebook(path));
|
|
}
|
|
}
|