wip student API #7

Author: kathmandu777

fastapi/app/crud/student.py

@@ -0,0 +1,59 @@
+from typing import List, Optional
+from uuid import UUID
+
+from app.core.exceptions import ApiException, NotFoundObjectMatchingUuid, create_error
+from app.db.database import get_db_session
+from app.models import Student
+from app.schemas import CreateStudentSchema, UpdateStudentSchema
+from sqlalchemy.orm import scoped_session
+
+from .base import BaseCRUD
+
+db_session = get_db_session()
+
+
+class StudentCRUD(BaseCRUD):
+    def __init__(self, db_session: scoped_session):
+        super().__init__(db_session, Student)
+
+    def gets_by_student_sheet_uuid(self, student_sheet_uuid: UUID) -> List[Student]:
+        return self.get_query().filter_by(student_sheet_uuid=student_sheet_uuid).all()
+
+    def get_by_student_sheet_uuid_and_number(
+        self, student_sheet_uuid: UUID, number: int
+    ) -> Optional[Student]:
+        return (
+            self.get_query()
+            .filter_by(student_sheet_uuid=student_sheet_uuid, number=number)
+            .first()
+        )
+
+    def create(self, schema: CreateStudentSchema) -> Student:
+        if (
+            self.get_by_student_sheet_uuid_and_number(
+                schema.student_sheet_uuid, schema.number
+            )
+            is not None
+        ):
+            raise ApiException(
+                create_error(
+                    f"Student with number {schema.number} already exists in this student sheet."
+                )
+            )
+        return super().create(schema.dict())
+
+    def update(self, uuid: UUID, schema: UpdateStudentSchema) -> Student:
+        update_obj = self.get_by_uuid(uuid)
+        if update_obj is None:
+            raise ApiException(NotFoundObjectMatchingUuid(self.model, uuid))
+
+        new_data_obj = self.get_by_student_sheet_uuid_and_number(
+            schema.student_sheet_uuid, schema.number
+        )
+        if new_data_obj is not None and new_data_obj.uuid != update_obj.uuid:
+            raise ApiException(
+                create_error(
+                    f"Student with number {schema.number} already exists in this student sheet."
+                )
+            )
+        return super().update(uuid, schema.dict())

fastapi/app/db/migrations/versions/20220104_110934_student.py

@@ -0,0 +1,54 @@
+"""student
+
+Revision ID: d0c79969f425
+Revises: 8bf6f6f70d43
+Create Date: 2022-01-04 11:09:34.821871+09:00
+
+"""
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = "d0c79969f425"
+down_revision = "8bf6f6f70d43"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "students",
+        sa.Column("uuid", postgresql.UUID(as_uuid=True), nullable=False),
+        sa.Column(
+            "created_at",
+            postgresql.TIMESTAMP(timezone=True),
+            server_default=sa.text("CURRENT_TIMESTAMP"),
+            nullable=False,
+            comment="登録日時",
+        ),
+        sa.Column(
+            "updated_at",
+            postgresql.TIMESTAMP(timezone=True),
+            nullable=True,
+            comment="最終更新日時",
+        ),
+        sa.Column("is_active", sa.BOOLEAN(), server_default="true", nullable=False),
+        sa.Column("name", sa.VARCHAR(length=100), nullable=False),
+        sa.Column("number", sa.INTEGER(), nullable=False),
+        sa.Column("student_sheet_uuid", postgresql.UUID(as_uuid=True), nullable=False),
+        sa.CheckConstraint("number > 0"),
+        sa.ForeignKeyConstraint(
+            ["student_sheet_uuid"], ["student_sheets.uuid"], ondelete="CASCADE"
+        ),
+        sa.PrimaryKeyConstraint("uuid"),
+        sa.UniqueConstraint("number", "student_sheet_uuid"),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table("students")
+    # ### end Alembic commands ###

fastapi/app/models/__init__.py

@@ -1,2 +1,3 @@
+from .student import Student
 from .student_sheet import StudentSheet
 from .user import User

fastapi/app/models/student.py

@@ -0,0 +1,25 @@
+from sqlalchemy import INTEGER, VARCHAR, CheckConstraint, Column, ForeignKey
+from sqlalchemy.dialects.postgresql import UUID
+from sqlalchemy.schema import UniqueConstraint
+
+from .base import BaseModelMixin
+
+
+class Student(BaseModelMixin):
+    __tablename__ = "students"
+
+    MAX_LENGTH_NAME = 100
+    name = Column(VARCHAR(MAX_LENGTH_NAME), nullable=False)
+
+    number = Column(INTEGER, nullable=False)
+
+    student_sheet_uuid = Column(
+        UUID(as_uuid=True),
+        ForeignKey("student_sheets.uuid", ondelete="CASCADE"),
+        nullable=False,
+    )
+
+    __table_args__ = (
+        UniqueConstraint("number", "student_sheet_uuid"),
+        CheckConstraint(number > 0),
+    )

fastapi/app/models/student_sheet.py

@@ -1,5 +1,6 @@
 from sqlalchemy import VARCHAR, Column, ForeignKey
 from sqlalchemy.dialects.postgresql import UUID
+from sqlalchemy.orm import relationship
 from sqlalchemy.schema import UniqueConstraint
 
 from .base import BaseModelMixin
@@ -17,3 +18,5 @@ class StudentSheet(BaseModelMixin):
         ForeignKey("users.uuid", ondelete="CASCADE"),
         nullable=False,
     )
+
+    students = relationship("Student", backref="student_sheet", cascade="all")

fastapi/app/schemas/__init__.py

@@ -1,3 +1,4 @@
 from .auth import *
+from .student import *
 from .student_sheet import *
 from .user import *

fastapi/app/schemas/student.py

@@ -0,0 +1,32 @@
+from uuid import UUID
+
+from app.models import Student
+from pydantic import BaseModel, Field
+
+
+class BaseStudentSchema(BaseModel):
+    name: str = Field(..., max_length=Student.MAX_LENGTH_NAME)
+    number: int = Field(..., gt=0)
+
+    class Config:
+        orm_mode = True
+
+
+class CreateStudentSchema(BaseStudentSchema):
+    student_sheet_uuid: UUID
+
+
+class UpdateStudentSchema(BaseStudentSchema):
+    student_sheet_uuid: UUID
+
+
+class CreateFormStudentSchema(BaseStudentSchema):
+    pass
+
+
+class UpdateFormStudentSchema(BaseStudentSchema):
+    pass
+
+
+class ReadStudentSchema(BaseStudentSchema):
+    uuid: UUID