Skip to content

[ruff] Add unsafe fix for os-path-commonprefix (RUF071) #23852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amyreese merged 3 commits into from
Mar 11, 2026
Merged

[ruff] Add unsafe fix for os-path-commonprefix (RUF071) #23852

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5fc5e9c
[ruff] add unsafe fix for ()
anishgirianish Mar 10, 2026
f19f12c
[ruff] address review refactors
anishgirianish Mar 10, 2026
aef6aba
[ruff] simple fix created broken fix, fixed it with combination
anishgirianish Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions crates/ruff_linter/src/rules/ruff/rules/os_path_commonprefix.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@ use ruff_macros::{ViolationMetadata, derive_message_formats};
use ruff_python_ast as ast;
use ruff_text_size::Ranged;

use crate::Violation;
use crate::checkers::ast::Checker;
use crate::importer::ImportRequest;
use crate::{AlwaysFixableViolation, Edit, Fix};

/// ## What it does
/// Checks for uses of `os.path.commonprefix`.
Expand Down Expand Up @@ -43,14 +44,14 @@ use crate::checkers::ast::Checker;
#[violation_metadata(preview_since = "NEXT_RUFF_VERSION")]
pub(crate) struct OsPathCommonprefix;

impl Violation for OsPathCommonprefix {
impl AlwaysFixableViolation for OsPathCommonprefix {
#[derive_message_formats]
fn message(&self) -> String {
"`os.path.commonprefix()` compares strings character-by-character".to_string()
}

fn fix_title(&self) -> Option<String> {
Some("Use `os.path.commonpath()` to compare path components".to_string())
fn fix_title(&self) -> String {
"Use `os.path.commonpath()` to compare path components".to_string()
}
}

Expand All @@ -61,4 +62,14 @@ pub(crate) fn os_path_commonprefix(checker: &Checker, call: &ast::ExprCall, segm
}
let mut diagnostic = checker.report_diagnostic(OsPathCommonprefix, call.func.range());
diagnostic.add_primary_tag(ruff_db::diagnostic::DiagnosticTag::Deprecated);

diagnostic.try_set_fix(|| {
let (import_edit, binding) = checker.importer().get_or_import_symbol(
&ImportRequest::import_from("os.path", "commonpath"),
call.func.start(),
checker.semantic(),
)?;
let reference_edit = Edit::range_replacement(binding, call.func.range());
Ok(Fix::unsafe_edits(import_edit, [reference_edit]))
});
Comment thread
anishgirianish marked this conversation as resolved.
}
33 changes: 30 additions & 3 deletions .../src/rules/ruff/snapshots/ruff_linter__rules__ruff__tests__preview__RUF071_RUF071.py.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
source: crates/ruff_linter/src/rules/ruff/mod.rs
---
RUF071 `os.path.commonprefix()` compares strings character-by-character
RUF071 [*] `os.path.commonprefix()` compares strings character-by-character
--> RUF071.py:7:1
|
6 | # Errors
Expand All @@ -11,8 +11,17 @@ RUF071 `os.path.commonprefix()` compares strings character-by-character
9 | path.commonprefix(["/usr/lib", "/usr/local/lib"])
|
help: Use `os.path.commonpath()` to compare path components
4 | from os import path
5 |
6 | # Errors
- os.path.commonprefix(["/usr/lib", "/usr/local/lib"])
7 + os.path.commonpath(["/usr/lib", "/usr/local/lib"])
8 | commonprefix(["/usr/lib", "/usr/local/lib"])
9 | path.commonprefix(["/usr/lib", "/usr/local/lib"])
10 |
note: This is an unsafe fix and may change runtime behavior

RUF071 `os.path.commonprefix()` compares strings character-by-character
RUF071 [*] `os.path.commonprefix()` compares strings character-by-character
--> RUF071.py:8:1
|
6 | # Errors
Expand All @@ -22,8 +31,17 @@ RUF071 `os.path.commonprefix()` compares strings character-by-character
9 | path.commonprefix(["/usr/lib", "/usr/local/lib"])
|
help: Use `os.path.commonpath()` to compare path components
5 |
6 | # Errors
7 | os.path.commonprefix(["/usr/lib", "/usr/local/lib"])
- commonprefix(["/usr/lib", "/usr/local/lib"])
8 + os.path.commonpath(["/usr/lib", "/usr/local/lib"])
9 | path.commonprefix(["/usr/lib", "/usr/local/lib"])
10 |
11 | # OK
note: This is an unsafe fix and may change runtime behavior

RUF071 `os.path.commonprefix()` compares strings character-by-character
RUF071 [*] `os.path.commonprefix()` compares strings character-by-character
--> RUF071.py:9:1
|
7 | os.path.commonprefix(["/usr/lib", "/usr/local/lib"])
Expand All @@ -34,3 +52,12 @@ RUF071 `os.path.commonprefix()` compares strings character-by-character
11 | # OK
|
help: Use `os.path.commonpath()` to compare path components
6 | # Errors
7 | os.path.commonprefix(["/usr/lib", "/usr/local/lib"])
8 | commonprefix(["/usr/lib", "/usr/local/lib"])
- path.commonprefix(["/usr/lib", "/usr/local/lib"])
9 + os.path.commonpath(["/usr/lib", "/usr/local/lib"])
10 |
11 | # OK
12 | os.path.commonpath(["/usr/lib", "/usr/local/lib"])
note: This is an unsafe fix and may change runtime behavior
Loading