GeezerVisonThe World Wide Web, restored to 800 pixels of glory. |
| Home|About|Gaming cabinet|Archives|How it works|Starter sites |
GeezerVison is showing github.com — playwright-python/scripts/documentation_provider.py at main · tmactong/playwright-python Expand file tree/ Copy pathdocumentation_provider.pyMore file actions 519 lines (470 loc) · 19.9 KB / Copy pathdocumentation_provider.pyFile metadata and controls519 lines (470 loc) · 19.9 KB 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 # Copyright (c) Microsoft Corporation. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. import json import re import subprocess from sys import stderr from typing import ( # type: ignore Any, Dict, List, Set, Union, get_args, get_origin, get_type_hints, ) from urllib.parse import urljoin from playwright._impl._helper import to_snake_case enum_regex = r"^\"[^\"]+\"(?:\|\"[^\"]+\")+$" union_regex = r"^[^\|]+(?:\|[^\|]+)+$" class DocumentationProvider: def __init__(self, is_async: bool) -> None: self.is_async = is_async self.api: Any = {} self.links: Dict[str, str] = {} self.printed_entries: List[str] = [] process_output = subprocess.run( ["python", "-m", "playwright", "print-api-json"], check=True, capture_output=True, ) self.api = json.loads(process_output.stdout) self.errors: Set[str] = set() self._patch_case() def _patch_case(self) -> None: self.classes = {} for clazz in self.api: if not works_for_python(clazz): continue members = {} self.classes[clazz["name"]] = clazz events = [] for member in clazz["members"]: if not works_for_python(member): continue member_name = member["name"] new_name = name_or_alias(member) self._add_link(member["kind"], clazz["name"], member_name, new_name) if member["kind"] == "event": events.append(member) else: new_name = to_snake_case(new_name) member["name"] = new_name members[new_name] = member apply_type_or_override(member) if "args" in member: args = {} for arg in member["args"]: if not works_for_python(arg): continue if arg["name"] == "options": for option in arg["type"]["properties"]: if not works_for_python(option): continue option = self_or_override(option) option_name = to_snake_case(name_or_alias(option)) option["name"] = option_name option["required"] = False args[option_name] = option else: arg = self_or_override(arg) arg_name = to_snake_case(name_or_alias(arg)) arg["name"] = arg_name args[arg_name] = arg member["args"] = args clazz["members"] = members clazz["events"] = events def _add_link(self, kind: str, clazz: str, member: str, alias: str) -> None: match = re.match(r"(JS|CDP|[A-Z])([^.]+)", clazz) if not match: raise Exception("Invalid class " + clazz) var_name = to_snake_case(f"{match.group(1).lower()}{match.group(2)}") new_name = to_snake_case(alias) if kind == "event": new_name = new_name.lower() self.links[ f"[`event: {clazz}.{member}`]" ] = f"`{var_name}.on('{new_name}')`" elif kind == "property": self.links[f"[`property: {clazz}.{member}`]"] = f"`{var_name}.{new_name}`" else: self.links[f"[`method: {clazz}.{member}`]"] = f"`{var_name}.{new_name}()`" def print_entry( self, class_name: str, method_name: str, signature: Dict[str, Any] = None, is_property: bool = False, ) -> None: if class_name in ["BindingCall"] or method_name in [ "pid", ]: return original_method_name = method_name self.printed_entries.append(f"{class_name}.{method_name}") clazz = self.classes[class_name] method = clazz["members"].get(method_name) if not method and "extends" in clazz: superclass = self.classes.get(clazz["extends"]) if superclass: method = superclass["members"].get(method_name) fqname = f"{class_name}.{method_name}" if not method: self.errors.add(f"Method not documented: {fqname}") return doc_is_property = ( not method.get("async") and not len(method["args"]) and "type" in method ) if method["name"].startswith("is_") or method["name"].startswith("as_"): doc_is_property = False if doc_is_property != is_property: self.errors.add(f"Method vs property mismatch: {fqname}") return indent = " " * 8 print(f'{indent}"""{class_name}.{to_snake_case(original_method_name)}') if method.get("comment"): print(f"{indent}{self.beautify_method_comment(method['comment'], indent)}") signature_no_return = {**signature} if signature else None if signature_no_return and "return" in signature_no_return: del signature_no_return["return"] # Collect a list of all names, flatten options. args = method["args"] if signature and signature_no_return: print("") print(" Parameters") print(" ----------") for [name, value] in signature.items(): name = to_snake_case(name) if name == "return": continue original_name = name doc_value = args.get(name) if name in args: del args[name] if not doc_value: self.errors.add(f"Parameter not documented: {fqname}({name}=)") else: code_type = self.serialize_python_type(value) print(f"{indent}{to_snake_case(original_name)} : {code_type}") if doc_value.get("comment"): print( f"{indent} {self.indent_paragraph(self.render_links(doc_value['comment']), f'{indent} ')}" ) if doc_value.get("deprecated"): print( f"{indent} Deprecated: {self.render_links(doc_value['deprecated'])}" ) self.compare_types(code_type, doc_value, f"{fqname}({name}=)", "in") if ( signature and "return" in signature and str(signature["return"]) != "<class 'NoneType'>" ): value = signature["return"] doc_value = method self.compare_types(value, doc_value, f"{fqname}(return=)", "out") print("") print(" Returns") print(" -------") print(f" {self.serialize_python_type(value)}") print(f'{indent}"""') for name in args: if args[name].get("deprecated"): continue self.errors.add( f"Parameter not implemented: {class_name}.{method_name}({name}=)" ) def print_events(self, class_name: str) -> None: clazz = self.classes[class_name] events = clazz["events"] if events: doc = [] for event_type in ["on", "once"]: for event in events: return_type = ( "typing.Union[typing.Awaitable[None], None]" if self.is_async else "None" ) func_arg = self.serialize_doc_type(event["type"], "") if func_arg.startswith("{"): func_arg = "typing.Dict" if "Union[" in func_arg: func_arg = func_arg.replace("Union[", "typing.Union[") if len(events) > 1: doc.append(" @typing.overload") impl = "" if len(events) == 1: impl = f" return super().{event_type}(event=event,f=f)" doc.append( f" def {event_type}(self, event: Literal['{event['name'].lower()}'], f: typing.Callable[['{func_arg}'], '{return_type}']) -> None:" ) doc.append( f' """{self.beautify_method_comment(event["comment"]," " * 8)}"""' ) doc.append(impl) if len(events) > 1: doc.append( f" def {event_type}(self, event: str, f: typing.Callable[...,{return_type}]) -> None:" ) doc.append(f" return super().{event_type}(event=event,f=f)") print("\n".join(doc)) def indent_paragraph(self, p: str, indent: str) -> str: lines = p.split("\n") result = [lines[0]] for line in lines[1:]: result.append(indent + line) return "\n".join(result) def beautify_method_comment(self, comment: str, indent: str) -> str: comment = comment.replace("\\", "\\\\") comment = comment.replace('"', '\\"') lines = comment.split("\n") result = [] skip_example = False last_was_blank = True for line in lines: if not line.strip(): last_was_blank = True continue match = re.match(r"\s*```(.+)", line) if match: lang = match[1] if lang in ["html", "yml", "sh", "py", "python"]: skip_example = False elif lang == "python " + ("async" if self.is_async else "sync"): skip_example = False line = "```py" else: skip_example = True if not skip_example: if last_was_blank: last_was_blank = False result.append("") result.append(self.render_links(line)) if skip_example and line.strip() == "```": skip_example = False comment = self.indent_paragraph("\n".join(result), indent) return self.resolve_playwright_dev_links(comment) def resolve_playwright_dev_links(self, comment: str) -> str: def replace_callback(m: re.Match) -> str: link_text = m.group(1) link_href = m.group(2) resolved = urljoin( "https://playwright.dev/python/docs/api/", link_href.replace(".md", "") ) return f"[{link_text}]({resolved})" # matches against internal markdown links which start with '.'/'..' # e.g. [Playwright](./class-foobar.md) return re.sub(r"\[([^\]]+)\]\((\.[^\)]+)\)", replace_callback, comment) def render_links(self, comment: str) -> str: for [old, new] in self.links.items(): comment = comment.replace(old, new) return comment def make_optional(self, text: str) -> str: if text.startswith("Union["): if text.endswith("None]"): return text return text[:-1] + ", None]" return f"Union[{text}, None]" def compare_types( self, value: Any, doc_value: Any, fqname: str, direction: str ) -> None: if "(arg=)" in fqname or "(pageFunction=)" in fqname: return code_type = self.serialize_python_type(value) doc_type = self.serialize_doc_type(doc_value["type"], direction) if not doc_value["required"]: doc_type = self.make_optional(doc_type) if doc_type != code_type: self.errors.add( f"Parameter type mismatch in {fqname}: documented as {doc_type}, code has {code_type}" ) def serialize_python_type(self, value: Any) -> str: str_value = str(value) if isinstance(value, list): return f"[{', '.join(list(map(lambda a: self.serialize_python_type(a), value)))}]" if str_value == "<class 'playwright._impl._types.Error'>": return "Error" if str_value == "<class 'NoneType'>": return "None" match = re.match(r"^<class '((?:pathlib\.)?\w+)'>$", str_value) if match: return match.group(1) match = re.match( r"playwright._impl._event_context_manager.EventContextManagerImpl\[playwright._impl.[^.]+.(.*)\]", str_value, ) if match: return "EventContextManager[" + match.group(1) + "]" match = re.match(r"^<class 'playwright\._impl\.[\w_]+\.([^']+)'>$", str_value) if ( match and "_api_structures" not in str_value and "_api_types" not in str_value ): if match.group(1) == "EventContextManagerImpl": return "EventContextManager" return match.group(1) match = re.match(r"^typing\.(\w+)$", str_value) if match: return match.group(1) origin = get_origin(value) args = get_args(value) hints = None try: hints = get_type_hints(value) except Exception: pass if hints: signature: List[str] = [] for [name, value] in hints.items(): signature.append(f"{name}: {self.serialize_python_type(value)}") return f"{{{', '.join(signature)}}}" if origin == Union: args = get_args(value) if len(args) == 2 and str(args[1]) == "<class 'NoneType'>": return self.make_optional(self.serialize_python_type(args[0])) ll = list(map(lambda a: self.serialize_python_type(a), args)) ll.sort(key=lambda item: "}" if item == "None" else item) return f"Union[{', '.join(ll)}]" if str(origin) == "<class 'dict'>": args = get_args(value) return f"Dict[{', '.join(list(map(lambda a: self.serialize_python_type(a), args)))}]" if str(origin) == "<class 'list'>": args = get_args(value) return f"List[{', '.join(list(map(lambda a: self.serialize_python_type(a), args)))}]" if str(origin) == "<class 'collections.abc.Callable'>": args = get_args(value) return f"Callable[{', '.join(list(map(lambda a: self.serialize_python_type(a), args)))}]" if str(origin) == "<class 're.Pattern'>": return "Pattern[str]" if str(origin) == "typing.Literal": args = get_args(value) if len(args) == 1: return '"' + self.serialize_python_type(args[0]) + '"' body = ", ".join( list(map(lambda a: '"' + self.serialize_python_type(a) + '"', args)) ) return f"Union[{body}]" return str_value def serialize_doc_type(self, type: Any, direction: str) -> str: result = self.inner_serialize_doc_type(type, direction) return result def inner_serialize_doc_type(self, type: Any, direction: str) -> str: if type["name"] == "Promise": type = type["templates"][0] if "union" in type: ll = [self.serialize_doc_type(t, direction) for t in type["union"]] ll.sort(key=lambda item: "}" if item == "None" else item) for i in range(len(ll)): if ll[i].startswith("Union["): ll[i] = ll[i][6:-1] return f"Union[{', '.join(ll)}]" type_name = type["name"] if type_name == "path": if direction == "in": return "Union[pathlib.Path, str]" else: return "pathlib.Path" if type_name == "function" and "args" not in type: return "Callable" if type_name == "function": return_type = "Any" if type.get("returnType"): return_type = self.serialize_doc_type(type["returnType"], direction) return f"Callable[[{', '.join(self.serialize_doc_type(t, direction) for t in type['args'])}], {return_type}]" if "templates" in type: base = type_name if type_name == "Array": base = "List" if type_name == "Object" or type_name == "Map": base = "Dict" return f"{base}[{', '.join(self.serialize_doc_type(t, direction) for t in type['templates'])}]" if type_name == "Object" and "properties" in type: items = [] for p in type["properties"]: items.append( (p["name"]) + ": " + ( self.serialize_doc_type(p["type"], direction) if p["required"] else self.make_optional( self.serialize_doc_type(p["type"], direction) ) ) ) return f"{{{', '.join(items)}}}" if type_name == "boolean": return "bool" if type_name.lower() == "string": return "str" if type_name == "any" or type_name == "Serializable": return "Any" if type_name == "Object": return "Dict" if type_name == "Function": return "Callable" if type_name == "Buffer" or type_name == "ReadStream": return "bytes" if type_name == "URL": return "str" if type_name == "RegExp": return "Pattern[str]" if type_name == "null": return "None" if type_name == "EvaluationArgument": return "Dict" return type["name"] def print_remainder(self) -> None: for [class_name, clazz] in self.classes.items(): for [member_name, member] in clazz["members"].items(): if member.get("deprecated"): continue entry = f"{class_name}.{member_name}" if entry not in self.printed_entries: self.errors.add(f"Method not implemented: {entry}") with open("scripts/expected_api_mismatch.txt") as f: for line in f.readlines(): sline = line.strip() if not len(sline) or sline.startswith("#"): continue if sline in self.errors: self.errors.remove(sline) else: print("No longer there: " + sline, file=stderr) if len(self.errors) > 0: for error in self.errors: print(error, file=stderr) exit(1) def works_for_python(item: Any) -> bool: return not item["langs"].get("only") or "python" in item["langs"]["only"] def name_or_alias(item: Any) -> str: alias = ( item["langs"].get("aliases").get("python") if item["langs"].get("aliases") else None ) return alias or item["name"] def self_or_override(item: Any) -> Any: override = ( item["langs"].get("overrides").get("python") if item["langs"].get("overrides") else None ) return override or item def apply_type_or_override(member: Any) -> Any: if member["langs"].get("types") and member["langs"]["types"].get("python"): member["type"] = member["langs"]["types"]["python"] |
| You are visitor 01402520 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required. |