Migrate model definition to latest sqlalchemy mapped class

Author: khteh

env.py

@@ -21,16 +21,13 @@
 # for 'autogenerate' support
 # from myapp import mymodel
 # target_metadata = mymodel.Base.metadata
-from src.models.base import Base
 from src.models.AuthorModel import AuthorModel
 from src.models.BookModel import BookModel
 from src.models.UserModel import UserModel
+from src.models.base import Base
 
 target_metadata = Base.metadata
 
-#from src.models.Database import LibraryMetadata
-#target_metadata = LibraryMetadata
-
 # other values from the config, defined by the needs of env.py,
 # can be acquired:
 # my_important_option = config.get_main_option("my_important_option")
@@ -41,6 +38,7 @@
 config.set_section_option(section, "DB_PASSWORD", urllib.parse.quote_plus(os.environ.get('DB_PASSWORD')).replace("%", "%%"))
 config.set_section_option(section, "DB_HOST", json_config["DB_HOST"])
 config.set_section_option(section, "DB_DATABASE", json_config["DB_DATABASE"])
+
 def run_migrations_offline() -> None:
     """Run migrations in 'offline' mode.
 

src/models/AuthorModel.py

@@ -1,27 +1,29 @@
+import sqlalchemy as sa
+import sqlalchemy.orm
 from datetime import datetime
 from sqlalchemy import Integer, String, DateTime
 from marshmallow import fields, Schema
 from sqlalchemy.sql import func
-import sqlalchemy as sa
-import sqlalchemy.orm
-from sqlalchemy.orm import Mapped, mapped_column
+from typing import List
+from sqlalchemy.orm import Mapped, mapped_column, relationship
 from quart import Quart
 from .base import Base
-from .BookModel import BookSchema
+from .BookModel import BookModel, BookSchema
+from .base import Base
 from . import db
-class AuthorModel(db.Model):
+class AuthorModel(Base):
     """
     Author Model
     """
     __tablename__ = 'authors'
-    id = db.Column(db.Integer, primary_key=True)
-    firstname = db.Column(db.String(128), nullable=False)
-    lastname = db.Column(db.String(128), nullable=False)
-    email = db.Column(db.String(255), unique=True, nullable=False, index=True)
-    phone = db.Column(db.String(15), unique=True, nullable=True, index=True)
-    created_at = db.Column(db.DateTime(timezone=True))
-    modified_at = db.Column(db.DateTime(timezone=True))
-    books = db.relationship("BookModel", backref="authors", lazy=True)	
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    firstname: Mapped[str] = mapped_column(String(128), nullable=False)
+    lastname: Mapped[str] = mapped_column(String(128), nullable=False)
+    email: Mapped[str] = mapped_column(String(255), unique=True, nullable=False, index=True)
+    phone: Mapped[str] = mapped_column(String(15), unique=True, nullable=True, index=True)
+    created_at: Mapped[DateTime] = mapped_column(DateTime(timezone=True))
+    modified_at: Mapped[DateTime] = mapped_column(DateTime(timezone=True))
+    books: Mapped[List["BookModel"]] = relationship(back_populates="authors", lazy=True)
     # Class constructor
     def __init__(self, data):
         """

src/models/BookModel.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from sqlalchemy import Integer, String, DateTime
+from sqlalchemy import Integer, String, DateTime, ForeignKey
 from marshmallow import fields, Schema
 from sqlalchemy.sql import func
 import sqlalchemy as sa
@@ -8,18 +8,18 @@
 from quart import Quart
 from .base import Base
 from . import db
-class BookModel(db.Model):
+class BookModel(Base):
     """
     Book Model
     """
     __tablename__ = "books"
-    id = db.Column(db.Integer, primary_key=True)
-    title = db.Column(db.String(128), nullable=False)
-    isbn = db.Column(db.String(255), nullable=False)
-    page_count = db.Column(db.Integer, nullable=False)
-    created_at = db.Column(db.DateTime(timezone=True))
-    modified_at = db.Column(db.DateTime(timezone=True))
-    author_id = db.Column(db.Integer, db.ForeignKey("authors.id"), nullable=False)
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    title: Mapped[str] = mapped_column(String(128), nullable=False)
+    isbn: Mapped[str] = mapped_column(String(255), nullable=False)
+    page_count: Mapped[int] = mapped_column(Integer, nullable=False)
+    created_at: Mapped[DateTime] = mapped_column(DateTime(timezone=True))
+    modified_at: Mapped[DateTime] = mapped_column(DateTime(timezone=True))
+    author_id: Mapped[int] = mapped_column(ForeignKey("authors.id"), nullable=False)
     def __init__(self, data):
         self.author_id = data.get("author_id")
         self.title = data.get("title")

src/models/UserModel.py

@@ -7,22 +7,23 @@
 from sqlalchemy.orm import Mapped, mapped_column
 from quart import Quart
 from src.common.Bcrypt import bcrypt
+from .base import Base
 from . import db
-from .BookModel import BookSchema
-class UserModel(db.Model):
+from .BookModel import BookModel, BookSchema
+class UserModel(Base):
     """
     User Model
     """
     __tablename__ = 'users'
-    id = db.Column(db.Integer, primary_key=True)
-    firstname = db.Column(db.String(128), nullable=False)
-    lastname = db.Column(db.String(128), nullable=False)
-    email = db.Column(db.String(255), unique=True, nullable=False, index=True)
-    phone = db.Column(db.String(15), unique=True, nullable=True, index=True)
-    password = db.Column(db.String(128), nullable=True)
-    lastlogin = db.Column(db.DateTime(timezone=True), nullable=True)
-    created_at = db.Column(db.DateTime(timezone=True))
-    modified_at = db.Column(db.DateTime(timezone=True))
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    firstname: Mapped[str] = mapped_column(String(128), nullable=False)
+    lastname: Mapped[str] = mapped_column(String(128), nullable=False)
+    email: Mapped[str] = mapped_column(String(255), unique=True, nullable=False, index=True)
+    phone: Mapped[str] = mapped_column(String(15), unique=True, nullable=True, index=True)
+    password: Mapped[str] = mapped_column(String(128), nullable=True)
+    lastlogin: Mapped[DateTime] = mapped_column(DateTime(timezone=True), nullable=True)
+    created_at: Mapped[DateTime] = mapped_column(DateTime(timezone=True))
+    modified_at: Mapped[DateTime] = mapped_column(DateTime(timezone=True))
     # Class constructor
     def __init__(self, data):
         """

src/models/base.py

@@ -1,2 +1,4 @@
-from sqlalchemy.ext.declarative import declarative_base
-Base = declarative_base()
+from sqlalchemy.orm import Mapped, mapped_column, DeclarativeBase
+
+class Base(DeclarativeBase):
+    pass