realpython / realpython/python-guide

Section idea: Elegant string formatting

Offen
#859 1 Kommentar 1 Reaktion 1 zugewiesene Person Auf GitHub ansehen

@mpoulin arbeitet bereits daran.

Seit 31.8.2018.

Vorherrschende Sprache
Batchfile
Sterne
29.8k
Forks
5.9k
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

One thing that I would love to see is an opinionated guide to elegant string formatting in python. I feel like there are many ways to do it, especially with f-strings now, and when it comes to indentation, interpolation, longer method names, etc, and I can never decide in the moment on what the most elegant approach is. This is especially hairy when trying to conform to a 79 character line length.

This seems obviously up the python guide's alley. ;) Just wanted to drop the seed in case it had ever crossed y'alls mind.

Some examples I can think of:

  1. What should a long string parameter in a method call look like? (This often comes up in exceptions being raised for example.)

  2. What should a long string parameter with interpolation in an error message look like?

  3. What should a string look like in a case with deep-ish indentation? (other than: break out to a method). Same question with interpolation.

  4. f-strings or .format() or %? When/why?

  5. What should multi-line f-strings look like? Should they be avoided?

  6. When to triple quote? Docs only?

etc

I feel like there's an opportunity for really good guidance here that is outside of pep8; something everybody would run into that you all would have well-formed opinions on. :) And I haven't seen much written about it.

Thoughts?

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.