Merge pull request #548 from realpython/python-function-names

Python Function Names

Author: brendaweles

python-function-names/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.

python-function-names/bank_account.py

@@ -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

python-function-names/naming_functions.py

@@ -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.