Simple, modern and high performance file watching and code reload in python.

These details have not been verified by PyPI

Project links

Homepage

Project description

watchfiles

Simple, modern and high performance file watching and code reload in python.

NOTICE

This package was significantly altered and renamed from watchgod to watchfiles, this files refers to the watchfiles package.

Documentation for the old version (watchgod) is available here. See issue #102 for details on the migration and its rationale.

Underlying file system notifications are handled by the Notify rust library.

Installation

watchfiles requires Python 3.7 - 3.10.

pip install watchfiles

Binaries are available for:

Linux: manylinux-x86_64, musllinux-x86_64 & manylinux-i686
MacOS: x86_64 & arm64 (except python 3.7)
Windows: amd64 & win32

Otherwise, you can install from source which requires Rust stable to be installed.

Usage

To watch for changes in a directory:

from watchfiles import watch

for changes in watch('./path/to/dir'):
    print(changes)

watch (and all other methods described below) can take multiple paths as arguments to watch.

To run a function and restart it when code changes:

from watchfiles import run_process

def foobar(a, b, c):
    ...

if __name__ == '__main__':
    run_process('./path/to/dir', target=foobar, args=(1, 2, 3))

run_process uses PythonFilter by default so only changes to python files will prompt a reload, see custom event filtering below.

If you need notifications about change events as well as to restart a process you can use the callback argument to pass a function which will be called on every file change with one argument: the set of file changes.

File changes are also available via the WATCHFILES_CHANGES environment variable which contains JSON encoded details of changes, see the CLI example below.

Asynchronous Methods

watchfiles comes with an asynchronous equivalents of watch: awatch.

import asyncio
from watchfiles import awatch

async def main():
    async for changes in awatch('/path/to/dir'):
        print(changes)

asyncio.run(main())

There's also an asynchronous equivalents of run_process: arun_process which in turn uses awatch:

import asyncio
from watchfiles import arun_process

def foobar(a, b, c):
    ...

async def main():
    await arun_process('./path/to/dir', target=foobar, args=(1, 2, 3))

if __name__ == '__main__':
    asyncio.run(main())

The signature of arun_process is almost identical to run_process except that the optional callback argument may be a coroutine.

Custom Filters

The watch_filter argument to the above methods allows you to specify which file system events watchfiles should react to (either yield or reload code). watch_filter should just be a callable which takes a change (either "added", "modified" or "deleted") and a path (as a string) and should return whether or not that change should be registered.

watchfiles comes with the following classes, instances of which can be with watch_filter:

DefaultFilter The watcher used by default by watch and awatch, commonly ignored files like *.swp, *.pyc and *~ are ignored along with directories like .git.
PythonFilter Specific to python files, only *.py, *.pyx and *.pyd files are watched.
BaseFilter, used by DefaultFilter and PythonFilter, useful for defining your own filters which leverage the same logic

Here's an example of a custom filter which extends DefaultFilter to only notice changes to common web files:

from watchfiles import Change, DefaultFilter, watch


class WebFilter(DefaultFilter):
    allowed_extensions = '.html', '.css', '.js'

    def __call__(self, change: Change, path: str) -> bool:
        return super().__call__(change, path) and path.endswith(self.allowed_extensions)

for changes in watch('my/web/project', watch_filter=WebFilter()):
    print (changes)

Here's an example of a customer filter which is a simple callable that ignores changes unless they represent a new file being created:

from watchfiles import Change, watch

def only_added(change: Change, path: str) -> bool:
    return change == Change.added

for changes in watch('my/project', watch_filter=only_added):
    print (changes)

For more details, checkout filters.py, it's pretty simple.

CLI

watchfiles also comes with a CLI for running and reloading python code.

Let's say you have foobar.py (this is a very simple web server using aiohttp) which gets details about recent file changes from the WATCHFILES_CHANGES environment variable and returns them as JSON.

import os, json
from aiohttp import web

async def handle(request):
    # get the most recent file changes and return them
    changes = os.getenv('WATCHFILES_CHANGES', '[]')
    changes = json.loads(changes)
    return web.json_response(dict(changes=changes))

app = web.Application()
app.router.add_get('/', handle)

def main():
    web.run_app(app, port=8000)

You could run this and reload it when any file in the current directory changes with:

watchfiles foobar.main

Run watchfiles --help for more options.

The CLI can also be used via python -m watchfiles ....

Project details

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

0.24.0

Aug 28, 2024

0.23.0

Aug 7, 2024

0.22.0

May 27, 2024

0.21.0

Oct 13, 2023

0.20.0

Aug 24, 2023

0.19.0

Mar 27, 2023

0.18.1

Nov 7, 2022

0.18.0

Oct 19, 2022

0.17.0

