adapt shakespeare models to sqlalchemy 2.0

app/models/shakespeare.py

@@ -1,154 +1,123 @@
-from sqlalchemy import (
-    Column,
-    ForeignKey,
-    ForeignKeyConstraint,
-    Integer,
-    PrimaryKeyConstraint,
-    String,
-    Table,
-    Text,
-    UniqueConstraint,
-    select,
-)
+from typing import List, Optional
+
+from sqlalchemy import Column, ForeignKeyConstraint, Integer, PrimaryKeyConstraint, String, Table, Text, \
+    UniqueConstraint, select
 from sqlalchemy.ext.asyncio import AsyncSession
-from sqlalchemy.orm import relationship
+from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship
 
-from app.models.base import Base
-
-metadata = Base.metadata
+class Base(DeclarativeBase):
+    pass
 
 
 class Character(Base):
-    __tablename__ = "character"
+    __tablename__ = 'character'
     __table_args__ = (
-        PrimaryKeyConstraint("id", name="character_pkey"),
-        {"schema": "shakespeare"},
+        PrimaryKeyConstraint('id', name='character_pkey'),
+        {'schema': 'shakespeare'}
     )
 
-    id = Column(String(32))
-    name = Column(String(64), nullable=False)
-    speech_count = Column(Integer, nullable=False)
-    abbrev = Column(String(32))
-    description = Column(String(2056))
+    id: Mapped[str] = mapped_column(String(32), primary_key=True)
+    name: Mapped[str] = mapped_column(String(64))
+    speech_count: Mapped[int] = mapped_column(Integer)
+    abbrev: Mapped[str | None] = mapped_column(String(32))
+    description: Mapped[str | None] = mapped_column(String(2056))
 
-    work = relationship("Work", secondary="shakespeare.character_work", back_populates="character")
-    paragraph = relationship("Paragraph", back_populates="character")
+    work: Mapped[list['Work']] = relationship('Work', secondary='shakespeare.character_work', back_populates='character')
+    paragraph: Mapped[list['Paragraph']] = relationship('Paragraph', back_populates='character')
 
 
 class Wordform(Base):
-    __tablename__ = "wordform"
+    __tablename__ = 'wordform'
     __table_args__ = (
-        PrimaryKeyConstraint("id", name="wordform_pkey"),
-        {"schema": "shakespeare"},
+        PrimaryKeyConstraint('id', name='wordform_pkey'),
+        {'schema': 'shakespeare'}
     )
 
-    id = Column(Integer)
-    plain_text = Column(String(64), nullable=False)
-    phonetic_text = Column(String(64), nullable=False)
-    stem_text = Column(String(64), nullable=False)
-    occurences = Column(Integer, nullable=False)
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    plain_text: Mapped[str] = mapped_column(String(64))
+    phonetic_text: Mapped[str] = mapped_column(String(64))
+    stem_text: Mapped[str] = mapped_column(String(64))
+    occurences: Mapped[int] = mapped_column(Integer)
 
 
 class Work(Base):
-    __tablename__ = "work"
+    __tablename__ = 'work'
     __table_args__ = (
-        PrimaryKeyConstraint("id", name="work_pkey"),
-        {"schema": "shakespeare"},
+        PrimaryKeyConstraint('id', name='work_pkey'),
+        {'schema': 'shakespeare'}
     )
 
-    id = Column(String(32))
-    title = Column(String(32), nullable=False)
-    long_title = Column(String(64), nullable=False)
-    year = Column(Integer, nullable=False)
-    genre_type = Column(String(1), nullable=False)
-    source = Column(String(16), nullable=False)
-    total_words = Column(Integer, nullable=False)
-    total_paragraphs = Column(Integer, nullable=False)
-    notes = Column(Text)
+    id: Mapped[str] = mapped_column(String(32), primary_key=True)
+    title: Mapped[str] = mapped_column(String(32))
+    long_title: Mapped[str] = mapped_column(String(64))
+    year: Mapped[int] = mapped_column(Integer)
+    genre_type: Mapped[str] = mapped_column(String(1))
+    source: Mapped[str] = mapped_column(String(16))
+    total_words: Mapped[int] = mapped_column(Integer)
+    total_paragraphs: Mapped[int] = mapped_column(Integer)
+    notes: Mapped[str | None] = mapped_column(Text)
 
-    character = relationship("Character", secondary="shakespeare.character_work", back_populates="work")
-    chapter = relationship("Chapter", back_populates="work")
-    paragraph = relationship("Paragraph", back_populates="work")
+    character: Mapped[list['Character']] = relationship('Character', secondary='shakespeare.character_work', back_populates='work')
+    chapter: Mapped[list['Chapter']] = relationship('Chapter', back_populates='work')
+    paragraph: Mapped[list['Paragraph']] = relationship('Paragraph', back_populates='work')
 
 
 class Chapter(Base):
-    __tablename__ = "chapter"
+    __tablename__ = 'chapter'
     __table_args__ = (
-        ForeignKeyConstraint(["work_id"], ["shakespeare.work.id"], name="chapter_work_id_fkey"),
-        PrimaryKeyConstraint("id", name="chapter_pkey"),
-        UniqueConstraint(
-            "work_id",
-            "section_number",
-            "chapter_number",
-            name="chapter_work_id_section_number_chapter_number_key",
-        ),
-        {"schema": "shakespeare"},
+        ForeignKeyConstraint(['work_id'], ['shakespeare.work.id'], name='chapter_work_id_fkey'),
+        PrimaryKeyConstraint('id', name='chapter_pkey'),
+        UniqueConstraint('work_id', 'section_number', 'chapter_number', name='chapter_work_id_section_number_chapter_number_key'),
+        {'schema': 'shakespeare'}
     )
 
