Harmonise methods for distinguishing different Python source types (#13682)

This commit is contained in:
Alex Waygood 2024-10-09 14:18:52 +01:00 committed by GitHub
parent b9827a4122
commit 5b4afd30ca
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 40 additions and 53 deletions

View file

@ -1,3 +1,4 @@
use std::ffi::OsStr;
use std::path::Path;
/// Return `true` if the [`Path`] is named `pyproject.toml`.
@ -6,38 +7,10 @@ pub fn is_pyproject_toml(path: &Path) -> bool {
.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")
}
/// Return `true` if a [`Path`] should use the name of its parent directory as its module name.
pub fn is_module_file(path: &Path) -> bool {
path.file_name().is_some_and(|file_name| {
file_name == "__init__.py"
|| file_name == "__init__.pyi"
|| file_name == "__main__.py"
|| file_name == "__main__.pyi"
})
}
#[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));
}
matches!(
path.file_name().and_then(OsStr::to_str),
Some("__init__.py" | "__init__.pyi" | "__main__.py" | "__main__.pyi")
)
}