Merge branch 'master' into python-logging-update

Author: brendaweles

.github/workflows/dircheck.py

@@ -46,7 +46,7 @@
             f"{f}: ensure folder name only uses "
             f"lowercase letters, numbers, and hyphens"
         )
-        has_error = True
+        has_errors = True
 
     files = sorted(_.name for _ in f.glob("*"))
     if "README.md" not in files:

pivot_tables/README.md pandas-pivot-table/README.mdpivot_tables/README.md renamed to pandas-pivot-table/README.md

@@ -0,0 +1,5 @@
+# How Do You Choose Python Function Names?
+
+This folder contains source code for the Real Python tutorial [How Do You Choose Python Function Names?](https://realpython.com/python-function-names/).
+
+For additional explanation, check out the associated tutorial.

pivot_tables/code_downloads.ipynb pandas-pivot-table/code_downloads.ipynbpivot_tables/code_downloads.ipynb renamed to pandas-pivot-table/code_downloads.ipynb

@@ -0,0 +1,29 @@
+class BankAccount:
+    def __init__(self, account_number, balance):
+        self.account_number = account_number
+        self.balance = balance
+
+    def __repr__(self):
+        return f"{type(self).__name__}({self.account_number}, {self.balance})"
+
+    def _verify_funds(self, amount):
+        return self.balance >= amount
+
+    def _deduct_funds(self, amount):
+        self.balance -= amount
+
+    def _add_funds(self, amount):
+        self.balance += amount
+
+    def get_balance(self):
+        return self.balance
+
+    def withdraw(self, amount):
+        if self._verify_funds(amount):
+            self._deduct_funds(amount)
+            return True
+        return False
+
+    def deposit(self, amount):
+        self._add_funds(amount)
+        return True

pivot_tables/sales_data.csv pandas-pivot-table/sales_data.csvpivot_tables/sales_data.csv renamed to pandas-pivot-table/sales_data.csv

@@ -0,0 +1,14 @@
+# Poorly-named function, parameter, and variable
+def init(n):
+    return " ".join(f"{i[0]}." for i in n.split())
+
+
+# Descriptive names improve readability
+def get_initials(full_name):
+    return " ".join(f"{name[0]}." for name in full_name.split())
+
+
+print(get_initials("James Clerk Maxwell"))
+# OUTPUT: J. C. M.
+print(get_initials("Richard Feynman"))
+# OUTPUT: R. F.

pivot_tables/solutions.ipynb pandas-pivot-table/solutions.ipynbpivot_tables/solutions.ipynb renamed to pandas-pivot-table/solutions.ipynb

@@ -0,0 +1,3 @@
+# Python Protocols: Leveraging Structural Subtyping
+
+This folder provides the code examples for the Real Python tutorial [Python Protocols: Leveraging Structural Subtyping](https://realpython.com/python-protocol/).

python-function-names/README.md

@@ -0,0 +1,27 @@
+from typing import Protocol
+
+
+class Adder(Protocol):
+    def add(self, x, y): ...
+
+
+class IntAdder:
+    def add(self, x, y):
+        return x + y
+
+
+class FloatAdder:
+    def add(self, x, y):
+        return x + y
+
+
+def add(adder: Adder) -> None:
+    print(adder.add(2, 3))
+
+
+add(IntAdder())
+add(FloatAdder())
+
+
+for adder in [IntAdder(), FloatAdder()]:
+    add(adder)