-    id = Column(Integer)
-    work_id = Column(ForeignKey("shakespeare.work.id"), nullable=False)
-    section_number = Column(Integer, nullable=False)
-    chapter_number = Column(Integer, nullable=False)
-    description = Column(String(256), nullable=False)
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    work_id: Mapped[str] = mapped_column(String(32))
+    section_number: Mapped[int] = mapped_column(Integer)
+    chapter_number: Mapped[int] = mapped_column(Integer)
+    description: Mapped[str] = mapped_column(String(256))
 
-    work = relationship("Work", back_populates="chapter")
-    paragraph = relationship("Paragraph", back_populates="chapter")
+    work: Mapped['Work'] = relationship('Work', back_populates='chapter')
+    paragraph: Mapped[list['Paragraph']] = relationship('Paragraph', back_populates='chapter')
 
 
 t_character_work = Table(
-    "character_work",
-    metadata,
-    Column("character_id", ForeignKey("shakespeare.character.id"), nullable=False),
-    Column("work_id", ForeignKey("shakespeare.work.id"), nullable=False),
-    ForeignKeyConstraint(
-        ["character_id"],
-        ["shakespeare.character.id"],
-        name="character_work_character_id_fkey",
-    ),
-    ForeignKeyConstraint(["work_id"], ["shakespeare.work.id"], name="character_work_work_id_fkey"),
-    PrimaryKeyConstraint("character_id", "work_id", name="character_work_pkey"),
-    schema="shakespeare",
+    'character_work', Base.metadata,
+    Column('character_id', String(32), primary_key=True, nullable=False),
+    Column('work_id', String(32), primary_key=True, nullable=False),
+    ForeignKeyConstraint(['character_id'], ['shakespeare.character.id'], name='character_work_character_id_fkey'),
+    ForeignKeyConstraint(['work_id'], ['shakespeare.work.id'], name='character_work_work_id_fkey'),
+    PrimaryKeyConstraint('character_id', 'work_id', name='character_work_pkey'),
+    schema='shakespeare'
 )
 
 
 class Paragraph(Base):
-    __tablename__ = "paragraph"
+    __tablename__ = 'paragraph'
     __table_args__ = (
-        ForeignKeyConstraint(
-            ["character_id"],
-            ["shakespeare.character.id"],
-            name="paragraph_character_id_fkey",
-        ),
-        ForeignKeyConstraint(
-            ["work_id", "section_number", "chapter_number"],
-            [
-                "shakespeare.chapter.work_id",
-                "shakespeare.chapter.section_number",
-                "shakespeare.chapter.chapter_number",
-            ],
-            name="paragraph_chapter_fkey",
-        ),
-        ForeignKeyConstraint(["work_id"], ["shakespeare.work.id"], name="paragraph_work_id_fkey"),
-        PrimaryKeyConstraint("id", name="paragraph_pkey"),
-        {"schema": "shakespeare"},
+        ForeignKeyConstraint(['character_id'], ['shakespeare.character.id'], name='paragraph_character_id_fkey'),
+        ForeignKeyConstraint(['work_id', 'section_number', 'chapter_number'], ['shakespeare.chapter.work_id', 'shakespeare.chapter.section_number', 'shakespeare.chapter.chapter_number'], name='paragraph_chapter_fkey'),
+        ForeignKeyConstraint(['work_id'], ['shakespeare.work.id'], name='paragraph_work_id_fkey'),
+        PrimaryKeyConstraint('id', name='paragraph_pkey'),
+        {'schema': 'shakespeare'}
     )
 
-    id = Column(Integer)
-    work_id = Column(ForeignKey("shakespeare.work.id"), nullable=False)
-    paragraph_num = Column(Integer, nullable=False)
-    character_id = Column(ForeignKey("shakespeare.character.id"), nullable=False)
-    plain_text = Column(Text, nullable=False)
-    phonetic_text = Column(Text, nullable=False)
-    stem_text = Column(Text, nullable=False)
-    paragraph_type = Column(String(1), nullable=False)
-    section_number = Column(Integer, nullable=False)
-    chapter_number = Column(Integer, nullable=False)
-    char_count = Column(Integer, nullable=False)
-    word_count = Column(Integer, nullable=False)
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    work_id: Mapped[str] = mapped_column(String(32))
+    paragraph_num: Mapped[int] = mapped_column(Integer)
+    character_id: Mapped[str] = mapped_column(String(32))
+    plain_text: Mapped[str] = mapped_column(Text)
+    phonetic_text: Mapped[str] = mapped_column(Text)
+    stem_text: Mapped[str] = mapped_column(Text)
+    paragraph_type: Mapped[str] = mapped_column(String(1))
+    section_number: Mapped[int] = mapped_column(Integer)
+    chapter_number: Mapped[int] = mapped_column(Integer)
+    char_count: Mapped[int] = mapped_column(Integer)
+    word_count: Mapped[int] = mapped_column(Integer)
 
-    character = relationship("Character", back_populates="paragraph", lazy="selectin")
-    chapter = relationship("Chapter", back_populates="paragraph", lazy="selectin")
-    work = relationship("Work", back_populates="paragraph", lazy="selectin")
+    character: Mapped['Character'] = relationship('Character', back_populates='paragraph')
+    chapter: Mapped['Chapter'] = relationship('Chapter', back_populates='paragraph')
+    work: Mapped['Work'] = relationship('Work', back_populates='paragraph')
 
     @classmethod
     async def find(cls, db_session: AsyncSession, character: str):