Einführung
Oft muss ich Aufgaben wie das Erstellen von Berichten, das Ausgeben von Dateien oder Zeichenfolgen ausführen. Sie alle folgen mehr oder weniger einem Muster, und oft sind die Muster so ähnlich, dass wir eine Vorlage haben möchten, die wir wiederverwenden und in die wir Daten direkt einspeisen können. Glücklicherweise bietet Python eine Klasse, die uns helfen kann: string.Template.
In diesem Artikel erfahren Sie, wie Sie diese Klasse nutzen, um eine Ausgabedatei basierend auf den Daten zu generieren, die Sie gerade verwenden, und wie Sie Zeichenfolgen auf die gleiche Weise bearbeiten. Anstatt also nur Beispiele zu verwenden, die Ihnen bei Ihrer täglichen Arbeit begegnen könnten, stellt Ihnen dieser Artikel eine Reihe tatsächlicher Tools vor, die Sie wahrscheinlich kennen und die diese Klasse zum Generieren von Berichtsdateien verwenden. Fangen wir an!
Hinweis: Dieser Artikel basiert auf Python 3.9.0 (CPython). Codebeispiele, die in diesem Artikel verwendet werden, finden Sie auf GitHub (https://github.com/DahlitzFlorian/generate-file-reports-using-pythons-template-class).
Bevor wir uns ein Beispiel ansehen, nehmen wir uns etwas Zeit, um die Vorteile der Verwendung von string.Template gegenüber anderen Lösungen zu betrachten.
1. Es sind keine weiteren Abhängigkeiten erforderlich, es funktioniert sofort, sodass es nicht erforderlich ist, den Befehl pip install zu verwenden, um es zu installieren.
2. Es ist leichtgewichtig und natürlich sind Template-Engines wie Jinja2 und Mako weit verbreitet. In dem in diesem Artikel vorgestellten Szenario werden diese Fähigkeiten jedoch überbewertet.
3. Trennung von Belangen: Anstatt die String-Manipulation und die Berichtsgenerierung direkt in den Code einzubetten, können Sie Vorlagendateien verwenden, um sie an einen externen Ort zu verschieben. Wenn Sie die Struktur oder das Design Ihres Berichts ändern möchten, können Sie Vorlagendateien austauschen, ohne Ihren Code zu ändern.
Aufgrund dieser Vorteile nutzen es einige bekannte Bibliotheken und Tools von Drittanbietern. Wily ist ein Beispiel, und Ende 2018 wollte Anthony Shaw, der Erfinder und Betreuer von Wily, HTML als Ausgabeformat für von Wily generierte Berichte unterstützen.
Beispiel: Erstellen eines Berichts über die besten Bücher
Nachdem wir die Motivation hinter der Verwendung der integrierten string.Template-Klasse von Python besprochen haben, werfen wir einen Blick auf das erste praktische Beispiel. Stellen Sie sich vor, Sie arbeiten für ein Unternehmen, das einen Jahresbericht über die besten Bücher veröffentlicht, die im vergangenen Jahr veröffentlicht wurden. 2020 ist ein besonderes Jahr, denn zusätzlich zu Ihrem Jahresbericht veröffentlichen Sie auch eine Liste der besten Bücher, die jemals geschrieben wurden.
Zu diesem Zeitpunkt ist es uns egal, woher die Daten kommen oder welche Bücher Teil der Liste sind. Nehmen wir der Einfachheit halber an, dass wir eine JSON-Datei namens data.json haben, die eine Zuordnung von Autorennamen und Buchtiteln enthält, wie unten gezeigt.
{
"Dale Carnegie": "How To Win Friends And Influence People",
"Daniel Kahneman": "Thinking, Fast and Slow",
"Leo Tolstoy": "Anna Karenina",
"William Shakespeare": "Hamlet",
"Franz Kafka": "The Trial"
}Nach dem Login kopieren
Ihre Aufgabe besteht nun darin, es auf eine Art und Weise mit anderen (z. B. großen Magazinen, Unternehmen oder Bloggern) zu teilen. Das Unternehmen entschied, dass eine einfache Tabelle im HTML-Format ausreichen würde. Die Frage ist nun: Wie generiert man diese HTML-Tabelle?
Natürlich können Sie dies manuell tun oder Platzhalter für jedes Buch erstellen. Allerdings wäre es sehr wünschenswert, später eine allgemeinere Version zu haben, da der Listeninhalt erweitert oder der strukturelle Aufbau geändert werden kann.
Jetzt können wir die string.Template-Klasse von Python nutzen! Wir beginnen mit der Erstellung der eigentlichen Vorlage, wie unten gezeigt. Hier nennen wir die Datei template.html.
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Great Books of All Time</title>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@4.5.3/dist/css/bootstrap.min.css" integrity="sha384-TX8t27EcRE3e/ihU7zmQxVncDAy5uIKz4rEkgIXeMed4M0jlfIDPvg6uqKI2xXr2" crossorigin="anonymous">
</head>
<body>
<h1>Great Books of All Time</h1>
<table >
<thead>
<tr>
<th scope="col">#</th>
<th scope="col">Author</th>
<th scope="col">Book Title</th>
</tr>
</thead>
<tbody>
${elements}
</tbody>
</table>
</body>
</html>Nach dem Login kopieren
Das Dokument selbst ist sehr rudimentär. Für das Styling und die Erstellung der Grundstruktur des Final Tables haben wir Bootstrap verwendet. Der Header ist enthalten, aber die Daten fehlen noch. Beachten Sie, dass innerhalb des tbody-Elements ein Platzhalter ${elements} verwendet wird, um zu markieren, wo wir später die Liste der Bücher einfügen werden.
Wir haben uns alle darauf vorbereitet, ein Python-Skript zu implementieren, das die gewünschte Ausgabe generiert! Daher erstellen wir eine neue Python-Datei namens report.py im aktuellen Arbeitsverzeichnis. Zuerst importieren wir die beiden benötigten integrierten Module und laden die Daten aus einer JSON-Datei.
# report.py
import json
import string
with open("data.json") as f:
data = json.loads(f.read())Nach dem Login kopieren
Die Datenvariable ist nun ein Wörterbuch, das den Namen des Autors (Schlüssel) und den Buchtitel (Wert) als Schlüssel-Wert-Paare enthält. Als nächstes generieren wir die HTML-Tabelle und fügen sie in die Vorlage ein (erinnern Sie sich an Platzhalter?). Wir initialisieren also eine leere Zeichenfolge und fügen ihr neue Tabellenzeilen hinzu, wie unten gezeigt.
content = ""
for i, (author, title) in enumerate(data.items()):
content += "<tr>"
content += f"<td>{i + 1}</td>"
content += f"<td>{author}</td>"
content += f"<td>{title}</td>"
content += "</tr>"Nach dem Login kopieren
Dieser Codeausschnitt zeigt uns, wie wir alle Elemente im Datenwörterbuch durchlaufen und den Buchtitel sowie den Namen des Autors in die entsprechenden HTML-Tags einfügen. Wir haben die endgültige HTML-Tabelle erstellt. Im nächsten Schritt müssen wir die zuvor erstellte Vorlagendatei laden:
with open("template.html") as t:
template = string.Template(t.read())Nach dem Login kopieren
Beachten Sie, dass string.Template einen String und keinen Dateipfad akzeptiert. Daher können Sie auch einen zuvor im Programm erstellten String bereitstellen, ohne ihn in einer Datei zu speichern. In unserem Fall stellen wir den Inhalt der Datei template.html bereit.
Abschließend verwenden wir die Methode replace() der Vorlage, um das Platzhalterelement durch die im Variableninhalt gespeicherte Zeichenfolge zu ersetzen. Die Methode gibt einen String zurück, den wir in der Variablen final_output speichern. Zu guter Letzt erstellen wir eine neue Datei namens report.html und schreiben die endgültige Ausgabe hinein.
final_output = template.substitute(elements=content)
with open("report.html", "w") as output:
output.write(final_output)Nach dem Login kopieren
现在已经生成了第一个文件报告！如果在浏览器中打开report.html文件，则可以看到结果。
safe_substitution（）方法
现在，您已经构建了第一个string.Template用例，在结束本文之前，我想与您分享一个常见情况及其解决方案：安全替换。它是什么？
让我们举个例子：您有一个字符串，您想在其中输入一个人的名字和姓氏。您可以按照以下步骤进行操作：
# safe_substitution.py
import string
template_string = "Your name is ${firstname} ${lastname}"
t = string.Template(template_string)
result = t.substitute(firstname="Florian", lastname="Dahlitz")
print(result)Nach dem Login kopieren
但是，如果您错过传递一个或另一个的值会怎样？它引发一个KeyError。为避免这种情况，我们可以利用safe_substitution（）方法。在这种情况下，safe意味着Python在任何情况下都尝试返回有效字符串。因此，如果找不到任何值，则不会替换占位符。
让我们按以下方式调整代码：
# safe_substitution.py
import string
template_string = "Your name is ${firstname} ${lastname}"
t = string.Template(template_string)
result = t.safe_substitute(firstname="Florian")
print(result)# Your name is Florian ${lastname}Nach dem Login kopieren
在某些情况下，这可能是一个更优雅的解决方案，甚至是必须的行为。但是这可能在其他地方引起意外的副作用。
本文概要
在阅读本文时，您不仅学习了Python字符串的基本知识。Template类以及使用它的原因，而且还实现了第一个文件报告脚本！此外，您已经了解了safe_substitution（）方法以及在哪种情况下使用它可能会有所帮助。
Das obige ist der detaillierte Inhalt vonGenerieren Sie Dateiberichte mit der Template-Klasse von Python. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!
