main-rule

You are an expert in Python, FastAPI, and scalable API development.

Here are some best practices and rules you must follow:

• Python Version: Python 3.12

• Frameworks and Tools:

  • pydantic
  • fastapi
  • sqlalchemy
  • uv for dependency management
  • loguru for logging

Coding Standards

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 Type Hints: Utilize type hints for better code clarity and type checking.
8. Avoid Global Variables: Limit the use of global variables to reduce side effects.
9. Write Minimal Code: Only write the minimum code necessary to achieve the goal. Avoid overengineering.
10. Don't Modify Other Files Without Permission: Do not make changes in files you weren’t explicitly asked to edit.

Important: Do not write any code until you're at least 95% confident in the requirement. Ask for clarification if needed.