Printf-style Formatierung, über Operator

Diese ehrwürdige Technik hat weiterhin ihre Verwendung, z. B. bei Byte-basierten Protokollen, Einfachheit in einfachen Fällen und Vertrautheit für viele Programmierer.

>>> 'Hello, user: %(user)s, id: %(id)s, on host: %(hostname)s' % params
'Hello, user: nobody, id: 9, on host: darkstar'

In dieser Form ist die Technik unter Berücksichtigung der vorausgesetzten Wörterbucherstellung ausführlich, ein wenig unordentlich, aber relativ gut lesbar. Weitere Probleme sind, dass ein Operator neben dem ursprünglichen String nur ein Argument annehmen kann, was bedeutet, dass mehrere Parameter als Tupel oder Wörterbuch übergeben werden müssen. Außerdem ist es relativ einfach, einen Fehler bei der Anzahl der übergebenen Argumente, dem erwarteten Typ, einem fehlenden Schlüssel oder dem Vergessen des abschließenden Typs, z. B. (s oder d), zu machen.

string.Template Klasse

Die string.Template Klasse aus PEP 292 (Simpler String Substitutions) ist ein bewusst vereinfachter Entwurf, der die vertraute Shell-Interpolationssyntax mit sicherer Substitutionsfunktion verwendet, die ihre Hauptanwendungsfälle in Shell- und Internationalisierungswerkzeugen findet.

Template('Hello, user: $user, id: ${id}, on host: $hostname').substitute(params)

Obwohl ebenfalls ausführlich, ist der String selbst lesbar. Obwohl die Funktionalität begrenzt ist, erfüllt sie ihre Anforderungen gut. Sie ist für viele Fälle nicht leistungsfähig genug, was unerfahrene Benutzer vor Problemen schützt und Probleme mit mäßig vertrauenswürdigen Eingaben (i18n) von Drittanbietern vermeidet. Es erfordert leider genügend Code, um seine Verwendung für Ad-hoc-String-Interpolation abzuschrecken, es sei denn, er wird in einer Komfortbibliothek wie flufl.i18n gekapselt.

PEP 215 - String Interpolation

PEP 215 war ein früherer Vorschlag, mit dem dieser viel gemeinsam hat. Anscheinend war die Welt zu dieser Zeit noch nicht bereit dafür, aber angesichts der jüngsten Unterstützung in einer Reihe anderer Sprachen könnte seine Zeit gekommen sein.

Die große Anzahl von Dollarzeichen ($), die er enthielt, könnte ihn Perl, Pythons Erzfeind, ähneln lassen und wahrscheinlich zum mangelnden Akzeptanz des PEP beigetragen haben. Er wurde durch den folgenden Vorschlag abgelöst.

str.format() Methode

Die str.format() Syntax von PEP 3101 ist die neueste und modernste der bestehenden Optionen. Sie ist auch leistungsfähiger und in der Regel besser lesbar als die anderen. Sie vermeidet viele der Nachteile und Einschränkungen der vorherigen Techniken.

Aufgrund des notwendigen Funktionsaufrufs und der Parameterübergabe ist sie jedoch in verschiedenen Situationen mit String-Literalen von ausführlich bis sehr ausführlich.

>>> 'Hello, user: {user}, id: {id}, on host: {hostname}'.format(**params)
'Hello, user: nobody, id: 9, on host: darkstar'

# when using keyword args, var name shortening sometimes needed to fit :/
>>> 'Hello, user: {user}, id: {id}, on host: {host}'.format(user=user,
                                                            id=id,
                                                            host=hostname)
'Hello, user: nobody, id: 9, on host: darkstar'

Die Ausführlichkeit des methodenbasierten Ansatzes wird hier veranschaulicht.

PEP 498 – Literal String Formatting

PEP 498 definiert und diskutiert Format-Strings, wie auch im Abstrakt oben beschrieben.

Er führt auch, für die ersten Betrachter etwas kontrovers, die Idee ein, dass Format-Strings mit Unterstützung für beliebige Ausdrücke erweitert werden sollen. Dies wird im Abschnitt "Restricting Syntax" unter Rejected Ideas weiter diskutiert.

