Guarding Your Function

Objective: Guarding Your Function

Let's begin by reviewing our objective.

Our goal is to create a Python function describe_polygon(num_sides) that acts as a 'guard'. It should check if the input num_sides is valid (at least 3). If it's not, the function should print an error and stop immediately using return. If the input is valid, it should proceed to print a descriptive message about the polygon.

Check Spec: See the Failing Tests

Next, we'll run pytest to see the failing tests. This confirms the engineering specification we need to meet.

Test Results:

  • test_invalid_input_less_than_3
  • test_invalid_input_zero
  • test_invalid_input_negative
  • test_valid_input_minimum_sides
  • test_valid_input_more_than_minimum_sides
  • test_guard_clause_prevents_further_execution

Implement: Add the Guard Clause and Description

Now, let's build the solution by following the TODO comments in the skeleton code (main.py).

Step by step checklist:

  1. Check if the number of sides is less than 3.
  2. If it is, print the specific error message "Cannot describe: A polygon must have at least 3 sides." and then immediately exit the function.
  3. Otherwise (if the number of sides is 3 or more), print a message describing the polygon, including the number of sides.

The following documentation sections are going to be helpful:

  • Basic if Statement
  • Comparison Operators
  • Early Exit with return (Guard Clauses)
  • F-Strings (Formatted String Literals)

Validate: Run the Tests Again

With the code in place, let's run the tests again to validate our work.

Test Results:

  • test_invalid_input_less_than_3
  • test_invalid_input_zero
  • test_invalid_input_negative
  • test_valid_input_minimum_sides
  • test_valid_input_more_than_minimum_sides
  • test_guard_clause_prevents_further_execution All tests passed!

Debrief: Prepare for Code Review

Great job! You've successfully implemented a function with a guard clause to validate input.

Now, let's prepare for the final step: the code review with your mentor. Be ready to explain your implementation, focusing on how the if statement and return work together to handle invalid input.

Documentation

Python Fundamentals: Building Blocks Documentation

This document provides a quick reference for core Python concepts related to functions, conditional logic, and output formatting.

1. Functions

Functions are blocks of reusable code that perform a specific task. They help organize code, make it easier to read, and avoid repetition.

Basic Definition and Call

You define a function using the def keyword, followed by the function's name, parentheses (), and a colon :. The code inside the function must be indented. To run the code inside a function, you "call" it by using its name followed by parentheses.

# Defining a simple function
def say_greeting():
    print("Hello!")
    print("Nice to meet you.")

# Calling the function (running its code)
say_greeting()
say_greeting()

Output:

Hello!
Nice to meet you.
Hello!
Nice to meet you.

Image or GIF showing the concept of calling a function multiple times to repeat a block of code.

Functions with Parameters

Parameters are variables listed inside the parentheses in the function definition. They act as placeholders for values (arguments) that you provide when you call the function. This allows functions to be flexible and perform similar tasks with different data.

def greet_person(name, occasion):
    print(f"Hello, {name}! Happy {occasion}!")

# Calling with arguments
greet_person("Alex", "Birthday")
greet_person("Jordan", "Graduation")

Output:

Hello, Alex! Happy Birthday!
Hello, Jordan! Happy Graduation!

Diagram illustrating parameters as inputs to a function.

Passing Objects as Parameters (e.g., Turtle)

You can pass any type of data as an argument, including objects like a Turtle graphics object. This allows functions to operate on specific objects that are created outside the function.

import turtle

# Create a turtle
my_artist = turtle.Turtle()

# Pass the turtle object to the function
draw_segment(my_artist, 100)
draw_segment(my_artist, 50)

2. Conditional Execution (if)

Conditional statements allow your program to make decisions and execute different code blocks based on whether a condition is true or false.

Basic if Statement

The syntax involves the if keyword, a condition, and a colon. The code to execute if the condition is true is indented.

def check_score(score):
    if score > 90:
        print("Excellent!")
    # No 'else' part here, so nothing happens if score is 90 or less

check_score(95)  # Output: Excellent!
check_score(88)  # No output

Flowchart of a basic if statement.

Comparison Operators

These are used to form conditions in if statements:

OperatorMeaningExample
==Equal toa == b
!=Not equal toa != b
<Less thana < b
>Greater thana > b
<=Less than or equal toa <= b
>=Greater than or equal toa >= b

Early Exit with return (Guard Clauses)

A return statement immediately exits the current function. This is useful for "guard clauses" that check input at the beginning of a function and stop execution if the input is invalid.

def process_positive_number(number):
    if number <= 0:
        print("Error: Input must be positive.")
        return  # Exit the function early

    # This code only runs if number is positive
    print(f"Processing {number}...")
    # ... rest of the function logic ...

process_positive_number(-5)
process_positive_number(10)

Output:

Error: Input must be positive.
Processing 10...

3. Output Formatting (print())

The print() function is used to display output to the console. It has several features to control how output is formatted.

Printing Multiple Items

You can pass multiple items to print(), separated by commas. By default, print() will insert a space between each item.

item_name = "Widgets"
count = 12
print("Inventory:", count, item_name)

Output:

Inventory: 12 Widgets

F-Strings (Formatted String Literals)

F-strings provide a concise way to embed expressions and variables inside string literals. Start the string with an f or F before the opening quote. You place variables or expressions inside curly braces {} within the string.

product = "Laptop"
price = 999.99
discount = 0.15
final_price = price * (1 - discount)

print(f"Product: {product}")
print(f"Original Price: ${price}")
# Format final_price to two decimal places
print(f"Discounted Price: ${final_price:.2f}")

Output:

Product: Laptop
Original Price: $999.99
Discounted Price: $849.99

Diagram showing how an f-string substitutes variable values into placeholders.

Controlling Separators and Endings with sep and end

The print() function accepts optional sep and end parameters.

  • sep: Specifies the string to insert between items, replacing the default space.
  • end: Specifies the string to append at the end of the output, replacing the default newline character (\n).
# Using sep
print("File", "Edit", "View", sep=" | ")

# Using end to stay on the same line
print("Loading...", end="")
print(" Complete!")

Output:

File | Edit | View
Loading... Complete!

Simple animation showing how sep changes the space between items and end changes what comes after the printed line.

4. Turtle Graphics Basics (Relevant Commands)

The turtle module provides a way to create graphics using a "turtle" that draws on a screen.

import turtle

# Setup (often done outside drawing functions for testability)
# screen = turtle.Screen()
# my_turtle = turtle.Turtle()

# Basic Movement
# my_turtle.forward(100) # Move forward 100 units
# my_turtle.backward(50) # Move backward 50 units
# my_turtle.left(90)     # Turn left 90 degrees
# my_turtle.right(45)    # Turn right 45 degrees
# my_turtle.goto(x, y)   # Move to specific coordinates

# Pen Control
# my_turtle.penup()    # Lift the pen (stop drawing when moving)
# my_turtle.pendown()  # Put the pen down (start drawing when moving)
# my_turtle.pencolor("red") # Set the pen color by name or hex code
# my_turtle.pensize(3) # Set the thickness of the line

# Keeping the window open (usually in the __main__ block)
# turtle.done() # or screen.mainloop()

[ASSET: Example: Drawing Polygons with Turtle Functions] Functions are powerful for creating reusable drawing logic with Turtle.

import turtle

def draw_polygon(t_obj, num_sides, side_length, pen_color):
    # Guard clause for valid polygon
    if num_sides < 3:
        print("A polygon needs at least 3 sides.")
        return

    t_obj.pencolor(pen_color)
    angle = 360.0 / num_sides  # Calculate exterior angle

    for _ in range(num_sides):
        t_obj.forward(side_length)
        t_obj.left(angle)

# Setup
# screen = turtle.Screen()
# my_turtle = turtle.Turtle()
# my_turtle.speed(1) # Slower for visibility

# Draw a blue triangle
# draw_polygon(my_turtle, 3, 100, "blue")

# Move turtle to a new position for the next shape
# my_turtle.penup()
# my_turtle.goto(150, 50)
# my_turtle.pendown()

# Draw an orange pentagon
# draw_polygon(my_turtle, 5, 70, "orange")

# screen.mainloop() # Keep the window open

An animation showing the draw_polygon function being called twice, first drawing a blue triangle, then the turtle moving, and then drawing an orange pentagon.