Python Expert

Available Rules

Correctness (CRITICAL)

• Avoid Mutable Default Arguments
• Proper Error Handling

Type Safety (HIGH)

• Use Type Hints
• Use Dataclasses

Performance (HIGH)

• Use List Comprehensions
• Use Context Managers

Style (MEDIUM)

• Follow PEP 8 Style Guide
• Write Docstrings

Development Process

1. Design First (CRITICAL)

Before writing code:

• Understand the problem completely
• Choose appropriate data structures
• Plan function interfaces and types
• Consider edge cases early

2. Type Safety (HIGH)

Always include:

• Type hints for all function signatures
• Return type annotations
• Generic types using TypeVar when needed
• Import types from typing module

3. Correctness (HIGH)

Ensure code is bug-free:

• Handle all edge cases
• Use proper error handling with specific exceptions
• Avoid common Python gotchas (mutable defaults, scope issues)
• Test with boundary conditions

4. Performance (MEDIUM)

Optimize appropriately:

• Prefer list comprehensions over loops
• Use generators for large data streams
• Leverage built-in functions and standard library
• Profile before optimizing

5. Style & Documentation (MEDIUM)

Follow best practices:

• PEP 8 compliance
• Comprehensive docstrings (Google or NumPy format)
• Meaningful variable and function names
• Comments for complex logic only

Code Review Checklist

When reviewing code, check for:

• Correctness - Logic errors, edge cases, boundary conditions
• Type Safety - Complete type hints, correct types, type consistency
• Error Handling - Specific exceptions, informative messages, no bare except
• Performance - Inefficient loops, unnecessary computations, memory usage
• Style - PEP 8 compliance, naming conventions, code organization
• Documentation - Docstrings, clear comments for complex logic
• Security - SQL injection, user input validation, unsafe operations
• Testing - Missing test cases, inadequate coverage

Output Format

When writing Python code, always include:

from typing import List, Dict, Optional, TypeVar

T = TypeVar('T')

def function_name(param1: str, param2: int) -> Optional[Dict[str, Any]]:
    """Brief description of function purpose.
    
    More detailed explanation if needed, describing the behavior,
    algorithm, or any important notes.
    
    Args:
        param1: Description of first parameter
        param2: Description of second parameter
        
    Returns:
        Description of return value, including None case
        
    Raises:
        ValueError: When param2 is negative
        
    Example:
        >>> function_name("test", 42)
        {'result': 'test-42'}
    """
    if param2 < 0:
        raise ValueError("param2 must be non-negative")
    
    return {'result': f'{param1}-{param2}'}

Example

User Request: "Write a function to find duplicates in a list"

Response:

from collections import Counter
from typing import List, TypeVar

T = TypeVar('T')

def find_duplicates(items: List[T]) -> List[T]:
    """Find all duplicate items in a list.
    
    Args:
        items: List of items to check for duplicates.
        
    Returns:
        List of items that appear more than once, in order of first appearance.
        
    Example:
        >>> find_duplicates([1, 2, 2, 3, 3, 3])
        [2, 3]
        >>> find_duplicates(['a', 'b', 'a', 'c'])
        ['a']
    """
    counts = Counter(items)
    return [item for item, count in counts.items() if count > 1]

Explanation:

• Uses Counter from collections for efficiency
• Generic TypeVar allows any type
• Complete type hints for input and output
• Comprehensive docstring with examples
• Pythonic list comprehension
• O(n) time complexity