python-pytest-creator

What I do

I implement a complete Python pytest test generation workflow by extending the test-generator-framework:

1. Analyze Python Codebase: Scan Python application to identify functions, classes, and modules
2. Detect Python Testing Setup: Identify pytest version and Poetry availability
3. Generate Python-Specific Scenarios: Create comprehensive test scenarios covering:
   • Happy paths, edge cases, and error handling
   • Python-specific patterns (decorators, context managers, async functions)
4. Delegate to Framework: Use test-generator-framework for core test generation workflow
5. Ensure Executability: Verify tests run with poetry run pytest or pytest

When to use me

Use this workflow when:

• You need to create comprehensive pytest test files for a Python application
• You want to ensure all edge cases and error conditions are covered
• You need tests that integrate with Poetry environments
• You prefer a systematic approach to test generation with user confirmation
• You want to ensure tests run correctly with your project's pytest version

Framework: This skill extends test-generator-framework for core test generation workflow, adding Python-specific functionality.

Prerequisites

• Python project with Poetry (pyproject.toml) or pip (requirements.txt)
• Pytest installed and configured in project
• Python source code to test
• Appropriate file permissions to create test files

Note: Poetry is optional. If Poetry is installed and pyproject.toml exists, tests will use poetry run pytest. Otherwise, tests will use pytest directly.

Steps

Step 1: Analyze Python Codebase

• Use glob patterns to find Python files: **/*.py
• Exclude test files: **/test_*.py, **/*_test.py, **/tests/**/*.py
• Read each Python file to identify:
  • Functions: def function_name(parameters):
  • Classes: class ClassName:
  • Methods: def method_name(self, parameters):
  • Async functions: async def async_function():
  • Decorators: @decorator_name
  • Context managers: with context_manager():
• Identify import statements to understand dependencies

Step 2: Detect Python Testing Setup

• Check for pyproject.toml or requirements.txt
• Determine pytest version and plugins
• Check for Poetry installation: poetry --version

Step 3: Generate Python-Specific Test Scenarios

Function Scenarios (Python-specific)

