chore(lint): added isort for import sorting (#75)

Author: mxschmitt

.github/workflows/ci.yml

@@ -21,10 +21,7 @@ jobs:
         pip install -r local-requirements.txt
         pip install .
     - name: Lint
-      run: |
-        black --check .
-        mypy .
-        flake8 playwright tests
+      run: pre-commit run --all-files
   build:
     timeout-minutes: 30
     strategy:

.pre-commit-config.yaml

@@ -20,3 +20,7 @@ repos:
     rev: 'a7be77f761a4c29121d6bb6f61c11902281f9105'
     hooks:
     -   id: flake8
+-   repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.1.3
+    hooks:
+    -   id: isort

SECURITY.md

@@ -14,7 +14,7 @@ Instead, please report them to the Microsoft Security Response Center (MSRC) at
 
 If you prefer to submit without logging in, send email to [[email protected]](mailto:[email protected]).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
 
-You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). 
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
 
 Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
 
@@ -38,4 +38,4 @@ We prefer all communications to be in English.
 
 Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
 
-<!-- END MICROSOFT SECURITY.MD BLOCK -->
+<!-- END MICROSOFT SECURITY.MD BLOCK -->

playwright/__init__.py

@@ -12,9 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import playwright.helper as helper
 from playwright._repo_version import version as __version__  # noqa:F401
 from playwright.main import playwright_object
-import playwright.helper as helper
 
 chromium = playwright_object.chromium
 firefox = playwright_object.firefox

playwright/accessibility.py

@@ -12,9 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import Dict
+
 from playwright.connection import Channel
 from playwright.element_handle import ElementHandle
-from typing import Dict
 
 
 class Accessibility:

playwright/browser.py

@@ -13,13 +13,14 @@
 # limitations under the License.
 
 import sys
+from types import SimpleNamespace
+from typing import Dict, List, Union
+
 from playwright.browser_context import BrowserContext
 from playwright.connection import ChannelOwner, ConnectionScope, from_channel
-from playwright.helper import locals_to_params, ColorScheme
+from playwright.helper import ColorScheme, locals_to_params
 from playwright.network import serialize_headers
 from playwright.page import Page
-from types import SimpleNamespace
-from typing import Dict, List, Union
 
 if sys.version_info >= (3, 8):  # pragma: no cover
     from typing import Literal

playwright/browser_context.py

@@ -13,11 +13,10 @@
 # limitations under the License.
 
 import asyncio
-from playwright.connection import (
-    ChannelOwner,
-    ConnectionScope,
-    from_channel,
-)
+from types import SimpleNamespace
+from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Union
+
+from playwright.connection import ChannelOwner, ConnectionScope, from_channel
 from playwright.helper import (
     Cookie,
     Error,
@@ -31,8 +30,6 @@
 )
 from playwright.network import Request, Route, serialize_headers
 from playwright.page import BindingCall, Page, wait_for_event
-from types import SimpleNamespace
-from typing import Any, Callable, Dict, List, Optional, Union, TYPE_CHECKING
 
 if TYPE_CHECKING:  # pragma: no cover
     from playwright.browser import Browser

playwright/browser_server.py

@@ -12,10 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from playwright.connection import ChannelOwner, ConnectionScope
 from types import SimpleNamespace
 from typing import Dict
 
+from playwright.connection import ChannelOwner, ConnectionScope
+
 
 class BrowserServer(ChannelOwner):
 

playwright/browser_type.py

@@ -12,11 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from playwright.connection import ChannelOwner, ConnectionScope, from_channel
+from typing import Dict, List
+
 from playwright.browser import Browser
 from playwright.browser_context import BrowserContext
-from playwright.helper import locals_to_params, ColorScheme
-from typing import Dict, List
+from playwright.connection import ChannelOwner, ConnectionScope, from_channel
+from playwright.helper import ColorScheme, locals_to_params
 
 
 class BrowserType(ChannelOwner):

playwright/connection.py

@@ -15,11 +15,13 @@
 import asyncio
 import sys
 import traceback
-from playwright.helper import parse_error, ParsedMessagePayload
-from playwright.transport import Transport
-from pyee import BaseEventEmitter
 from typing import Any, Dict, List, Optional
 
+from pyee import BaseEventEmitter
+
+from playwright.helper import ParsedMessagePayload, parse_error
+from playwright.transport import Transport
+
 
 class Channel(BaseEventEmitter):
     def __init__(self, scope: "ConnectionScope", guid: str) -> None:

playwright/console_message.py

@@ -12,10 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import Dict, List
+
 from playwright.connection import ChannelOwner, ConnectionScope, from_channel
 from playwright.helper import ConsoleMessageLocation
 from playwright.js_handle import JSHandle
-from typing import Dict, List
 
 
 class ConsoleMessage(ChannelOwner):

playwright/dialog.py

@@ -12,9 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import Dict
+
 from playwright.connection import ChannelOwner, ConnectionScope
 from playwright.helper import locals_to_params
-from typing import Dict
 
 
 class Dialog(ChannelOwner):

playwright/download.py

@@ -12,9 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from playwright.connection import ChannelOwner, ConnectionScope
 from typing import Dict, Optional
 
+from playwright.connection import ChannelOwner, ConnectionScope
+
 
 class Download(ChannelOwner):
     def __init__(self, scope: ConnectionScope, guid: str, initializer: Dict) -> None:

playwright/drivers/browsers.json

@@ -14,4 +14,4 @@
       "revision": "1308"
     }
   ]
-}
+}

playwright/element_handle.py

@@ -16,29 +16,17 @@
 import mimetypes
 import os
 import sys
-from playwright.connection import (
-    ConnectionScope,
-    from_nullable_channel,
-)
+from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Union, cast
+
+from playwright.connection import ConnectionScope, from_nullable_channel
 from playwright.helper import (
     FilePayload,
     KeyboardModifier,
     MouseButton,
     SelectOption,
     locals_to_params,
 )
-from playwright.js_handle import parse_result, serialize_argument, JSHandle
-
-from typing import (
-    Any,
-    Callable,
-    Dict,
-    List,
-    Optional,
-    Union,
-    TYPE_CHECKING,
-    cast,
-)
+from playwright.js_handle import JSHandle, parse_result, serialize_argument
 
 if sys.version_info >= (3, 8):  # pragma: no cover
     from typing import Literal

playwright/file_chooser.py

@@ -12,13 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from playwright.helper import FilePayload
+from typing import TYPE_CHECKING, List, Union
 
-from typing import List, Union, TYPE_CHECKING
+from playwright.helper import FilePayload
 
 if TYPE_CHECKING:  # pragma: no cover
-    from playwright.page import Page
     from playwright.element_handle import ElementHandle
+    from playwright.page import Page
 
 
 class FileChooser:

playwright/frame.py

@@ -13,8 +13,11 @@
 # limitations under the License.
 
 import asyncio
-from pyee import BaseEventEmitter
 import sys
+from typing import TYPE_CHECKING, Any, Awaitable, Dict, List, Optional, Set, Union, cast
+
+from pyee import BaseEventEmitter
+
 from playwright.connection import (
     ChannelOwner,
     ConnectionScope,
@@ -28,16 +31,15 @@
     normalize_file_payloads,
 )
 from playwright.helper import (
+    DocumentLoadState,
     FilePayload,
-    is_function_body,
-    locals_to_params,
     KeyboardModifier,
     MouseButton,
-    DocumentLoadState,
+    is_function_body,
+    locals_to_params,
 )
 from playwright.js_handle import JSHandle, parse_result, serialize_argument
 from playwright.network import Response
-from typing import Any, Awaitable, Dict, List, Optional, Set, Union, TYPE_CHECKING, cast
 
 if sys.version_info >= (3, 8):  # pragma: no cover
     from typing import Literal

playwright/helper.py

@@ -15,31 +15,29 @@
 import asyncio
 import fnmatch
 import re
+import sys
 import traceback
 from types import TracebackType
-
 from typing import (
+    TYPE_CHECKING,
     Any,
     Callable,
     Dict,
     List,
     Optional,
-    Union,
-    TYPE_CHECKING,
     Pattern,
+    Union,
     cast,
 )
 
-import sys
-
 if sys.version_info >= (3, 8):  # pragma: no cover
     from typing import Literal, TypedDict
 else:  # pragma: no cover
     from typing_extensions import Literal, TypedDict
 
 
 if TYPE_CHECKING:  # pragma: no cover
-    from playwright.network import Route, Request
+    from playwright.network import Request, Route
 
 Cookie = List[Dict[str, Union[str, int, bool]]]
 URLMatch = Union[str, Pattern, Callable[[str], bool]]

playwright/input.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 from playwright.connection import Channel
-from playwright.helper import locals_to_params, MouseButton
+from playwright.helper import MouseButton, locals_to_params
 
 
 class Keyboard:

playwright/js_handle.py

@@ -13,11 +13,11 @@
 # limitations under the License.
 
 import math
-
 from datetime import datetime
+from typing import TYPE_CHECKING, Any, Dict, List, Optional
+
 from playwright.connection import ChannelOwner, ConnectionScope, from_channel
 from playwright.helper import Error, is_function_body
-from typing import Any, Dict, List, Optional, TYPE_CHECKING
 
 if TYPE_CHECKING:  # pragma: no cover
     from playwright.element_handle import ElementHandle

playwright/main.py

@@ -17,8 +17,8 @@
 import os
 import shutil
 import stat
-import sys
 import subprocess
+import sys
 
 from playwright.connection import Connection
 from playwright.object_factory import create_remote_object

playwright/network.py

@@ -14,14 +14,15 @@
 
 import base64
 import json
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union, cast
+
 from playwright.connection import (
     ChannelOwner,
     ConnectionScope,
-    from_nullable_channel,
     from_channel,
+    from_nullable_channel,
 )
-from playwright.helper import Error, ContinueParameters, Header
-from typing import Any, Dict, List, Optional, Union, TYPE_CHECKING, cast
+from playwright.helper import ContinueParameters, Error, Header
 
 if TYPE_CHECKING:  # pragma: no cover
     from playwright.frame import Frame

playwright/object_factory.py

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import Any, Dict
+
 from playwright.browser import Browser
 from playwright.browser_context import BrowserContext
 from playwright.browser_server import BrowserServer
@@ -27,7 +29,6 @@
 from playwright.page import BindingCall, Page
 from playwright.playwright import Playwright
 from playwright.worker import Worker
-from typing import Any, Dict
 
 
 class DummyObject(ChannelOwner):