fastapi - 💡(How to fix) Fix Add .cursorrules file to help Cursor IDE users follow FastAPI conventions [1 participants]

cd fastapi          # repo root
touch .cursorrules

# .cursorrules – Cursor IDE guidance for FastAPI contributors

# ----------------------------------------------------------------------
# General Python style
# ----------------------------------------------------------------------
style:
  line_length: 120
  import_sorting: isort
  type_checking: true          # enforce mypy/pyright strict mode
  no_implicit_any: true

# ----------------------------------------------------------------------
# FastAPI‑specific patterns
# ----------------------------------------------------------------------
fastapi:
  # Dependency injection
  depends:
    pattern: "def get_{{name}}(request: Request) -> {{type}}:"
    description: |
      Use `Depends()` for reusable resources (DB sessions, auth, etc.).
      Return concrete types, never `Any`.

  # Async route handlers
  async_route:
    pattern: |
      @router.get("/{{path}}")
      async def {{func_name}}(params: {{ParamsModel}}) -> {{ResponseModel}}:
          ...
    notes: |
      - All I/O should be `await`‑ed.
      - For parallel calls use `await asyncio.gather(*coros)`.

# ----------------------------------------------------------------------
# Pydantic v2 model conventions
# ----------------------------------------------------------------------
pydantic:
  base_model:
    config: |
      class Config:
          from_attributes =