Merge branch 'master' into python-ty

brendaweles · web-flow · commit 0ae5b15c2bcd · 2025-09-01T14:54:06.000-06:00
diff --git a/how-to-drop-null-values-in-pandas/README.md b/how-to-drop-null-values-in-pandas/README.md
@@ -0,0 +1,25 @@
+# How to Drop Null Values in pandas
+
+The materials contained in this download are designed to complement the Real Python tutorial [How to Drop Null Values in pandas](https://realpython.com/how-to-drop-null-values-in-pandas/).
+
+Consider creating a [Python virtual environment](https://realpython.com/python-virtual-environments-a-primer/) before installing the dependencies:
+
+```shell
+$ python3 -m venv .venv/ --prompt pandas-nulls
+$ source .venv/bin/activate
+(pandas-nulls) $ python -m pip install -r requirements.txt
+```
+
+Your download bundle contains the following four files:
+
+1. `drop_null_rows.py`
+2. `drop_null_columns.py`
+3. `drop_a_subset.py`
+4. `exercise_solutions.py`
+
+The first three files contain the code from different tutorial sections, while the fourth contains the solutions to the exercise.
+
+There are also two data files containing the data used throughout the tutorial:
+
+1. `sales_data_with_missing_values.csv`
+2. `grades.csv`
diff --git a/how-to-drop-null-values-in-pandas/drop_a_subset.py b/how-to-drop-null-values-in-pandas/drop_a_subset.py
@@ -0,0 +1,14 @@
+import pandas as pd
+
+pd.set_option("display.max_columns", None)
+
+sales_data = pd.read_csv(
+    "sales_data_with_missing_values.csv",
+    parse_dates=["order_date"],
+    date_format="%d/%m/%Y",
+).convert_dtypes(dtype_backend="pyarrow")
+
+print(sales_data.dropna(axis=0, subset=(["discount", "sale_price"])))
+print(sales_data.dropna(how="all"))
+print(sales_data.dropna(thresh=5))
+print(sales_data.dropna(thresh=5, ignore_index=True))
diff --git a/how-to-drop-null-values-in-pandas/drop_null_columns.py b/how-to-drop-null-values-in-pandas/drop_null_columns.py
@@ -0,0 +1,9 @@
+import pandas as pd
+
+sales_data = pd.read_csv(
+    "sales_data_with_missing_values.csv",
+    parse_dates=["order_date"],
+    date_format="%d/%m/%Y",
+).convert_dtypes(dtype_backend="pyarrow")
+
+print(sales_data.dropna(axis="columns"))
diff --git a/how-to-drop-null-values-in-pandas/drop_null_rows.py b/how-to-drop-null-values-in-pandas/drop_null_rows.py
@@ -0,0 +1,19 @@
+import pandas as pd
+
+pd.set_option("display.max_columns", None)
+
+sales_data = pd.read_csv(
+    "sales_data_with_missing_values.csv",
+    parse_dates=["order_date"],
+    date_format="%d/%m/%Y",
+).convert_dtypes(dtype_backend="pyarrow")
+
+print(sales_data)
+print(sales_data.isna().sum())
+print(sales_data.dropna())
+
+clean_sales_data = sales_data.dropna()
+print(clean_sales_data)
+
+sales_data.dropna(inplace=True)
+print(sales_data)
diff --git a/how-to-drop-null-values-in-pandas/exercise_solutions.py b/how-to-drop-null-values-in-pandas/exercise_solutions.py
@@ -0,0 +1,20 @@
+import pandas as pd
+
+grades = pd.read_csv(
+    "grades.csv",
+).convert_dtypes(dtype_backend="pyarrow")
+
+# 1. Use `.dropna()` in such a way that it permanently drops the row in the dataframe containing only null values.
+grades.dropna(how="all", inplace=True)
+
+# 2. Display the rows for the exams that all students have completed.
+grades.dropna()
+
+# 3. Display any columns with no missing data.
+grades.dropna(axis=1)
+
+# 4. Display the exams sat by at least five students.
+grades.dropna(axis=0, thresh=6)  # Remember there are seven columns.
+
+# 5. Who else was in in every exam that both S2 and S4 sat?
+grades.dropna(subset=["S2", "S4"]).dropna(axis=1, ignore_index=True)
diff --git a/how-to-drop-null-values-in-pandas/grades.csv b/how-to-drop-null-values-in-pandas/grades.csv
@@ -0,0 +1,8 @@
+Subject,S1,S2,S3,S4,S5,S6
+math,18,,15,20,17,18
+science,26,35,19,,33,
+art,15,,9,17,18,14
+music,14,20,12,20,13,18
+history,18,19,,17,,18
+sport,20,17,20,17,18
+,,,,,
diff --git a/how-to-drop-null-values-in-pandas/requirements.txt b/how-to-drop-null-values-in-pandas/requirements.txt
@@ -0,0 +1,7 @@
+numpy==2.3.2
+pandas==2.3.2
+pyarrow==21.0.0
+python-dateutil==2.9.0.post0
+pytz==2025.2
+six==1.17.0
+tzdata==2025.2
diff --git a/how-to-drop-null-values-in-pandas/sales_data_with_missing_values.csv b/how-to-drop-null-values-in-pandas/sales_data_with_missing_values.csv
@@ -0,0 +1,12 @@
+order_number,order_date,customer_name,product_purchased,discount,sale_price
+,09/02/2025,Skipton Fealty,Chili Extra Virgin Olive Oil,TRUE,135.00
+70041,,Carmine Priestnall,,,150.00
+70042,09/02/2025,,Rosemary Olive Oil Candle,FALSE,78.00
+70043,10/02/2025,Lanni D'Ambrogi,,TRUE,19.50
+70044,10/02/2025,Tann Angear,Vanilla and Olive Oil Candle,,13.98
+70045,10/02/2025,Skipton Fealty,Basil Extra Virgin Olive Oil,TRUE,
+70046,11/02/2025,Far Pow,Chili Extra Virgin Olive Oil,FALSE,150.00
+70047,11/02/2025,Hill Group,Chili Extra Virgin Olive Oil,TRUE,135.00
+70048,11/02/2025,Devlin Nock,Lavender and Olive Oil Lotion,FALSE,39.96
+,,,,,
+70049,12/02/2025,Swift Inc,Garlic Extra Virgin Olive Oil,TRUE,936.00
diff --git a/python-docstrings/README.md b/python-docstrings/README.md
@@ -0,0 +1,3 @@
+# How To Write Docstrings in Python
+
+This folder provides the code examples for the Real Python tutorial [How To Write Docstrings in Python](https://realpython.com/how-to-write-docstrings-in-python/).
diff --git a/python-docstrings/classes_docstring.py b/python-docstrings/classes_docstring.py
@@ -0,0 +1,33 @@
+class Potion:
+    """
+    Represents a magical potion composed of various ingredients.
+
+    Attributes
+    ----------
+    name : str
+        The name of the potion.
+    ingredients : list of str
+        A list of ingredients used in the potion.
+    potency : int
+        The strength level of the potion.
+
+    Methods
+    -------
+    brew():
+        Completes the potion and sets its potency.
+    describe():
+        Returns a human-readable summary of the potion.
+    """
+
+    def __init__(self, name, ingredients):
+        self.name = name
+        self.ingredients = ingredients
+        self.potency = 0
+
+    def brew(self):
+        """Simulate brewing the potion by calculating potency."""
+        self.potency = len(self.ingredients) * 10
+
+    def describe(self):
+        """Return a string describing the potion and its strength."""
+        return f"{self.name} (Potency: {self.potency})"
diff --git a/python-docstrings/docstring_format.py b/python-docstrings/docstring_format.py
@@ -0,0 +1,5 @@
+def determine_magic_level(magic_number):
+    """
+    Multiply a wizard's favorite number by 3 to reveal their magic level.
+    """
+    return magic_number * 3
diff --git a/python-docstrings/function_docstring.py b/python-docstrings/function_docstring.py
@@ -0,0 +1,17 @@
+def enchant_wand(wand_type, level=1):
+    """
+    Enhance a wand with magical properties.
+
+    Args:
+        wand_type (str): The type of wand to enchant.
+        level (int, optional): The enchantment level. Defaults to 1.
+
+    Returns:
+        str: A message confirming the enchantment.
+
+    Raises:
+        ValueError: If the enchantment level is invalid.
+    """
+    if level < 1:
+        raise ValueError("Enchantment level must be at least 1.")
+    return f"{wand_type.title()} enchanted to level {level}!"
diff --git a/python-docstrings/get_potter_books.py b/python-docstrings/get_potter_books.py
@@ -0,0 +1,3 @@
+from multiline_docstring import get_harry_potter_books
+
+print(get_harry_potter_books.__doc__)
diff --git a/python-docstrings/google_style.py b/python-docstrings/google_style.py
@@ -0,0 +1,15 @@
+def get_magic_items(user_id, include_potions=False):
+    """
+    Retrieve a list of magical items for a specific user.
+
+    Args:
+        user_id (int): The ID of the user whose items should be retrieved.
+        include_potions (bool, optional): Whether to include potions.
+
+    Returns:
+        list[str]: A list of item names associated with the user.
+    """
+    items = ["wand", "cloak", "crystal ball"]
+    if include_potions:
+        items.extend(["healing potion", "invisibility potion"])
+    return items
diff --git a/python-docstrings/inconsistent_format.py b/python-docstrings/inconsistent_format.py
@@ -0,0 +1,8 @@
+def summon(spell, caster):
+    """Summons a creature.
+    Parameters:
+    spell - name of the spell
+    caster: name of the caster
+    Return:
+    The summoned creature
+    """
diff --git a/python-docstrings/inconsistent_format_fix.py b/python-docstrings/inconsistent_format_fix.py
@@ -0,0 +1,11 @@
+def summon(spell, caster):
+    """
+    Summons a creature using the given spell.
+
+    Args:
+        spell (str): The name of the summoning spell.
+        caster (str): The name of the person casting the spell.
+
+    Returns:
+        str: The name of the summoned creature.
+    """
diff --git a/python-docstrings/magic_spells.py b/python-docstrings/magic_spells.py
@@ -0,0 +1,12 @@
+def undo_spell(spell):
+    """
+    Reverses characters in a spell incantation, thereby undoing a spell.
+
+    Example:
+    >>> undo_spell("Expelliarmus")
+    'sumraillepxE'
+
+    >>> undo_spell("Lumos")
+    'somuL'
+    """
+    return spell[::-1]
diff --git a/python-docstrings/magical_characters.py b/python-docstrings/magical_characters.py
@@ -0,0 +1,10 @@
+"""A module for adding and listing magical characters."""
+
+
+def add_characters(magical_being):
+    """Add a new magical character."""
+    return f"You've added {magical_being} to the magical beings record"
+
+
+if __name__ == "__main__":
+    print(add_characters("Gandalf"))
diff --git a/python-docstrings/math_doc.py b/python-docstrings/math_doc.py
@@ -0,0 +1,3 @@
+import math
+
+print(math.__doc__)
diff --git a/python-docstrings/math_help.py b/python-docstrings/math_help.py
@@ -0,0 +1,3 @@
+import math
+
+help(math)
diff --git a/python-docstrings/minimal_return_details.py b/python-docstrings/minimal_return_details.py
@@ -0,0 +1,8 @@
+def generate_shield(strength):
+    """
+    Generates a magical shield based on input strength.
+
+    Args:
+        strength (int): Strength level.
+    """
+    return f"Shield with strength {strength}"
diff --git a/python-docstrings/minimal_return_details_fix.py b/python-docstrings/minimal_return_details_fix.py
@@ -0,0 +1,11 @@
+def generate_shield(strength):
+    """
+    Generates a magical shield based on input strength.
+
+    Args:
+        strength (int): The strength level of the shield.
+
+    Returns:
+        str: A human-readable description of the generated shield.
+    """
+    return f"Shield with strength {strength}"
diff --git a/python-docstrings/minipotion.py b/python-docstrings/minipotion.py
@@ -0,0 +1,10 @@
+from classes_docstring import Potion
+
+
+class MiniPotion(Potion):
+    pass
+
+
+help(MiniPotion)
+print(MiniPotion.__doc__)
+print(MiniPotion.brew.__doc__)
diff --git a/python-docstrings/minipotion_overide_docstring.py b/python-docstrings/minipotion_overide_docstring.py
@@ -0,0 +1,10 @@
+from classes_docstring import Potion
+
+
+class MiniPotion(Potion):
+    """Represents a mini magical potion composed of tiny ingredients."""
+
+    pass
+
+
+print(MiniPotion.__doc__)
diff --git a/python-docstrings/multiline_docstring.py b/python-docstrings/multiline_docstring.py
@@ -0,0 +1,12 @@
+def get_harry_potter_book(publication_year, title):
+    """
+    Retrieve a Harry Potter book by its publication year and name.
+
+    Parameters:
+    publication_year (int): The year the book was published.
+    title (str): The title of the book.
+
+    Returns:
+    str: A sentence describing the book and its publication year.
+    """
+    return f"The book {title!r} was published in the year {publication_year}."
diff --git a/python-docstrings/navigation.py b/python-docstrings/navigation.py
@@ -0,0 +1,7 @@
+"""
+This module provides tools for creating and managing magical maps.
+
+Example:
+    from navigation import build_map
+    build_map(["mandrake", "phoenix feather", "tree bark"], heat_level=3)
+"""
diff --git a/python-docstrings/numpy_style.py b/python-docstrings/numpy_style.py
@@ -0,0 +1,17 @@
+def brew_potion(ingredients, heat_level):
+    """
+    Brew a potion using selected ingredients and heat.
+
+    Parameters
+    ----------
+    ingredients : list of str
+        A list of magical ingredients.
+    heat_level : int
+        The intensity of the heat used for brewing.
+
+    Returns
+    -------
+    str
+        A description of the brewed potion.
+    """
+    return f"A sparkling blue elixir of friendship heated at {heat_level}."
diff --git a/python-docstrings/one_line_docstring.py b/python-docstrings/one_line_docstring.py
@@ -0,0 +1,7 @@
+import random
+
+
+def picking_hat():
+    """Return a random house name."""
+    houses = ["Gryffindor", "Hufflepuff", "Ravenclaw", "Slytherin"]
+    return random.choice(houses)
diff --git a/python-docstrings/reStructuredText.py b/python-docstrings/reStructuredText.py
@@ -0,0 +1,24 @@
+def cast_spell(wand, incantation, target=None):
+    """
+    Cast a magical spell using a wand and incantation.
+    This function simulates casting a spell. With no
+    target specified, it is cast into the void.
+
+    :param wand: The wand used to do the spell-casting deed.
+    :type wand: str
+    :param incantation: The words said to activate the magic.
+    :type incantation: str
+    :param target: The object or person the spell is directed at (optional).
+    :return: A string describing the result of the spell.
+    :rtype: str
+
+    :raises ValueError: If the incantation is unknown or the wand fails to work.
+    """
+    valid_incantations = ["Lumos", "Alohomora", "Expelliarmus"]
+    if not wand:
+        raise ValueError("You can't cast spells without a wand!")
+    if incantation not in valid_incantations:
+        raise ValueError("Incantation not recognized.")
+    if target:
+        return f"{incantation} hits {target} with magic speed!"
+    return f"{incantation} is cast into the void...sparkles shimmer faintly"
diff --git a/python-docstrings/vague_descriptions.py b/python-docstrings/vague_descriptions.py
@@ -0,0 +1,3 @@
+def brew(item):
+    """Does something with the item."""
+    pass
diff --git a/python-docstrings/vague_descriptions_fix.py b/python-docstrings/vague_descriptions_fix.py
@@ -0,0 +1,11 @@
+def brew(potion_ingredients):
+    """
+    Mixes the provided ingredients to brew a potion.
+
+    Args:
+        potion_ingredients (list of str): Ingredients needed to brew the potion.
+
+    Returns:
+        str: The name of the completed potion.
+    """
+    return f"Magical potion brewed from {', '.join(potion_ingredients)}"
diff --git a/what-does-arrow-mean-in-python/README.md b/what-does-arrow-mean-in-python/README.md
@@ -0,0 +1,3 @@
+# What Does -> Mean in Python Function Definitions?
+
+This folder provides the code examples for the Real Python tutorial [What Does -> Mean in Python Function Definitions?](https://realpython.com/what-does-arrow-mean-in-python/) 
diff --git a/what-does-arrow-mean-in-python/dictionary_return_type_example.py b/what-does-arrow-mean-in-python/dictionary_return_type_example.py
diff --git a/what-does-arrow-mean-in-python/dynamic_variable_example.py b/what-does-arrow-mean-in-python/dynamic_variable_example.py
diff --git a/what-does-arrow-mean-in-python/game_class_example.py b/what-does-arrow-mean-in-python/game_class_example.py
diff --git a/what-does-arrow-mean-in-python/mismatched_return_type_example.py b/what-does-arrow-mean-in-python/mismatched_return_type_example.py
diff --git a/what-does-arrow-mean-in-python/none_return_type_hint_example.py b/what-does-arrow-mean-in-python/none_return_type_hint_example.py
diff --git a/what-does-arrow-mean-in-python/simple_type_hint_example.py b/what-does-arrow-mean-in-python/simple_type_hint_example.py
diff --git a/what-does-arrow-mean-in-python/str_return_type_hint_example.py b/what-does-arrow-mean-in-python/str_return_type_hint_example.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# How To Write Docstrings in Python`
	`2`	`+`
	`3`	`+This folder provides the code examples for the Real Python tutorial [How To Write Docstrings in Python](https://realpython.com/how-to-write-docstrings-in-python/).`