Sep 11, 2022

0.16.1

Jul 25, 2022

0.16.0

Jul 21, 2022

0.15.0

Jun 17, 2022

0.15.0a1 pre-release

Jun 3, 2022

0.14.1

May 17, 2022

0.14

May 16, 2022

0.13

Apr 9, 2022

0.12

Apr 1, 2022

0.11

Mar 30, 2022

This version

0.10

Mar 23, 2022

0.0.0a1 pre-release

Mar 15, 2022

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

watchfiles-0.10.tar.gz (17.8 kB view details)

Uploaded Mar 23, 2022 Source

Built Distributions

watchfiles-0.10-cp310-cp310-win_amd64.whl (202.0 kB view details)

Uploaded Mar 23, 2022 CPython 3.10 Windows x86-64

watchfiles-0.10-cp310-cp310-win32.whl (196.0 kB view details)

Uploaded Mar 23, 2022 CPython 3.10 Windows x86

watchfiles-0.10-cp310-cp310-manylinux_2_24_x86_64.whl (1.1 MB view details)

Uploaded Mar 23, 2022 CPython 3.10 manylinux: glibc 2.24+ x86-64

watchfiles-0.10-cp310-cp310-manylinux_2_24_i686.whl (1.1 MB view details)

Uploaded Mar 23, 2022 CPython 3.10 manylinux: glibc 2.24+ i686

watchfiles-0.10-cp310-cp310-macosx_11_0_arm64.whl (272.9 kB view details)

Uploaded Mar 23, 2022 CPython 3.10 macOS 11.0+ ARM64

watchfiles-0.10-cp310-cp310-macosx_10_9_x86_64.whl (284.1 kB view details)

Uploaded Mar 23, 2022 CPython 3.10 macOS 10.9+ x86-64

watchfiles-0.10-cp39-cp39-win_amd64.whl (202.1 kB view details)

Uploaded Mar 23, 2022 CPython 3.9 Windows x86-64

watchfiles-0.10-cp39-cp39-win32.whl (196.0 kB view details)

Uploaded Mar 23, 2022 CPython 3.9 Windows x86

watchfiles-0.10-cp39-cp39-manylinux_2_24_x86_64.whl (1.1 MB view details)

Uploaded Mar 23, 2022 CPython 3.9 manylinux: glibc 2.24+ x86-64

watchfiles-0.10-cp39-cp39-manylinux_2_24_i686.whl (1.1 MB view details)

Uploaded Mar 23, 2022 CPython 3.9 manylinux: glibc 2.24+ i686

watchfiles-0.10-cp39-cp39-macosx_11_0_arm64.whl (273.1 kB view details)

Uploaded Mar 23, 2022 CPython 3.9 macOS 11.0+ ARM64

watchfiles-0.10-cp39-cp39-macosx_10_9_x86_64.whl (284.1 kB view details)

Uploaded Mar 23, 2022 CPython 3.9 macOS 10.9+ x86-64

watchfiles-0.10-cp38-cp38-win_amd64.whl (201.6 kB view details)

Uploaded Mar 23, 2022 CPython 3.8 Windows x86-64

watchfiles-0.10-cp38-cp38-win32.whl (195.8 kB view details)

Uploaded Mar 23, 2022 CPython 3.8 Windows x86

watchfiles-0.10-cp38-cp38-manylinux_2_24_x86_64.whl (1.1 MB view details)

Uploaded Mar 23, 2022 CPython 3.8 manylinux: glibc 2.24+ x86-64

watchfiles-0.10-cp38-cp38-manylinux_2_24_i686.whl (1.1 MB view details)

Uploaded Mar 23, 2022 CPython 3.8 manylinux: glibc 2.24+ i686

watchfiles-0.10-cp38-cp38-macosx_11_0_arm64.whl (272.9 kB view details)

Uploaded Mar 23, 2022 CPython 3.8 macOS 11.0+ ARM64

watchfiles-0.10-cp38-cp38-macosx_10_9_x86_64.whl (284.5 kB view details)

Uploaded Mar 23, 2022 CPython 3.8 macOS 10.9+ x86-64

watchfiles-0.10-cp37-cp37m-win_amd64.whl (201.6 kB view details)

Uploaded Mar 23, 2022 CPython 3.7m Windows x86-64

watchfiles-0.10-cp37-cp37m-win32.whl (195.8 kB view details)

Uploaded Mar 23, 2022 CPython 3.7m Windows x86

watchfiles-0.10-cp37-cp37m-manylinux_2_24_x86_64.whl (1.1 MB view details)

Uploaded Mar 23, 2022 CPython 3.7m manylinux: glibc 2.24+ x86-64

watchfiles-0.10-cp37-cp37m-manylinux_2_24_i686.whl (1.1 MB view details)

