depr(python, rust!): Rename write_csv parameter quote to quote_char

[svaningelgem]

closes #11545.

• I left line_terminator for sink_csv/write_csv. And eol_char for read_csv/scan_csv. The reason is that for sink/write this isn't necessarily a character, but can be a string.

• I adjusted the docs to explain this -hopefully- better for read/scan.

• Adjusted delimiter -> separator, quote -> quote_char, comment -> comment_char where they were not the target.

[alexander-beedie]

So, aligning quote to quote_char is a winner - ensures both calls use the same param, makes perfect sense. You just need to make use of the @deprecate_renamed_parameter decorator to avoid making it a breaking change though.

However, I'd revert the change from separator to delimiter_char - I see why you're thinking about it, but it "feels" somewhat unwieldy, and we have already changed that param (from sep) in recent memory 🤔

[svaningelgem]

However, I'd revert the change from separator to delimiter_char - I see why you're thinking about it, but it "feels" somewhat unwieldy, and we have already changed that param (from sep) in recent memory 🤔

I agree that it feels unwieldy, but I am in strong favor of consistency here.

fwiw: in CsvParserOptions, there is used delimiter, and then in PyBatchedCsv, there is used separator in the new method, which is passed to CsvReader in with_delimiter. So externally facing it's called -most of the time- separator, but internally it's most of the time delimiter...

I would strongly suggest to make up our minds ;-)

[alexander-beedie]

I would strongly suggest to make up our minds ;-)

Yup; I'd suggest making it separator everywhere.
It is, after all, usually found "in the wild" as CSV, TSV, etc (not CDV, TDV, ... ;)

[svaningelgem]

Yup; I'd suggest making it separator everywhere. It is, after all, usually found "in the wild" as CSV, TSV, etc (not CDV, TDV, ... ;)

Aaaargh, all that tedious work 😠 ... Let's see what I can easily revert.
Should I make it separator_char then? Or simply separator? I'd assume the latter.

[alexander-beedie]

Yup; I'd suggest making it separator everywhere. It is, after all, usually found "in the wild" as CSV, TSV, etc (not CDV, TDV, ... ;)

Aaaargh, all that tedious work 😠 ... Let's see what I can easily revert. Should I make it separator_char then? Or simply separator? I'd assume the latter.

I think separator is the cleanest / least-awkward formulation 😅

[stinodego]

Thanks for this! A few comments - some can probably be done in follow-up PRs if you prefer.

[stinodego]

Great stuff, really appreciate the great attention to detail - that saves a lot of review cycles!

[alexander-beedie]

Nice one :)