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
|
All classes described here are designed to be used for the `watch_filter` argument
to the [`watch`][watchfiles.watch] function and similar.
This argument requires a simple callable which takes two arguments
(the [`Change`][watchfiles.Change] type and the path as a string) and returns a boolean indicating if the change
should be included (`True`) or ignored (`False`).
As shown below in [Custom Filters](#custom-filters), you can either a `BaseFilter` subclass instance or
your own callable.
::: watchfiles.BaseFilter
rendering:
merge_init_into_class: false
::: watchfiles.DefaultFilter
::: watchfiles.PythonFilter
## Custom Filters
Here's an example of a custom filter which extends `DefaultFilter` to only notice changes to common web files:
```python
from watchfiles import Change, DefaultFilter, watch
class WebFilter(DefaultFilter):
allowed_extensions = '.html', '.css', '.js'
def __call__(self, change: Change, path: str) -> bool:
return (
super().__call__(change, path) and
path.endswith(self.allowed_extensions)
)
for changes in watch('my/web/project', watch_filter=WebFilter()):
print (changes)
```
Here's an example of a customer filter which is a simple callable that ignores changes unless they represent
a new file being created:
```py
from watchfiles import Change, watch
def only_added(change: Change, path: str) -> bool:
return change == Change.added
for changes in watch('my/project', watch_filter=only_added):
print (changes)
```
For more details, see [`filters.py`](https://github.com/samuelcolvin/watchfiles/blob/main/watchfiles/filters.py).
|
