mirror of
https://github.com/enpaul/peewee-plus.git
synced 2024-11-14 18:46:47 +00:00
Add flat transaction decorator function
This commit is contained in:
parent
af7d420267
commit
b8a684cec7
@ -12,7 +12,9 @@
|
|||||||
|
|
||||||
.. _`Peewee documentation`: http://docs.peewee-orm.com/en/latest/peewee/database.html#recommended-settings
|
.. _`Peewee documentation`: http://docs.peewee-orm.com/en/latest/peewee/database.html#recommended-settings
|
||||||
"""
|
"""
|
||||||
|
import contextlib
|
||||||
import enum
|
import enum
|
||||||
|
import functools
|
||||||
import json
|
import json
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any
|
from typing import Any
|
||||||
@ -42,6 +44,7 @@ __all__ = [
|
|||||||
"__authors__",
|
"__authors__",
|
||||||
"calc_batch_size",
|
"calc_batch_size",
|
||||||
"EnumField",
|
"EnumField",
|
||||||
|
"flat_transaction",
|
||||||
"JSONField",
|
"JSONField",
|
||||||
"PathField",
|
"PathField",
|
||||||
"PrecisionFloatField",
|
"PrecisionFloatField",
|
||||||
@ -131,6 +134,48 @@ def calc_batch_size(
|
|||||||
return len(models)
|
return len(models)
|
||||||
|
|
||||||
|
|
||||||
|
def flat_transaction(interface: peewee.Database):
|
||||||
|
"""Database transaction wrapper that avoids nested transactions
|
||||||
|
|
||||||
|
A decorator that can be used to decorate functions or methods so that the entire callable
|
||||||
|
is executed in a single transaction context. If a transaction is already open then it will
|
||||||
|
be reused rather than opening a nested transaction.
|
||||||
|
|
||||||
|
Example usage:
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
db = peewee.SqliteDatabase("test.db")
|
||||||
|
|
||||||
|
|
||||||
|
@flat_transaction(db)
|
||||||
|
def subquery():
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
|
@flat_transaction(db)
|
||||||
|
def my_query():
|
||||||
|
...
|
||||||
|
subquery()
|
||||||
|
|
||||||
|
|
||||||
|
# This call opens only a single transaction
|
||||||
|
my_query()
|
||||||
|
|
||||||
|
:param interface: Peewee database interface that should be used to open the transaction
|
||||||
|
"""
|
||||||
|
|
||||||
|
def outer(func):
|
||||||
|
@functools.wraps(func)
|
||||||
|
def inner(*args, **kwargs):
|
||||||
|
with interface.atomic() if not interface.in_transaction() else contextlib.nullcontext():
|
||||||
|
return func(*args, **kwargs)
|
||||||
|
|
||||||
|
return inner
|
||||||
|
|
||||||
|
return outer
|
||||||
|
|
||||||
|
|
||||||
class PathField(peewee.CharField):
|
class PathField(peewee.CharField):
|
||||||
"""Field class for storing file paths
|
"""Field class for storing file paths
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user