1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
# Event-based actions
You can register methods as pre- or post- actions for document events.
Currently supported events:
- Save
- Insert
- Replace
- Update
- SaveChanges
- Delete
- ValidateOnSave
Currently supported directions:
- `Before`
- `After`
Current operations creating events:
- `insert()` for Insert
- `replace()` for Replace
- `save()` for Save and triggers Insert if it is creating a new document, or triggers Replace if it replaces an existing document
- `save_changes()` for SaveChanges
- `insert()`, `replace()`, `save_changes()`, and `save()` for ValidateOnSave
- `set()`, `update()` for Update
- `delete()` for Delete
To register an action, you can use `@before_event` and `@after_event` decorators respectively:
```python
from beanie import Insert, Replace, before_event, after_event
class Sample(Document):
num: int
name: str
@before_event(Insert)
def capitalize_name(self):
self.name = self.name.capitalize()
@after_event(Replace)
def num_change(self):
self.num -= 1
```
It is possible to register action for several events:
```python
from beanie import Insert, Replace, before_event
class Sample(Document):
num: int
name: str
@before_event(Insert, Replace)
def capitalize_name(self):
self.name = self.name.capitalize()
```
This will capitalize the `name` field value before each document's Insert and Replace.
And sync and async methods could work as actions.
```python
from beanie import Insert, Replace, after_event
class Sample(Document):
num: int
name: str
@after_event(Insert, Replace)
async def send_callback(self):
await client.send(self.id)
```
Actions can be selectively skipped by passing the `skip_actions` argument when calling
the operations that trigger events. `skip_actions` accepts a list of directions and action names.
```python
from beanie import After, Before, Insert, Replace, before_event, after_event
class Sample(Document):
num: int
name: str
@before_event(Insert)
def capitalize_name(self):
self.name = self.name.capitalize()
@before_event(Replace)
def redact_name(self):
self.name = "[REDACTED]"
@after_event(Replace)
def num_change(self):
self.num -= 1
sample = Sample()
# capitalize_name will not be executed
await sample.insert(skip_actions=['capitalize_name'])
# num_change will not be executed
await sample.replace(skip_actions=[After])
# redact_name and num_change will not be executed
await sample.replace(skip_actions[Before, 'num_change'])
```
|
