|
| 1 | +import uuid |
| 2 | +from sqlalchemy.dialects.postgresql import UUID |
| 3 | +from sqlalchemy import Column, text |
| 4 | + |
| 5 | +try: |
| 6 | + from sqlalchemy.orm.decl_api import DeclarativeMeta |
| 7 | +except ImportError: |
| 8 | + from sqlalchemy.ext.declarative.api import DeclarativeMeta |
| 9 | + |
| 10 | +from sqlalchemy_postgresql_audit.event_listeners.sqlalchemy import ( |
| 11 | + create_audit_table as create_raw_audit_table, |
| 12 | +) |
| 13 | + |
| 14 | + |
| 15 | +default_primary_key = Column( |
| 16 | + "audit_pk", |
| 17 | + UUID(as_uuid=True), |
| 18 | + primary_key=True, |
| 19 | + default=uuid.uuid4, |
| 20 | + server_default=text("uuid_generate_v4()"), |
| 21 | +) |
| 22 | + |
| 23 | + |
| 24 | +def audit_model(_func=None, *, enabled=True, primary_key=default_primary_key, **spec): |
| 25 | + """Decorate a model to automatically enable audit modeling. |
| 26 | +
|
| 27 | + Arguments: |
| 28 | + enabled: Defaults to true, enables auditing. |
| 29 | + primary_key: Default to a uuid primary key. Can be disabled by using `None`. |
| 30 | +
|
| 31 | + By default, automatically enables the auditing in addition to hooking |
| 32 | + up the actual audit machinery. |
| 33 | +
|
| 34 | + Additionally, leaves a reference to the audit model's own sqlachemy model |
| 35 | + on the ``__audit_cls__`` attribute of the decorated class. |
| 36 | +
|
| 37 | + Examples: |
| 38 | + >>> from sqlalchemy import Column, types |
| 39 | + >>> from sqlalchemy.ext.declarative import declarative_base |
| 40 | + >>> from sqlalchemy_postgresql_audit import audit_model |
| 41 | +
|
| 42 | + >>> Base = declarative_base() |
| 43 | +
|
| 44 | + >>> @audit_model |
| 45 | + ... class Foo(Base): |
| 46 | + ... __tablename__ = 'foo' |
| 47 | + ... id = Column(types.Integer(), primary_key=True) |
| 48 | +
|
| 49 | + >>> Foo.__audit_cls__ |
| 50 | + <class '...FooAudit'> |
| 51 | +
|
| 52 | + >>> @audit_model(enabled=False) |
| 53 | + ... class Bar(Base): |
| 54 | + ... __tablename__ = 'bar' |
| 55 | + ... id = Column(types.Integer(), primary_key=True) |
| 56 | + """ |
| 57 | + |
| 58 | + def decorated(model_cls): |
| 59 | + model = create_audit_model( |
| 60 | + model_cls, enabled=enabled, primary_key=primary_key, **spec |
| 61 | + ) |
| 62 | + if model: |
| 63 | + model_cls.__audit_cls__ = model |
| 64 | + |
| 65 | + return model_cls |
| 66 | + |
| 67 | + if _func is None: |
| 68 | + return decorated |
| 69 | + return decorated(_func) |
| 70 | + |
| 71 | + |
| 72 | +def create_audit_model( |
| 73 | + model_cls, *, enabled=True, primary_key=default_primary_key, **spec |
| 74 | +): |
| 75 | + """Create an SQLAlchemy declarative Model class for the given `model_cls`. |
| 76 | +
|
| 77 | + Arguments: |
| 78 | + model_cls: The SQLAlchemy model being audited |
| 79 | + enabled: Defaults to true, enables auditing. |
| 80 | + primary_key: Default to a uuid primary key. Can be disabled by using `None`. |
| 81 | +
|
| 82 | + Examples: |
| 83 | + >>> from sqlalchemy import Column, types |
| 84 | + >>> from sqlalchemy.ext.declarative import declarative_base |
| 85 | + >>> from sqlalchemy_postgresql_audit import create_audit_model |
| 86 | +
|
| 87 | + >>> Base = declarative_base() |
| 88 | +
|
| 89 | + >>> class Foo(Base): |
| 90 | + ... __tablename__ = 'foo' |
| 91 | + ... id = Column(types.Integer(), primary_key=True) |
| 92 | +
|
| 93 | + >>> class Bar(Base): |
| 94 | + ... __tablename__ = 'bar' |
| 95 | + ... id = Column(types.Integer(), primary_key=True) |
| 96 | +
|
| 97 | + >>> class Baz(Base): |
| 98 | + ... __tablename__ = 'baz' |
| 99 | + ... id = Column(types.Integer(), primary_key=True) |
| 100 | +
|
| 101 | + >>> AuditModel = create_audit_model(Foo) |
| 102 | + >>> AuditModel3 = create_audit_model(Baz, primary_key=default_primary_key) |
| 103 | + >>> create_audit_model(Bar, enabled=False) |
| 104 | + """ |
| 105 | + base_table = model_cls.__table__ |
| 106 | + metadata = model_cls.metadata |
| 107 | + |
| 108 | + table = create_audit_table( |
| 109 | + base_table, metadata, enabled=enabled, primary_key=primary_key, **spec |
| 110 | + ) |
| 111 | + if table is None: |
| 112 | + return |
| 113 | + |
| 114 | + model_base = _find_model_base(model_cls) |
| 115 | + |
| 116 | + cls = type( |
| 117 | + "{model_cls}Audit".format(model_cls=model_cls.__name__), |
| 118 | + (model_base,), |
| 119 | + {"__table__": table}, |
| 120 | + ) |
| 121 | + |
| 122 | + return cls |
| 123 | + |
| 124 | + |
| 125 | +def create_audit_table( |
| 126 | + table, |
| 127 | + metadata, |
| 128 | + *, |
| 129 | + enabled=True, |
| 130 | + primary_key=default_primary_key, |
| 131 | + ignore_columns=(), |
| 132 | + **spec |
| 133 | +): |
| 134 | + """Create an audit SQLAlchemy ``Table`` for a given `Table` instance. |
| 135 | +
|
| 136 | + Arguments: |
| 137 | + table: The SQLAlchemy `Table` to audit. |
| 138 | + metadata: The `SQLAlchemy` metadata on which to attach the table. |
| 139 | + enabled: Defaults to true, enables auditing. |
| 140 | + primary_key: Default to a uuid primary key. Can be disabled by using `None`. |
| 141 | + spec: Optional auditing spec options. |
| 142 | +
|
| 143 | + Examples: |
| 144 | + >>> from sqlalchemy import MetaData, Table |
| 145 | + >>> from sqlalchemy_postgresql_audit import create_audit_table |
| 146 | +
|
| 147 | + >>> meta = MetaData() |
| 148 | +
|
| 149 | + >>> foo_table = Table('foo', meta) |
| 150 | + >>> audit_table1 = create_audit_table(foo_table, meta) |
| 151 | +
|
| 152 | + >>> baz_table = Table('baz', meta) |
| 153 | + >>> audit_table3 = create_audit_table(baz_table, meta, primary_key=None) |
| 154 | +
|
| 155 | + >>> bar_table = Table('bar', meta) |
| 156 | + >>> create_audit_table(bar_table, meta, enabled=False) |
| 157 | + """ |
| 158 | + existing_info = table.info |
| 159 | + existing_info["audit.options"] = {"enabled": enabled, **spec} |
| 160 | + |
| 161 | + return create_raw_audit_table( |
| 162 | + table, |
| 163 | + metadata, |
| 164 | + primary_key=primary_key, |
| 165 | + ignore_columns=ignore_columns, |
| 166 | + ) |
| 167 | + |
| 168 | + |
| 169 | +def _find_model_base(model_cls): |
| 170 | + for cls in model_cls.__mro__: |
| 171 | + if isinstance(cls, DeclarativeMeta) and not hasattr(cls, "__mapper__"): |
| 172 | + return cls |
| 173 | + |
| 174 | + raise ValueError("Invalid model, does not subclass a `DeclarativeMeta`.") |
0 commit comments