FilesExpand file tree

 master

/

generate_sync_api.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

executable file

·

179 lines (161 loc) · 6.61 KB

 master

/

generate_sync_api.py

Copy path

Top

File metadata and controls

• Code
• Blame

executable file

·

179 lines (161 loc) · 6.61 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

#!/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, get_type_hints # type: ignore

from playwright._impl._helper import to_snake_case

from scripts.documentation_provider import DocumentationProvider

from scripts.generate_api import (

all_types,

api_globals,

arguments,

header,

process_type,

return_type,

return_value,

short_name,

signature,

)

documentation_provider = DocumentationProvider()

def generate(t: Any) -> None:

print("")

class_name = short_name(t)

base_class = t.__bases__[0].__name__

base_sync_class = (

"SyncBase"

if base_class == "ChannelOwner" or base_class == "object"

else base_class

)

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

print("")

print(f" def __init__(self, obj: {class_name}Impl):")

print(" super().__init__(obj)")

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

print("")

print(" @property")

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

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

[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 not name.startswith("_") and str(value).startswith("<property"):

value = value.fget

print("")

print(" @property")

print(

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

)

documentation_provider.print_entry(

class_name, name, get_type_hints(value, api_globals)

)

[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 name in ["expect_dialog"]:

continue

if (

not name.startswith("_")

and isinstance(value, FunctionType)

and "expect_" not in name

and "remove_listener" != name

):

is_async = inspect.iscoroutinefunction(value)

print("")

print(

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

)

documentation_provider.print_entry(

class_name, name, get_type_hints(value, api_globals)

)

[prefix, suffix] = return_value(

get_type_hints(value, api_globals)["return"]

)

if is_async:

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

suffix = "))" + suffix

else:

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

suffix = ")" + suffix

print(

f"""

try:

log_api("=> {to_snake_case(class_name)}.{to_snake_case(name)} started")

result = {prefix}{arguments(value, len(prefix))}{suffix}

log_api("<= {to_snake_case(class_name)}.{to_snake_case(name)} succeded")

return result

except Exception as e:

log_api("<= {to_snake_case(class_name)}.{to_snake_case(name)} failed")

raise e"""

)

if "expect_" in name:

print("")

return_type_value = return_type(value)

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

event_name = re.sub(r"expect_(.*)", r"\1", name)

event_name = re.sub(r"_", "", event_name)

event_name = re.sub(r"consolemessage", "console", event_name)

print(

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

\"\"\"{class_name}.{name}

Returns context manager that waits for ``event`` to fire upon exit. It passes event's value

into the ``predicate`` function and waits for the predicate to return a truthy value. Will throw

an error if the page is closed before the ``event`` is fired.

with page.expect_{event_name}() as event_info:

page.click("button")

value = event_info.value

Parameters

----------

predicate : Optional[typing.Callable[[Any], bool]]

Predicate receiving event data.

timeout : Optional[int]

Maximum wait time in milliseconds, defaults to 30 seconds, pass `0` to disable the timeout.

The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or

page.setDefaultTimeout(timeout) methods.

\"\"\""""

)

wait_for_method = "waitForEvent(event, predicate, timeout)"

if event_name == "request":

wait_for_method = "waitForRequest(url, predicate, timeout)"

elif event_name == "response":

wait_for_method = "waitForResponse(url, predicate, timeout)"

elif event_name == "loadstate":

wait_for_method = "waitForLoadState(state, timeout)"

elif event_name == "navigation":

wait_for_method = "waitForNavigation(url, wait_until, timeout)"

elif event_name != "event":

print(f' event = "{event_name}"')

print(

f" return EventContextManager(self, self._impl_obj.{wait_for_method})"

)

print("")

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

def main() -> None:

print(header)

print(

"from playwright._impl._sync_base import EventContextManager, SyncBase, mapping"

)

print("NoneType = type(None)")

for t in all_types:

generate(t)

documentation_provider.print_remainder()

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

main()