Feature: Change reload to be configurable with glob patterns

docs/deployment.md

@@ -37,6 +37,13 @@ Options:
   --reload                        Enable auto-reload.
   --reload-dir PATH               Set reload directories explicitly, instead
                                   of using the current working directory.
+  --reload-include TEXT           Set glob patterns to include while watching
+                                  for files. Includes '*.py' by default, which
+                                  can be overridden in reload-excludes.
+  --reload-exclude TEXT           Set glob patterns to exclude while watching
+                                  for files. Includes '.*, .py[cod], .sw.*,
+                                  ~*' by default, which can be overridden in
+                                  reload-excludes.
   --reload-delay FLOAT            Delay between previous and next check if
                                   application needs to be. Defaults to 0.25s.
                                   [default: 0.25]

docs/index.md

@@ -110,6 +110,13 @@ Options:
   --reload                        Enable auto-reload.
   --reload-dir PATH               Set reload directories explicitly, instead
                                   of using the current working directory.
+  --reload-include TEXT           Set glob patterns to include while watching
+                                  for files. Includes '*.py' by default, which
+                                  can be overridden in reload-excludes.
+  --reload-exclude TEXT           Set glob patterns to exclude while watching
+                                  for files. Includes '.*, .py[cod], .sw.*,
+                                  ~*' by default, which can be overridden in
+                                  reload-excludes.
   --reload-delay FLOAT            Delay between previous and next check if
                                   application needs to be. Defaults to 0.25s.
                                   [default: 0.25]

docs/settings.md

@@ -22,7 +22,14 @@ you should put `uvicorn.run` into `if __name__ == '__main__'` clause in the main
 ## Development
 
 * `--reload` - Enable auto-reload.
-* `--reload-dir <path>` - Specify which directories to watch for python file changes. May be used multiple times. If unused, then by default all directories in current directory will be watched. If you are running programmatically use `reload_dirs=[]` and pass a list of strings.
+* `--reload-dir <path>` - Specify which directories to watch for python file changes. May be used multiple times. If unused, then by default the whole current directory will be watched. If you are running programmatically use `reload_dirs=[]` and pass a list of strings.
+* `--reload-include <glob-pattern>` - Specify a glob pattern to match files or directories which will be watched. May be used multiple times. By default the following patterns are included: `*.py`. These can be overwritten by explicitly excluding them.
+* `--reload-exclude <glob-pattern>` - Specify a glob pattern to match files or directories which will excluded from watching. May be used multiple times. By default the following patterns are excluded: `.*, .py[cod], .sw.*, ~*`. These can be overwritten by explicitly including them.
+
+By default Uvicorn uses simple changes detection strategy that compares python files modification times few times a second. If this approach doesn't work for your project (eg. because of its complexity), or you need watching of non python files you can install [watchgod](https://pypi.org/project/watchgod/) or install uvicorn with `uvicorn[standard]`, which will include watchgod.
+
+```
+```
 
 ## Production
 

tests/conftest.py

@@ -71,3 +71,60 @@ def tls_ca_ssl_context(tls_certificate_authority: trustme.CA) -> ssl.SSLContext:
     ssl_ctx = ssl.create_default_context(ssl.Purpose.SERVER_AUTH)
     tls_certificate_authority.configure_trust(ssl_ctx)
     return ssl_ctx
+
+
+@pytest.fixture(scope="package")
+def reload_directory_structure(tmp_path_factory: pytest.TempPathFactory):
+    """
+    This fixture creates a directory structure to enable reload parameter tests
+
+    The fixture has the following structure:
+    root
+    ├── [app, app_first, app_second, app_third]
+    │   ├── css
+    │   │   └── main.css
+    │   ├── js
+    │   │   └── main.js
+    │   ├── src
+    │   │   └── main.py
+    │   └── sub
+    │       └── sub.py
+    ├── ext
+    │   └── ext.jpg
+    └── main.py
+    """
+    root = tmp_path_factory.mktemp("reload_directory")
+    apps = ["app", "app_first", "app_second", "app_third"]
+
+    root_file = root / "main.py"
+    root_file.touch()
+
+    dotted_file = root / ".dotted"
+    dotted_file.touch()
+
+    dotted_dir = root / ".dotted_dir"
+    dotted_dir.mkdir()
+    dotted_dir_file = dotted_dir / "file.txt"
+    dotted_dir_file.touch()
+
+    for app in apps:
+        app_path = root / app
+        app_path.mkdir()
+        dir_files = [
+            ("src", ["main.py"]),
+            ("js", ["main.js"]),
+            ("css", ["main.css"]),
+            ("sub", ["sub.py"]),
+        ]
+        for directory, files in dir_files:
+            directory_path = app_path / directory
+            directory_path.mkdir()
+            for file in files:
+                file_path = directory_path / file
+                file_path.touch()
+    ext_dir = root / "ext"
+    ext_dir.mkdir()
+    ext_file = ext_dir / "ext.jpg"
+    ext_file.touch()
+
+    yield root