Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Using (py)inotify to run commands when files change

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 .gitignore ignore more October 19, 2012
Octocat-spinner-32 CONTRIBUTORS.txt
Octocat-spinner-32 LICENSE make gorun pip installable September 22, 2012
Octocat-spinner-32 MANIFEST.in
Octocat-spinner-32 README.rst fixing my email address October 19, 2012
Octocat-spinner-32 gorun.py
Octocat-spinner-32 gorun_settings.py.example ability to have multiple directories for one command. See example set… September 17, 2009
Octocat-spinner-32 requirements.txt make gorun pip installable September 22, 2012
Octocat-spinner-32 setup.py make gorun pip installable September 22, 2012
README.rst

gorun

(c) Peter Bengtsson, mail@peterbe.com, 2009-2012 License: Python

Using (py)inotify to run commands when files change

Tired of switching console, arrow-up, Enter, switch console back for every little change you make when you're writing code that has tests? Running with gorun.py enables you to just save in your editor and the tests are run automatically and immediately.

gorun.py does not use a slow pulling process which keeps taps on files modification time. Instead it uses the inotify which is "a Linux kernel subsystem that provides file system event notification".

Installation

This will only work on Linux which has the inotify module enabled in the kernel. (Most modern kernels do)

pip install gorun

This will install pyinotify.

Then, create a settings file, which is just a python file that is expected to define a variable called DIRECTORIES. Here's an example:

DIRECTORIES = (
   ('some/place/', './myframework test --dir some/place'),
   ('some/place/unitests.py',
    './myframework test --dir some/place --testclass Unittests'),
   ('/var/log/torrentsdownload.log',
    'growl downloads --logfile /var/log/torrentsdownload.log'),
)

Save that file as, for example, gorun_settings.py and then start it like this:

$ gorun.py gorun_settings

Configuration

Once you've set gorun to monitor a directory it will kick off on any file that changes in that directory. By default things like autosave files from certain editors are automatically created (e.g. #foo.py# or foo.py~) and these are ignored. If there are other file extensions you want gorun to ignore add this to your settings file:

IGNORE_EXTENSIONS = ('log',)

This will add to the list of already ignored file extensions such as .pyc.

Similarly, if there are certain directories that you don't want the inotify to notice, you can list them like this:

IGNORE_DIRECTORIES = ('xapian_index', '.autosavefiles')

Disclaimer

This code hasn't been extensively tested and relies on importing python modules so don't let untrusted morons fiddle with your dev environment.

Todo

When doing Django development I often run on single test method over and over and over again till I get rid of all errors. When doing this I have to change the settings so it just runs one single test and when I'm done I go back to set it up so that it runs all tests when adjacent code works.

This is a nuisance and I might try to solve that one day. If you have any tips please let me know.

Something went wrong with that request. Please try again.