• Happy Path: Normal inputs with expected outputs
• Edge Cases: Empty strings, empty lists, None, 0, -1
• Error Cases: Invalid types, out of range values, missing parameters
• Python Features: Decorators, type hints, default arguments, *args/**kwargs

Class Scenarios

• Initialization: __init__ with valid/invalid parameters
• Method Behavior: Public/private method testing
• Special Methods: __str__, __repr__, __eq__, __hash__
• Class Methods: @classmethod, @staticmethod
• Property: Properties defined with @property
• Context Managers: __enter__ and __exit__ methods

Async Function Scenarios

• Awaitable Results: Normal async execution
• Concurrency: Multiple async calls with asyncio.gather()
• Error Handling: Async exceptions with pytest.raises()
• Timeout: Tests that should timeout

Step 4: Delegate to Test Generator Framework

Note: Core test generation workflow is provided by test-generator-framework. This skill focuses only on Python-specific aspects.

Refer to test-generator-framework for:

• Generic test file creation structure
• Framework detection and command determination
• User confirmation workflow
• Executability verification

Python-specific test file templates below extend the framework structure.

Step 5: Create Test Files (Python-specific)

"""
Test suite for <module_name>.py
Generated by python-pytest-creator skill
"""

import pytest
from <module_path> import <function_name>, <ClassName>

@pytest.fixture
def sample_instance():
    """Create a sample instance for testing"""
    return ClassName(param1, param2)

def test_function_name_happy_path(sample_instance):
    """Test that function_name works with valid inputs"""
    result = function_name(valid_input)
    assert result == expected_output

def test_function_name_edge_case_empty():
    """Test that function_name handles empty input"""
    result = function_name("")
    assert result is None

def test_function_name_error_invalid_type():
    """Test that function_name raises ValueError for invalid type"""
    with pytest.raises(ValueError):
        function_name(invalid_input)

@pytest.mark.parametrize("input,expected", [
    (1, "one"),
    (2, "two"),
])
def test_function_name_parametrized(input, expected):
    """Test function_name with multiple inputs"""
    result = function_name(input)
    assert result == expected

class TestClassName:
    """Test suite for ClassName"""
    
    def test_initialization(self):
        """Test that ClassName initializes correctly"""
        instance = ClassName(param1, param2)
        assert instance.attribute == expected_value
    
    def test_method_behavior(self, sample_instance):
        """Test that ClassName.method_name works correctly"""
        result = sample_instance.method_name(param)
        assert result == expected_result

@pytest.mark.asyncio
async def test_async_function_happy_path():
    """Test successful async execution"""
    result = await async_function(valid_input)
    assert result["status"] == "success"

Step 6: Verify Executability

Refer to test-generator-framework for core executability verification.

Step 7: Display Summary

✅ Python test files created successfully!

**Test Files Created:**
- tests/test_<module_name>.py (<number> tests)

**Total Tests Generated:** <number>
**Test Framework:** Pytest

**Python-Specific Categories:**
- Decorator tests: <number>
- Context manager tests: <number>
- Special method tests: <number>
- Async function tests: <number>

**To run tests:**
```bash
# If Poetry is installed:
poetry run pytest tests/test_<module_name>.py -v
poetry run pytest --cov=<module_name> tests/

# Otherwise:
pytest tests/test_<module_name>.py -v
pytest --cov=<module_name> tests/

• Check for requirements.txt:
  bashCopy

  # Check if requirements.txt exists
  ls requirements.txt
  
  # Extract pytest version
  grep pytest requirements.txt
  

• Determine pytest-specific configurations:
  • Test discovery patterns
  • Coverage requirements
  • Custom pytest plugins

Step 3: Detect Poetry Installation

• Check if Poetry is installed:
  bashCopy

  poetry --version 2>/dev/null
  

• Determine which command to use:
  • If Poetry is installed AND pyproject.toml exists → use poetry run pytest
  • Otherwise → use pytest directly
• Store the appropriate pytest command for use in later steps:
  bashCopy

  if command -v poetry &>/dev/null && [ -f pyproject.toml ]; then
      PYTEST_CMD="poetry run pytest"
      echo "Using Poetry: $PYTEST_CMD"
  else
      PYTEST_CMD="pytest"
      echo "Using pytest directly: $PYTEST_CMD"
  fi
  

Step 4: Generate Test Scenarios

For each function/class identified, generate scenarios:

Function Scenarios

• Happy Path: Normal inputs with expected outputs
• Edge Cases: Minimum/maximum values, empty inputs, None values
• Error Cases: Invalid inputs, type mismatches, exceptions
• Boundary Conditions: Zero, negative numbers, string length limits

Class Scenarios

• Initialization: Constructor with valid/invalid parameters
• Method Behavior: Public/private method testing
• State Management: Instance variable changes
• Inheritance: Subclass behavior testing

Async Function Scenarios

• Awaitable Results: Normal async execution
• Concurrency: Multiple async calls
• Error Handling: Async exceptions

Step 5: Display Scenarios for Confirmation

Display formatted output:

📋 Generated Test Scenarios for <module_name>.py

**Functions to Test:**
1. function_name(param1, param2)
   - Happy path: Valid inputs return expected result
   - Edge case: Empty param1 returns default
   - Error case: Invalid type raises ValueError
   - Boundary: Maximum param2 size handled

2. another_function(param)
   - Happy path: Valid param returns success
   - Edge case: None param raises TypeError
   - Error case: Negative param raises ValueError

**Classes to Test:**
1. ClassName
   - Initialization: Valid params create instance
   - Method behavior: method_name() returns expected
   - State: Instance variables updated correctly

**Total Scenarios: <number>**
**Estimated Test Lines: <number>**

Are these scenarios acceptable? (y/n/suggest)

Wait for user response:

• y: Proceed to create test files
• n: Ask for modifications or cancel
• suggest: Ask user to add/remove scenarios

Step 6: Create Test Files

• Create tests/ directory if not exists
• Generate test file structure:
  pythonCopy

  """
  Test suite for <module_name>.py
  Generated by python-pytest-creator skill
  """
  
  import pytest
  from <module_path> import <function_name>, <ClassName>
  
  # Test function_name
  def test_function_name_happy_path():
      """
      Test that function_name works with valid inputs
      """
      result = function_name(param1, param2)
      assert result == expected_result
  
  def test_function_name_edge_case_empty():
      """
      Test that function_name handles empty param1
      """
      result = function_name("", param2)
      assert result is None
  
  def test_function_name_error_invalid_type():
      """
      Test that function_name raises ValueError for invalid type
      """
      with pytest.raises(ValueError):
          function_name(invalid_param, param2)
  
  # Test ClassName
  def test_class_name_initialization():
      """
      Test that ClassName initializes correctly
      """
      instance = ClassName(param1, param2)
      assert instance.attribute == expected_value
  
  def test_class_name_method():
      """
      Test that ClassName.method_name works correctly
      """
      instance = ClassName(param1, param2)
      result = instance.method_name(param)
      assert result == expected_result
  

• Use pytest fixtures for common setup:
  pythonCopy

  @pytest.fixture
  def sample_instance():
      """Create a sample instance for testing"""
      return ClassName(param1, param2)
  
  @pytest.fixture
  def sample_data():
      """Provide sample test data"""
      return {"key": "value"}
  

• Use pytest.mark for categorization:
  pythonCopy

  @pytest.mark.unit
  def test_unit_scenario():
      pass
  
  @pytest.mark.integration
  def test_integration_scenario():
      pass
  
  @pytest.mark.slow
  def test_performance_scenario():
      pass
  

Step 7: Verify Executability

• Ensure tests can be run with the appropriate pytest command:
  bashCopy

  # If Poetry is installed and pyproject.toml exists:
  poetry run pytest tests/test_<module_name>.py -v
  
  # Otherwise:
  pytest tests/test_<module_name>.py -v
  
  # Run all tests
  [poetry run] pytest -v
  
  # Run with coverage
  [poetry run] pytest --cov=<module_name> tests/
  

• Verify no import errors or syntax issues
• Check that all tests are discoverable by pytest

Step 8: Display Summary

✅ Test files created successfully!

**Test Files Created:**
- tests/test_<module_name1>.py (<number> tests)
- tests/test_<module_name2>.py (<number> tests)

**Total Tests Generated: <number>**
**Test Categories:**
- Unit tests: <number>
- Integration tests: <number>
- Edge case tests: <number>
- Error handling tests: <number>

**To run tests:**
```bash
# If Poetry is installed and pyproject.toml exists:
poetry run pytest -v
poetry run pytest tests/test_<module_name>.py -v
poetry run pytest --cov=<module_name> tests/

# Otherwise:
pytest -v
pytest tests/test_<module_name>.py -v
pytest --cov=<module_name> tests/

Next Steps:

1. Review generated test files
2. Adjust test data and expected values
3. Run tests to verify they pass
4. Update coverage badge in README.md using coverage-readme-workflow
5. Add any missing scenarios

## Python-Specific Scenario Generation

Python-specific patterns to focus on:

### Decorator Testing
- **Decorator Execution**: Decorator modifies function behavior correctly
- **Decorator Chaining**: Multiple decorators apply correctly
- **Decorator Arguments**: Decorator with parameters works
- **Class Decorators**: Decorator classes properly

### Context Manager Testing
- **`__enter__`**: Returns context manager correctly
- **`__exit__`**: Cleans up resources properly
- **Exception Handling**: Exceptions in context are handled
- **Nested Context**: Multiple context managers work together

### Special Method Testing
- **`__str__`**: String representation is correct
- **`__repr__`**: Developer representation is correct
- **`__eq__`**: Equality comparison works
- **`__hash__`**: Hash allows use in sets/dicts
- **`__len__`**: Length function returns correct value
- **`__getitem__`**: Item access works
- **`__setitem__`**: Item assignment works

### Property Testing
- **Getter**: Property returns correct value
- **Setter**: Property sets value correctly
- **Deleter**: Property deletion works
- **Cached Properties**: Cached behavior is correct

## Best Practices

Refer to `test-generator-framework` for general best practices.

Python-specific best practices:
- **Pytest Features**: Use fixtures, parametrization, marks
- **Async Testing**: Use pytest-asyncio for async functions
- **Type Hints**: Include type hints for better test coverage
- **Mocking**: Use pytest-mock or unittest.mock appropriately

## Common Issues

Refer to `test-generator-framework` for general issues.

Python-specific issues:

### Poetry Not Installed
**Issue**: `poetry run pytest` command not found

**Solution**: Use `pytest` directly instead:
```bash
pytest tests/

pytest-asyncio Not Installed

Issue: Async tests fail or don't run

Solution: Install pytest-asyncio:

poetry add --group dev pytest-asyncio
# or
pip install pytest-asyncio

Module Not Found

Issue: Import errors for modules to test

Solution: Add source to PYTHONPATH:

export PYTHONPATH="${PYTHONPATH}:$(pwd)"

Troubleshooting Checklist

Refer to test-generator-framework for general checklist.

Python-specific additions: Before generating tests:

• Python files exist and are syntactically correct
• pyproject.toml or requirements.txt exists
• Pytest is installed
• Poetry is installed (if using Poetry)

Related Commands

# Poetry commands
poetry run pytest -v
poetry run pytest --cov=<module> tests/
poetry install --group dev pytest-asyncio

# Direct pytest commands
pytest -v
pytest tests/test_module.py -v
pytest --cov=<module> tests/
pytest -k "test_name"

# Python commands
python -m pytest
export PYTHONPATH="${PYTHONPATH}:$(pwd)"

Related Skills

• test-generator-framework: Core test generation framework
• coverage-readme-workflow: For updating README with coverage badges
• python-ruff-linter: Python code quality before testing
• linting-workflow: Generic linting workflow