Using AI for code review and debugging in AI for Everyone - Mini Project: Build & Apply

Using AI for code review and debugging

📖 Scenario: You are a software developer working on a small project. You want to use AI tools to help review your code and find bugs before you share it with your team.

🎯 Goal: Build a simple step-by-step guide that shows how to prepare code for AI review, set up the review process, analyze AI feedback, and apply fixes to improve code quality.

📋 What You'll Learn

Create a sample code snippet to review

Set up a configuration for AI review criteria

Simulate AI feedback by identifying issues in the code

Apply fixes based on AI suggestions to improve the code

💡 Why This Matters

🌍 Real World

Developers often use AI tools to quickly find problems and improve code quality before sharing or deploying software.

💼 Career

Knowing how to use AI for code review helps programmers write better code faster and reduces errors in professional software projects.

1

DATA SETUP: Create a sample code snippet

Create a variable called code_snippet that holds this exact Python code as a string: def add_numbers(a, b):\n return a + b

AI for Everyone

# Create a variable called code_snippet with the given Python code as a string
# Your code here

Hint

Use triple quotes or escaped newlines to store multi-line code as a string.

2

CONFIGURATION: Set AI review criteria

Create a variable called review_criteria as a list containing these exact strings: 'check_syntax', 'check_style', 'check_performance'

AI for Everyone

code_snippet = "def add_numbers(a, b):\n    return a + b"
# Create a list called review_criteria with the specified checks
# Your code here

Hint

Use square brackets to create a list with the exact strings inside.

3

CORE LOGIC: Simulate AI feedback

Create a variable called ai_feedback as a dictionary with these exact entries: 'syntax': 'No errors found', 'style': 'Consider adding type hints', 'performance': 'Function is efficient'

AI for Everyone

code_snippet = "def add_numbers(a, b):\n    return a + b"
review_criteria = ['check_syntax', 'check_style', 'check_performance']
# Create a dictionary called ai_feedback with the specified entries
# Your code here

Hint

Use curly braces to create a dictionary with the exact keys and values.

4

COMPLETION: Apply AI suggestions to improve code

Create a variable called improved_code that holds this exact Python code as a string with type hints added: def add_numbers(a: int, b: int) -> int:\n return a + b

AI for Everyone

code_snippet = "def add_numbers(a, b):\n    return a + b"
review_criteria = ['check_syntax', 'check_style', 'check_performance']
ai_feedback = {
    'syntax': 'No errors found',
    'style': 'Consider adding type hints',
    'performance': 'Function is efficient'
}
# Create improved_code with type hints added as a string
# Your code here

Hint

Add type hints for parameters and return type exactly as shown.

Practice

1. What is one main benefit of using AI for code review and debugging?

easy

A. It helps find errors faster and suggests fixes.

B. It writes all code automatically without human input.

C. It replaces the need to learn programming.

D. It guarantees code will never have bugs.

Solution

1. Step 1: Understand AI's role in code review

   AI tools analyze code to spot mistakes and suggest improvements quickly.

2. Step 2: Compare options

   Only It helps find errors faster and suggests fixes. correctly states AI helps find errors faster and suggests fixes, while others exaggerate or misstate AI's capabilities.

3. Final Answer:

   It helps find errors faster and suggests fixes. -> Option A

4. Quick Check:

   AI aids debugging = Faster error detection [OK]

Hint: AI speeds up error finding and suggests fixes [OK]

Common Mistakes:

• Thinking AI writes all code alone
• Believing AI removes need to learn coding
• Assuming AI makes code perfect always

2. Which of the following is a correct way to ask AI for help in debugging code?

easy

A. Ignore the error and run the code again

B. Write a poem about debugging

C. Explain why this code throws an error: print(5/0)

D. Delete all code and start over

Solution

1. Step 1: Identify valid AI debugging requests

   Asking AI to explain a specific error in code is a proper debugging question.

2. Step 2: Evaluate options

   Explain why this code throws an error: print(5/0) asks for explanation of an error, which AI can help with. Others are unrelated or poor practices.

3. Final Answer:

   Explain why this code throws an error: print(5/0) -> Option C

4. Quick Check:

   Ask AI about error causes = Correct debugging help [OK]

Hint: Ask AI specific error questions for debugging help [OK]

Common Mistakes:

• Asking unrelated questions
• Ignoring errors instead of understanding them
• Deleting code without analysis

3. Given this code snippet:

def add_numbers(a, b):
    return a + b

result = add_numbers(2, '3')
print(result)

What will AI most likely identify as the problem?

medium

A. Syntax error in function definition

B. Type error due to adding integer and string

C. Missing return statement

D. Variable 'result' is undefined

Solution

1. Step 1: Analyze the code behavior

   The function tries to add 2 (integer) and '3' (string), which causes a type error in Python.

2. Step 2: Match problem to options

   Type error due to adding integer and string correctly identifies the type error. Other options are incorrect because the function syntax is valid, return exists, and 'result' is defined.

3. Final Answer:

   Type error due to adding integer and string -> Option B

4. Quick Check:

   Integer + string = TypeError [OK]

Hint: Check data types when adding values [OK]

Common Mistakes:

• Confusing syntax error with type error
• Overlooking data type mismatch
• Assuming variables are undefined

4. You asked AI to review this code:

for i in range(5)
    print(i)

AI points out an error. What is the likely fix?

medium

A. Change 'range(5)' to 'range 5'

B. Indent the for loop line

C. Remove the print statement

D. Add a colon ':' after the for loop declaration

Solution

1. Step 1: Identify syntax error in code

   The for loop is missing a colon ':' at the end of the declaration line, which is required in Python.

2. Step 2: Determine correct fix

   Adding the colon fixes the syntax error. Changing range syntax or removing print is incorrect. Indenting the loop line is already correct.

3. Final Answer:

   Add a colon ':' after the for loop declaration -> Option D

4. Quick Check:

   Python for loops need ':' [OK]

Hint: Look for missing colons in Python loops [OK]

Common Mistakes:

• Removing needed statements
• Misunderstanding Python syntax
• Incorrectly changing function calls

5. You want AI to help improve this code that filters out empty strings from a list:

items = ["apple", "", "banana", "", "cherry"]
filtered = {len(item) for item in items if item}

What is the best AI suggestion to fix the code for correct output?

hard

A. Change curly braces {} to square brackets [] to create a list instead of a set

B. Remove the if condition to include all items

C. Add a print statement inside the comprehension

D. Replace len(item) with item.upper()

Solution

1. Step 1: Understand the code's intention

   The code aims to filter out empty strings and get lengths of remaining items. Using curly braces creates a set, but the goal is likely a list of lengths.

2. Step 2: Identify correct fix

   Changing {} to [] creates a list comprehension, producing a list of lengths for non-empty strings. Other options change logic or add invalid syntax.

3. Final Answer:

   Change curly braces {} to square brackets [] to create a list instead of a set -> Option A

4. Quick Check:

   Use [] for list comprehension, {} for set [OK]

Hint: Use [] for lists, {} for dictionaries in comprehensions [OK]

Common Mistakes:

• Confusing list and set comprehensions
• Removing filters that exclude empty strings
• Adding statements inside comprehensions