Skip to content
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.

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

Add hidden --extension to override inference of source type from file extension #8373

Merged
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
make extension_override a private struct
  • Loading branch information
felix-cw committed Nov 7, 2023
commit b2c4caacbf54d1df66cc9e24ee5e3c80c87aa003
8 changes: 4 additions & 4 deletions crates/ruff_cli/src/cache.rs
Original file line number Diff line number Diff line change
@@ -564,7 +564,7 @@ mod tests {
use anyhow::Result;
use filetime::{set_file_mtime, FileTime};
use itertools::Itertools;
use rustc_hash::FxHashMap;
use ruff_linter::settings::types::ExtensionMapping;
use test_case::test_case;

use ruff_cache::CACHE_DIR_NAME;
@@ -628,7 +628,7 @@ mod tests {
flags::Noqa::Enabled,
flags::FixMode::Generate,
UnsafeFixes::Enabled,
&FxHashMap::default(),
&ExtensionMapping::default(),
)
.unwrap();
if diagnostics
@@ -675,7 +675,7 @@ mod tests {
flags::Noqa::Enabled,
flags::FixMode::Generate,
UnsafeFixes::Enabled,
&FxHashMap::default(),
&ExtensionMapping::default(),
)
.unwrap();
}
@@ -1049,7 +1049,7 @@ mod tests {
flags::Noqa::Enabled,
flags::FixMode::Generate,
UnsafeFixes::Enabled,
&FxHashMap::default(),
&ExtensionMapping::default(),
)
}

