Monitoring contents of files/directories?

Question

I'm looking for a cross-platform file monitoring python package? I know it is possible to monitor files on windows using pywin32, and there are packages working on Linux/Unix but does anyone know about a cross-platform one?

Tim Golden has a very simple cross-platform method of polling a directory with os.listdir here: http://timgolden.me.uk/python/win32_how_do_i/watch_directory_for_changes.html — mechanical_meat, Feb 28 '09 at 12:07
What does "monitor" mean? Please provide some hint as to what you are trying to do. — S.Lott, Feb 28 '09 at 12:08

score 98 · Answer 1 · edited Dec 26 '22 at 06:41

98

I'm working on an MIT-licensed library that helps Python programs monitor file system events as portably as possible. There are differences that I'm trying to iron out. Highly alpha version at the moment:

Check it out here: http://github.com/gorakhargosh/watchdog/

Patches and contributions are welcome.

edited Dec 26 '22 at 06:41

starball

20,030
7
43
238

answered Nov 19 '10 at 10:42

GoraKhargosh

1,175
1
7
5

Thanks a lot, I was looking for a cross platform solution and watchdog is really helpful! – mtrovo Oct 17 '11 at 13:35
When will this be available for python3? – avendael Oct 06 '12 at 11:39
4

@avendael - Now, apparently. It supports py3k at this point. – Fake Name Apr 30 '14 at 04:54
1

This is definitely the must-be-accepted-answer. Works as charm :) Here is the usage of watchdog: http://pythonhosted.org/watchdog/quickstart.html – swdev Nov 30 '14 at 22:14
Is this till active? – DonyorM Jan 28 '16 at 15:17
Just want to say that the project is still actively being developed and looks pretty awesome. Thanks! – Johndt Nov 03 '16 at 00:18
docs are awful, not helping at all ... just saying ... Example: 'patterns argument description: (Read-only) Patterns to allow matching event paths.', ohh it's reallly descriptive – Dawid Gosławski Nov 14 '16 at 09:32
2

Last update was three years ago, should I still use this library or go for something like `watchgod`? – Marcus Mann Jul 02 '18 at 13:07
I'm going to make a warning against the library: it currently has an issue, where the watchdog will randomly stop working. – Mahrkeenerh Apr 14 '22 at 08:27

score 33 · Accepted Answer · edited Jul 23 '10 at 02:30

33

For Unix/Linux based systems, you should use File Alteration Monitor Python bindings to libfam.

For Windows based systems, you should tie into the Win32 API FindFirstChangeNotification and related functions.

As for a cross platform way, I don't know about a good cross platform way. I think it would be best to build a module yourself that works on either OS that uses one of the 2 above methods after detecting what OS it is.

edited Jul 23 '10 at 02:30

Matt Joiner

112,946
110
377
526

answered Feb 28 '09 at 12:27

Brian R. Bondy

339,232
124
596
636

1

Could you explain how to use the W32 API in an example... because I don't get that... – wishi Oct 25 '10 at 20:01

score 3 · Answer 3 · answered Sep 06 '11 at 03:50

3

Also check out this option:

http://pypi.python.org/pypi/watchdog

Was used with a cross-platform app on Windows and OS X.

answered Sep 06 '11 at 03:50

reese.ch

97
1
2

4

Possibly because the author of watchdog posted about it in an answer a year earlier and there's not much in this response? Probably not worth a downvote, but not much worth an upvote either. – fencepost Dec 23 '11 at 19:06
2

I like it because he said he's used it and it's OK. – Pedro Oct 29 '12 at 22:37
1

I never get it why an answer got downvoted. Here is the usage of watchdog: http://pythonhosted.org/watchdog/quickstart.html – swdev Nov 30 '14 at 22:13

batbrat · Answer 4 · 2009-02-28T12:29:41.060

2

I found this link, which talks about your problem. Although it doesn't really provide s solution/library, I think it will help. http://www.stepthreeprofit.com/2008/06/cross-platform-monitoring-of-filesystem.html

I don't think there is a cross-platform one yet, so you might want to roll your own.

I am inexperienced in this area so I am not really sure. I hope this helps.

Note
I stand corrected, gamin is available on cygwin as Adam Bernier pointed out to me in a comment. You may want to research other options on cygwin (if they exist).

edited Feb 28 '09 at 12:29

answered Feb 28 '09 at 11:55

batbrat

5,155
3
32
38

Seems to be some good feedback for Gamin on Linux. FWIW, Gamin is listed in cygwin packages: http://cygwin.com/packages/ – mechanical_meat Feb 28 '09 at 12:12
Ah! cygwin! I didn't think of that. I stand corrected. – batbrat Feb 28 '09 at 12:28

score 0 · Answer 5 · edited May 23 '17 at 12:09

0

The easiest way on Linux is to use inotifywait (given that your kernel is recent enough). You don't need any special bindings, inotifywait can be customized to print output lines on standard output in any way you want. Look and this question for a good example.

edited May 23 '17 at 12:09

Community

1
1

answered May 14 '09 at 13:46

JesperE

63,317
21
138
197

He specifically mentioned cross platform. inotifywait is only for linux – Quintin Par Jan 05 '10 at 18:56

Monitoring contents of files/directories?

5 Answers5

Linked

Related