pinnwand: use aware datetime objects

Deprecation warnings are being emitted about using `datetime.utcnow` and
to replace those with `datetime.now(timezone.utc)`. This creates a
timezone aware datetime object hence we now need to get datetime aware
objects from the database as well.

This seems to a bit annoying in (for example SQLite) for the backend.

We use a 3rd-party package to provide us with an `UtcDateTime` type for
SQLAlchemy to fix this.

Signed-off-by: Simon de Vlieger <[email protected]>

CHANGELOG.rst

@@ -8,6 +8,8 @@ v1.6.1 (unreleased)
 *******************
 * Removed the default indentation from pastes. It now only applies to configured 
   languages again. Opened a public discussion about this behavior.
+* Switched to timezone-aware objects in the databse to squash deprecation
+  warnings.
 
 v1.6.0 (20241101)
 *******************

pyproject.toml

@@ -15,6 +15,7 @@ dependencies = [
     "token-bucket>=0.3.0",
     "tomli>=2.0.1",
     "python-dotenv>=1.0.1",
+    "sqlalchemy-utc>=0.14.0",
 ]
 requires-python = ">=3.8"
 readme = "README.md"

src/pinnwand/database/models.py

@@ -1,12 +1,11 @@
 import datetime
-from datetime import timedelta
+from datetime import timedelta, timezone
 from typing import Optional
 
 import pygments.lexers
 from pygments_better_html import BetterHtmlFormatter
 from sqlalchemy import (
     Column,
-    DateTime,
     ForeignKey,
     Integer,
     String,
@@ -18,6 +17,8 @@
     relationship,
 )
 
+from sqlalchemy_utc import UtcDateTime
+
 from pinnwand import defensive, error, logger, utility
 from pinnwand.configuration import Configuration, ConfigurationProvider
 
@@ -42,15 +43,15 @@ def __tablename__(cls) -> str:  # pylint: disable=no-self-argument
 class Paste(Base):  # type: ignore
     """The Paste model represents a single Paste."""
 
-    pub_date = Column(DateTime)
-    chg_date = Column(DateTime)
+    pub_date = Column(UtcDateTime)
+    chg_date = Column(UtcDateTime)
 
     slug = Column(String(250), unique=True)
     removal = Column(String(250), unique=True)
 
     src = Column(String(250))
 
-    exp_date = Column(DateTime)
+    exp_date = Column(UtcDateTime)
 
     files = relationship("File", cascade="all,delete", backref="paste")
 
