Merge c1920a1 into 05f2cf4

Author: DanCardin

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## 0.15
 
+### 0.15.5
+
+- fix: Dont set `None` audit "context values".
+
 ### 0.15.4
 
 - fix: Undo accidental inclusion of alembic as required dependencies.

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sqlalchemy-declarative-extensions"
-version = "0.15.4"
+version = "0.15.5"
 authors = [
     {name = "Dan Cardin", email = "ddcardin@gmail.com"},
 ]

src/sqlalchemy_declarative_extensions/audit.py

@@ -296,6 +296,9 @@ def create_audit_triggers(
 def set_context_values(connectable, **values):
     """Set transaction-local context values, to be included on audit-tables."""
     for name, value in values.items():
+        if value is None:
+            continue
+
         statement = f"SET LOCAL audit.{name} = '{value}'"
         connectable.execute(text(statement))
 

tests/audit/test_context_values.py

@@ -19,7 +19,10 @@ class Base(_Base):  # type: ignore  # type: ignore
     __abstract__ = True
 
 
-context_columns = [Column("username", types.Unicode(), nullable=False)]
+context_columns = [
+    Column("username", types.Unicode(), nullable=False),
+    Column("nickname", types.Unicode(), nullable=True),
+]
 
 
 @audit(context_columns=context_columns)
@@ -48,6 +51,19 @@ def test_sets_session_values(pg):
     assert audit_row.audit_username == "foo@foo.com"
 
 
+def test_sets_session_value_to_none(pg):
+    Base.metadata.create_all(bind=pg.connection())
+    pg.commit()
+
+    set_context_values(pg, username="foo@foo.com", nickname=None)
+    pg.add(Foo(id=1, name=None, json=None))
+    pg.commit()
+
+    audit_row = pg.execute(Foo.__audit_table__.select()).fetchone()
+    assert audit_row.audit_username == "foo@foo.com"
+    assert audit_row.audit_nickname is None
+
+
 def test_fails_to_set_session_values(pg):
     Base.metadata.create_all(bind=pg.connection())
     pg.commit()