Sample code for the article on string formatting

Author: lpozo

python-string-formatting/README.md

@@ -0,0 +1,3 @@
+# Python String Formatting: Available Tools and Their Features
+
+This folder provides the code examples for the Real Python tutorial [Python String Formatting: Available Tools and Their Features](https://realpython.com/python-string-formatting/).

python-string-formatting/grades_report.py

@@ -0,0 +1,71 @@
+student = {
+    "name": "John Doe",
+    "subjects": [
+        {
+            "name": "Mathematics",
+            "grade": 88,
+            "comment": "Excellent improvement.",
+        },
+        {
+            "name": "Science",
+            "grade": 92,
+            "comment": "Outstanding performance.",
+        },
+        {
+            "name": "History",
+            "grade": 78,
+            "comment": "Needs to participate more.",
+        },
+        {"name": "Art", "grade": 85, "comment": "Very creative."},
+    ],
+}
+
+
+# def build_student_report(student):
+#     report_header = f"Progress Report. Student: {student['name']}"
+
+#     total = sum(subject["grade"] for subject in student["subjects"])
+#     average = total / len(student["subjects"])
+#     average_report = f"Average: {average:.2f} / 100\n"
+
+#     subject_report = "Course Details:\n"
+#     for subject in student["subjects"]:
+#         subject_report += (
+#             f"{subject['name']:<15} "
+#             f"Grade: {subject['grade']:3} "
+#             f"Comment: {subject['comment']}\n"
+#         )
+
+#     report = f"""
+#     {report_header}
+#     {average_report}
+#     {subject_report}
+#     Thank you for reviewing the progress report.
+#     """
+
+#     return report
+
+
+def build_student_report(student):
+    report_header = f"Progress Report. Student: {student['name']}"
+
+    total = sum(subject["grade"] for subject in student["subjects"])
+    average = total / len(student["subjects"])
+    average_report = f"Average: {average:.2f} / 100\n"
+
+    subject_report = "Course Details:\n"
+    detail_template = "{name:<15} Grade: {grade:3} Comment: {comment}\n"
+    for subject in student["subjects"]:
+        subject_report += detail_template.format(**subject)
+
+    report = f"""
+    {report_header}
+    {average_report}
+    {subject_report}
+    Thank you for reviewing the progress report.
+    """
+
+    return report
+
+
+print(build_student_report(student))

python-string-formatting/sales_report.py

@@ -0,0 +1,38 @@
+REPORT_TEMPLATE = """
+Monthly Sales Report
+--------------------
+Report Date Range: {start_date} to {end_date}
+
+Number of Transactions: {sep:.>20} {transactions:,}
+Average Transaction Value: {sep:.>11} ${avg_transaction:,.2f}
+
+Total Sales: {sep:.>23} ${total_sales:,.2f}
+"""
+
+
+def build_sales_report(sales_data, report_template=REPORT_TEMPLATE):
+    total_sales = sum(sale["amount"] for sale in sales_data)
+    transactions = len(sales_data)
+    avg_transaction = total_sales / transactions
+
+    report = report_template.format(
+        sep=".",
+        start_date=sales_data[0]["date"],
+        end_date=sales_data[-1]["date"],
+        total_sales=total_sales,
+        transactions=transactions,
+        avg_transaction=avg_transaction,
+    )
+
+    return report
+
+
+sales_data = [
+    {"date": "2024-04-01", "amount": 100},
+    {"date": "2024-04-02", "amount": 200},
+    {"date": "2024-04-03", "amount": 300},
+    {"date": "2024-04-04", "amount": 400},
+    {"date": "2024-04-05", "amount": 500},
+]
+
+print(build_sales_report(sales_data))