PY-1.3-BP5-MQ05

Our Goal: Clean Up Code

We will make code easier to read and understand. This is like tidying up your room so everything is in its right place.

Here is what a blank game window looks like: Pygame Window

Check Your Work: See the Failing Tests

Now, let's run the tests to see what needs fixing.

Run this command in your terminal:

pytest module-1.3/blueprint-5/quest-05

You should see these tests failing:

  • test_calculate_subtotal
  • test_apply_tax
  • test_apply_discount
  • test_process_order_standard
  • test_process_order_custom_rates
  • test_process_order_no_items
  • test_process_order_no_discount_or_tax

Write Your Code: `main.py`

Now, let's write the code for main.py.

This file has some functions that need to be cleaned up. You will make them clearer and easier to use.

Here are some general examples of how you might make code cleaner:

# Before:
# def calculate_total(item1_price, item2_price, tax_rate, discount_amount):
#     subtotal = item1_price + item2_price
#     tax_amount = subtotal * tax_rate
#     total_after_tax = subtotal + tax_amount
#     final_total = total_after_tax - discount_amount
#     return final_total

# After (using smaller, clearer functions):
def calculate_subtotal(prices):
    # Make sure prices is a list of numbers
    return sum(prices)

def apply_tax(amount, tax_rate):
    # Make sure amount and tax_rate are numbers
    return amount * (1 + tax_rate)

def apply_discount(amount, discount_rate):
    # Make sure amount and discount_rate are numbers
    return amount * (1 - discount_rate)

def process_order(item_prices, tax_rate, discount_rate):
    subtotal = calculate_subtotal(item_prices)
    discounted_total = apply_discount(subtotal, discount_rate)
    final_price = apply_tax(discounted_total, tax_rate)
    return final_price

# Example of type checking:
def add_numbers(a, b):
    if not isinstance(a, (int, float)) or not isinstance(b, (int, float)):
        raise TypeError("Both inputs must be numbers")
    return a + b

Check Your Work Again: All Tests Pass!

Now that you've written your code, let's run the tests one more time.

Run this command in your terminal:

pytest module-1.3/blueprint-5/quest-05

You should see all tests passing:

  • test_calculate_subtotal
  • test_apply_tax
  • test_apply_discount
  • test_process_order_standard
  • test_process_order_custom_rates
  • test_process_order_no_items
  • test_process_order_no_discount_or_tax

Documentation

Displaying Text with Pygame Fonts

Pygame allows you to render text onto the screen using fonts. This is essential for displaying information like scores, lives, or game messages.

The process involves:

  1. Initializing the font module (often done with pygame.init(), but pygame.font.init() is specific).
  2. Creating a Font object.
  3. Rendering the desired text onto a Surface.
  4. Getting the Rect for the text surface to position it.
  5. Blitting (drawing) the text surface onto the main screen surface.
import pygame

# Example: Font creation
# Use None for the default font, specify size
font = pygame.font.Font(None, 36)

# Example: Rendering text
# Arguments: text string, anti-aliasing (True/False), color
text_surface = font.render("Hello, Pygame!", True, (255, 255, 255)) # White text

# Example: Positioning text
text_rect = text_surface.get_rect()
text_rect.topleft = (10, 10) # Position at (10, 10)

# Example: Drawing text (inside the game loop)
# screen.fill((0, 0, 0)) # Fill background
# screen.blit(text_surface, text_rect)
# pygame.display.flip()

[Image/Gif: Show a simple Pygame window with static text rendered in the corner.]

Updating Game State Variables

Game state refers to the current condition of the game, such as the player's score, remaining lives, or the game's overall status (playing, paused, game over). These are typically stored in variables.

To update the display of these variables, you need to:

  1. Modify the variable's value based on game events (e.g., increment score on collision, decrement lives on miss).
  2. Re-render the text surface with the new variable value.
  3. Re-blit the updated text surface to the screen in the drawing phase of the game loop.
# Example: Initial state
score = 0
lives = 3

# Example: Updating state based on an event (inside game logic)
# if collision_with_brick:
#     score += 10
# if ball_went_off_bottom:
#     lives -= 1

# Example: Re-rendering text after state change (inside game logic or drawing)
# Assuming 'font' and 'screen' are defined
score_text_surface = font.render(f"Score: {score}", True, (255, 255, 255))
lives_text_surface = font.render(f"Lives: {lives}", True, (255, 255, 255))

# Example: Drawing updated text (inside drawing phase)
# screen.blit(score_text_surface, (10, 10))
# screen.blit(lives_text_surface, (screen_width - lives_text_surface.get_width() - 10, 10))

[Image/Gif: Show a score counter incrementing or a lives counter decrementing.]

Handling Events and Conditional Logic

Game logic often depends on specific conditions being met. For example, a score should only increase when a collision occurs, or a life should only be lost when the ball goes off-screen. if statements are used to check these conditions and execute code accordingly.

Common conditions involve checking:

  • Collisions between sprites (sprite.rect.colliderect(other_sprite.rect)).
  • Position relative to screen boundaries (ball.rect.bottom >= screen_height).
  • The value of game state variables (if lives <= 0).
# Example: Checking for ball going off bottom (inside game logic)
# Assuming 'ball' object and 'screen_height' constant exist
if ball.rect.bottom > screen_height:
    # This condition is true when the ball is below the screen
    print("Ball missed!")
    # Trigger actions like losing a life and resetting the ball
    # lives -= 1
    # ball.reset_position()

# Example: Checking for collision (inside game logic)
# Assuming 'ball' and 'paddle' objects exist
if ball.rect.colliderect(paddle.rect):
    print("Ball hit paddle!")
    # Trigger actions like bouncing the ball
    # ball.speed_y *= -1

