Replace watchgod library with watchfiles

RELEASE.md

@@ -16,6 +16,7 @@ Please follow the established format:
 
 - Improve `kedro viz build` usage documentation (#2126)
 - Fix unserializable parameters value (#2122)
+- Replace `watchgod` library with `watchfiles` (#2134)
 
 
 # Release 10.0.0

package/features/steps/lower_requirements.txt

@@ -3,7 +3,7 @@ fastapi==0.100.0
 fsspec==2021.4
 aiofiles==22.1.0
 uvicorn[standard]==0.22.0
-watchgod==0.8.2
+watchfiles==0.24.0
 plotly==4.8
 packaging==23.0
 pandas==1.3; python_version < '3.10'

package/kedro_viz/launchers/cli/run.py

@@ -9,6 +9,7 @@
 
 from kedro_viz.constants import DEFAULT_HOST, DEFAULT_PORT
 from kedro_viz.launchers.cli.main import viz
+from kedro_viz.utils import file_extension_filter
 
 _VIZ_PROCESSES: Dict[str, int] = {}
 
@@ -164,17 +165,19 @@ def run(
             "is_lite": lite,
         }
         if autoreload:
-            from watchgod import RegExpWatcher, run_process
+            from watchfiles import run_process
 
+            run_process_args = [str(kedro_project_path)]
             run_process_kwargs = {
-                "path": kedro_project_path,
                 "target": run_server,
                 "kwargs": run_server_kwargs,
-                "watcher_cls": RegExpWatcher,
-                "watcher_kwargs": {"re_files": r"^.*(\.yml|\.yaml|\.py|\.json)$"},
+                "watch_filter": file_extension_filter,
             }
             viz_process = multiprocessing.Process(
-                target=run_process, daemon=False, kwargs={**run_process_kwargs}
+                target=run_process,
+                daemon=False,
+                args=run_process_args,
+                kwargs={**run_process_kwargs},
             )
         else:
             viz_process = multiprocessing.Process(

package/kedro_viz/launchers/jupyter.py

@@ -14,10 +14,11 @@
 import IPython
 from IPython.display import HTML, display
 from kedro.framework.project import PACKAGE_NAME
-from watchgod import RegExpWatcher, run_process
+from watchfiles import run_process
 
 from kedro_viz.launchers.utils import _check_viz_up, _wait_for
 from kedro_viz.server import DEFAULT_HOST, DEFAULT_PORT, run_server
+from kedro_viz.utils import file_extension_filter
 
 _VIZ_PROCESSES: Dict[str, int] = {}
 _DATABRICKS_HOST = "0.0.0.0"
@@ -148,15 +149,17 @@ def run_viz(  # pylint: disable=too-many-locals
     }
     process_context = multiprocessing.get_context("spawn")
     if autoreload:
+        run_process_args = [str(project_path)]
         run_process_kwargs = {
-            "path": project_path,
             "target": run_server,
             "kwargs": run_server_kwargs,
-            "watcher_cls": RegExpWatcher,
-            "watcher_kwargs": {"re_files": r"^.*(\.yml|\.yaml|\.py|\.json)$"},
+            "watch_filter": file_extension_filter,
         }
         viz_process = process_context.Process(
-            target=run_process, daemon=False, kwargs={**run_process_kwargs}
+            target=run_process,
+            daemon=False,
+            args=run_process_args,
+            kwargs={**run_process_kwargs},
         )
     else:
         viz_process = process_context.Process(

package/kedro_viz/server.py

@@ -15,6 +15,7 @@
 from kedro_viz.integrations.kedro import data_loader as kedro_data_loader
 from kedro_viz.integrations.kedro.sqlite_store import SQLiteStore
 from kedro_viz.launchers.utils import _check_viz_up, _wait_for
+from kedro_viz.utils import file_extension_filter
 
 DEV_PORT = 4142
 
@@ -142,7 +143,7 @@ def run_server(
     import argparse
     import multiprocessing
 
-    from watchgod import RegExpWatcher, run_process
+    from watchfiles import run_process
 
     parser = argparse.ArgumentParser(description="Launch a development viz server")
     parser.add_argument("project_path", help="Path to a Kedro project")
@@ -156,20 +157,22 @@ def run_server(
 
     project_path = (Path.cwd() / args.project_path).absolute()
 
+    run_process_args = [str(project_path)]
     run_process_kwargs = {
-        "path": project_path,
         "target": run_server,
         "kwargs": {
             "host": args.host,
             "port": args.port,
             "project_path": str(project_path),
         },
-        "watcher_cls": RegExpWatcher,
-        "watcher_kwargs": {"re_files": r"^.*(\.yml|\.yaml|\.py|\.json)$"},
+        "watch_filter": file_extension_filter,
     }
 
     viz_process = multiprocessing.Process(
-        target=run_process, daemon=False, kwargs={**run_process_kwargs}
+        target=run_process,
+        daemon=False,
+        args=run_process_args,
+        kwargs={**run_process_kwargs},
     )
 
     print("Starting Kedro Viz ...")

package/kedro_viz/utils.py

@@ -57,3 +57,8 @@ def _strip_transcoding(element: str) -> str:
 def is_dataset_param(dataset_name: str) -> bool:
     """Return whether a dataset is a parameter"""
     return dataset_name.lower().startswith("params:") or dataset_name == "parameters"
+
+
+def file_extension_filter(_, file_path: str) -> bool:
+    """Determine if a given file path ends with one of the specified extensions."""
+    return file_path.endswith((".yml", ".yaml", ".py", ".json"))

package/requirements.txt

@@ -15,4 +15,4 @@ secure>=0.3.0
 sqlalchemy>=1.4, <3
 strawberry-graphql>=0.192.0, <1.0
 uvicorn[standard]>=0.30.0, <1.0
-watchgod>=0.8.2, <1.0
+watchfiles>=0.24.0

package/tests/test_launchers/test_cli/test_run.py

@@ -4,13 +4,14 @@
 import requests
 from click.testing import CliRunner
 from packaging.version import parse
-from watchgod import RegExpWatcher, run_process
+from watchfiles import run_process
 
 from kedro_viz import __version__
 from kedro_viz.launchers.cli import main
 from kedro_viz.launchers.cli.run import _VIZ_PROCESSES
 from kedro_viz.launchers.utils import _PYPROJECT
 from kedro_viz.server import run_server
+from kedro_viz.utils import file_extension_filter
 
 
 @pytest.fixture
@@ -357,8 +358,8 @@ def test_kedro_viz_command_with_autoreload(
         with runner.isolated_filesystem():
             runner.invoke(main.viz_cli, ["viz", "run", "--autoreload"])
 
+        run_process_args = [str(mock_project_path)]
         run_process_kwargs = {
-            "path": mock_project_path,
             "target": run_server,
             "kwargs": {
                 "host": "127.0.0.1",
@@ -374,11 +375,13 @@ def test_kedro_viz_command_with_autoreload(
                 "extra_params": {},
                 "is_lite": False,
             },
-            "watcher_cls": RegExpWatcher,
-            "watcher_kwargs": {"re_files": "^.*(\\.yml|\\.yaml|\\.py|\\.json)$"},
+            "watch_filter": file_extension_filter,
         }
 
         process_init.assert_called_once_with(
-            target=run_process, daemon=False, kwargs={**run_process_kwargs}
+            target=run_process,
+            daemon=False,
+            args=run_process_args,
+            kwargs={**run_process_kwargs},
         )
         assert run_process_kwargs["kwargs"]["port"] in _VIZ_PROCESSES

package/tests/test_launchers/test_jupyter.py

@@ -140,6 +140,7 @@ def test_run_viz_with_autoreload(self, mocker, patched_check_viz_up):
         mock_process.assert_called_once_with(
             target=mocker.ANY,
             daemon=False,  # No daemon for autoreload
+            args=mocker.ANY,
             kwargs=mocker.ANY,
         )
 

package/tests/test_utils.py

@@ -0,0 +1,19 @@
+import pytest
+
+from kedro_viz.utils import file_extension_filter
+
+
+@pytest.mark.parametrize(
+    "file_path, expected",
+    [
+        ("config.yml", True),
+        ("config.yaml", True),
+        ("script.py", True),
+        ("data.json", True),
+        ("image.png", False),
+        ("document.txt", False),
+        ("archive.zip", False),
+    ],
+)
+def test_file_extension_filter(file_path, expected):
+    assert file_extension_filter(None, file_path) == expected