chore: add missing methods and use a set for it (microsoft#184)

mxschmitt · web-flow · commit f5f9614ae126 · 2020-09-03T19:10:41.000+02:00
* chore: add missing methods and use a set for it

* fix: exit script as failure if methods are missing
diff --git a/playwright/async_api.py b/playwright/async_api.py
@@ -810,6 +810,15 @@ class ElementHandle(JSHandle):
     def __init__(self, obj: ElementHandleImpl):
         super().__init__(obj)
 
+    def toString(self) -> str:
+        """ElementHandle.toString
+
+        Returns
+        -------
+        str
+        """
+        return mapping.from_maybe_impl(self._impl_obj.toString())
+
     def asElement(self) -> typing.Union["ElementHandle", NoneType]:
         """ElementHandle.asElement
 
diff --git a/playwright/element_handle.py b/playwright/element_handle.py
@@ -51,6 +51,9 @@ def __init__(
     ) -> None:
         super().__init__(parent, type, guid, initializer)
 
+    def toString(self) -> str:
+        return self._preview
+
     def asElement(self) -> Optional["ElementHandle"]:
         return self
 
diff --git a/playwright/sync_api.py b/playwright/sync_api.py
@@ -830,6 +830,15 @@ class ElementHandle(JSHandle):
     def __init__(self, obj: ElementHandleImpl):
         super().__init__(obj)
 
+    def toString(self) -> str:
+        """ElementHandle.toString
+
+        Returns
+        -------
+        str
+        """
+        return mapping.from_maybe_impl(self._impl_obj.toString())
+
     def asElement(self) -> typing.Union["ElementHandle", NoneType]:
         """ElementHandle.asElement
 
diff --git a/scripts/documentation_provider.py b/scripts/documentation_provider.py
@@ -43,6 +43,29 @@
     },
 }
 
+expected_mismatches = [
+    "Download.createReadStream",
+    "Browser.startTracing",
+    "Browser.stopTracing",
+    "Logger.log",
+    "BrowserContext.setHTTPCredentials",  # deprecated
+    "BrowserContext.serviceWorkers",  # CR only (and the following)
+    "BrowserContext.backgroundPages",
+    "Browser.newBrowserCDPSession",
+    "Page.coverage",
+    "Coverage.startCSSCoverage",
+    "Coverage.stopCSSCoverage",
+    "Coverage.startJSCoverage",
+    "Coverage.stopJSCoverage",
+    "BrowserContext.newCDPSession",
+    "Logger.isEnabled",
+    "BrowserServer.kill",  # not relevant for RPC clients (and the following)
+    "BrowserType.launchServer",
+    "BrowserServer.close",
+    "BrowserServer.process",
+    "BrowserServer.wsEndpoint",
+]
+
 
 class DocumentationProvider:
     def __init__(self) -> None:
@@ -371,6 +394,7 @@ def rewrite_param_name(self, fqname: str, method_name: str, name: str) -> str:
         return name
 
     def print_remainder(self) -> None:
+        remainders = set()
         for [class_name, value] in self.api.items():
             class_name = re.sub(r"Chromium(.*)", r"\1", class_name)
             class_name = re.sub(r"WebKit(.*)", r"\1", class_name)
@@ -379,8 +403,15 @@ def print_remainder(self) -> None:
                 if method["kind"] == "event":
                     continue
                 entry = f"{class_name}.{method_name}"
-                if entry not in self.printed_entries:
-                    print(f"Method not implemented: {entry}", file=stderr)
+                if (
+                    entry not in self.printed_entries
+                    and entry not in expected_mismatches
+                ):
+                    remainders.add(f"Method not implemented: {entry}")
+        for remainder in remainders:
+            print(remainder, file=stderr)
+        if len(remainders) > 0:
+            exit(1)
 
 
 if __name__ == "__main__":
diff --git a/scripts/generate_async_api.py b/scripts/generate_async_api.py
@@ -1,3 +1,4 @@
+#!/usr/bin/env python
 # Copyright (c) Microsoft Corporation.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
diff --git a/scripts/generate_sync_api.py b/scripts/generate_sync_api.py
@@ -1,3 +1,4 @@
+#!/usr/bin/env python
 # Copyright (c) Microsoft Corporation.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+#!/usr/bin/env python`
`1`	`2`	`# Copyright (c) Microsoft Corporation.`
`2`	`3`	`#`
`3`	`4`	`# Licensed under the Apache License, Version 2.0 (the "License");`