chore: run pyright on CI as type checker (microsoft#942)

kumaraditya303 · web-flow · commit 0be6efeee616 · 2021-10-25T14:11:58.000+02:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -18,15 +18,24 @@ repos:
     hooks:
       - id: black
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.910
+    rev: v0.910-1
     hooks:
       - id: mypy
         additional_dependencies: [types-pyOpenSSL==20.0.6]
   - repo: https://github.com/pycqa/flake8
-    rev: 3.9.2
+    rev: 4.0.1
     hooks:
       - id: flake8
   - repo: https://github.com/pycqa/isort
     rev: 5.9.3
     hooks:
       - id: isort
+  - repo: local
+    hooks:
+      - id: pyright
+        name: pyright
+        entry: pyright
+        language: node
+        pass_filenames: false
+        types: [python]
+        additional_dependencies: ["pyright@1.1.181"]
diff --git a/playwright/_impl/_browser.py b/playwright/_impl/_browser.py
@@ -16,7 +16,7 @@
 import json
 from pathlib import Path
 from types import SimpleNamespace
-from typing import TYPE_CHECKING, Dict, List, Union
+from typing import TYPE_CHECKING, Any, Dict, List, Union
 
 from playwright._impl._api_structures import (
     Geolocation,
@@ -208,7 +208,8 @@ async def normalize_context_params(is_sync: bool, params: Dict) -> None:
     if "extraHTTPHeaders" in params:
         params["extraHTTPHeaders"] = serialize_headers(params["extraHTTPHeaders"])
     if "recordHarPath" in params:
-        params["recordHar"] = {"path": str(params["recordHarPath"])}
+        recordHar: Dict[str, Any] = {"path": str(params["recordHarPath"])}
+        params["recordHar"] = recordHar
         if "recordHarOmitContent" in params:
             params["recordHar"]["omitContent"] = params["recordHarOmitContent"]
             del params["recordHarOmitContent"]
diff --git a/playwright/_impl/_connection.py b/playwright/_impl/_connection.py
@@ -204,10 +204,11 @@ def _send_message_to_server(
         id = self._last_id
         callback = ProtocolCallback(self._loop)
         task = asyncio.current_task(self._loop)
-        callback.stack_trace = getattr(task, "__pw_stack_trace__", None)
-        if not callback.stack_trace:
-            callback.stack_trace = traceback.extract_stack()
-
+        stack_trace: Optional[traceback.StackSummary] = getattr(
+            task, "__pw_stack_trace__", None
+        )
+        callback.stack_trace = stack_trace or traceback.extract_stack()
+        self._callbacks[id] = callback
         metadata = {"stack": serialize_call_stack(callback.stack_trace)}
         api_name = getattr(task, "__pw_api_name__", None)
         if api_name:
diff --git a/playwright/_impl/_frame.py b/playwright/_impl/_frame.py
@@ -265,7 +265,7 @@ async def query_selector(
     async def query_selector_all(self, selector: str) -> List[ElementHandle]:
         return list(
             map(
-                cast(ElementHandle, from_channel),
+                from_channel,
                 await self._channel.send("querySelectorAll", dict(selector=selector)),
             )
         )
diff --git a/playwright/_impl/_helper.py b/playwright/_impl/_helper.py
@@ -181,6 +181,7 @@ def patch_error_message(message: Optional[str]) -> Optional[str]:
     match = re.match(r"(\w+)(: expected .*)", message)
     if match:
         message = to_snake_case(match.group(1)) + match.group(2)
+    assert message is not None
     message = message.replace(
         "Pass { acceptDownloads: true }", "Pass { accept_downloads: True }"
     )
diff --git a/playwright/_impl/_selectors.py b/playwright/_impl/_selectors.py
@@ -13,7 +13,7 @@
 # limitations under the License.
 
 from pathlib import Path
-from typing import Dict, Union
+from typing import Any, Dict, Union
 
 from playwright._impl._api_types import Error
 from playwright._impl._connection import ChannelOwner
@@ -37,7 +37,7 @@ async def register(
             raise Error("Either source or path should be specified")
         if path:
             script = (await async_readfile(path)).decode()
-        params: Dict = dict(name=name, source=script)
+        params: Dict[str, Any] = dict(name=name, source=script)
         if contentScript:
             params["contentScript"] = True
         await self._channel.send("register", params)
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,3 +1,36 @@
 [build-system]
 requires = ["setuptools-scm==6.3.2", "wheel==0.37.0", "auditwheel==5.0.0"]
 build-backend = "setuptools.build_meta"
+
+[tool.pytest.ini_options]
+addopts = "-Wall -rsx -vv -s"
+markers = [
+    "skip_browser",
+    "only_browser",
+    "skip_platform",
+    "only_platform"
+]
+junit_family = "xunit2"
+
+[tool.mypy]
+ignore_missing_imports = true
+python_version = "3.7"
+warn_unused_ignores = true
+warn_redundant_casts = true
+warn_unused_configs = true
+check_untyped_defs = true
+disallow_untyped_defs = true
+
+[[tool.mypy.overrides]]
+module = "tests/async.*"
+ignore_errors = true
+
+[tool.isort]
+profile = "black"
+
+[tool.pyright]
+include = ["playwright"]
+ignore = ["tests/", "scripts/"]
+pythonVersion = "3.7"
+reportMissingImports = false
+reportTypedDictNotRequiredAccess = false
diff --git a/setup.cfg b/setup.cfg
@@ -1,25 +1,5 @@
-[tool:pytest]
-addopts = -Wall -rsx -vv -s
-markers =
-    skip_browser
-    only_browser
-    skip_platform
-    only_platform
-junit_family=xunit2
-[mypy]
-ignore_missing_imports = True
-python_version = 3.7
-warn_unused_ignores = True
-warn_redundant_casts = True
-warn_unused_configs = True
-check_untyped_defs = True
-disallow_untyped_defs = True
-[mypy-tests/async.*]
-ignore_errors = True
 [flake8]
 ignore =
     E501
     W503
     E302
-[isort]
-profile = black

Original file line number	Diff line number	Diff line change
`@@ -265,7 +265,7 @@ async def query_selector(`
`265`	`265`	`async def query_selector_all(self, selector: str) -> List[ElementHandle]:`
`266`	`266`	`return list(`
`267`	`267`	`map(`
`268`		`- cast(ElementHandle, from_channel),`
	`268`	`+ from_channel,`
`269`	`269`	`await self._channel.send("querySelectorAll", dict(selector=selector)),`
`270`	`270`	`)`
`271`	`271`	`)`
Original file line number	Diff line number	Diff line change
`@@ -181,6 +181,7 @@ def patch_error_message(message: Optional[str]) -> Optional[str]:`
`181`	`181`	`match = re.match(r"(\w+)(: expected .*)", message)`
`182`	`182`	`if match:`
`183`	`183`	`message = to_snake_case(match.group(1)) + match.group(2)`
	`184`	`+ assert message is not None`
`184`	`185`	`message = message.replace(`
`185`	`186`	`"Pass { acceptDownloads: true }", "Pass { accept_downloads: True }"`
`186`	`187`	`)`