add isort (gorakhargosh#969)

* add isort (not applied)

* fixup

* apply isort

* fixup

Author: altendky

.github/workflows/tests.yml

@@ -55,6 +55,15 @@ jobs:
               name: Linux
               emoji: 🐧
               runs-on: [ubuntu-latest]
+          - tox:
+              name: isort
+              environment: isort-ci
+              timeout: 5
+            python: "3.11"
+            os:
+              name: Linux
+              emoji: 🐧
+              runs-on: [ubuntu-latest]
           - tox:
               name: Docs
               environment: docs

.isort.cfg

@@ -0,0 +1,5 @@
+[settings]
+line_length = 120
+profile=black
+skip_gitignore=true
+add_imports=from __future__ import annotations

requirements-tests.txt

@@ -1,6 +1,7 @@
 eventlet
 flake8
 flaky
+isort
 pytest
 pytest-cov
 pytest-timeout

src/watchdog/events.py

@@ -91,11 +91,13 @@
 
 """
 
-import os.path
+from __future__ import annotations
+
 import logging
+import os.path
 import re
-from watchdog.utils.patterns import match_any_paths
 
+from watchdog.utils.patterns import match_any_paths
 
 EVENT_TYPE_MOVED = "moved"
 EVENT_TYPE_DELETED = "deleted"

src/watchdog/observers/__init__.py

@@ -50,11 +50,14 @@
 
 """
 
+from __future__ import annotations
+
 import sys
 import warnings
 from typing import Type
 
 from watchdog.utils import UnsupportedLibc
+
 from .api import BaseObserver
 
 Observer: Type[BaseObserver]

src/watchdog/observers/api.py

@@ -13,6 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from __future__ import annotations
+
 import queue
 import threading
 from pathlib import Path

src/watchdog/observers/fsevents.py

@@ -21,32 +21,29 @@
 :platforms: macOS
 """
 
-import time
+from __future__ import annotations
+
 import logging
 import os
 import threading
+import time
 import unicodedata
+
 import _watchdog_fsevents as _fsevents  # type: ignore[import]
 
 from watchdog.events import (
-    FileDeletedEvent,
-    FileModifiedEvent,
-    FileCreatedEvent,
-    FileMovedEvent,
+    DirCreatedEvent,
     DirDeletedEvent,
     DirModifiedEvent,
-    DirCreatedEvent,
     DirMovedEvent,
+    FileCreatedEvent,
+    FileDeletedEvent,
+    FileModifiedEvent,
+    FileMovedEvent,
     generate_sub_created_events,
     generate_sub_moved_events,
 )
-
-from watchdog.observers.api import (
-    BaseObserver,
-    EventEmitter,
-    DEFAULT_EMITTER_TIMEOUT,
-    DEFAULT_OBSERVER_TIMEOUT,
-)
+from watchdog.observers.api import DEFAULT_EMITTER_TIMEOUT, DEFAULT_OBSERVER_TIMEOUT, BaseObserver, EventEmitter
 from watchdog.utils.dirsnapshot import DirectorySnapshot
 
 logger = logging.getLogger("fsevents")

src/watchdog/observers/fsevents2.py

@@ -18,61 +18,55 @@
 :platforms: macOS
 """
 
-import os
+from __future__ import annotations
+
 import logging
+import os
 import queue
 import unicodedata
 import warnings
 from threading import Thread
 
-from watchdog.events import (
-    FileDeletedEvent,
-    FileModifiedEvent,
-    FileCreatedEvent,
-    FileMovedEvent,
-    DirDeletedEvent,
-    DirModifiedEvent,
-    DirCreatedEvent,
-    DirMovedEvent,
-)
-from watchdog.observers.api import (
-    BaseObserver,
-    EventEmitter,
-    DEFAULT_EMITTER_TIMEOUT,
-    DEFAULT_OBSERVER_TIMEOUT,
-)
-
 # pyobjc
 import AppKit  # type: ignore[import]
 from FSEvents import (  # type: ignore[import]
-    FSEventStreamCreate,
     CFRunLoopGetCurrent,
-    FSEventStreamScheduleWithRunLoop,
-    FSEventStreamStart,
     CFRunLoopRun,
     CFRunLoopStop,
-    FSEventStreamStop,
+    FSEventStreamCreate,
     FSEventStreamInvalidate,
     FSEventStreamRelease,
-)
-
-from FSEvents import (
+    FSEventStreamScheduleWithRunLoop,
+    FSEventStreamStart,
+    FSEventStreamStop,
     kCFAllocatorDefault,
     kCFRunLoopDefaultMode,
-    kFSEventStreamEventIdSinceNow,
-    kFSEventStreamCreateFlagNoDefer,
     kFSEventStreamCreateFlagFileEvents,
+    kFSEventStreamCreateFlagNoDefer,
+    kFSEventStreamEventFlagItemChangeOwner,
     kFSEventStreamEventFlagItemCreated,
-    kFSEventStreamEventFlagItemRemoved,
-    kFSEventStreamEventFlagItemInodeMetaMod,
-    kFSEventStreamEventFlagItemRenamed,
-    kFSEventStreamEventFlagItemModified,
     kFSEventStreamEventFlagItemFinderInfoMod,
-    kFSEventStreamEventFlagItemChangeOwner,
-    kFSEventStreamEventFlagItemXattrMod,
+    kFSEventStreamEventFlagItemInodeMetaMod,
     kFSEventStreamEventFlagItemIsDir,
     kFSEventStreamEventFlagItemIsSymlink,
+    kFSEventStreamEventFlagItemModified,
+    kFSEventStreamEventFlagItemRemoved,
+    kFSEventStreamEventFlagItemRenamed,
+    kFSEventStreamEventFlagItemXattrMod,
+    kFSEventStreamEventIdSinceNow,
+)
+
+from watchdog.events import (
+    DirCreatedEvent,
+    DirDeletedEvent,
+    DirModifiedEvent,
+    DirMovedEvent,
+    FileCreatedEvent,
+    FileDeletedEvent,
+    FileModifiedEvent,
+    FileMovedEvent,
 )
+from watchdog.observers.api import DEFAULT_EMITTER_TIMEOUT, DEFAULT_OBSERVER_TIMEOUT, BaseObserver, EventEmitter
 
 logger = logging.getLogger(__name__)
 

src/watchdog/observers/inotify.py

@@ -64,33 +64,29 @@
 
 """
 
+from __future__ import annotations
+
 import logging
 import os
 import threading
-from .inotify_buffer import InotifyBuffer
-
-from watchdog.observers.api import (
-    EventEmitter,
-    BaseObserver,
-    DEFAULT_EMITTER_TIMEOUT,
-    DEFAULT_OBSERVER_TIMEOUT,
-)
 
 from watchdog.events import (
+    DirCreatedEvent,
     DirDeletedEvent,
     DirModifiedEvent,
     DirMovedEvent,
-    DirCreatedEvent,
+    FileClosedEvent,
+    FileCreatedEvent,
     FileDeletedEvent,
     FileModifiedEvent,
     FileMovedEvent,
-    FileCreatedEvent,
-    FileClosedEvent,
     FileOpenedEvent,
-    generate_sub_moved_events,
     generate_sub_created_events,
+    generate_sub_moved_events,
 )
+from watchdog.observers.api import DEFAULT_EMITTER_TIMEOUT, DEFAULT_OBSERVER_TIMEOUT, BaseObserver, EventEmitter
 
+from .inotify_buffer import InotifyBuffer
 
 logger = logging.getLogger(__name__)
 

src/watchdog/observers/inotify_buffer.py

@@ -12,10 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from __future__ import annotations
+
 import logging
+
+from watchdog.observers.inotify_c import Inotify
 from watchdog.utils import BaseThread
 from watchdog.utils.delayed_queue import DelayedQueue
-from watchdog.observers.inotify_c import Inotify
 
 logger = logging.getLogger(__name__)
 

src/watchdog/observers/inotify_c.py

@@ -13,14 +13,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import os
+from __future__ import annotations
+
+import ctypes
+import ctypes.util
 import errno
+import os
 import struct
 import threading
-import ctypes
-import ctypes.util
+from ctypes import c_char_p, c_int, c_uint32
 from functools import reduce
-from ctypes import c_int, c_char_p, c_uint32
+
 from watchdog.utils import UnsupportedLibc
 
 libc = ctypes.CDLL(None)

src/watchdog/observers/kqueue.py

@@ -13,14 +13,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from __future__ import annotations
+
 # The `select` module varies between platforms.
 # mypy may complain about missing module attributes
 # depending on which platform it's running on.
 # The comment below disables mypy's attribute check.
 #
 # mypy: disable-error-code=attr-defined
 #
-
 """
 :module: watchdog.observers.kqueue
 :synopsis: ``kqueue(2)`` based emitter implementation.
@@ -73,38 +74,30 @@
 
 """
 
-from watchdog.utils import platform
-
-import threading
 import errno
-from stat import S_ISDIR
 import os
 import os.path
 import select
-
-from watchdog.observers.api import (
-    BaseObserver,
-    EventEmitter,
-    DEFAULT_OBSERVER_TIMEOUT,
-    DEFAULT_EMITTER_TIMEOUT,
-)
-
-from watchdog.utils.dirsnapshot import DirectorySnapshot
+import threading
+from stat import S_ISDIR
 
 from watchdog.events import (
-    DirMovedEvent,
-    DirDeletedEvent,
+    EVENT_TYPE_CREATED,
+    EVENT_TYPE_DELETED,
+    EVENT_TYPE_MOVED,
     DirCreatedEvent,
+    DirDeletedEvent,
     DirModifiedEvent,
-    FileMovedEvent,
-    FileDeletedEvent,
+    DirMovedEvent,
     FileCreatedEvent,
+    FileDeletedEvent,
     FileModifiedEvent,
-    EVENT_TYPE_MOVED,
-    EVENT_TYPE_DELETED,
-    EVENT_TYPE_CREATED,
+    FileMovedEvent,
     generate_sub_moved_events,
 )
+from watchdog.observers.api import DEFAULT_EMITTER_TIMEOUT, DEFAULT_OBSERVER_TIMEOUT, BaseObserver, EventEmitter
+from watchdog.utils import platform
+from watchdog.utils.dirsnapshot import DirectorySnapshot
 
 # Maximum number of events to process.
 MAX_EVENTS = 4096

src/watchdog/observers/polling.py

@@ -32,28 +32,24 @@
    :special-members:
 """
 
+from __future__ import annotations
+
 import os
 import threading
 from functools import partial
 
-from watchdog.utils.dirsnapshot import DirectorySnapshot, DirectorySnapshotDiff
-from watchdog.observers.api import (
-    EventEmitter,
-    BaseObserver,
-    DEFAULT_OBSERVER_TIMEOUT,
-    DEFAULT_EMITTER_TIMEOUT,
-)
-
 from watchdog.events import (
-    DirMovedEvent,
-    DirDeletedEvent,
     DirCreatedEvent,
+    DirDeletedEvent,
     DirModifiedEvent,
-    FileMovedEvent,
-    FileDeletedEvent,
+    DirMovedEvent,
     FileCreatedEvent,
+    FileDeletedEvent,
     FileModifiedEvent,
+    FileMovedEvent,
 )
+from watchdog.observers.api import DEFAULT_EMITTER_TIMEOUT, DEFAULT_OBSERVER_TIMEOUT, BaseObserver, EventEmitter
+from watchdog.utils.dirsnapshot import DirectorySnapshot, DirectorySnapshotDiff
 
 
 class PollingEmitter(EventEmitter):