@@ -66,8 +67,8 @@ def __init__(
         self.slug = slug
         self.removal = utility.slug_create(auto_scale=False)
 
-        self.pub_date = datetime.datetime.utcnow()
-        self.chg_date = datetime.datetime.utcnow()
+        self.pub_date = datetime.datetime.now(timezone.utc)
+        self.chg_date = datetime.datetime.now(timezone.utc)
 
         self.src = src
 
@@ -82,8 +83,8 @@ class File(Base):  # type: ignore
     paste_id = Column(ForeignKey("paste.id"))
     slug = Column(String(255), unique=True)
 
-    pub_date = Column(DateTime)
-    chg_date = Column(DateTime)
+    pub_date = Column(UtcDateTime)
+    chg_date = Column(UtcDateTime)
 
     lexer = Column(String(250))
 
@@ -110,8 +111,8 @@ def __init__(
                 f"Text exceeds size limit {configuration.paste_size//1024} (kB)"
             )
 
-        self.pub_date = datetime.datetime.utcnow()
-        self.chg_date = datetime.datetime.utcnow()
+        self.pub_date = datetime.datetime.now(timezone.utc)
+        self.chg_date = datetime.datetime.now(timezone.utc)
 
         self.raw = raw
 

src/pinnwand/handler/api_deprecated.py

@@ -1,5 +1,5 @@
 import json
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from typing import Any
 from urllib.parse import urljoin
 
@@ -87,7 +87,7 @@ async def get(self, slug: str) -> None:  # type: ignore
             if not paste:
                 raise tornado.web.HTTPError(404)
 
-            if paste.exp_date < datetime.utcnow():
+            if paste.exp_date < datetime.now(timezone.utc):
                 session.delete(paste)
                 session.commit()
 

src/pinnwand/handler/api_v1.py

@@ -1,5 +1,5 @@
 import json
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from typing import Any
 from urllib.parse import urljoin
 
@@ -136,7 +136,7 @@ async def get(self, slug: str) -> None:
             if not paste:
                 raise tornado.web.HTTPError(404)
 
-            if paste.exp_date < datetime.utcnow():
+            if paste.exp_date < datetime.now(timezone.utc):
                 session.delete(paste)
                 session.commit()
 

src/pinnwand/handler/website.py

@@ -1,7 +1,7 @@
 import binascii
 import io
 import zipfile
-from datetime import datetime
+from datetime import datetime, timezone
 from typing import Any
 
 import docutils.core
@@ -307,7 +307,7 @@ async def get(self, slug: str) -> None:  # type: ignore
             if not paste:
                 raise tornado.web.HTTPError(404)
 
-            if paste.exp_date < datetime.utcnow():
+            if paste.exp_date < datetime.now(timezone.utc):
                 session.delete(paste)
                 session.commit()
 
@@ -344,7 +344,7 @@ async def get(self, slug: str) -> None:  # type: ignore
             if not paste:
                 raise tornado.web.HTTPError(404)
 
-            if paste.exp_date < datetime.utcnow():
+            if paste.exp_date < datetime.now(timezone.utc):
                 session.delete(paste)
                 session.commit()
 
@@ -374,7 +374,7 @@ async def get(self, file_id: str) -> None:  # type: ignore
             if not file:
                 raise tornado.web.HTTPError(404)
 
-            if file.paste.exp_date < datetime.utcnow():
+            if file.paste.exp_date < datetime.now(timezone.utc):
                 session.delete(file.paste)
                 session.commit()
 
@@ -405,7 +405,7 @@ async def get(self, file_id: str) -> None:  # type: ignore
             if not file:
                 raise tornado.web.HTTPError(404)
 
-            if file.paste.exp_date < datetime.utcnow():
+            if file.paste.exp_date < datetime.now(timezone.utc):
                 session.delete(file.paste)
                 session.commit()
 
@@ -436,7 +436,7 @@ async def get(self, paste_id: str) -> None:  # type: ignore
             if not paste:
                 raise tornado.web.HTTPError(404)
 
-            if paste.exp_date < datetime.utcnow():
+            if paste.exp_date < datetime.now(timezone.utc):
                 session.delete(paste)
                 session.commit()
 
@@ -483,7 +483,7 @@ async def get(self, file_id: str) -> None:  # type: ignore
             if not file:
                 raise tornado.web.HTTPError(404)
 
-            if file.paste.exp_date < datetime.utcnow():
+            if file.paste.exp_date < datetime.now(timezone.utc):
                 session.delete(file.paste)
                 session.commit()
 
@@ -527,7 +527,7 @@ async def get(self, removal: str) -> None:  # type: ignore
                 log.info("RemovePaste.get: someone visited with invalid id")
                 raise tornado.web.HTTPError(404)
 
-            if paste.exp_date < datetime.utcnow():
+            if paste.exp_date < datetime.now(timezone.utc):
                 session.delete(paste)
                 session.commit()
 

src/pinnwand/utility.py

@@ -1,7 +1,7 @@
 import math
 import re
 from base64 import b32encode
-from datetime import datetime
+from datetime import datetime, timezone
 from os import urandom
 from typing import Any, Dict, List, Optional
 
@@ -192,7 +192,7 @@ def reap() -> None:
     with manager.DatabaseManager.get_session() as session:
         pastes = (
             session.query(models.Paste)
-            .filter(models.Paste.exp_date < datetime.utcnow())
+            .filter(models.Paste.exp_date < datetime.now(timezone.utc))
             .all()
         )
 

test/e2e/pinnwand.toml

@@ -1,5 +1,5 @@
-database_uri = "sqlite:///C:\\Users\\shtlrs\\AppData\\Local\\Temp\\tmpvb8tgs72"
-reaping_periodicity = 2000 # in milliseconds
+database_uri = "sqlite:////tmp/tmp5r3kq5tn"
+reaping_periodicity = 2000
 
 [ratelimit.read]
 capacity = 200