GeezerVison is showing github.com — playwright-python/scripts/generate_async_api.py at main · FadeHack/playwright-python

Expand file tree

generate_async_api.py

Copy path

More file actions

Latest commit

History

executable file

145 lines (135 loc) · 5.33 KB

generate_async_api.py

Copy path

File metadata and controls

executable file

145 lines (135 loc) · 5.33 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

#!/usr/bin/env python

# 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 inspect

import re

from types import FunctionType

from typing import Any

from documentation_provider import DocumentationProvider

from generate_api import (

api_globals,

arguments,

generated_types,

get_type_hints,

header,

process_type,

return_type,

return_value,

short_name,

signature,

)

documentation_provider = DocumentationProvider(True)

def generate(t: Any) -> None:

print("")

class_name = short_name(t)

base_class = t.__bases__[0].__name__

if class_name in ["Page", "BrowserContext", "Browser", "Disposable"]:

base_sync_class = "AsyncContextManager"

elif base_class in ["ChannelOwner", "object", "AssertionsBase"]:

base_sync_class = "AsyncBase"

else:

base_sync_class = base_class

print(f"class {class_name}({base_sync_class}):")

print("")

documentation_provider.print_events(class_name)

for [name, type] in get_type_hints(t, api_globals).items():

print("")

print(" @property")

print(f" def {name}(self) -> {process_type(type)}:")

documentation_provider.print_entry(class_name, name, {"return": type}, True)

[prefix, suffix] = return_value(type)

prefix = " return " + prefix + f"self._impl_obj.{name}"

print(f"{prefix}{suffix}")

for [name, value] in t.__dict__.items():

if name.startswith("_"):

continue

if str(value).startswith("<property"):

value = value.fget

print("")

print(" @property")

print(

f" def {name}({signature(value, len(name) + 9)}) -> {return_type(value)}:"

)

documentation_provider.print_entry(

class_name, name, get_type_hints(value, api_globals), True

)

[prefix, suffix] = return_value(

get_type_hints(value, api_globals)["return"]

)

prefix = " return " + prefix + f"self._impl_obj.{name}"

print(f"{prefix}{arguments(value, len(prefix))}{suffix}")

for [name, value] in t.__dict__.items():

if isinstance(value, FunctionType) and "remove_listener" != name:

# List of dunder methods to allow without docs

allow_without_docs_methods = [

"__getitem__",

]

if name.startswith("_") and name not in allow_without_docs_methods:

continue

is_async = inspect.iscoroutinefunction(value)

return_type_value = return_type(value)

return_type_value = re.sub(r"\"([^\"]+)Impl\"", r"\1", return_type_value)

return_type_value = return_type_value.replace(

"EventContextManager", "AsyncEventContextManager"

)

return_type_value = return_type_value.replace(

'"Disposable"', '"AsyncContextManager"'

).replace('"DisposableStub"', '"AsyncContextManager"')

print("")

if name in ("expect_event", "wait_for_event"):

documentation_provider.print_event_overloads(class_name, name)

async_prefix = "async " if is_async else ""

print(

f" {async_prefix}def {name}({signature(value, len(name) + 9)}) -> {return_type_value}:"

)

# Allow dunder methods without docs

if name not in allow_without_docs_methods:

documentation_provider.print_entry(

class_name, name, get_type_hints(value, api_globals)

)

if class_name in [

"LocatorAssertions",

"PageAssertions",

"APIResponseAssertions",

print(" __tracebackhide__ = True")

if "expect_" in name:

print("")

print(

f" return AsyncEventContextManager(self._impl_obj.{name}({arguments(value, 12)}).future)"

)

else:

[prefix, suffix] = return_value(

get_type_hints(value, api_globals)["return"]

)

if is_async:

prefix += "await "

prefix = prefix + f"self._impl_obj.{name}("

suffix = ")" + suffix

print(

f"""

return {prefix}{arguments(value, len(prefix))}{suffix}"""

)

print("")

print(f"mapping.register({class_name}Impl, {class_name})")

def main() -> None:

print(header)

print(

"from playwright._impl._async_base import AsyncEventContextManager, AsyncBase, AsyncContextManager, mapping"

)

for t in generated_types:

generate(t)

documentation_provider.print_remainder()

if __name__ == "__main__": # pragma: no cover

main()