mhammond / pywin32

Python for Windows (pywin32) Extensions
4.9k stars 783 forks source link

Stop using `printf`-style string formatting for direct string interpolation (`%s`) #2277

Open Avasam opened 3 weeks ago

Avasam commented 3 weeks ago

Follow-up to https://github.com/mhammond/pywin32/pull/2122

Ran using ruff check --fix --unsafe-fixes --select=UP031 --exclude=adodbapi then black . This replaces all usages of exclusively %s for string formatting with newer style .format introduced in Python 2.6 . This autofix is considered "unsafe" when Ruff cannot statically establish that the following case is always false:

A single %s in the string, formatted with a 1-item tuple. ie: "foor%s" % ("bar",)

Due to the sheer amount o changes (359) this is kept to automated changes only.

%d and %r will be done in separate PRs as they're not handled by UP031. Preferring f-strings will come as a follow-up since that can make the line go over the 100 chars limit.

References:

https://docs.astral.sh/ruff/rules/printf-string-formatting/#why-is-this-bad

printf-style string formatting has a number of quirks, and leads to less readable code than using str.format calls or f-strings. In general, prefer the newer str.format and f-strings constructs over printf-style string formatting.

https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting

Note The formatting operations described here exhibit a variety of quirks that lead to a number of common errors (such as failing to display tuples and dictionaries correctly). Using the newer formatted string literals, the str.format() interface, or template strings may help avoid these errors. Each of these alternatives provides their own trade-offs and benefits of simplicity, flexibility, and/or extensibility.