[Image/Gif: Show a ball hitting the bottom edge and disappearing, or hitting a paddle and bouncing.]

Implementing a Simple Game State Machine

For games with distinct phases (like a title screen, playing, game over), a simple state machine can manage which logic and drawing code runs. A variable (e.g., game_state) holds the current state, and if/elif/else statements control the flow.

# Example: Initializing state
game_state = 'playing' # Possible states: 'playing', 'game_over'

# Example: State transition (inside game logic)
# if lives <= 0:
#     game_state = 'game_over'

# Example: Logic and Drawing based on state (inside main loop)
# if game_state == 'playing':
#     # Update ball, paddle, check collisions, etc.
#     ball.move()
#     paddle.move(keys)
#     # ... collision checks ...
#     
#     # Draw playing elements
#     screen.fill(BLACK)
#     ball.draw(screen)
#     paddle.draw(screen)
#     # ... draw bricks, score, lives ...
#
# elif game_state == 'game_over':
#     # Stop movement (implicitly done by not calling move() above)
#     
#     # Draw game over screen
#     screen.fill(BLACK)
#     # ... draw 'GAME OVER' text, final score ...

[Image/Gif: Show a transition from the active game screen to a static "GAME OVER" screen.]

Integrating Multiple Game Components

A complete game loop combines all the elements: event handling, updating game state variables, moving objects, checking collisions, managing game state transitions, and drawing everything to the screen. The main loop iterates continuously, performing these steps in order for each frame.

The structure typically looks like:

# Initialize Pygame, screen, clock, game state, objects

# Main game loop
running = True
while running:
    # 1. Event Handling (check for quit, key presses)
    for event in pygame.event.get():
        # ... handle events ...

    # 2. Game Logic (based on current state)
    # if game_state == 'playing':
        # Update object positions (ball.move(), paddle.move())
        # Check collisions (ball-paddle, ball-brick)
        # Update score/lives based on collisions/misses
        # Check for win/lose conditions and update game_state
    # elif game_state == 'game_over':
        # Handle game over screen logic (e.g., wait for restart input)

    # 3. Drawing
    screen.fill(background_color)
    # if game_state == 'playing':
        # Draw all active game objects (paddle, ball, bricks)
        # Draw score and lives text
    # elif game_state == 'game_over':
        # Draw game over message and final score

    # 4. Update Display
    pygame.display.flip()

    # 5. Control Frame Rate
    clock.tick(FPS)

# Quit Pygame

[Image/Gif: Show a full, simple Breakout game loop running.]

Adding Sound Effects with pygame.mixer

Sound effects enhance the game experience by providing audio feedback for events like collisions.

Steps to add sound:

  1. Initialize the mixer module (pygame.mixer.init()). This is separate from pygame.init().
  2. Load a sound file (.wav, .ogg, etc.) into a Sound object (pygame.mixer.Sound("path/to/sound.wav")). It's good practice to handle potential errors if the file is missing.
  3. Play the sound object when the corresponding game event occurs (sound_object.play()).
import pygame

# Example: Initialize mixer (after pygame.init())
# pygame.init()
pygame.mixer.init()

# Example: Load sound file
try:
    bounce_sound = pygame.mixer.Sound("assets/bounce.wav")
except pygame.error as e:
    print(f"Could not load sound file: {e}")
    # Create a dummy object if loading fails to prevent crashes
    class DummySound:
        def play(self): pass
    bounce_sound = DummySound()


# Example: Play sound on event (inside game logic)
# if ball.rect.colliderect(paddle.rect):
#     ball.speed_y *= -1
#     bounce_sound.play() # Play the sound here

[Image/Gif: Show a visual representation of a sound wave playing when a collision happens.]

Code Refactoring: Improving Code Structure

Refactoring is the process of restructuring existing computer code without changing its external behavior. The goal is to improve nonfunctional attributes of the software, such as readability, maintainability, and simplicity.

Common refactoring techniques include:

  • Extracting methods/functions: Turning a block of code into a reusable function with a clear purpose.
  • Renaming variables/functions: Using descriptive names that explain the code's intent.
  • Introducing constants: Replacing "magic numbers" or hardcoded values with named constants.
  • Adding comments and docstrings: Explaining complex logic or the purpose of functions/classes.
# Example: Before Refactoring (simplified)
# def calculate_total(prices, tax, discount_percent):
#     subtotal = 0
#     for p in prices:
#         subtotal += p
#     discount_amount = subtotal * (discount_percent / 100)
#     discounted_total = subtotal - discount_amount
#     tax_amount = discounted_total * tax
#     final_price = discounted_total + tax_amount
#     return final_price

# Example: After Refactoring (using extracted functions and better names)
# DEFAULT_TAX_RATE = 0.08
# DEFAULT_DISCOUNT_PERCENTAGE = 10

# def calculate_subtotal(item_prices):
#     """Calculates the sum of all item prices."""
#     return sum(item_prices)

# def apply_discount(amount, discount_percentage):
#     """Applies a discount to a given amount."""
#     discount_amount = amount * (discount_percentage / 100.0)
#     return amount - discount_amount

# def apply_tax(amount, tax_rate):
#     """Applies tax to a given amount."""
#     tax_amount = amount * tax_rate
#     return amount + tax_amount

# def process_order(item_prices, tax_rate=DEFAULT_TAX_RATE, discount_percentage=DEFAULT_DISCOUNT_PERCENTAGE):
#     """Processes a customer's order."""
#     subtotal = calculate_subtotal(item_prices)
#     discounted_total = apply_discount(subtotal, discount_percentage)
#     final_price = apply_tax(discounted_total, tax_rate)
#     return final_price

Refactoring makes code easier to understand, test, and modify in the future. It's an ongoing process, not a one-time task.