Merge branch 'master' into python-scope-legb-rule

brendaweles · web-flow · commit e77c645c7702 · 2025-06-30T12:15:40.000-06:00
diff --git a/python-bitwise-operators/README.md b/python-bitwise-operators/README.md
@@ -1,22 +1,28 @@
 # Bitwise Operators in Python
 
-Source code of the least-significant bit **steganography** example from the [Bitwise Operators in Python](https://realpython.com/python-bitwise-operators/) article.  
+Source code of the least-significant bit steganography example from the [Bitwise Operators in Python](https://realpython.com/python-bitwise-operators/) tutorial.  
 
 ## Installation
 
-There are no external dependencies except for a Python interpreter.
+There are no external dependencies except for a Python interpreter. You can install this project by creating a new [virtual environment](https://realpython.com/python-virtual-environments-a-primer/), activating it, and installing the Python package:
+
+```shell
+$ python -m venv venv/
+$ source venv/bin/activate
+(venv) python -m pip install .
+```
 
 ## Running
 
-Change directory to the current folder, where this `README.md` file is located, and then execute Python module:
+Once the project is installed within your virtual environment, you can use the `stegano` command:
 
 ```shell
-$ python -m stegano /path/to/bitmap (--encode /path/to/file | --decode | --erase)
+$ stegano /path/to/bitmap (--encode /path/to/file | --decode | --erase)
 ```
 
 For example, to extract a secret file from the attached bitmap, type the following:
 
 ```shell
-$ python -m stegano example.bmp -d
+$ stegano example.bmp -d
 Extracted a secret file: podcast.mp4
 ```
diff --git a/python-bitwise-operators/pyproject.toml b/python-bitwise-operators/pyproject.toml
@@ -0,0 +1,16 @@
+[build-system]
+requires = ["setuptools>=64.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "stegano"
+version = "1.0.0"
+description = "Least Significant Bit Steganography in Python"
+authors = [
+    { name="Bartosz Zaczyński", email="bartosz@realpython.com" }
+]
+readme = "README.md"
+license = { text = "MIT" }
+
+[project.scripts]
+stegano = "stegano.__main__:entry_point"
diff --git a/python-bitwise-operators/src/stegano/__init__.py b/python-bitwise-operators/src/stegano/__init__.py
diff --git a/python-bitwise-operators/src/stegano/__main__.py b/python-bitwise-operators/src/stegano/__main__.py
@@ -3,15 +3,23 @@
 $ python -m stegano
 """
 
-from .bitmap import Bitmap
-from .cli import CommandLineArguments, parse_args
-from .decoder import DecodingError, decode
-from .encoder import EncodingError, encode
-from .eraser import erase
+from stegano.bitmap import Bitmap
+from stegano.cli import CommandLineArguments, parse_args
+from stegano.decoder import DecodingError, decode
+from stegano.encoder import EncodingError, encode
+from stegano.eraser import erase
 
 
-def main(args: CommandLineArguments) -> None:
+def entry_point() -> None:
     """Entry point to the script."""
+    try:
+        main(parse_args())
+    except (EncodingError, DecodingError) as ex:
+        print(ex)
+
+
+def main(args: CommandLineArguments) -> None:
+    """Handle the command line arguments and perform actions."""
     with Bitmap(args.bitmap) as bitmap:
         if args.encode:
             encode(bitmap, args.encode)
@@ -22,7 +30,4 @@ def main(args: CommandLineArguments) -> None:
 
 
 if __name__ == "__main__":
-    try:
-        main(parse_args())
-    except (EncodingError, DecodingError) as ex:
-        print(ex)
+    entry_point()
diff --git a/python-bitwise-operators/src/stegano/bitmap.py b/python-bitwise-operators/src/stegano/bitmap.py
diff --git a/python-bitwise-operators/src/stegano/cli.py b/python-bitwise-operators/src/stegano/cli.py
diff --git a/python-bitwise-operators/src/stegano/decoder.py b/python-bitwise-operators/src/stegano/decoder.py
@@ -6,7 +6,7 @@
 from pathlib import Path
 from typing import Iterator
 
-from .bitmap import Bitmap
+from stegano.bitmap import Bitmap
 
 
 class DecodingError(Exception):
diff --git a/python-bitwise-operators/src/stegano/encoder.py b/python-bitwise-operators/src/stegano/encoder.py
@@ -5,7 +5,7 @@
 import pathlib
 from typing import Iterator
 
-from .bitmap import Bitmap
+from stegano.bitmap import Bitmap
 
 
 class EncodingError(Exception):
diff --git a/python-bitwise-operators/src/stegano/eraser.py b/python-bitwise-operators/src/stegano/eraser.py
@@ -5,7 +5,7 @@
 from itertools import islice
 from random import random
 
-from .bitmap import Bitmap
+from stegano.bitmap import Bitmap
 
 
 def erase(bitmap: Bitmap) -> None:
diff --git a/python-enumerate/README.md b/python-enumerate/README.md
@@ -0,0 +1,3 @@
+# Python enumerate(): Simplify Loops That Need Counters
+
+This folder contains sample code for the Real Python tutorial [Python enumerate(): Simplify Loops That Need Counters](https://realpython.com/python-enumerate/).
diff --git a/python-enumerate/custom_enumerate.py b/python-enumerate/custom_enumerate.py
@@ -0,0 +1,12 @@
+def my_enumerate(iterable, start=0):
+    n = start
+    for elem in iterable:
+        yield n, elem
+        n += 1
+
+
+seasons = ["Spring", "Summer", "Fall", "Winter"]
+
+print(my_enumerate(seasons))
+print(list(my_enumerate(seasons)))
+print(list(my_enumerate(seasons, start=1)))
diff --git a/python-enumerate/enumerate_alternatives.py b/python-enumerate/enumerate_alternatives.py
@@ -0,0 +1,21 @@
+from itertools import pairwise
+
+# Advanced Iteration Patterns
+
+cities = ["Graz", "Belgrade", "Warsaw", "Berlin"]
+
+for city, next_city in pairwise(cities):
+    print(f"{city} -> {next_city}")
+
+# Slicing
+
+game_name = "Stardew Valley"
+print(game_name[:4])
+
+# Multi-Sequence Iteration
+
+pets = ["Leo", "Aubrey", "Frieda"]
+owners = ["Bartosz", "Sarah Jane", "Philipp"]
+
+for pet, owner in zip(pets, owners):
+    print(f"{pet} & {owner}")
diff --git a/python-enumerate/line_numbers.py b/python-enumerate/line_numbers.py
@@ -0,0 +1,11 @@
+lines = [
+    "This is a\tline",
+    "This line is fine",
+    "Another line with whitespace ",
+]
+
+for lineno, line in enumerate(lines, start=1):
+    if "\t" in line:
+        print(f"Line {lineno}: Contains a tab character.")
+    if line.rstrip() != line:
+        print(f"Line {lineno}: Contains trailing whitespace.")
diff --git a/python-enumerate/runners_v1.py b/python-enumerate/runners_v1.py
@@ -0,0 +1,4 @@
+runners = ["Lenka", "Martina", "Gugu"]
+
+for position, name in enumerate(runners):
+    print(position, name)
diff --git a/python-enumerate/runners_v2.py b/python-enumerate/runners_v2.py
@@ -0,0 +1,4 @@
+runners = ["Lenka", "Martina", "Gugu"]
+
+for position, name in enumerate(runners, start=1):
+    print(position, name)
diff --git a/python-enumerate/secret_message.py b/python-enumerate/secret_message.py
@@ -0,0 +1,8 @@
+secret_message = "3LAigf7eq 5fhiOnpdDs2 Ra6 nwUalyo.9"
+message = ""
+
+for index, char in enumerate(secret_message):
+    if index % 2:
+        message += char
+
+print(message)
diff --git a/python-enumerate/tasks.py b/python-enumerate/tasks.py
@@ -0,0 +1,7 @@
+tasks_by_priority = ["Pay Rent", "Clean Dishes", "Buy Milk"]
+
+for index, task in enumerate(tasks_by_priority):
+    if index == 0:
+        print(f"* {task.upper()}!")
+    else:
+        print(f"* {task}")
diff --git a/python-init-py/README.md b/python-init-py/README.md
@@ -0,0 +1,5 @@
+# What Is Python's `__init__.py` For?
+
+This folder contains the code discussed in the Real Python tutorial on [Python's `__init__.py` file](https://realpython.com/python-init-py/).
+
+You can start a Python interpreter inside this folder, then interact with the modules like shown in the tutorial. Some of the code is currently commented-out. Follow the tutorial instructions for when to uncomment.
diff --git a/python-init-py/media_project/mediatools/__init__.py b/python-init-py/media_project/mediatools/__init__.py
@@ -0,0 +1,8 @@
+# print(f"Importing {__name__}")
+
+__version__ = "0.1.0"
+
+# from .audio.utils import enhance as audio_enhance
+# from .audio.utils import wobbulate
+# from .graphics.utils import enhance as graphics_enhance
+# from .graphics.utils import solarize
diff --git a/python-init-py/media_project/mediatools/audio/__init__.py b/python-init-py/media_project/mediatools/audio/__init__.py
@@ -0,0 +1 @@
+# print(f"Importing {__name__}")
diff --git a/python-init-py/media_project/mediatools/audio/utils.py b/python-init-py/media_project/mediatools/audio/utils.py
@@ -0,0 +1,13 @@
+# print(f"Importing {__name__}")
+
+
+def wobbulate():
+    print("Wibble wobble")
+
+
+def enhance():
+    print("Enhancing audio")
+
+
+_secret_password = "Alakazam!"
+__top_secret_password = "!mazakalA"
diff --git a/python-init-py/media_project/mediatools/graphics/__init__.py b/python-init-py/media_project/mediatools/graphics/__init__.py
@@ -0,0 +1 @@
+# print(f"Importing {__name__}")
diff --git a/python-init-py/media_project/mediatools/graphics/utils.py b/python-init-py/media_project/mediatools/graphics/utils.py
@@ -0,0 +1,14 @@
+# print(f"Importing {__name__}")
+
+__all__ = ["solarize", "enhance"]
+
+
+def solarize():
+    print("Solarizing")
+
+
+def enhance():
+    print("Enhancing graphics")
+
+
+indiana_pi = 3.2
diff --git a/python-init-py/tools_project/tools/__init__.py b/python-init-py/tools_project/tools/__init__.py
@@ -0,0 +1,2 @@
+__version__ = "1.0.0"
+magic_number = 42
diff --git a/python-namedtuple/database.py b/python-namedtuple/database.py
@@ -0,0 +1,10 @@
+def get_column_names(table):
+    if table == "passenger":
+        return ("id", "first_name", "last_name", "class")
+    raise ValueError(f"unknown table {table}")
+
+
+def get_passenger_by_id(passenger_id):
+    if passenger_id == 1234:
+        return (1234, "John", "Doe", "Business")
+    raise ValueError(f"no record with id={passenger_id}")
diff --git a/python-namedtuple/employees.py b/python-namedtuple/employees.py
@@ -1,9 +1,9 @@
 import csv
 from collections import namedtuple
 
-with open("employees.csv", "r", encoding="utf-8") as csv_file:
+with open("employees.csv", mode="r", encoding="utf-8") as csv_file:
     reader = csv.reader(csv_file)
     Employee = namedtuple("Employee", next(reader), rename=True)
     for row in reader:
         employee = Employee(*row)
-        print(employee.name, employee.job, employee.email)
+        print(employee)
diff --git a/python-namedtuple/namedtuple_dataclass_memory.py b/python-namedtuple/namedtuple_dataclass_memory.py
@@ -17,5 +17,5 @@ class PointDataClass:
 dataclass_memory = asizeof.asizeof(PointDataClass(x=1, y=2, z=3))
 gain = 100 - namedtuple_memory / dataclass_memory * 100
 
-print(f"namedtuple: {namedtuple_memory} bytes ({gain:.2f}% lower)")
+print(f"namedtuple: {namedtuple_memory} bytes ({gain:.2f}% smaller)")
 print(f"data class: {dataclass_memory} bytes")
diff --git a/python-namedtuple/passenger.py b/python-namedtuple/passenger.py
@@ -0,0 +1,5 @@
+from collections import namedtuple
+
+from database import get_column_names
+
+Passenger = namedtuple("Passenger", get_column_names("passenger"), rename=True)
diff --git a/python-namedtuple/performance.py b/python-namedtuple/performance.py
diff --git a/python-namedtuple/person_dataclass.py b/python-namedtuple/person_dataclass.py
@@ -11,3 +11,8 @@ class Person:
 
     def __iter__(self):
         return iter(astuple(self))
+
+
+jane = Person("Jane", 25, 1.75, 67)
+for field in jane:
+    print(field)
diff --git a/python-namedtuple/requirements.txt b/python-namedtuple/requirements.txt
@@ -0,0 +1 @@
+pympler
diff --git a/python-namedtuple/subclass.py b/python-namedtuple/subclass.py
@@ -11,15 +11,15 @@ class Person(BasePerson):
 
     __slots__ = ()
 
-    def __repr__(self):
+    def __str__(self):
         return f"Name: {self.name}, age: {self.age} years old."
 
     @property
     def age(self):
         return (date.today() - self.birthdate).days // 365
 
 
-Person.__doc__
+print(Person.__doc__)
 
 jane = Person("Jane", date(1996, 3, 5))
 print(jane.age)
diff --git a/python-namedtuple/typed_namedtuple_time.py b/python-namedtuple/typed_namedtuple_time.py
@@ -34,7 +34,6 @@ class PointTypedNamedTuple(NamedTuple):
 typed_namedtuple_time = average_time(
     PointTypedNamedTuple(x=1, y=2, z=3), time_structure
 )
-gain = typed_namedtuple_time / namedtuple_time
 
 print(f"namedtuple:        {namedtuple_time:.2f} ns")
 print(f"typing.NamedTuple: {typed_namedtuple_time:.2f} ns")
diff --git a/python-t-strings/README.md b/python-t-strings/README.md
@@ -0,0 +1,3 @@
+# Python 3.14 Preview: Template Strings (T-Strings)
+
+This folder provides the code examples for the Real Python tutorial [Python 3.14 Preview: Template Strings (T-Strings)](https://realpython.com/python-t-strings/).
diff --git a/python-t-strings/asynchronous.py b/python-t-strings/asynchronous.py
@@ -0,0 +1,20 @@
+import asyncio
+
+
+async def main():
+    greeting = await greeting_template()
+    print(greeting)
+
+
+async def greeting_template():
+    """Uncomment in Python 3.14+"""
+    # return t"Hello, {await get_name()}!"
+
+
+async def get_name():
+    # Simulate an asynchronous operation
+    await asyncio.sleep(0.5)
+    return "Pythonista"
+
+
+asyncio.run(main())
diff --git a/python-t-strings/escape_html.py b/python-t-strings/escape_html.py
diff --git a/python-t-strings/logging_message.py b/python-t-strings/logging_message.py
diff --git a/python-t-strings/sql.py b/python-t-strings/sql.py
diff --git a/python-t-strings/to_string.py b/python-t-strings/to_string.py
diff --git a/torchaudio/README.md b/torchaudio/README.md
diff --git a/torchaudio/speech.py b/torchaudio/speech.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Python enumerate(): Simplify Loops That Need Counters`
	`2`	`+`
	`3`	`+This folder contains sample code for the Real Python tutorial [Python enumerate(): Simplify Loops That Need Counters](https://realpython.com/python-enumerate/).`