Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix watchfiles file filtering #1770

Closed
wants to merge 2 commits into from
Closed

Fix watchfiles file filtering #1770

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d40b537
Fix watchfiles file filtering
br3ndonland Nov 20, 2022
41a0435
Remove duplicate call to `FileFilter.__call__`
br3ndonland Nov 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions tests/supervisors/test_reload.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,26 @@ def test_watchfiles_no_changes(self) -> None:

reloader.shutdown()

@pytest.mark.skipif(WatchFilesReload is None, reason="watchfiles not available")
@pytest.mark.parametrize("reloader_class", [WatchFilesReload])
def test_watchfiles_should_only_call_watch_filter_once_per_reload(
self, mocker, touch_soon
):
mock_call = mocker.patch(
"uvicorn.supervisors.watchfilesreload.FileFilter.__call__"
)
file = self.reload_path / "main.py"

with as_cwd(self.reload_path):
config = Config(app="tests.test_config:asgi_app", reload=True)
reloader = self._setup_reloader(config)

self._reload_tester(touch_soon, reloader, file)

mock_call.assert_called_once()

reloader.shutdown()

@pytest.mark.parametrize("reloader_class", [WatchGodReload])
def test_should_detect_new_reload_dirs(
self, touch_soon, caplog: pytest.LogCaptureFixture, tmp_path: Path
Expand Down
9 changes: 5 additions & 4 deletions uvicorn/supervisors/watchfilesreload.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from socket import socket
from typing import Callable, List, Optional

from watchfiles import watch
from watchfiles import Change, watch

from uvicorn.config import Config
from uvicorn.supervisors.basereload import BaseReload
Expand Down Expand Up @@ -40,7 +40,8 @@ def __init__(self, config: Config):
self.excludes.append(e)
self.excludes = list(set(self.excludes))

def __call__(self, path: Path) -> bool:
def __call__(self, change: Change, path_string: str) -> bool:
path = Path(path_string)
for include_pattern in self.includes:
if path.match(include_pattern):
for exclude_dir in self.exclude_dirs:
Expand Down Expand Up @@ -74,7 +75,7 @@ def __init__(
self.watch_filter = FileFilter(config)
self.watcher = watch(
*self.reload_dirs,
watch_filter=None,
watch_filter=self.watch_filter,
stop_event=self.should_exit,
# using yield_on_timeout here mostly to make sure tests don't
# hang forever, won't affect the class's behavior
Expand All @@ -85,5 +86,5 @@ def should_restart(self) -> Optional[List[Path]]:
changes = next(self.watcher)
if changes:
unique_paths = {Path(c[1]) for c in changes}
return [p for p in unique_paths if self.watch_filter(p)]
return [p for p in unique_paths]
return None