Merge branch 'main' into feature/#233-add-nox-task-to-verify-dependency-declarations

Author: Jannis-Mittenzwei

doc/_static/idioms/adapter.py

@@ -0,0 +1,15 @@
+# With Adapter
+for first, item in loop_first([]):
+    if first:
+        edge_case(item)
+        continue
+    default(item)
+
+# Naive Approach
+is_first = True
+for items in []:
+    if is_first:
+        edge_case(item)
+        is_first = False
+        continue
+    default(item)

doc/_static/idioms/concat.py

@@ -0,0 +1,11 @@
+# Good
+names = ["Peter", "Albert", "Cleo", "Ember"]
+output = ", ".join(names)
+
+# Bad
+names = ["Peter", "Albert", "Cleo", "Ember"]
+output = ""
+for name in names:
+    output += name
+    if not is_last_element(name):
+        output += ", "

doc/_static/idioms/context_decorator.py

@@ -0,0 +1,42 @@
+# With Decorator
+import logging
+from functools import wraps
+
+
+def log_execution(f):
+    @wraps(f)
+    def wrapper(*args, **kwargs):
+        logging.debug(f"Entering: {f.__name__}")
+        result = f(*args, **kwargs)
+        logging.debug(f"Leaving: {f.__name__}")
+        return result
+
+    return wrapper
+
+
+@log_execution
+def some_function():
+    return "Some Result"
+
+
+@log_execution
+def other_function():
+    return "Other Result"
+
+
+# Naive Approach
+import logging
+
+
+def some_function():
+    logging.debug("Entering: some_function")
+    result = "Some Result"
+    logging.debug("Leaving: some_function")
+    return result
+
+
+def other_function():
+    logging.debug("Entering: other_function")
+    result = "Some Result"
+    logging.debug("Leaving: other_function")
+    return result

doc/_static/idioms/context_filter.py

@@ -0,0 +1,40 @@
+# With Context Manager
+import os
+from contextlib import contextmanager
+
+
+@contextmanager
+def chdir(path):
+    old_dir = os.getcwd()
+    os.chdir(path)
+    yield path
+    os.chdir(old_dir)
+
+
+def initialize(directory):
+    with chdir(directory) as _working_dir:
+        with open('some-file.txt', 'w') as f:
+            f.write("Some content")
+
+
+# With Python 3.11
+from contextlib import chdir
+
+
+def initialize(directory):
+    with chdir(directory) as _working_dir:
+        with open('some-file.txt', 'w') as f:
+            f.write("Some content")
+
+
+# Naive Approach
+import os
+
+
+def initialize(directory):
+    old_dir = os.getcwd()
+    os.chdir(directory)
+    os.chdir(old_dir)
+    with open('some-file.txt', 'w') as f:
+        f.write("Some content")
+    os.chdir(old_dir)

doc/_static/idioms/context_manager.py

@@ -0,0 +1,15 @@
+# Good
+from collections import Counter
+
+colors = ["green", "blue", "red", "green", "red", "red"]
+
+counts = Counter(colors)
+
+# Bad
+from collections import defaultdict
+
+colors = ["green", "blue", "red", "green", "red", "red"]
+
+d = defaultdict(int)
+for color in colors:
+    d[color] += 1

doc/_static/idioms/count.py

@@ -0,0 +1,11 @@
+# Good
+customers = ["Marry", "Thor", "Peter", "Batman"]
+for index, customer in enumerate(customers):
+    print(f"Customer: {customer}, Queue position: {index}")
+
+# Bad
+index = 0
+customers = ["Marry", "Thor", "Peter", "Batman"]
+for customer in customers:
+    print(f"Customer: {customer}, Queue position: {index}")
+    index += 1

doc/_static/idioms/enumerate.py

@@ -0,0 +1,21 @@
+# With Filter
+numbers = [1, 2, 3, 4, 5, 6, 7, 8, 9]
+odd = filter(lambda n: n % 2, numbers)
+even = (number for number in numbers if not number % 2)
+
+print(f"Sum of odd values: {sum(odd)}")
+print(f"Sum of even values: {sum(even)}")
+
+# Naive Approach
+numbers = [1, 2, 3, 4, 5, 6, 7, 8, 9]
+odd = 0
+even = 0
+
+for number in numbers:
+    if number % 2:
+        odd += number
+    else:
+        even += number
+
+print(f"Sum of odd values: {odd}")
+print(f"Sum of even values: {even}")

doc/_static/idioms/filters.py

@@ -0,0 +1,26 @@
+# Good
+template = """
+{heading} - from: {date}
+---------------------------------
+{users}
+"""
+output = template.format(
+    heading="User Overview",
+    date=datetime.now().strftime("%Y-%m-%d"),
+    users="\n".join(
+        (
+            f"Firstname: {user.first_name}, Lastname: {user.last_name}, Age: {user.age}"
+            for user in users
+        )
+    ),
+)
+
+# Bad
+heading = "User Overview"
+date = datetime.now().strftime("%Y-%m-%d")
+output = f"{heading} - from: {date}" + "\n"
+output += "---------------------------------" + "\n"
+for user in users:
+    output += (
+        f"Firstname: {user.first_name}, Lastname: {user.last_name}, Age: {user.age}\n"
+    )

doc/_static/idioms/format.py

@@ -0,0 +1,7 @@
+# Good
+output = f"Firstname: {user.first_name}, Lastname: {user.last_name}, Age: {user.age}"
+
+# Bad
+output = "Firstname: {}, Lastname: {}, Age: {}".format(
+    user.first_name, user.last_name, user.age
+)