Uploaded Mar 23, 2022 CPython 3.7m manylinux: glibc 2.24+ i686

watchfiles-0.10-cp37-cp37m-macosx_10_9_x86_64.whl (284.5 kB view details)

Uploaded Mar 23, 2022 CPython 3.7m macOS 10.9+ x86-64

File details

Details for the file watchfiles-0.10.tar.gz.

File metadata

Download URL: watchfiles-0.10.tar.gz
Upload date: Mar 23, 2022
Size: 17.8 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for watchfiles-0.10.tar.gz
Algorithm	Hash digest
SHA256	`ffa852c0baed22ade6c7c5f0876c2bb6e86e0fad01ec32402aabf3899cd03965`
MD5	`44f21044ad747a3a343096113be2ee69`
BLAKE2b-256	`009932e58ea07389206191e2511811cb273469d928cda4bf48c89c57827c1ffa`

Algorithm	Hash digest
SHA256	`1a9412edb421f53233fd4b38f6303d3f87ef9fa010117233214c6bfb01b7e8a1`
MD5	`b11b7f56c7076ad8062a104fd7749f12`
BLAKE2b-256	`0ac7fa77bd1f738a30c708b87db4aec877152745043500eafe2ceaacedcd5a67`

Algorithm	Hash digest
SHA256	`49592d7d4b357944227271718ae91e11f632937bb0592ff84e744dcbc7f302a2`
MD5	`d0c2ba2bea890786bde5d236769af7df`
BLAKE2b-256	`20009d2012453d5701106f8eb61ab5ecf24f1ec593ae0f6673c9ca18ed026155`

Algorithm	Hash digest
SHA256	`f3461284828dfa1fcdb21626ed52eb3bc7fe34cea16dc63c771c453a8834052b`
MD5	`e01270a18cb25448ca3bf62ba0163175`
BLAKE2b-256	`040498ae8d90c0f4318b79c64b092e3e4e1bccbafea7ae6f873cb924ebc5e915`

Algorithm	Hash digest
SHA256	`03a0837519b24e0c8f8c2f59420bc36e3ced9bf5e90f5c816d5411beabe95bd0`
MD5	`8882aa4e48fbd184daeaee27d6acc83c`
BLAKE2b-256	`662080d3395f5582364c18e6e2a0babf2e04f1c30f8f4fb2f756c7644dd42270`

Algorithm	Hash digest
SHA256	`8ddc2b3e399879ebe193a01c0c71d56dec23c01960413e5b5d69e7c80a4a6a57`
MD5	`135b65e747ad9ce583932a22c0eccb08`
BLAKE2b-256	`5c16761f9ab2ed3afcc5105263f35c58266a5d776c54455baab1c6851182cedf`

Algorithm	Hash digest
SHA256	`ecfa5bb3429afa0a07c06dada19422e67b4a3a1b522f73d99cb7489f93372661`
MD5	`e3105f98da057f18393fdf1974750a18`
BLAKE2b-256	`693759499f85eab5f00b66f4f271110fb35b9e794ad595f38d7151555aa53a0f`

Algorithm	Hash digest
SHA256	`3d35da7fef5e04888bdf02c40b05e8f99eff158d8a14382fb303ff230a4a22a0`
MD5	`380a5a9900cd7425f6d3f5a558717438`
BLAKE2b-256	`affb3b19c84d59324293056b5f81c1751923ef4e34b7c1b54965c4cfd12b959c`

Algorithm	Hash digest
SHA256	`f07043cb9d57bb7d3c36aac558dfa76e212c4a890c651dd184611512b6a62d5d`
MD5	`3a20219ca8e085f443ad51d1bb57ad7c`
BLAKE2b-256	`5142005a342b0db643b044fc58a5e52e4923d586ee25318d0f3ce0821d3951ab`

Algorithm	Hash digest
SHA256	`ee0b7f81cbfb9315c433318d0edc1a92f2659332862a6169df7adf940968acfe`
MD5	`e5e553665875271517b90dd1012ebef6`
BLAKE2b-256	`886c121d64879d988095c4259385eea08513f53f5ae36899b42c5710cc14ad24`

Algorithm	Hash digest
SHA256	`55a835fa16ab914ba4e1edcb439a3224a93e74aa4c15607e8a4ced0bab58f8c6`
MD5	`9d60ba0eb7ba70eb62654b40677519ba`
BLAKE2b-256	`95ad875766d03a6c61362a60d7775160d0d6d4e8b4a00fe3d9400c8462ba7518`

