switch from watchgod to watchfiles

python-arq · samuelcolvin · Aug 23, 2022 · Aug 23, 2022 · Aug 23, 2022 · 1d469526621aa9216b4792ae5c9fd3ca2a0cda86
commit 1d469526621aa9216b4792ae5c9fd3ca2a0cda86
diff --git a/arq/cli.py b/arq/cli.py
@@ -56,9 +56,9 @@ def cli(*, worker_settings: str, burst: bool, check: bool, watch: str, verbose:
 
 async def watch_reload(path: str, worker_settings: 'WorkerSettingsType') -> None:
     try:
-        from watchgod import awatch
+        from watchfiles import awatch
     except ImportError as e:  # pragma: no cover
-        raise ImportError('watchgod not installed, use `pip install watchgod`') from e
+        raise ImportError('watchfiles not installed, use `pip install watchfiles`') from e
 
     loop = asyncio.get_event_loop()
     stop_event = asyncio.Event()

diff --git a/docs/index.rst b/docs/index.rst
@@ -105,7 +105,7 @@ You can also watch for changes and reload the worker when the source changes::
 
     arq demo.WorkerSettings --watch path/to/src
 
-This requires watchgod_ to be installed (``pip install watchgod``).
+This requires watchfiles_ to be installed (``pip install watchfiles``).
 
 For details on the *arq* CLI::
 
@@ -268,5 +268,5 @@ Reference
 .. |license| image:: https://img.shields.io/pypi/l/arq.svg
    :target: https://github.com/samuelcolvin/arq
 .. _asyncio: https://docs.python.org/3/library/asyncio.html
-.. _watchgod: https://pypi.org/project/watchgod/
+.. _watchfiles: https://pypi.org/project/watchfiles/
 .. _rq: http://python-rq.org/
diff --git a/pyproject.toml b/pyproject.toml
@@ -54,7 +54,3 @@ disallow_untyped_defs = true
 # remaining arguments from `mypy --strict` which cause errors
 #no_implicit_optional = true
 #warn_return_any = true
-
-[[tool.mypy.overrides]]
-module = ['redis.asyncio.*',  'watchgod']
-ignore_missing_imports = true
diff --git a/requirements/setup.txt b/requirements/setup.txt
@@ -2,8 +2,10 @@
 # This file is autogenerated by pip-compile with python 3.9
 # To update, run:
 #
-#    pip-compile --output-file=requirements/setup.txt setup.py
+#    pip-compile --extra=watch --output-file=requirements/setup.txt setup.py
 #
+anyio==3.6.1
+    # via watchfiles
 async-timeout==4.0.2
     # via redis
 click==8.1.3
@@ -12,6 +14,8 @@ deprecated==1.2.13
     # via redis
 hiredis==2.0.0
     # via redis
+idna==3.3
+    # via anyio
 packaging==21.3
     # via redis
 pydantic==1.9.2
@@ -20,9 +24,13 @@ pyparsing==3.0.9
     # via packaging
 redis[hiredis]==4.2.2
     # via arq (setup.py)
+sniffio==1.2.0
+    # via anyio
 typing-extensions==4.3.0
     # via
     #   arq (setup.py)
     #   pydantic
+watchfiles==0.16.1
+    # via arq (setup.py)
 wrapt==1.14.1
     # via deprecated
diff --git a/setup.py b/setup.py
@@ -62,6 +62,6 @@
         'typing-extensions>=4.1.0,<5.0.0',
     ],
     extras_require={
-        'watch': ['watchgod>=0.8,<0.9'],
+        'watch': ['watchfiles<=1'],
     }
 )
diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -40,9 +40,8 @@ async def mock_awatch():
     yield [1]
 
 
-@pytest.mark.filterwarnings('ignore::DeprecationWarning')
 def test_run_watch(mocker, cancel_remaining_task):
-    mocker.patch('watchgod.awatch', return_value=mock_awatch())
+    mocker.patch('watchfiles.awatch', return_value=mock_awatch())
     runner = CliRunner()
     result = runner.invoke(cli, ['tests.test_cli.WorkerSettings', '--watch', 'tests'])
     assert result.exit_code == 0