Support --ignore or --reload-file option

Is your feature related to a problem? Please describe.

My application’s file structure is as follows:

cloud-app git:(dev) ✗ tree -L 1
.
├── Dockerfile
├── README.md
├── frontend
├── gatekeeper
├── iam
├── main.py
├── manage.py
├── requirements.txt
├── templates
└── util.py

frontend is a React SPA, gatekeeper and iam belong to a Django application that we mount as an ASGI sub-application alongside our fastapi ASGI app which is defined in main.py.

Currently I run uvicorn as follow:

uvicorn main:app --reload --host 0.0.0.0 --port 8000 --reload-dir iam --reload-dir gatekeeper

I would like to see one of the following (or both!) flags supported:

• --ignore-dir frontend: would enable me to ignore changes to frontend source code that are triggering a large number of reloads of my uvicorn app, despite those changes being irrelevant;
• --reload-file main.py: would enable me to whitelist specific files to watch.

I believe WatchDog can be configured to ignore/exclude files and dirs based on pattern matching.

Refs

https://pythonhosted.org/watchdog/api.html#watchdog.events.RegexMatchingEventHandler.ignore_regexes https://pythonhosted.org/watchdog/api.html#watchdog.events.PatternMatchingEventHandler.ignore_patterns

[Andrew-Chen-Wang]

For anyone looking to monkey patch uvicorn with watchgod for the moment, you can do something like this: https://github.com/pydanny/cookiecutter-django/pull/3168

import os
import sys

import uvicorn
from uvicorn.supervisors.watchgodreload import CustomWatcher


ignored = {
    "templates",
    "static",
    "staticfiles",
    "compose",
    ".ipython",
    "bin",
    ".pytest_cache",
    ".idea",
    "media",
    "htmlcov",
    "docs",
    "locale",
    "requirements",
}


class WatchgodWatcher(CustomWatcher):
    def __init__(self, *args, **kwargs):
        self.ignored_dirs.update(ignored)
        super(WatchgodWatcher, self).__init__(*args, **kwargs)


uvicorn.supervisors.watchgodreload.CustomWatcher = WatchgodWatcher
if __name__ == "__main__":
    sys.path.insert(0, os.path.abspath("/app"))
    uvicorn.run("config.asgi:application", host="0.0.0.0", reload=True)

Although that’s only dirs only, there’s also a ignored_file_regexes tuple-typed attribute that you can use as well since uvicorn uses DefaultWatcher.

[slavaGanzin]

Vote for #820

And it would be great if uvicorn.supervisors.watchgodreload.DefaultWatcher.ignored_file_regexes had image, video and log files in it. Cause it’s expected behavior for servers to save uploaded files in app folder