Merge branch 'master' into python-t-strings

Author: bzaczynski

python-namedtuple/README.md

@@ -0,0 +1,3 @@
+# Write Pythonic and Clean Code With namedtuple
+
+This folder provides the code examples for the Real Python tutorial [Write Pythonic and Clean Code With namedtuple](https://realpython.com/python-namedtuple/).

python-namedtuple/database.py

@@ -0,0 +1,10 @@
+def get_column_names(table):
+    if table == "passenger":
+        return ("id", "first_name", "last_name", "class")
+    raise ValueError(f"unknown table {table}")
+
+
+def get_passenger_by_id(passenger_id):
+    if passenger_id == 1234:
+        return (1234, "John", "Doe", "Business")
+    raise ValueError(f"no record with id={passenger_id}")

python-namedtuple/employees.csv

@@ -0,0 +1,6 @@
+name,job,email
+"Linda","Technical Lead","[email protected]"
+"Joe","Senior Web Developer","[email protected]"
+"Lara","Project Manager","[email protected]"
+"David","Data Analyst","[email protected]"
+"Jane","Senior Python Developer","[email protected]"

python-namedtuple/employees.py

@@ -0,0 +1,9 @@
+import csv
+from collections import namedtuple
+
+with open("employees.csv", mode="r", encoding="utf-8") as csv_file:
+    reader = csv.reader(csv_file)
+    Employee = namedtuple("Employee", next(reader), rename=True)
+    for row in reader:
+        employee = Employee(*row)
+        print(employee)

python-namedtuple/namedtuple_dataclass_memory.py

@@ -0,0 +1,21 @@
+from collections import namedtuple
+from dataclasses import dataclass
+
+from pympler import asizeof
+
+PointNamedTuple = namedtuple("PointNamedTuple", "x y z")
+
+
+@dataclass
+class PointDataClass:
+    x: int
+    y: int
+    z: int
+
+
+namedtuple_memory = asizeof.asizeof(PointNamedTuple(x=1, y=2, z=3))
+dataclass_memory = asizeof.asizeof(PointDataClass(x=1, y=2, z=3))
+gain = 100 - namedtuple_memory / dataclass_memory * 100
+
+print(f"namedtuple: {namedtuple_memory} bytes ({gain:.2f}% smaller)")
+print(f"data class: {dataclass_memory} bytes")

python-namedtuple/namedtuple_dataclass_time.py

@@ -0,0 +1,36 @@
+from collections import namedtuple
+from dataclasses import dataclass
+from time import perf_counter
+
+
+def average_time(structure, test_func):
+    time_measurements = []
+    for _ in range(1_000_000):
+        start = perf_counter()
+        test_func(structure)
+        end = perf_counter()
+        time_measurements.append(end - start)
+    return sum(time_measurements) / len(time_measurements) * int(1e9)
+
+
+def time_structure(structure):
+    structure.x
+    structure.y
+    structure.z
+
+
+PointNamedTuple = namedtuple("PointNamedTuple", "x y z", defaults=[3])
+
+
+@dataclass
+class PointDataClass:
+    x: int
+    y: int
+    z: int
+
+
+namedtuple_time = average_time(PointNamedTuple(x=1, y=2, z=3), time_structure)
+dataclass_time = average_time(PointDataClass(x=1, y=2, z=3), time_structure)
+
+print(f"namedtuple: {namedtuple_time:.2f} ns")
+print(f"data class: {dataclass_time:.2f} ns")

python-namedtuple/namedtuple_dict_memory.py

@@ -0,0 +1,13 @@
+from collections import namedtuple
+
+from pympler import asizeof
+
+Point = namedtuple("Point", "x y z")
+point = Point(1, 2, 3)
+
+namedtuple_size = asizeof.asizeof(point)
+dict_size = asizeof.asizeof(point._asdict())
+gain = 100 - namedtuple_size / dict_size * 100
+
+print(f"namedtuple: {namedtuple_size} bytes ({gain:.2f}% smaller)")
+print(f"dict:       {dict_size} bytes")

python-namedtuple/namedtuple_dict_time.py

@@ -0,0 +1,39 @@
+from collections import namedtuple
+from time import perf_counter
+
+
+def average_time(structure, test_func):
+    time_measurements = []
+    for _ in range(1_000_000):
+        start = perf_counter()
+        test_func(structure)
+        end = perf_counter()
+        time_measurements.append(end - start)
+    return sum(time_measurements) / len(time_measurements) * int(1e9)
+
+
+def time_dict(dictionary):
+    "x" in dictionary
+    "missing_key" in dictionary
+    2 in dictionary.values()
+    "missing_value" in dictionary.values()
+    dictionary["y"]
+
+
+def time_namedtuple(named_tuple):
+    "x" in named_tuple._fields
+    "missing_field" in named_tuple._fields
+    2 in named_tuple
+    "missing_value" in named_tuple
+    named_tuple.y
+
+
+Point = namedtuple("Point", "x y z")
+point = Point(x=1, y=2, z=3)
+
+namedtuple_time = average_time(point, time_namedtuple)
+dict_time = average_time(point._asdict(), time_dict)
+gain = dict_time / namedtuple_time
+
+print(f"namedtuple: {namedtuple_time:.2f} ns ({gain:.2f}x faster)")
+print(f"dict:       {dict_time:.2f} ns")

python-namedtuple/passenger.py

@@ -0,0 +1,5 @@
+from collections import namedtuple
+
+from database import get_column_names
+
+Passenger = namedtuple("Passenger", get_column_names("passenger"), rename=True)

python-namedtuple/person_dataclass.py

@@ -0,0 +1,18 @@
+from dataclasses import astuple, dataclass
+
+
+@dataclass
+class Person:
+    name: str
+    age: int
+    height: float
+    weight: float
+    country: str = "Canada"
+
+    def __iter__(self):
+        return iter(astuple(self))
+
+
+jane = Person("Jane", 25, 1.75, 67)
+for field in jane:
+    print(field)