PEP 501 – Übersetzungsfertige String-Interpolation

Der ergänzende PEP 501 bringt die Internationalisierung als primäre Sorge ein, mit seinem Vorschlag des i-Präfixes, der string.Template-Syntax-Integration, die mit ES6 (Javascript) kompatibel ist, verzögertem Rendering und einem Objekt-Rückgabewert.

Bash

Bash unterstützt eine Reihe von beliebigen, sogar rekursiven Konstrukten innerhalb von Strings:

> echo "user: $USER, id: $((id + 6)) on host: $(echo is $(hostname))"
user: nobody, id: 15 on host: is darkstar

• Explizite Interpolation innerhalb von doppelten Anführungszeichen.
• Direkter Zugriff auf Umgebungsvariablen wird unterstützt.
• Beliebige Ausdrücke werden unterstützt. [4]
• Ausführung externer Prozesse und Erfassung von Ausgaben werden unterstützt. [5]
• Rekursive Ausdrücke werden unterstützt.

Perl

Perl hat ebenfalls beliebige Ausdruckskonstrukte, vielleicht nicht so bekannt:

say "I have @{[$id + 6]} guanacos.";                # lists
say "I have ${\($id + 6)} guanacos.";               # scalars
say "Hello { @names.join(', ') } how are you?";     # Perl 6 version

• Explizite Interpolation innerhalb von doppelten Anführungszeichen.
• Beliebige Ausdrücke werden unterstützt. [6] [7]

Ruby

Ruby erlaubt beliebige Ausdrücke in seinen interpolierten Strings:

puts "One plus one is two: #{1 + 1}\n"

• Explizite Interpolation innerhalb von doppelten Anführungszeichen.
• Beliebige Ausdrücke werden unterstützt. [8] [9]
• Möglichkeit, Trennzeichen mit % zu ändern.
• Siehe den Abschnitt "Referenzimplementierung(en)" für eine Implementierung in Python.

Andere

Betrachten wir einige weniger ähnliche moderne Sprachen, die kürzlich String-Interpolation implementiert haben.

Scala

Scala-Interpolation wird über String-Präfixe gesteuert. Jedes Präfix hat ein anderes Ergebnis.

s"Hello, $name ${1 + 1}"                    # arbitrary
f"$name%s is $height%2.2f meters tall"      # printf-style
raw"a\nb"                                   # raw, like r''

Diese Präfixe können auch vom Benutzer implementiert werden, indem die Klasse StringContext von Scala erweitert wird.

• Explizite Interpolation innerhalb von doppelten Anführungszeichen mit Literal-Präfix.
• Benutzerdefinierte Präfixe werden unterstützt.
• Beliebige Ausdrücke werden unterstützt.

ES6 (Javascript)

Designer von Template-Strings standen vor dem gleichen Problem wie Python, wo einfache und doppelte Anführungszeichen bereits vergeben waren. Im Gegensatz zu Python waren die „Backticks“ jedoch nicht vergeben. Trotz ihrer Probleme wurden sie als Teil des ECMAScript 2015 (ES6) Standards gewählt.

console.log(`Fifteen is ${a + b} and\nnot ${2 * a + b}.`);

Benutzerdefinierte Präfixe werden auch unterstützt, indem eine Funktion mit demselben Namen wie das Tag implementiert wird.

function tag(strings, ...values) {
    console.log(strings.raw[0]);    // raw string is also available
    return "Bazinga!";
}
tag`Hello ${ a + b } world ${ a * b}`;

• Explizite Interpolation innerhalb von Backticks.
• Benutzerdefinierte Präfixe werden unterstützt.
• Beliebige Ausdrücke werden unterstützt.

C#, Version 6

C# hat ebenfalls eine nützliche neue Interpolationsfunktion mit gewisser Möglichkeit, die Interpolation anzupassen über das IFormattable-Interface.

$"{person.Name, 20} is {person.Age:D3} year{(p.Age == 1 ? "" : "s")} old.";

• Explizite Interpolation mit doppelten Anführungszeichen und dem $-Präfix.
• Benutzerdefinierte Interpolationen sind verfügbar.
• Beliebige Ausdrücke werden unterstützt.

