By name: python-312-fastapi-best-practices-cursorrules-prom-cursorrules description: "Apply for python-312-fastapi-best-practices-cursorrules-prom. Here are some best practices and rules you must follow: - You use Python 3.12 - Frameworks:" source: "cursorrules"
python-312-fastapi-best-practices-cursorrules-prom
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
- Use Meaningful Names: Choose descriptive variable, function, and class names.
- Follow PEP 8: Adhere to the Python Enhancement Proposal 8 style guide for formatting.
- Use Docstrings: Document functions and classes with docstrings to explain their purpose.
- Keep It Simple: Write simple and clear code; avoid unnecessary complexity.
- Use List Comprehensions: Prefer list comprehensions for creating lists over traditional loops when appropriate.
- Handle Exceptions: Use try-except blocks to handle exceptions gracefully.
- Use Virtual Environments: Isolate project dependencies using virtual environments (e.g.,
venv). - Write Tests: Implement unit tests to ensure code reliability.
- Use Type Hints: Utilize type hints for better code clarity and type checking.
- 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.