Configurable "unparse mode" for ruff_python_codegen::Generator
#21041
Conversation
|
| /// Like [`round_trip`] but configure the [`Generator`] with the requested | ||
| /// `indentation`, `line_ending` and `preferred_quote` settings. | ||
| /// `indentation`, `line_ending`, `preferred_quote` and `forced_tuple_parentheses` settings. | ||
| fn round_trip_with( |
There was a problem hiding this comment.
The signature here becomes a bit awkward. Should we introduce a GeneratorOptions struct with:
indentationline_endingpreferred_quote: Optionforced_tuple_parentheses
ShaharNaveh
changed the title
ruff_python_codegen::Generatorruff_python_codegen::Generator
| pub enum UnparseMode { | ||
| #[default] | ||
| Default, | ||
| Ast, | ||
| } |
There was a problem hiding this comment.
Nit: I think just Mode is enough. I'd rename Ast to AstUnparse and document that the intent is to emit the same output as Python's ast.unparse method
There was a problem hiding this comment.
np, would you prefer this documented at the enum variant, or the Generator::with_unparse_mode?
There was a problem hiding this comment.
I suggest documenting it at the variant level
| let quote_style = match self.unparse_mode { | ||
| UnparseMode::Default => flags.quote_style(), | ||
| UnparseMode::Ast => Quote::Single, | ||
| }; |
There was a problem hiding this comment.
We could make this a method on Mode insteada of repeating it at every call site
impl Mode {
const fn quote_style(self, flags: AnyStringFlags) -> QuoteStyle {
...
}
}
There was a problem hiding this comment.
I guess that it would make sense to move the tuple precedence value to it's own method as well, right? although it's only used once it kind of makes more sense to me for some reason. I'll do that if you think it's a good idea
There was a problem hiding this comment.
I'm less concerned about the tuple case because it's used exactly once.
| /// - [`Default`](`Mode::Default`): Output of `[AnyStringFlags.quote_style`]. | ||
| /// - [`AstUnparse`](`Mode::AstUnparse`): Always return [`Quote::Single`]. | ||
| #[must_use] | ||
| fn quote_style(&self, flags: impl StringFlags) -> Quote { |
There was a problem hiding this comment.
had to use generics because this gets called with either AnyStringFlags or BytesLiteralFlags
| use crate::stylist::Indentation; | ||
|
|
||
| use super::Generator; | ||
| use super::{Generator, Mode as UnparseMode}; |
There was a problem hiding this comment.
Renamed to UnparsedMode here because the name collides with
use ruff_python_parser::{..., Mode, ...};
|
tysm @MichaReiser <3 ! |
3 participants
Summary
At RustPython we want to fully replace https://github.com/RustPython/RustPython/blob/153d0eef51ea109d8a322fd351678847b2fb8fe2/compiler/codegen/src/unparse.rs.
Currently our only regression when using Ruff's unparsing, is forcing tuple parentheses.
Test Plan
Added tests