File: test_events.py

package info (click to toggle)
python-watchdog 6.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 808 kB
  • sloc: python: 6,384; ansic: 609; xml: 155; makefile: 124; sh: 8
file content (220 lines) | stat: -rw-r--r-- 6,302 bytes parent folder | download
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
from __future__ import annotations

from watchdog.events import (
    EVENT_TYPE_CLOSED,
    EVENT_TYPE_CLOSED_NO_WRITE,
    EVENT_TYPE_CREATED,
    EVENT_TYPE_DELETED,
    EVENT_TYPE_MODIFIED,
    EVENT_TYPE_MOVED,
    EVENT_TYPE_OPENED,
    DirCreatedEvent,
    DirDeletedEvent,
    DirModifiedEvent,
    DirMovedEvent,
    FileClosedEvent,
    FileClosedNoWriteEvent,
    FileCreatedEvent,
    FileDeletedEvent,
    FileModifiedEvent,
    FileMovedEvent,
    FileOpenedEvent,
    FileSystemEventHandler,
)

path_1 = "/path/xyz"
path_2 = "/path/abc"


def test_file_deleted_event():
    event = FileDeletedEvent(path_1)
    assert path_1 == event.src_path
    assert event.event_type == EVENT_TYPE_DELETED
    assert not event.is_directory
    assert not event.is_synthetic


def test_file_delete_event_is_directory():
    # Inherited properties.
    event = FileDeletedEvent(path_1)
    assert not event.is_directory
    assert not event.is_synthetic


def test_file_modified_event():
    event = FileModifiedEvent(path_1)
    assert path_1 == event.src_path
    assert event.event_type == EVENT_TYPE_MODIFIED
    assert not event.is_directory
    assert not event.is_synthetic


def test_file_modified_event_is_directory():
    # Inherited Properties
    event = FileModifiedEvent(path_1)
    assert not event.is_directory
    assert not event.is_synthetic


def test_file_created_event():
    event = FileCreatedEvent(path_1)
    assert path_1 == event.src_path
    assert event.event_type == EVENT_TYPE_CREATED
    assert not event.is_directory
    assert not event.is_synthetic


def test_file_moved_event():
    event = FileMovedEvent(path_1, path_2)
    assert path_1 == event.src_path
    assert path_2 == event.dest_path
    assert event.event_type == EVENT_TYPE_MOVED
    assert not event.is_directory
    assert not event.is_synthetic


def test_file_closed_event():
    event = FileClosedEvent(path_1)
    assert path_1 == event.src_path
    assert event.event_type == EVENT_TYPE_CLOSED
    assert not event.is_directory
    assert not event.is_synthetic


def test_file_closed_no_write_event():
    event = FileClosedNoWriteEvent(path_1)
    assert path_1 == event.src_path
    assert event.event_type == EVENT_TYPE_CLOSED_NO_WRITE
    assert not event.is_directory
    assert not event.is_synthetic


def test_file_opened_event():
    event = FileOpenedEvent(path_1)
    assert path_1 == event.src_path
    assert event.event_type == EVENT_TYPE_OPENED
    assert not event.is_directory
    assert not event.is_synthetic


def test_dir_deleted_event():
    event = DirDeletedEvent(path_1)
    assert path_1 == event.src_path
    assert event.event_type == EVENT_TYPE_DELETED
    assert event.is_directory
    assert not event.is_synthetic


def test_dir_modified_event():
    event = DirModifiedEvent(path_1)
    assert path_1 == event.src_path
    assert event.event_type == EVENT_TYPE_MODIFIED
    assert event.is_directory
    assert not event.is_synthetic


def test_dir_created_event():
    event = DirCreatedEvent(path_1)
    assert path_1 == event.src_path
    assert event.event_type == EVENT_TYPE_CREATED
    assert event.is_directory
    assert not event.is_synthetic


def test_file_system_event_handler_dispatch():
    dir_del_event = DirDeletedEvent("/path/blah.py")
    file_del_event = FileDeletedEvent("/path/blah.txt")
    dir_cre_event = DirCreatedEvent("/path/blah.py")
    file_cre_event = FileCreatedEvent("/path/blah.txt")
    file_cls_event = FileClosedEvent("/path/blah.txt")
    file_cls_nw_event = FileClosedNoWriteEvent("/path/blah.txt")
    file_opened_event = FileOpenedEvent("/path/blah.txt")
    dir_mod_event = DirModifiedEvent("/path/blah.py")
    file_mod_event = FileModifiedEvent("/path/blah.txt")
    dir_mov_event = DirMovedEvent("/path/blah.py", "/path/blah")
    file_mov_event = FileMovedEvent("/path/blah.txt", "/path/blah")

    all_events = [
        dir_mod_event,
        dir_del_event,
        dir_cre_event,
        dir_mov_event,
        file_mod_event,
        file_del_event,
        file_cre_event,
        file_mov_event,
        file_cls_event,
        file_cls_nw_event,
        file_opened_event,
    ]

    checkpoint = 0

    class TestableEventHandler(FileSystemEventHandler):
        def on_any_event(self, event):
            nonlocal checkpoint
            checkpoint += 1

        def on_modified(self, event):
            nonlocal checkpoint
            checkpoint += 1
            assert event.event_type == EVENT_TYPE_MODIFIED

        def on_deleted(self, event):
            nonlocal checkpoint
            checkpoint += 1
            assert event.event_type == EVENT_TYPE_DELETED

        def on_moved(self, event):
            nonlocal checkpoint
            checkpoint += 1
            assert event.event_type == EVENT_TYPE_MOVED

        def on_created(self, event):
            nonlocal checkpoint
            checkpoint += 1
            assert event.event_type == EVENT_TYPE_CREATED

        def on_closed(self, event):
            nonlocal checkpoint
            checkpoint += 1
            assert event.event_type == EVENT_TYPE_CLOSED

        def on_closed_no_write(self, event):
            nonlocal checkpoint
            checkpoint += 1
            assert event.event_type == EVENT_TYPE_CLOSED_NO_WRITE

        def on_opened(self, event):
            nonlocal checkpoint
            checkpoint += 1
            assert event.event_type == EVENT_TYPE_OPENED

    handler = TestableEventHandler()

    for event in all_events:
        assert not event.is_synthetic
        handler.dispatch(event)

    assert checkpoint == len(all_events) * 2  # `on_any_event()` + specific `on_XXX()`


def test_event_comparison():
    creation1 = FileCreatedEvent("foo")
    creation2 = FileCreatedEvent("foo")
    creation3 = FileCreatedEvent("bar")
    assert creation1 == creation2
    assert creation1 != creation3
    assert creation2 != creation3

    move1 = FileMovedEvent("a", "b")
    move2 = FileMovedEvent("a", "b")
    move3 = FileMovedEvent("a", "c")
    move4 = FileMovedEvent("b", "a")
    assert creation1 != move1  # type: ignore[comparison-overlap]
    assert move1 == move2
    assert move1 != move3
    assert move1 != move4
    assert move2 != move3
    assert move2 != move4
    assert move3 != move4