Apples Swift

Beliebige Interpolation unter Swift ist auf allen Strings verfügbar.

let multiplier = 3
let message = "\(multiplier) times 2.5 is \(Double(multiplier) * 2.5)"
// message is "3 times 2.5 is 7.5"

• Implizite Interpolation mit doppelten Anführungszeichen.
• Beliebige Ausdrücke werden unterstützt.
• Kann CR/LF nicht enthalten.

Zusätzliche Beispiele

Eine Reihe von zusätzlichen Beispielen für String-Interpolation kann auf Wikipedia gefunden werden.

Nachdem nun Hintergrund und Geschichte behandelt wurden, fahren wir mit einer Lösung fort.

Minderung durch Werkzeuge

Die Idee ist, dass Werkzeuge oder Linter wie pyflakes, pylint oder Pycharm Strings mit Ausdrücken überprüfen und sie entsprechend hervorheben können. Da dies eine gängige Aufgabe in Programmiersprachen von heute ist, müssen Multi-Sprachen-Werkzeuge diese Funktion nicht ausschließlich für Python implementieren, was die Implementierungszeit erheblich verkürzt.

Weiter in der Zukunft könnten Strings auch auf Konstrukte überprüft werden, die die Sicherheitsrichtlinie eines Projekts überschreiten.

Internationalisierung

Obwohl es sehr wünschenswert war, Internationalisierungsunterstützung zu integrieren (siehe PEP 501), weichen die feineren Details bei fast jedem Punkt ab, was eine gemeinsame Lösung unwahrscheinlich macht: [15]

• Unterschiedliche Anwendungsfälle
• Kompilierungs- vs. Laufzeitaufgaben
• Anforderungen an die Interpolationssyntax
• Zielgruppe
• Sicherheitsrichtlinie

Syntaxbeschränkung auf nur str.format()

Die gängigen Argumente gegen die Unterstützung von beliebigen Ausdrücken waren:

1. YAGNI, "You Aren't Gonna Need It."
2. Das Feature ist nicht kongruent mit dem historischen Python-Konservatismus.
3. Verschieben - kann in einer zukünftigen Version implementiert werden, wenn Bedarf nachgewiesen wird.

Die Unterstützung nur der str.format()-Syntax wurde jedoch nicht als ausreichende Lösung des Problems angesehen. Oft ist vor dem Drucken beispielsweise die einfache Länge oder Inkrementierung eines Objekts gewünscht.

Im Abschnitt Implementierungen in anderen Sprachen ist zu sehen, dass die Entwicklergemeinschaft im Allgemeinen zustimmt. String-Interpolation mit beliebigen Ausdrücken wird in modernen Sprachen aufgrund ihres Nutzens zu einem Industriestandard.

Zusätzliche/Benutzerdefinierte String-Präfixe

Wie im Abschnitt Implementierungen in anderen Sprachen zu sehen ist, verfügen viele moderne Sprachen über erweiterbare String-Präfixe mit einer gemeinsamen Schnittstelle. Dies könnte eine Möglichkeit sein, Code in gängigen Situationen zu verallgemeinern und zu reduzieren. Beispiele finden sich in ES6 (Javascript), Scala, Nim und C# (in geringerem Maße). Dies wurde vom BDFL abgelehnt. [14]

Automatisches Escaping von Eingabevariablen

Obwohl in einigen Fällen hilfreich, wurde angenommen, dass dies zu viel Unsicherheit darüber schafft, wann und wo String-Ausdrücke sicher verwendet werden können oder nicht. Das Konzept war auch schwer anderen zu vermitteln. [12]

Betrachten Sie String-Formatierungsvariablen immer als unescaped, es sei denn, der Entwickler hat sie explizit escaped.

Umgebungsvariablenzugriff und Befehlssubstitution

Für Systemprogrammierung und Shell-Skript-Ersatz wäre es nützlich, Umgebungsvariablen zu verarbeiten und Ausgaben von Befehlen direkt in einem Ausdrucksstring zu erfassen. Dies wurde als nicht wichtig genug abgelehnt und ähnelte zu sehr Bash/Perl, was zu schlechten Gewohnheiten ermutigen könnte. [13]