Algorithm	Hash digest
SHA256	`f971f2096d0c51007a2fb0526b9d55ea94422bb96a92470bed909fda2e3262de`
MD5	`7f53d8bad724216eb28e0e914b3b49ac`
BLAKE2b-256	`30e6b57977a7311cc69dfab7ce97cfb2c3e44d4a3836a81f0dfdfc69c80c2977`

Algorithm	Hash digest
SHA256	`5295312e7811dc6414d7f14bb0e0cd28fa155be9a6f5606e0196154df285722e`
MD5	`9a3c9d950bb9c2799d2785a64e7a0e51`
BLAKE2b-256	`6b9aace3acda27769531774eea1716160466feaf1bc52058942e96b3d1e60d5c`

Algorithm	Hash digest
SHA256	`3bda32f138f62e608a67f97ec62f7634f75bfa29c7ee3d8981631499d611df91`
MD5	`010057ccc5133f8f45d6e87d9710f7ef`
BLAKE2b-256	`967b0c673db9d38a8d38a08111f3a6467ddcd5df0f3201b1fd2816f477525148`

Algorithm	Hash digest
SHA256	`da75e633ac334369e4a4577ecb3135cb029efaeb039809a597aad18c20f12359`
MD5	`e2aeb6a528e3bb36900b3c61e18a1dc5`
BLAKE2b-256	`2cefc8588a68575d984b0266a331ac2de6c9c83a3a4e5ca1b94d579258994299`

Algorithm	Hash digest
SHA256	`abadc052319a92f0a0d6aff9f2f34ac33543c4dea549f4d3af1b722ddcc0d3e0`
MD5	`8348d63f72c8c37b5d9ea9f95f5026e5`
BLAKE2b-256	`18f4e2b41f6d4d082b42390a354a5ea6a20028fb18819cd04efea307476a7f1a`

Algorithm	Hash digest
SHA256	`1a955776ff85fe075598b0866a3656f894609c80e18486b91a74a93ad55ed307`
MD5	`9ec4cf791b84d3bfe067009aa319f345`
BLAKE2b-256	`93ed99ec7fe67cce213b61e667e54cdb8f9edc2320c0a857accd20691e2a8ca0`

Algorithm	Hash digest
SHA256	`e47763063772ba52dee3dc3a3d281483145e5bf5a3fe12fc3b5908f374c67216`
MD5	`d38efc0a409818e394225e533893cab5`
BLAKE2b-256	`9b5b8dcf53e760c373e86cc5d8b1596ca4e08dfa5be0f2bc560c5bbaad41be0d`

Algorithm	Hash digest
SHA256	`962c593e8c1e3f63c4ce04290a8bca7c96e14400a4358ab0f9fa41de1341d189`
MD5	`fb9dacb7592372a99423475b3f141615`
BLAKE2b-256	`2402faf94eefc5cc46d35c0797e4c63b6ae443111661f60199b8b3e6a8b9705e`

Algorithm	Hash digest
SHA256	`1d58141210a33bbb67b5418dcdc45c3938b9b4db971f5b3ca29adf7e7ae790b2`
MD5	`8c431cd692cea165593f9554399d93dc`
BLAKE2b-256	`b9e04d8217994851835b5271036fa5d7beea20fd10c4f3d63c841fe3f8a768ad`

Algorithm	Hash digest
SHA256	`ccc5a674d6ccf28c4a0802d923144ace0a3976c4badc0a274b98909bf8f91dfe`
MD5	`b9d7de46b40af05c596f566fcaba0ae1`
BLAKE2b-256	`4a667801c81a22070e1190d14249e92e503a691b3f44f8f8c9261e0fde7909e9`

watchfiles 0.10

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

watchfiles

NOTICE

Installation

Usage

Asynchronous Methods

Custom Filters

CLI

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distributions

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

Algorithm	Hash digest
SHA256	`5e361bf84bf0a5b19c07e2d6f0d0537d39c29caf175fa844a397c66d852abe60`
MD5	`0fc6cd0a03c4c52ab51dd89d5ab78500`
BLAKE2b-256	`9bcd0cd582700928255cc8ea46052563882a24809eeda4dabcecff6112ca986d`

Algorithm	Hash digest
SHA256	`2647421ed79f0d8874f0a7fc6f020a11e63b3345a20d4c5acf3e9d15c2d127b6`
MD5	`905c2e39068aef658b1349cb5969a776`
BLAKE2b-256	`b2a0c841b717b148ba9c4864767bc6dcaaa80dc642e1b4fca051358d3d52d2ae`

Algorithm	Hash digest
SHA256	`5828ada5dd62714b243ddb99d09b1b356faa9c9befe79268ce108baec87c5d04`
MD5	`88b37d3ff156c0c9d2ad280e6c563125`
BLAKE2b-256	`119c0764004cd7738465fe967691f685943d2389c19dacc3b38a591de4bb40a3`