Python 312 FastAPI Best Practices Cursorrules Prom

Cursor-Regel für FastAPI mit Python-3.12-spezifischen Idiomen und Best Practices.

Original-Beschreibung der Autoren: Cursor rules for Python FastAPI development with best practices.

Die Regel

---
description: "Cursor rules for Python FastAPI development with best practices."
globs: **/*
alwaysApply: false
---
Here are some best practices and rules you must follow:

- You use Python 3.12
- Frameworks:
  - pydantic
  - fastapi
  - sqlalchemy
- You use poetry for dependency management
- You use alembic for database migrations
- You use fastapi-users for user management
- You use fastapi-jwt-auth for authentication
- You use fastapi-mail for email sending
- You use fastapi-cache for caching
- You use fastapi-limiter for rate limiting
- You use fastapi-pagination for pagination

1. **Use Meaningful Names**: Choose descriptive variable, function, and class names.
2. **Follow PEP 8**: Adhere to the Python Enhancement Proposal 8 style guide for formatting.
3. **Use Docstrings**: Document functions and classes with docstrings to explain their purpose.
4. **Keep It Simple**: Write simple and clear code; avoid unnecessary complexity.
5. **Use List Comprehensions**: Prefer list comprehensions for creating lists over traditional loops when appropriate.
6. **Handle Exceptions**: Use try-except blocks to handle exceptions gracefully.
7. **Use Virtual Environments**: Isolate project dependencies using virtual environments (e.g., `venv`).
8. **Write Tests**: Implement unit tests to ensure code reliability.
9. **Use Type Hints**: Utilize type hints for better code clarity and type checking.
10. **Avoid Global Variables**: Limit the use of global variables to reduce side effects.

These rules will help you write clean, efficient, and maintainable Python code.

So nutzt du sie

Die Regel kopieren (Button oben) oder als Datei herunterladen und im Projekt unter .cursor/rules/ ablegen — Cursor lädt sie beim nächsten Start automatisch. Ältere Cursor-Versionen lesen alternativ eine einzelne .cursorrules-Datei im Projektstamm; dort einfach den Regel-Text ohne den Kopfblock zwischen den ----Zeilen einfügen.

Der Regel-Text ist englisch — Cursor versteht ihn unabhängig von der Sprache, in der Sie mit dem Editor chatten.

Im Detail

Diese Regel bringt Cursor bei, beim Schreiben von FastAPI-Code gezielt die seit Python 3.12 verfügbaren Sprachmittel zu nutzen – etwa die neue type-Statement-Syntax, verbesserte Generics und klarere Fehlermeldungen – kombiniert mit aktuellen FastAPI- und Pydantic-v2-Idiomen. Der Vorteil gegenüber generischen FastAPI-Regeln: generierter Code fällt nicht auf veraltete Kompatibilitäts-Workarounds zurück, wenn das Projekt bereits fest auf 3.12 läuft. Sinnvoll für neue Projekte, die gezielt auf 3.12 aufgesetzt werden. Wer noch ältere Python-Versionen (3.9–3.11) unterstützen muss, sollte diese Regel meiden, da die verwendete Syntax dort zu Laufzeitfehlern führt.

Praxis-Tipp

Zum Beispiel: ‘Erstelle einen FastAPI-Router mit Pydantic-v2-Modellen und Python-3.12-Type-Parameter-Syntax für einen generischen Response-Wrapper.’

Lizenz & Quelle

• Lizenz: CC0 1.0
• Quelle: PatrickJS/awesome-cursorrules (GitHub)

Lade …