Merge branch 'master' into python-exec

KateFinegan · web-flow · commit 0f3c9237fc90 · 2022-08-09T16:11:36.000-06:00
diff --git a/github-copilot/GitHub Copilot (Keyboard Shortcuts).pdf b/github-copilot/GitHub Copilot (Keyboard Shortcuts).pdf
diff --git a/github-copilot/README.md b/github-copilot/README.md
@@ -0,0 +1,3 @@
+# GitHub Copilot: Fly With Python at the Speed of Thought
+
+Supplementing materials for the [tutorial on GitHub Copilot](https://realpython.com/github-copilot-python/) hosted on Real Python.
diff --git a/how-to-check-if-a-python-string-contains-a-substring/README.md b/how-to-check-if-a-python-string-contains-a-substring/README.md
@@ -0,0 +1,9 @@
+# How to Check if a Python String Contains a Substring
+
+If you're new to programming or come from a different programming language to Python, you may not know what's the best way to check whether a string contains another string in Python.
+
+In this tutorial you'll focus on the most pythonic approach to tackle this task, using the **membership operator `in`**. Additionally, you'll learn how to **identify the right string methods** for related, but different, use cases.
+
+Finally, you'll also learn how to **find substrings in pandas columns**. This is helpful if you need to search through data from a CSV file.
+
+Head over to Real Python to the full tutorial on [How to Check if a Python String Contains a Substring](https://realpython.com/python-string-contains-substring/).
diff --git a/how-to-check-if-a-python-string-contains-a-substring/check_case.py b/how-to-check-if-a-python-string-contains-a-substring/check_case.py
@@ -0,0 +1,14 @@
+file_content_title = """Hi There And Welcome.
+This Is A Special Hidden File With A Secret Secret.
+I Don't Want To Tell You The Secret,
+But I Do Want To Secretly Tell You That I Have One."""
+
+# Strings are case-sensitive
+print("secret" in file_content_title)  # False
+
+# Convert the input string to lowercase to generalize matching
+file_content = file_content_title.lower()
+
+print(file_content)
+
+print("secret" in file_content)  # True
diff --git a/how-to-check-if-a-python-string-contains-a-substring/check_substring.py b/how-to-check-if-a-python-string-contains-a-substring/check_substring.py
@@ -0,0 +1,14 @@
+raw_file_content = """Hi there and welcome.
+This is a special hidden file with a SECRET secret.
+I don't want to tell you The Secret,
+but I do want to secretly tell you that I have one."""
+
+# Use the membership operator for pythonic membership checks
+print("secret" in raw_file_content)
+
+# You can do the inverse with `not in`
+print("secret" not in raw_file_content)
+
+# Using `in` is a readable way to check if a string contains a substring
+if "secret" in raw_file_content:
+    print("Found!")
diff --git a/how-to-check-if-a-python-string-contains-a-substring/companies.csv b/how-to-check-if-a-python-string-contains-a-substring/companies.csv
diff --git a/how-to-check-if-a-python-string-contains-a-substring/pandas_search.py b/how-to-check-if-a-python-string-contains-a-substring/pandas_search.py
@@ -0,0 +1,17 @@
+import pandas as pd
+
+
+# Read the CSV data into a pandas dataframe
+companies = pd.read_csv("companies.csv")
+
+# Check the size of the dataframe
+print(companies.shape)
+
+# Inspect the first 5 rows of the dataframe
+print(companies.head())
+
+# Filter for rows where the company slogan contains the word "secret"
+print(companies[companies.slogan.str.contains("secret")])
+
+# Apply a regex pattern to the string search to narrow the results
+print(companies[companies.slogan.str.contains(r"secret\w+")])
diff --git a/how-to-check-if-a-python-string-contains-a-substring/regex_search.py b/how-to-check-if-a-python-string-contains-a-substring/regex_search.py
@@ -0,0 +1,32 @@
+import re
+
+
+file_content = """hi there and welcome.
+this is a special hidden file with a secret secret.
+i don't want to tell you the secret,
+but i do want to secretly tell you that i have one."""
+
+# Find words that start with "secret"
+print(re.search(r"secret\w+", file_content))
+
+# Inspect what methods on the Match object can give you
+m = re.search(r"secret\w+", file_content)
+print(m.group())  # "secretly"
+print(m.span())  # (128, 136)
+
+# Find the first word followed by certain punctuation characters
+print(re.search(r"secret[\.,]", file_content))
+
+# Find all words followed by certain punctuation characters
+print(re.findall(r"secret[\.,]", file_content))
+
+# Use a capturing group to remove the punctuation character
+print(re.findall(r"(secret)[\.,]", file_content))
+
+# Iterate over all matches as Match objects
+for match in re.finditer(r"(secret)[\.,]", file_content):
+    print(match)
+
+# Print only the first capturing group from the match
+for match in re.finditer(r"(secret)[\.,]", file_content):
+    print(match.group(1))
diff --git a/how-to-check-if-a-python-string-contains-a-substring/string_info.py b/how-to-check-if-a-python-string-contains-a-substring/string_info.py
@@ -0,0 +1,21 @@
+file_content = """hi there and welcome.
+this is a special hidden file with a secret secret.
+i don't want to tell you the secret,
+but i do want to secretly tell you that i have one."""
+
+# Use .index() to get the starting index of the first match
+print(file_content.index("secret"))
+
+# Pass a custom start index to .index() to search from a different point
+print(file_content.index("secret", 60))
+
+# Count the number of matches in the text
+print(file_content.count("secret"))
+
+# Use a for loop to inspect all matches
+for word in file_content.split():
+    if "secret" in word:
+        print(word)
+
+# Use a list comprehension and a conditional check for a one-liner
+print([word for word in file_content.split() if "secret" in word])
diff --git a/python-absolute-value/README.md b/python-absolute-value/README.md
@@ -0,0 +1,3 @@
+# How to Find an Absolute Value in Python
+
+Supplemental materials for the [tutorial on absolute values](https://realpython.com/python-absolute-value/) hosted on Real Python.
diff --git a/python-absolute-value/sample_code.py b/python-absolute-value/sample_code.py
@@ -0,0 +1,61 @@
+import math
+from decimal import Decimal
+from fractions import Fraction
+from math import sqrt
+
+
+class VectorBound:
+    def __init__(self, *coordinates):
+        self.coordinates = coordinates
+
+    def __abs__(self):
+        origin = [0] * len(self.coordinates)
+        return math.dist(origin, self.coordinates)
+
+
+class VectorFree:
+    def __init__(self, *coordinates):
+        self.coordinates = coordinates
+
+    def __abs__(self):
+        return math.hypot(*self.coordinates)
+
+
+def absolute_value_piecewise(x):
+    if x >= 0:
+        return x
+    else:
+        return -x
+
+
+def absolute_value_piecewise_conditional_expression(x):
+    return x if x >= 0 else -x
+
+
+def absolute_value_algebraic(x):
+    return sqrt(pow(x, 2))
+
+
+def absolute_value_algebraic_exponents(x):
+    return (x**2) ** 0.5
+
+
+def absolute_value_silly(x):
+    return float(str(x).replace("-", ""))
+
+
+if __name__ == "__main__":
+    print(f"{absolute_value_piecewise(-12) = }")
+    print(f"{absolute_value_piecewise_conditional_expression(-12) = }")
+    print(f"{absolute_value_algebraic(-12) = }")
+    print(f"{absolute_value_algebraic_exponents(-12) = }")
+    print(f"{absolute_value_silly(-12) = }")
+
+    print(f"{abs(-12) = }")
+    print(f"{abs(-12.0) = }")
+    print(f"{abs(complex(3, 2)) = }")
+    print(f"{abs(Fraction('-3/4')) = }")
+    print(f"{abs(Decimal('-0.75')) = }")
+
+    print(f"{abs(VectorBound(0.42, 1.5, 0.87)) = }")
+    print(f"{abs(VectorFree(0.42, 1.5, 0.87)) = }")
diff --git a/sort-python-dictionary/README.md b/sort-python-dictionary/README.md
@@ -0,0 +1,3 @@
+# How to Sort a Python Dictionary
+
+Corresponding code for ["How to Sort a Python Dictionary"](https://realpython.com/sort-python-dictionary/)
diff --git a/sort-python-dictionary/compare_lambda_vs_getter.py b/sort-python-dictionary/compare_lambda_vs_getter.py
@@ -0,0 +1,46 @@
+from timeit import timeit
+
+dict_to_order = {
+    1: "requests",
+    2: "pip",
+    3: "jinja",
+    4: "setuptools",
+    5: "pandas",
+    6: "numpy",
+    7: "black",
+    8: "pillow",
+    9: "pyparsing",
+    10: "boto3",
+    11: "botocore",
+    12: "urllib3",
+    13: "s3transfer",
+    14: "six",
+    15: "python-dateutil",
+    16: "pyyaml",
+    17: "idna",
+    18: "certifi",
+    19: "typing-extensions",
+    20: "charset-normalizer",
+    21: "awscli",
+    22: "wheel",
+    23: "rsa",
+}
+
+sorted_with_lambda = "sorted(dict_to_order.items(), key=lambda item: item[1])"
+sorted_with_itemgetter = "sorted(dict_to_order.items(), key=itemgetter(1))"
+
+sorted_with_lambda_time = timeit(stmt=sorted_with_lambda, globals=globals())
+sorted_with_itemgetter_time = timeit(
+    stmt=sorted_with_itemgetter,
+    setup="from operator import itemgetter",
+    globals=globals(),
+)
+
+print(
+    f"""\
+{sorted_with_lambda_time=:.2f} seconds
+{sorted_with_itemgetter_time=:.2f} seconds
+itemgetter is {(
+    sorted_with_lambda_time / sorted_with_itemgetter_time
+):.2f} times faster"""
+)
diff --git a/sort-python-dictionary/compare_lookup_dict_vs_list.py b/sort-python-dictionary/compare_lookup_dict_vs_list.py
@@ -0,0 +1,38 @@
+from timeit import timeit
+
+lookups = [15, 18, 19, 16, 6, 12, 5, 3, 9, 20, 2, 10, 13, 17, 4, 14, 11, 7, 8]
+
+list_setup = """
+from samples import list_of_dictionaries
+
+def get_key_from_list(key):
+    for item in list_of_dictionaries:
+        if item["id"] == key:
+            return item
+"""
+
+dict_setup = "from samples import dictionary_of_dictionaries"
+
+lookup_list = """
+for key in lookups:
+    get_key_from_list(key)
+"""
+
+lookup_dict = """
+for key in lookups:
+    dictionary_of_dictionaries[key]
+"""
+
+lookup_list_time = timeit(
+    stmt=lookup_list, setup=list_setup, globals=globals()
+)
+lookup_dict_time = timeit(
+    stmt=lookup_dict, setup=dict_setup, globals=globals()
+)
+
+print(
+    f"""\
+{lookup_list_time=:.2f} seconds
+{lookup_dict_time=:.2f} seconds
+dict is {(lookup_list_time / lookup_dict_time):.2f} times faster"""
+)
diff --git a/sort-python-dictionary/compare_sorting_dict_vs_list.py b/sort-python-dictionary/compare_sorting_dict_vs_list.py
@@ -0,0 +1,28 @@
+from timeit import timeit
+
+sorting_list = "sorted(list_of_dictionaries, key=lambda item:item['age'])"
+sorting_dict = """
+dict(
+    sorted(
+        dictionary_of_dictionaries.items(), key=lambda item: item[1]['age']
+    )
+)
+"""
+
+sorting_list_time = timeit(
+    stmt=sorting_list,
+    setup="from samples import list_of_dictionaries",
+    globals=globals(),
+)
+sorting_dict_time = timeit(
+    stmt=sorting_dict,
+    setup="from samples import dictionary_of_dictionaries",
+    globals=globals(),
+)
+
+print(
+    f"""\
+{sorting_list_time=:.2f} seconds
+{sorting_dict_time=:.2f} seconds
+list is {(sorting_dict_time/sorting_list_time):.2f} times faster"""
+)
diff --git a/sort-python-dictionary/nested_sort.py b/sort-python-dictionary/nested_sort.py
@@ -0,0 +1,33 @@
+data = {
+    193: {"name": "John", "age": 30, "skills": {"python": 8, "js": 7}},
+    209: {"name": "Bill", "age": 15, "skills": {"python": 6}},
+    746: {"name": "Jane", "age": 58, "skills": {"js": 2, "python": 5}},
+    109: {"name": "Jill", "age": 83, "skills": {"java": 10}},
+    984: {"name": "Jack", "age": 28, "skills": {"c": 8, "assembly": 7}},
+    765: {"name": "Penelope", "age": 76, "skills": {"python": 8, "go": 5}},
+    598: {"name": "Sylvia", "age": 62, "skills": {"bash": 8, "java": 7}},
+    483: {"name": "Anna", "age": 24, "skills": {"js": 10}},
+    277: {"name": "Beatriz", "age": 26, "skills": {"python": 2, "js": 4}},
+}
+
+
+def get_relevant_skills(item):
+    """Get the sum of Python and JavaScript skill"""
+    skills = item[1]["skills"]
+
+    # Return default value that is equivalent to no skill
+    return skills.get("python", 0) + skills.get("js", 0)
+
+
+print(sorted(data.items(), key=get_relevant_skills, reverse=True))
+
+# Doing the same thing with lambda function
+print(
+    sorted(
+        data.items(),
+        key=lambda item: (
+            item[1]["skills"].get("python", 0) + item[1]["skills"].get("js", 0)
+        ),
+        reverse=True,
+    )
+)
diff --git a/sort-python-dictionary/samples.py b/sort-python-dictionary/samples.py
@@ -0,0 +1,45 @@
+dictionary_of_dictionaries = {
+    1: {"first_name": "Dorthea", "last_name": "Emmanuele", "age": 29},
+    2: {"first_name": "Evelina", "last_name": "Ferras", "age": 91},
+    3: {"first_name": "Frederica", "last_name": "Livesay", "age": 99},
+    4: {"first_name": "Murray", "last_name": "Linning", "age": 36},
+    5: {"first_name": "Annette", "last_name": "Garioch", "age": 93},
+    6: {"first_name": "Rozamond", "last_name": "Todd", "age": 36},
+    7: {"first_name": "Tiffi", "last_name": "Varian", "age": 28},
+    8: {"first_name": "Noland", "last_name": "Cowterd", "age": 51},
+    9: {"first_name": "Dyana", "last_name": "Fallows", "age": 100},
+    10: {"first_name": "Diahann", "last_name": "Cutchey", "age": 44},
+    11: {"first_name": "Georgianne", "last_name": "Steinor", "age": 32},
+    12: {"first_name": "Sabina", "last_name": "Lourens", "age": 31},
+    13: {"first_name": "Lynde", "last_name": "Colbeck", "age": 35},
+    14: {"first_name": "Abdul", "last_name": "Crisall", "age": 84},
+    15: {"first_name": "Quintus", "last_name": "Brando", "age": 95},
+    16: {"first_name": "Rowena", "last_name": "Geraud", "age": 21},
+    17: {"first_name": "Maurice", "last_name": "MacAindreis", "age": 83},
+    18: {"first_name": "Pall", "last_name": "O'Cullinane", "age": 79},
+    19: {"first_name": "Kermie", "last_name": "Willshere", "age": 20},
+    20: {"first_name": "Holli", "last_name": "Tattoo", "age": 88},
+}
+
+list_of_dictionaries = [
+    {"id": 1, "first_name": "Dorthea", "last_name": "Emmanuele", "age": 29},
+    {"id": 2, "first_name": "Evelina", "last_name": "Ferras", "age": 91},
+    {"id": 3, "first_name": "Frederica", "last_name": "Livesay", "age": 99},
+    {"id": 4, "first_name": "Murray", "last_name": "Linning", "age": 36},
+    {"id": 5, "first_name": "Annette", "last_name": "Garioch", "age": 93},
+    {"id": 6, "first_name": "Rozamond", "last_name": "Todd", "age": 36},
+    {"id": 7, "first_name": "Tiffi", "last_name": "Varian", "age": 28},
+    {"id": 8, "first_name": "Noland", "last_name": "Cowterd", "age": 51},
+    {"id": 9, "first_name": "Dyana", "last_name": "Fallows", "age": 100},
+    {"id": 10, "first_name": "Diahann", "last_name": "Cutchey", "age": 44},
+    {"id": 11, "first_name": "Georgianne", "last_name": "Steinor", "age": 32},
+    {"id": 12, "first_name": "Sabina", "last_name": "Lourens", "age": 31},
+    {"id": 13, "first_name": "Lynde", "last_name": "Colbeck", "age": 35},
+    {"id": 14, "first_name": "Abdul", "last_name": "Crisall", "age": 84},
+    {"id": 15, "first_name": "Quintus", "last_name": "Brando", "age": 95},
+    {"id": 16, "first_name": "Rowena", "last_name": "Geraud", "age": 21},
+    {"id": 17, "first_name": "Maurice", "last_name": "MacAindreis", "age": 83},
+    {"id": 18, "first_name": "Pall", "last_name": "O'Cullinane", "age": 79},
+    {"id": 19, "first_name": "Kermie", "last_name": "Willshere", "age": 20},
+    {"id": 20, "first_name": "Holli", "last_name": "Tattoo", "age": 88},
+]
diff --git a/sort-python-dictionary/sorting_a_dictionary.py b/sort-python-dictionary/sorting_a_dictionary.py
diff --git a/sort-python-dictionary/using_itemgetter.py b/sort-python-dictionary/using_itemgetter.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# GitHub Copilot: Fly With Python at the Speed of Thought`
	`2`	`+`
	`3`	`+Supplementing materials for the [tutorial on GitHub Copilot](https://realpython.com/github-copilot-python/) hosted on Real Python.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# How to Find an Absolute Value in Python`
	`2`	`+`
	`3`	`+Supplemental materials for the [tutorial on absolute values](https://realpython.com/python-absolute-value/) hosted on Real Python.`