Add separate method for file/directory metadata modifcation

.github/workflows/tests.yml

@@ -6,6 +6,13 @@ on:
       - master
   pull_request:
 
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: 'The branch, tag or SHA to release from'
+        required: true
+        default: 'master'
+
 concurrency:
   group: ${{ github.ref }}-${{ github.workflow }}-${{ github.event_name }}-${{ github.event_name != 'pull_request' && github.sha || '' }}
   cancel-in-progress: true

src/watchdog/events.py

@@ -69,6 +69,15 @@
    :members:
    :show-inheritance:
 
+.. autoclass:: FileAttribEvent
+   :members:
+   :show-inheritance:
+
+.. autoclass:: DirAttribEvent
+   :members:
+   :show-inheritance:
+
+
 
 Event Handler Classes
 ---------------------
@@ -106,6 +115,7 @@
 EVENT_TYPE_MODIFIED = "modified"
 EVENT_TYPE_CLOSED = "closed"
 EVENT_TYPE_OPENED = "opened"
+EVENT_TYPE_ATTRIB = "attrib"
 
 
 @dataclass(unsafe_hash=True)
@@ -145,6 +155,14 @@ class FileDeletedEvent(FileSystemEvent):
     event_type = EVENT_TYPE_DELETED
 
 
+class FileAttribEvent(FileSystemEvent):
+    """
+    File system event representing file metadata modification on the file system.
+    """
+
+    event_type = EVENT_TYPE_ATTRIB
+
+
 class FileModifiedEvent(FileSystemEvent):
     """File system event representing file modification on the file system."""
 
@@ -203,6 +221,15 @@ class DirMovedEvent(FileSystemMovedEvent):
     is_directory = True
 
 
+class DirAttribEvent(FileSystemEvent):
+    """
+    File system event representing directory metadata modification on the file system.
+    """
+
+    event_type = EVENT_TYPE_ATTRIB
+    is_directory = True
+
+
 class FileSystemEventHandler:
     """Base file system event handler that you can override methods from."""
 
@@ -222,6 +249,7 @@ def dispatch(self, event: FileSystemEvent) -> None:
             EVENT_TYPE_MOVED: self.on_moved,
             EVENT_TYPE_CLOSED: self.on_closed,
             EVENT_TYPE_OPENED: self.on_opened,
+            EVENT_TYPE_ATTRIB: self.on_attrib,
         }[event.event_type](event)
 
     def on_any_event(self, event: FileSystemEvent) -> None:
@@ -287,6 +315,15 @@ def on_opened(self, event: FileSystemEvent) -> None:
             :class:`FileOpenedEvent`
         """
 
+    def on_attrib(self, event: FileSystemEvent) -> None:
+        """Called when a file or directory metadata is modified.
+
+        :param event:
+            Event representing file/directory metadata modification.
+        :type event:
+            :class:`FileAttribEvent` or :class:`DirAttribEvent`
+        """
+
 
 class PatternMatchingEventHandler(FileSystemEventHandler):
     """
@@ -478,6 +515,12 @@ def on_modified(self, event: FileSystemEvent) -> None:
         what = "directory" if event.is_directory else "file"
         self.logger.info("Modified %s: %s", what, event.src_path)
 
+    def on_attrib(self, event):
+        super().on_attrib(event)
+
+        what = "directory" if event.is_directory else "file"
+        self.logger.info("Attrib %s: %s", what, event.src_path)
+
     def on_closed(self, event: FileSystemEvent) -> None:
         super().on_closed(event)
 

src/watchdog/observers/fsevents.py