10 changes: 5 additions & 5 deletions crates/ruff_cli/src/commands/check.rs
Original file line number Diff line number Diff line change
@@ -14,7 +14,7 @@ use rustc_hash::FxHashMap;
use ruff_diagnostics::Diagnostic;
use ruff_linter::message::Message;
use ruff_linter::registry::Rule;
use ruff_linter::settings::types::{Language, UnsafeFixes};
use ruff_linter::settings::types::{ExtensionMapping, UnsafeFixes};
use ruff_linter::settings::{flags, LinterSettings};
use ruff_linter::{fs, warn_user_once, IOError};
use ruff_python_ast::imports::ImportMap;
@@ -39,7 +39,7 @@ pub(crate) fn check(
noqa: flags::Noqa,
fix_mode: flags::FixMode,
unsafe_fixes: UnsafeFixes,
extension_override: &FxHashMap<String, Language>,
extension_override: &ExtensionMapping,
) -> Result<Diagnostics> {
// Collect all the Python files to check.
let start = Instant::now();
@@ -196,7 +196,7 @@ fn lint_path(
noqa: flags::Noqa,
fix_mode: flags::FixMode,
unsafe_fixes: UnsafeFixes,
extension_override: &FxHashMap<String, Language>,
extension_override: &ExtensionMapping,
) -> Result<Diagnostics> {
let result = catch_unwind(|| {
crate::diagnostics::lint_path(
@@ -245,7 +245,7 @@ mod test {

use ruff_linter::message::{Emitter, EmitterContext, TextEmitter};
use ruff_linter::registry::Rule;
use ruff_linter::settings::types::UnsafeFixes;
use ruff_linter::settings::types::{ExtensionMapping, UnsafeFixes};
use ruff_linter::settings::{flags, LinterSettings};
use ruff_workspace::resolver::{PyprojectConfig, PyprojectDiscoveryStrategy};
use ruff_workspace::Settings;
@@ -294,7 +294,7 @@ mod test {
flags::Noqa::Disabled,
flags::FixMode::Generate,
UnsafeFixes::Enabled,
&FxHashMap::default(),
&ExtensionMapping::default(),
)
.unwrap();
let mut output = Vec::new();
5 changes: 2 additions & 3 deletions crates/ruff_cli/src/commands/check_stdin.rs
Original file line number Diff line number Diff line change
@@ -4,9 +4,8 @@ use anyhow::Result;

use ruff_linter::packaging;
use ruff_linter::settings::flags;
use ruff_linter::settings::types::Language;
use ruff_linter::settings::types::ExtensionMapping;
use ruff_workspace::resolver::{match_exclusion, python_file_at_path, PyprojectConfig};
use rustc_hash::FxHashMap;

use crate::args::CliOverrides;
use crate::diagnostics::{lint_stdin, Diagnostics};
@@ -19,7 +18,7 @@ pub(crate) fn check_stdin(
overrides: &CliOverrides,
noqa: flags::Noqa,
fix_mode: flags::FixMode,
extension_override: &FxHashMap<String, Language>,
extension_override: &ExtensionMapping,
) -> Result<Diagnostics> {
if let Some(filename) = filename {
if !python_file_at_path(filename, pyproject_config, overrides)? {
15 changes: 5 additions & 10 deletions crates/ruff_cli/src/diagnostics.rs
Original file line number Diff line number Diff line change
@@ -17,7 +17,7 @@ use ruff_linter::logging::DisplayParseError;
use ruff_linter::message::Message;
use ruff_linter::pyproject_toml::lint_pyproject_toml;
use ruff_linter::registry::AsRule;
use ruff_linter::settings::types::{Language, UnsafeFixes};
use ruff_linter::settings::types::{ExtensionMapping, UnsafeFixes};
use ruff_linter::settings::{flags, LinterSettings};
use ruff_linter::source_kind::{SourceError, SourceKind};
use ruff_linter::{fs, IOError, SyntaxError};
@@ -179,17 +179,12 @@ impl AddAssign for FixMap {

fn get_override_source_type(
path: Option<&Path>,
extension: &FxHashMap<String, Language>,
extension: &ExtensionMapping,
) -> Option<PySourceType> {
let Some(ext) = path.and_then(|p| p.extension()).and_then(|p| p.to_str()) else {
return None;
};
match extension.get(ext) {
Some(Language::Python) => Some(PySourceType::Python),
Some(Language::Ipynb) => Some(PySourceType::Ipynb),
Some(Language::Pyi) => Some(PySourceType::Stub),
None => None,
}
extension.map_ext(ext).map(PySourceType::from)
}

/// Lint the source code at the given `Path`.
@@ -202,7 +197,7 @@ pub(crate) fn lint_path(
noqa: flags::Noqa,
fix_mode: flags::FixMode,
unsafe_fixes: UnsafeFixes,
extension_override: &FxHashMap<String, Language>,
extension_override: &ExtensionMapping,
) -> Result<Diagnostics> {
// Check the cache.
let caching = match cache {
@@ -388,7 +383,7 @@ pub(crate) fn lint_stdin(
settings: &Settings,
noqa: flags::Noqa,
fix_mode: flags::FixMode,
extension_override: &FxHashMap<String, Language>,
extension_override: &ExtensionMapping,
) -> Result<Diagnostics> {
// TODO(charlie): Support `pyproject.toml`.
let source_type = if let Some(source_type) = get_override_source_type(path, extension_override)
4 changes: 1 addition & 3 deletions crates/ruff_cli/src/lib.rs
Original file line number Diff line number Diff line change
@@ -17,7 +17,6 @@ use ruff_linter::settings::flags::FixMode;
use ruff_linter::settings::types::SerializationFormat;
use ruff_linter::{fs, warn_user, warn_user_once};
use ruff_workspace::Settings;
use rustc_hash::FxHashMap;

use crate::args::{Args, CheckCommand, Command, FormatCommand, HelpFormat};
use crate::printer::{Flags as PrinterFlags, Printer};
@@ -317,8 +316,7 @@ pub fn check(args: CheckCommand, log_level: LogLevel) -> Result<ExitStatus> {
);
let extension_override = cli
.extension_override
.map(|eo| eo.into_iter().map(|y| (y.extension, y.language)))
.map(FxHashMap::from_iter)
.map(|eo| eo.into_iter().collect())
.unwrap_or_default();

if cli.watch {
41 changes: 41 additions & 0 deletions crates/ruff_linter/src/settings/types.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
use rustc_hash::FxHashMap;
use std::hash::{Hash, Hasher};
use std::ops::Deref;
use std::path::{Path, PathBuf};
@@ -8,6 +9,7 @@ use anyhow::{bail, Result};
use globset::{Glob, GlobSet, GlobSetBuilder};
use pep440_rs::{Version as Pep440Version, VersionSpecifiers};
use ruff_diagnostics::Applicability;
use ruff_python_ast::PySourceType;
use serde::{de, Deserialize, Deserializer, Serialize};
use strum::IntoEnumIterator;
use strum_macros::EnumIter;
@@ -328,6 +330,16 @@ impl FromStr for Language {
}
}

impl From<Language> for PySourceType {
fn from(value: Language) -> Self {
match value {
Language::Python => Self::Python,
Language::Ipynb => Self::Ipynb,
Language::Pyi => Self::Stub,
}
}
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct ExtensionPair {
pub extension: String,
@@ -363,6 +375,35 @@ impl From<ExtensionPair> for (String, Language) {
(value.extension, value.language)
}
}
#[derive(Debug, Clone)]
pub struct ExtensionMapping {
mapping: FxHashMap<String, Language>,
}

impl ExtensionMapping {
pub fn map_ext(&self, ext: &str) -> Option<Language> {
self.mapping.get(ext).copied()
}
}

impl Default for ExtensionMapping {
fn default() -> Self {
Self {
mapping: FxHashMap::from_iter([]),
}
}
}

impl FromIterator<ExtensionPair> for ExtensionMapping {
fn from_iter<T: IntoIterator<Item = ExtensionPair>>(iter: T) -> Self {
Self {
mapping: iter
.into_iter()
.map(|y| (y.extension, y.language))
.collect(),
}
}
}

#[derive(Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Debug, Hash)]
#[cfg_attr(feature = "clap", derive(clap::ValueEnum))]