nirbarazida
/
promptfoo
mirror of https://github.com/promptfoo/promptfoo


  
1

	
2

	
3

	
4

	
5

	
6

	
7

	
8

	
9

	
10

	
11

	
12

	
13

	
14

	
15

	
16

	
17

	
18

	
19

	
20

	
21

	
22

	
23

	
24

	
25

	
26

	
27

	
28

	
29

	
30

	
31

	
32

	
33

	
34

	
            ---
description: Guidelines for Python development
globs: '**/*.py'
alwaysApply: false
---

# Python Development Guidelines

Files: "\*_/_.py"

This rule provides guidance for Python development in the promptfoo project.

## Python Guidelines

- Use Python 3.9 or later
- Follow the [Google Python Style Guide](mdc:https://google.github.io/styleguide/pyguide.html)
- Use type hints to improve code readability and catch potential errors
- Use `ruff` for linting and formatting
  - Run `ruff check --fix` for general linting
  - Run `ruff check --select I --fix` for import sorting
  - Run `ruff format` for formatting
- Write unit tests for new Python functions using the built-in `unittest` module
- Keep the Python codebase simple and minimal, without unnecessary external dependencies

## Examples and Custom Components

- When adding Python examples, update relevant `requirements.txt` files
- When implementing custom providers, prompts, or asserts in Python, follow the promptfoo API patterns
- Place example Python code in the `examples/` directory with appropriate documentation

## Integration with TypeScript

- Understand the interaction between Python components and the TypeScript core
- Follow the patterns established in existing Python files for interfacing with the main codebase