language-servers/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-09-26 11:59:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Stabilize quote-style preserve (#9922)

Browse source
This commit is contained in:
Micha Reiser 2024-02-12 10:30:07 +01:00 • committed by GitHub
parent 6dc1b21917
commit 4946a1876f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 37 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

6
crates/ruff_python_formatter/src/options.rs
View file

@ -248,6 +248,12 @@ pub enum QuoteStyle {
Preserve,
}
impl QuoteStyle {
pub const fn is_preserve(self) -> bool {
matches!(self, QuoteStyle::Preserve)
}
}
impl fmt::Display for QuoteStyle {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {

8
crates/ruff_python_formatter/src/other/string_literal.rs
View file

@ -50,11 +50,13 @@ impl Format<PyFormatContext<'_>> for FormatStringLiteral<'_> {
fn fmt(&self, f: &mut PyFormatter) -> FormatResult<()> {
let locator = f.context().locator();
let quote_style = if self.layout.is_docstring() {
// Per PEP 8 and PEP 257, always prefer double quotes for docstrings
let quote_style = f.options().quote_style();
let quote_style = if self.layout.is_docstring() && !quote_style.is_preserve() {
// Per PEP 8 and PEP 257, always prefer double quotes for docstrings,
// except when using quote-style=preserve
QuoteStyle::Double
} else {
f.options().quote_style()
quote_style
};
let normalized = StringPart::from_source(self.value.range(), &locator).normalize(

3
crates/ruff_python_formatter/src/string/mod.rs
View file

@ -306,6 +306,7 @@ impl StringPart {
normalize_hex: bool,
) -> NormalizedString<'a> {
// Per PEP 8, always prefer double quotes for triple-quoted strings.
// Except when using quote-style-preserve.
let preferred_style = if self.quotes.triple {
// ... unless we're formatting a code snippet inside a docstring,
// then we specifically want to invert our quote style to avoid
@ -354,6 +355,8 @@ impl StringPart {
// if it doesn't have perfect alignment with PEP8.
if let Some(quote) = parent_docstring_quote_char {
QuoteStyle::from(quote.invert())
} else if configured_style.is_preserve() {
QuoteStyle::Preserve
} else {
QuoteStyle::Double
}