@@ -31,10 +31,12 @@
 import _watchdog_fsevents as _fsevents
 
 from watchdog.events import (
+    DirAttribEvent,
     DirCreatedEvent,
     DirDeletedEvent,
     DirModifiedEvent,
     DirMovedEvent,
+    FileAttribEvent,
     FileCreatedEvent,
     FileDeletedEvent,
     FileModifiedEvent,
@@ -128,6 +130,10 @@ def _queue_modified_event(self, event, src_path, dirname):
         cls = DirModifiedEvent if event.is_directory else FileModifiedEvent
         self.queue_event(cls(src_path))
 
+    def _queue_attrib_event(self, event, src_path, dirname):
+        cls = DirAttribEvent if event.is_directory else FileAttribEvent
+        self.queue_event(cls(src_path))
+
     def _queue_renamed_event(self, src_event, src_path, dst_path, src_dirname, dst_dirname):
         cls = DirMovedEvent if src_event.is_directory else FileMovedEvent
         dst_path = self._encode_path(dst_path)
@@ -208,9 +214,12 @@ def queue_events(self, timeout, events):
 
                 self._fs_view.add(event.inode)
 
-                if event.is_modified or self._is_meta_mod(event):
+                if event.is_modified:
                     self._queue_modified_event(event, src_path, src_dirname)
 
+                elif self._is_meta_mod(event):
+                    self._queue_attrib_event(event, src_path, src_dirname)
+
                 self._queue_deleted_event(event, src_path, src_dirname)
                 self._fs_view.discard(event.inode)
 
@@ -220,10 +229,13 @@ def queue_events(self, timeout, events):
 
                 self._fs_view.add(event.inode)
 
-                if event.is_modified or self._is_meta_mod(event):
+                if event.is_modified:
                     self._queue_modified_event(event, src_path, src_dirname)
 
-                if event.is_renamed:
+                elif self._is_meta_mod(event):
+                    self._queue_attrib_event(event, src_path, src_dirname)
+
+                elif event.is_renamed:
                     # Check if we have a corresponding destination event in the watched path.
                     dst_event = next(
                         iter(e for e in events if e.is_renamed and e.inode == event.inode),
@@ -247,10 +259,13 @@ def queue_events(self, timeout, events):
 
                         events.remove(dst_event)
 
-                        if dst_event.is_modified or self._is_meta_mod(dst_event):
+                        if dst_event.is_modified:
                             self._queue_modified_event(dst_event, dst_path, dst_dirname)
 
-                        if dst_event.is_removed:
+                        elif self._is_meta_mod(dst_event):
+                            self._queue_attrib_event(dst_event, dst_path, dst_dirname)
+
+                        elif dst_event.is_removed:
                             self._queue_deleted_event(dst_event, dst_path, dst_dirname)
                             self._fs_view.discard(dst_event.inode)
 
@@ -272,7 +287,7 @@ def queue_events(self, timeout, events):
                         # Skip further coalesced processing.
                         continue
 
-                if event.is_removed:
+                elif event.is_removed:
                     # Won't occur together with renamed.
                     self._queue_deleted_event(event, src_path, src_dirname)
                     self._fs_view.discard(event.inode)

src/watchdog/observers/fsevents2.py

@@ -57,10 +57,12 @@
 )
 
 from watchdog.events import (
+    DirAttribEvent,
     DirCreatedEvent,
     DirDeletedEvent,
     DirModifiedEvent,
     DirMovedEvent,
+    FileAttribEvent,
     FileCreatedEvent,
     FileDeletedEvent,
     FileModifiedEvent,
@@ -191,6 +193,7 @@ def queue_events(self, timeout):
         events = self._fsevents.read_events()
         if events is None:
             return
+
         i = 0
         while i < len(events):
             event = events[i]
@@ -222,10 +225,14 @@ def queue_events(self, timeout):
                     self.queue_event(DirModifiedEvent(os.path.dirname(event.path)))
                 # TODO: generate events for tree
 
-            elif event.is_modified or event.is_inode_meta_mod or event.is_xattr_mod:
+            elif event.is_modified:
                 cls = DirModifiedEvent if event.is_directory else FileModifiedEvent
                 self.queue_event(cls(event.path))
 
+            elif event.is_inode_meta_mod or event.is_xattr_mod:
+                cls = DirAttribEvent if event.is_directory else FileAttribEvent
+                self.queue_event(cls(event.path))
+
             elif event.is_created:
                 cls = DirCreatedEvent if event.is_directory else FileCreatedEvent
                 self.queue_event(cls(event.path))
@@ -235,6 +242,7 @@ def queue_events(self, timeout):
                 cls = DirDeletedEvent if event.is_directory else FileDeletedEvent
                 self.queue_event(cls(event.path))
                 self.queue_event(DirModifiedEvent(os.path.dirname(event.path)))
+
             i += 1
 
 

src/watchdog/observers/inotify.py

@@ -70,10 +70,12 @@
 import threading
 
 from watchdog.events import (
+    DirAttribEvent,
     DirCreatedEvent,
     DirDeletedEvent,
     DirModifiedEvent,
     DirMovedEvent,
+    FileAttribEvent,
     FileClosedEvent,
     FileCreatedEvent,
     FileDeletedEvent,
@@ -166,7 +168,10 @@ def queue_events(self, timeout, full_events=False):
                 if event.is_directory and self.watch.is_recursive:
                     for sub_event in generate_sub_created_events(src_path):
                         self.queue_event(sub_event)
-            elif event.is_attrib or event.is_modify:
+            elif event.is_attrib:
+                cls = DirAttribEvent if event.is_directory else FileAttribEvent
+                self.queue_event(cls(src_path))
+            elif event.is_modify:
                 cls = DirModifiedEvent if event.is_directory else FileModifiedEvent
                 self.queue_event(cls(src_path))
             elif event.is_delete or (event.is_moved_from and not full_events):

src/watchdog/observers/kqueue.py

@@ -84,10 +84,12 @@
     EVENT_TYPE_CREATED,
     EVENT_TYPE_DELETED,
     EVENT_TYPE_MOVED,
+    DirAttribEvent,
     DirCreatedEvent,
     DirDeletedEvent,
     DirModifiedEvent,
     DirMovedEvent,
+    FileAttribEvent,
     FileCreatedEvent,
     FileDeletedEvent,
     FileModifiedEvent,
@@ -122,7 +124,6 @@
 def absolute_path(path):
     return os.path.abspath(os.path.normpath(path))
 
-
 # Flag tests.
 
 
@@ -515,9 +516,9 @@ def _gen_kqueue_events(self, kev, ref_snapshot, new_snapshot):
             yield from self._gen_renamed_events(src_path, descriptor.is_directory, ref_snapshot, new_snapshot)
         elif is_attrib_modified(kev):
             if descriptor.is_directory:
-                yield DirModifiedEvent(src_path)
+                yield DirAttribEvent(src_path)
             else:
-                yield FileModifiedEvent(src_path)
+                yield FileAttribEvent(src_path)
         elif is_modified(kev):
             if descriptor.is_directory:
                 if self.watch.is_recursive or self.watch.path == src_path:

tests/conftest.py

@@ -8,7 +8,7 @@
 
 import pytest
 
-from .utils import ExpectEvent, Helper, P, StartWatching, TestEventQueue
+from .utils import ExpectAnyEvent, ExpectEvent, Helper, P, StartWatching, TestEventQueue
 
 
 @pytest.fixture()
@@ -79,3 +79,8 @@ def start_watching_fixture(helper: Helper) -> StartWatching:
 @pytest.fixture(name="expect_event")
 def expect_event_fixture(helper: Helper) -> ExpectEvent:
     return helper.expect_event
+
+
+@pytest.fixture(name="expect_any_event")
+def expect_any_event_fixture(helper: Helper) -> ExpectAnyEvent:
+    return helper.expect_any_event

tests/shell.py

@@ -28,15 +28,6 @@
 import tempfile
 import time
 
-# def tree(path='.', show_files=False):
-#    print(path)
-#    padding = ''
-#    for root, directories, filenames in os.walk(path):
-#        print(padding + os.path.basename(root) + os.path.sep)
-#        padding = padding + '   '
-#        for filename in filenames:
-#            print(padding + filename)
-
 
 def cd(path):
     os.chdir(path)
@@ -124,6 +115,11 @@ def msize(path):
     os.utime(path, (0, 0))
 
 
+def chmod(path, mode):
+    """Change file mode bits."""
+    os.chmod(path, mode)
+
+
 def mount_tmpfs(path):
     os.system(f"sudo mount -t tmpfs none {path}")