added CreatedDateTimeBase, renamed column, edited migration

tested migration manually
This commit is contained in:
Viet Than 2023-07-14 22:02:58 -04:00
parent 2fe05d07f7
commit 2d3120f0a7
3 changed files with 88 additions and 11 deletions

View file

@ -1,9 +1,10 @@
import time
from datetime import datetime, timedelta, timezone
from sqlalchemy import text
from sqlalchemy.orm import declarative_base, declared_attr
from sqlalchemy.schema import Column
from sqlalchemy.sql.sqltypes import Integer
from sqlalchemy.sql.sqltypes import Integer, DateTime
from files.helpers.time import format_age, format_datetime
@ -45,3 +46,80 @@ class CreatedBase(Base):
@property
def age_string(self) -> str:
return format_age(self.created_utc)
class CreatedDateTimeBase(Base):
"""
An abstract class extending our default SQLAlchemy's `Base`.
All classes inherit from this class automatically maps a `created_datetimez` column
for the corresponding SQL table. This column will automatically record the created
timestamp of rows. Retrieving `created_datetimez` will return a `datetime` object with
`tzinfo` of UTC.
This class holds various convenience properties to get `created_datetimez` in different
formats.
"""
__abstract__ = True
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
@declared_attr
def created_datetimez(self):
"""
Retrieving `created_datetimez` will return a `datetime` object with `tzinfo` for UTC.
"""
return Column(DateTime(timezone=True), nullable=False, server_default=text("now()"))
@property
def created_utc(self):
"""
the created date in UTC seconds. Milliseconds are truncated/rounded down.
"""
return int(self.created_datetimez.timestamp())
@property
def created_date(self) -> str:
"""
the created date in string.
See `file.helpers.time.DATETIME_FORMAT` for the exact format
Note: should this be using `format_date` and not `format_datetime`?
"""
return self.created_datetime
@property
def created_datetime(self) -> str:
"""
the created datetime in string.
See `file.helpers.time.DATETIME_FORMAT` for the exact format.
"""
return format_datetime(self.created_datetimez)
@property
def created_datetime_py(self) -> datetime:
"""
the created datetime as a `datetime` object with `tzinfo` of UTC.
"""
return self.created_datetimez
@property
def age_seconds(self) -> int:
"""
number of seconds since created.
"""
return time.time() - self.created_utc
@property
def age_timedelta(self) -> timedelta:
"""
a `timedelta` object representing time since created.
"""
return datetime.now(tz=timezone.utc) - self.created_datetimez
@property
def age_string(self) -> str:
"""
a string representing time since created. Example: "1h ago", "2d ago".
"""
return format_age(self.created_datetimez)

View file

@ -1,6 +1,6 @@
from sqlalchemy import *
from sqlalchemy.orm import relationship
from files.classes.base import CreatedBase, Base
from files.classes.base import CreatedBase, CreatedDateTimeBase, Base
from files.helpers.lazy import lazy
from files.helpers.config.const import *
@ -26,15 +26,14 @@ class Flag(CreatedBase):
return self.reason
class CommentFlag(Base):
class CommentFlag(CreatedDateTimeBase):
__tablename__ = "commentflags"
id = Column(Integer, primary_key=True)
comment_id = Column(Integer, ForeignKey("comments.id"), nullable=False)
user_id = Column(Integer, ForeignKey("users.id"), nullable=False)
reason = Column(String)
created_timestampz = Column(TIMESTAMP(timezone=True), nullable=False, server_default=text("now()"))
Index('cflag_user_idx', user_id)
user = relationship("User", primaryjoin = "CommentFlag.user_id == User.id", uselist = False, viewonly=True)

View file

@ -1,4 +1,4 @@
"""Change created_utc to timestampz for commentflags
"""Change created_utc to datetimez for commentflags
Revision ID: 7ae4658467d7
Revises: ea282d7c711c
@ -17,17 +17,17 @@ depends_on = None
def upgrade():
op.add_column('commentflags', sa.Column('created_timestampz', sa.TIMESTAMP(timezone=True), nullable=False, server_default=sa.text('NOW()')))
op.add_column('commentflags', sa.Column('created_datetimez', sa.DateTime(timezone=True), nullable=True, server_default=sa.text('NOW()')))
op.execute("""
UPDATE commentflags
SET created_timestampz =
SET created_datetimez =
CASE
WHEN created_utc > 0 THEN
(timestamp 'epoch' + created_utc * interval '1 second') at time zone 'utc'
ELSE NULL
END
""")
op.alter_column('commentflags', 'created_datetimez', nullable=False)
op.drop_column('commentflags', 'created_utc')
@ -37,9 +37,9 @@ def downgrade():
UPDATE commentflags
SET created_utc =
COALESCE(
EXTRACT(EPOCH FROM created_timestampz)::integer,
EXTRACT(EPOCH FROM created_datetimez)::integer,
0
)
""")
op.alter_column('commentflags', 'created_utc', nullable=False)
op.drop_column('commentflags', 'created_timestampz')
op.drop_column('commentflags', 'created_datetimez')