Refactor code to improve typing and linting
This commit is contained in:
parent
8e26cae20e
commit
fb99c09cdd
@ -47,7 +47,7 @@ Once the server is running, you can access:
|
||||
|
||||
## API Endpoints
|
||||
|
||||
- `GET /health` - Health check endpoint
|
||||
- `GET /api/health` - Health check endpoint
|
||||
- `GET /api/todos` - List all todos
|
||||
- `GET /api/todos/{id}` - Get a single todo by ID
|
||||
- `POST /api/todos` - Create a new todo
|
||||
|
@ -1 +1 @@
|
||||
# This file makes the api directory a Python package
|
||||
# This file makes the api directory a Python package
|
||||
|
@ -1 +1 @@
|
||||
# This file makes the crud directory a Python package
|
||||
# This file makes the crud directory a Python package
|
||||
|
@ -1,10 +1,12 @@
|
||||
from typing import Optional
|
||||
|
||||
from sqlalchemy.orm import Session
|
||||
from typing import List, Optional
|
||||
from db.models import Todo
|
||||
|
||||
from api.schemas.todo import TodoCreate, TodoUpdate
|
||||
from db.models import Todo
|
||||
|
||||
|
||||
def get_todos(db: Session, skip: int = 0, limit: int = 100) -> List[Todo]:
|
||||
def get_todos(db: Session, skip: int = 0, limit: int = 100) -> list[Todo]:
|
||||
"""
|
||||
Get all todos with pagination
|
||||
"""
|
||||
@ -36,12 +38,12 @@ def update_todo(db: Session, todo_id: int, todo: TodoUpdate) -> Optional[Todo]:
|
||||
db_todo = get_todo(db, todo_id)
|
||||
if db_todo is None:
|
||||
return None
|
||||
|
||||
|
||||
# Update only provided fields
|
||||
todo_data = todo.dict(exclude_unset=True)
|
||||
for key, value in todo_data.items():
|
||||
setattr(db_todo, key, value)
|
||||
|
||||
|
||||
db.commit()
|
||||
db.refresh(db_todo)
|
||||
return db_todo
|
||||
@ -55,7 +57,7 @@ def delete_todo(db: Session, todo_id: int) -> bool:
|
||||
db_todo = get_todo(db, todo_id)
|
||||
if db_todo is None:
|
||||
return False
|
||||
|
||||
|
||||
db.delete(db_todo)
|
||||
db.commit()
|
||||
return True
|
||||
return True
|
||||
|
@ -1 +1 @@
|
||||
# This file makes the routers directory a Python package
|
||||
# This file makes the routers directory a Python package
|
||||
|
@ -1,10 +1,11 @@
|
||||
from fastapi import APIRouter, Depends
|
||||
from sqlalchemy.orm import Session
|
||||
import platform
|
||||
import sys
|
||||
|
||||
from db.database import get_db
|
||||
from fastapi import APIRouter, Depends
|
||||
from sqlalchemy.orm import Session
|
||||
|
||||
from api.schemas.health import HealthResponse
|
||||
from db.database import get_db
|
||||
|
||||
router = APIRouter()
|
||||
|
||||
@ -20,7 +21,8 @@ def health_check(db: Session = Depends(get_db)):
|
||||
# Just run a simple query to verify DB connection
|
||||
db.execute("SELECT 1")
|
||||
db_status = "healthy"
|
||||
except Exception as e:
|
||||
except (RuntimeError, ConnectionError) as e:
|
||||
# Catch specific exceptions rather than a broad Exception
|
||||
db_status = f"unhealthy: {str(e)}"
|
||||
|
||||
return HealthResponse(
|
||||
@ -30,5 +32,5 @@ def health_check(db: Session = Depends(get_db)):
|
||||
"database": db_status,
|
||||
"python_version": sys.version,
|
||||
"platform": platform.platform(),
|
||||
}
|
||||
)
|
||||
},
|
||||
)
|
||||
|
@ -1,15 +1,14 @@
|
||||
from fastapi import APIRouter, Depends, HTTPException, status
|
||||
from sqlalchemy.orm import Session
|
||||
from typing import List
|
||||
|
||||
from db.database import get_db
|
||||
from api.crud.todo import create_todo, delete_todo, get_todo, get_todos, update_todo
|
||||
from api.schemas.todo import TodoCreate, TodoResponse, TodoUpdate
|
||||
from api.crud.todo import get_todos, get_todo, create_todo, update_todo, delete_todo
|
||||
from db.database import get_db
|
||||
|
||||
router = APIRouter()
|
||||
|
||||
|
||||
@router.get("/", response_model=List[TodoResponse])
|
||||
@router.get("/", response_model=list[TodoResponse])
|
||||
def read_todos(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)):
|
||||
"""
|
||||
Get all todos with pagination
|
||||
@ -56,4 +55,4 @@ def delete_existing_todo(todo_id: int, db: Session = Depends(get_db)):
|
||||
success = delete_todo(db=db, todo_id=todo_id)
|
||||
if not success:
|
||||
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="Todo not found")
|
||||
return None
|
||||
return None
|
||||
|
@ -1 +1 @@
|
||||
# This file makes the schemas directory a Python package
|
||||
# This file makes the schemas directory a Python package
|
||||
|
@ -1,9 +1,10 @@
|
||||
from typing import Any
|
||||
|
||||
from pydantic import BaseModel
|
||||
from typing import Dict, Any
|
||||
|
||||
|
||||
class HealthResponse(BaseModel):
|
||||
"""Response schema for the health check endpoint"""
|
||||
status: str
|
||||
version: str
|
||||
details: Dict[str, Any]
|
||||
details: dict[str, Any]
|
||||
|
@ -1,12 +1,15 @@
|
||||
from pydantic import BaseModel, Field
|
||||
from typing import Optional
|
||||
from datetime import datetime
|
||||
from typing import Optional
|
||||
|
||||
from pydantic import BaseModel, Field
|
||||
|
||||
|
||||
class TodoBase(BaseModel):
|
||||
"""Base Todo schema with common attributes"""
|
||||
title: str = Field(..., min_length=1, max_length=100, description="Title of the todo")
|
||||
description: Optional[str] = Field(None, max_length=500, description="Detailed description of the todo")
|
||||
description: Optional[str] = Field(
|
||||
None, max_length=500, description="Detailed description of the todo",
|
||||
)
|
||||
completed: bool = Field(False, description="Whether the todo is completed")
|
||||
|
||||
|
||||
@ -17,8 +20,12 @@ class TodoCreate(TodoBase):
|
||||
|
||||
class TodoUpdate(BaseModel):
|
||||
"""Schema for updating an existing todo, all fields are optional"""
|
||||
title: Optional[str] = Field(None, min_length=1, max_length=100, description="Title of the todo")
|
||||
description: Optional[str] = Field(None, max_length=500, description="Detailed description of the todo")
|
||||
title: Optional[str] = Field(
|
||||
None, min_length=1, max_length=100, description="Title of the todo",
|
||||
)
|
||||
description: Optional[str] = Field(
|
||||
None, max_length=500, description="Detailed description of the todo",
|
||||
)
|
||||
completed: Optional[bool] = Field(None, description="Whether the todo is completed")
|
||||
|
||||
|
||||
@ -31,4 +38,4 @@ class TodoResponse(TodoBase):
|
||||
class Config:
|
||||
"""ORM mode config for the TodoResponse schema"""
|
||||
orm_mode = True
|
||||
from_attributes = True
|
||||
from_attributes = True
|
||||
|
@ -1,4 +1,5 @@
|
||||
from pathlib import Path
|
||||
|
||||
from sqlalchemy import create_engine
|
||||
from sqlalchemy.ext.declarative import declarative_base
|
||||
from sqlalchemy.orm import sessionmaker
|
||||
@ -13,7 +14,7 @@ SQLALCHEMY_DATABASE_URL = f"sqlite:///{DB_DIR}/db.sqlite"
|
||||
# Create engine
|
||||
engine = create_engine(
|
||||
SQLALCHEMY_DATABASE_URL,
|
||||
connect_args={"check_same_thread": False}
|
||||
connect_args={"check_same_thread": False},
|
||||
)
|
||||
|
||||
# Create session factory
|
||||
@ -36,4 +37,4 @@ def create_tables():
|
||||
"""
|
||||
Create all tables defined in models
|
||||
"""
|
||||
Base.metadata.create_all(bind=engine)
|
||||
Base.metadata.create_all(bind=engine)
|
||||
|
@ -1,5 +1,6 @@
|
||||
from sqlalchemy import Column, Integer, String, Boolean, DateTime
|
||||
from sqlalchemy import Boolean, Column, DateTime, Integer, String
|
||||
from sqlalchemy.sql import func
|
||||
|
||||
from .database import Base
|
||||
|
||||
|
||||
@ -14,4 +15,4 @@ class Todo(Base):
|
||||
description = Column(String, nullable=True)
|
||||
completed = Column(Boolean, default=False)
|
||||
created_at = Column(DateTime(timezone=True), server_default=func.now())
|
||||
updated_at = Column(DateTime(timezone=True), onupdate=func.now())
|
||||
updated_at = Column(DateTime(timezone=True), onupdate=func.now())
|
||||
|
9
main.py
9
main.py
@ -1,7 +1,8 @@
|
||||
import uvicorn
|
||||
from fastapi import FastAPI
|
||||
from fastapi.middleware.cors import CORSMiddleware
|
||||
import uvicorn
|
||||
from api.routers import todo_router, health_router
|
||||
|
||||
from api.routers import health_router, todo_router
|
||||
from db.database import create_tables
|
||||
|
||||
app = FastAPI(
|
||||
@ -21,7 +22,7 @@ app.add_middleware(
|
||||
|
||||
# Include routers
|
||||
app.include_router(todo_router.router, prefix="/api/todos", tags=["todos"])
|
||||
app.include_router(health_router.router, tags=["health"])
|
||||
app.include_router(health_router.router, prefix="/api", tags=["health"])
|
||||
|
||||
# Create database tables on startup
|
||||
@app.on_event("startup")
|
||||
@ -29,4 +30,4 @@ async def startup():
|
||||
create_tables()
|
||||
|
||||
if __name__ == "__main__":
|
||||
uvicorn.run("main:app", host="0.0.0.0", port=8000, reload=True)
|
||||
uvicorn.run("main:app", host="0.0.0.0", port=8000, reload=True)
|
||||
|
@ -1,9 +1,7 @@
|
||||
from logging.config import fileConfig
|
||||
|
||||
from sqlalchemy import engine_from_config
|
||||
from sqlalchemy import pool
|
||||
|
||||
from alembic import context
|
||||
from sqlalchemy import engine_from_config, pool
|
||||
|
||||
from db.models import Base
|
||||
|
||||
@ -66,7 +64,7 @@ def run_migrations_online():
|
||||
|
||||
with connectable.connect() as connection:
|
||||
context.configure(
|
||||
connection=connection, target_metadata=target_metadata
|
||||
connection=connection, target_metadata=target_metadata,
|
||||
)
|
||||
|
||||
with context.begin_transaction():
|
||||
@ -76,4 +74,4 @@ def run_migrations_online():
|
||||
if context.is_offline_mode():
|
||||
run_migrations_offline()
|
||||
else:
|
||||
run_migrations_online()
|
||||
run_migrations_online()
|
||||
|
@ -1,13 +1,12 @@
|
||||
"""Initial create todos table
|
||||
|
||||
Revision ID: 1_initial_create_todos_table
|
||||
Revises:
|
||||
Revises:
|
||||
Create Date: 2023-09-20 12:00:00.000000
|
||||
|
||||
"""
|
||||
from alembic import op
|
||||
import sqlalchemy as sa
|
||||
|
||||
from alembic import op
|
||||
|
||||
# revision identifiers, used by Alembic.
|
||||
revision = '1_initial_create_todos_table'
|
||||
@ -25,11 +24,11 @@ def upgrade():
|
||||
sa.Column('completed', sa.Boolean(), default=False),
|
||||
sa.Column('created_at', sa.DateTime(timezone=True), server_default=sa.func.now()),
|
||||
sa.Column('updated_at', sa.DateTime(timezone=True), onupdate=sa.func.now()),
|
||||
sa.PrimaryKeyConstraint('id')
|
||||
sa.PrimaryKeyConstraint('id'),
|
||||
)
|
||||
op.create_index(op.f('ix_todos_id'), 'todos', ['id'], unique=False)
|
||||
|
||||
|
||||
def downgrade():
|
||||
op.drop_index(op.f('ix_todos_id'), table_name='todos')
|
||||
op.drop_table('todos')
|
||||
op.drop_table('todos')
|
||||
|
@ -1,8 +1,13 @@
|
||||
[tool.ruff]
|
||||
line-length = 100
|
||||
target-version = "py39"
|
||||
select = ["E", "F", "I", "W", "N", "B", "A", "COM", "C4", "UP", "S", "BLE", "T10", "ISC", "G"]
|
||||
ignore = []
|
||||
|
||||
[tool.ruff.isort]
|
||||
[tool.ruff.lint]
|
||||
select = ["E", "F", "I", "W", "N", "B", "A", "COM", "C4", "UP", "S", "BLE", "T10", "ISC", "G"]
|
||||
ignore = [
|
||||
"B008", # Function call in argument defaults (used by FastAPI for dependency injection)
|
||||
"S104", # Binding to all interfaces (common in development environments)
|
||||
]
|
||||
|
||||
[tool.ruff.lint.isort]
|
||||
known-third-party = ["fastapi", "sqlalchemy", "pydantic", "alembic"]
|
Loading…
x
Reference in New Issue
Block a user