chore: adjust Observer.schedule() path type annotation to reflect the pathlib.Path support (#1096)

Co-authored-by: Mickaël Schoentgen <[email protected]>

Author: 2 people

changelog.rst

@@ -8,8 +8,8 @@ Changelog
 
 202x-xx-xx • `full history <https://github.com/gorakhargosh/watchdog/compare/v6.0.0...HEAD>`__
 
-- 
-- Thanks to our beloved contributors: @BoboTiG, @
+- Adjust ``Observer.schedule()`` ``path`` type annotation to reflect the ``pathlib.Path`` support. (`#1096 <https://github.com/gorakhargosh/watchdog/pull/1096>`__)
+- Thanks to our beloved contributors: @BoboTiG, @tybug
 
 6.0.0
 ~~~~~

src/watchdog/observers/api.py

@@ -283,7 +283,7 @@ def start(self) -> None:
     def schedule(
         self,
         event_handler: FileSystemEventHandler,
-        path: str,
+        path: str | Path,
         *,
         recursive: bool = False,
         event_filter: list[type[FileSystemEvent]] | None = None,
@@ -301,7 +301,7 @@ def schedule(
         :param path:
             Directory path that will be monitored.
         :type path:
-            ``str``
+            ``str`` or :class:`pathlib.Path`
         :param recursive:
             ``True`` if events will be emitted for sub-directories
             traversed recursively; ``False`` otherwise.

src/watchdog/observers/fsevents.py

@@ -12,6 +12,7 @@
 import threading
 import time
 import unicodedata
+from pathlib import Path
 from typing import TYPE_CHECKING
 
 import _watchdog_fsevents as _fsevents
@@ -326,7 +327,7 @@ def __init__(self, *, timeout: float = DEFAULT_OBSERVER_TIMEOUT) -> None:
     def schedule(
         self,
         event_handler: FileSystemEventHandler,
-        path: str,
+        path: str | Path,
         *,
         recursive: bool = False,
         follow_symlink: bool = False,