playwright._impl._page.Page Class Reference

Inheritance diagram for playwright._impl._page.Page:

Collaboration diagram for playwright._impl._page.Page:

Public Member Functions
None	__init__ (self, ChannelOwner parent, str type, str guid, Dict initializer)
str	__repr__ (self)
"BrowserContext"	context (self)
Clock	clock (self)
Optional["Page"]	opener (self)
Frame	main_frame (self)
Optional[Frame]	frame (self, str name=None, URLMatch url=None)
List[Frame]	frames (self)
None	set_default_navigation_timeout (self, float timeout)
None	set_default_timeout (self, float timeout)
Optional[ElementHandle]	query_selector (self, str selector, bool strict=None)
List[ElementHandle]	query_selector_all (self, str selector)
Optional[ElementHandle]	wait_for_selector (self, str selector, float timeout=None, Literal["attached", "detached", "hidden", "visible"] state=None, bool strict=None)
bool	is_checked (self, str selector, bool strict=None, float timeout=None)
bool	is_disabled (self, str selector, bool strict=None, float timeout=None)
bool	is_editable (self, str selector, bool strict=None, float timeout=None)
bool	is_enabled (self, str selector, bool strict=None, float timeout=None)
bool	is_hidden (self, str selector, bool strict=None, float timeout=None)
bool	is_visible (self, str selector, bool strict=None, float timeout=None)
None	dispatch_event (self, str selector, str type, Dict eventInit=None, float timeout=None, bool strict=None)
Any	evaluate (self, str expression, Serializable arg=None)
JSHandle	evaluate_handle (self, str expression, Serializable arg=None)
Any	eval_on_selector (self, str selector, str expression, Serializable arg=None, bool strict=None)
Any	eval_on_selector_all (self, str selector, str expression, Serializable arg=None)
ElementHandle	add_script_tag (self, str url=None, Union[str, Path] path=None, str content=None, str type=None)
ElementHandle	add_style_tag (self, str url=None, Union[str, Path] path=None, str content=None)
None	expose_function (self, str name, Callable callback)
None	expose_binding (self, str name, Callable callback, bool handle=None)
None	set_extra_http_headers (self, Dict[str, str] headers)
str	url (self)
str	content (self)
None	set_content (self, str html, float timeout=None, DocumentLoadState waitUntil=None)
Optional[Response]	goto (self, str url, float timeout=None, DocumentLoadState waitUntil=None, str referer=None)
Optional[Response]	reload (self, float timeout=None, DocumentLoadState waitUntil=None)
None	wait_for_load_state (self, Literal["domcontentloaded", "load", "networkidle"] state=None, float timeout=None)
None	wait_for_url (self, URLMatch url, DocumentLoadState waitUntil=None, float timeout=None)
Any	wait_for_event (self, str event, Callable predicate=None, float timeout=None)
Optional[Response]	go_back (self, float timeout=None, DocumentLoadState waitUntil=None)
Optional[Response]	go_forward (self, float timeout=None, DocumentLoadState waitUntil=None)
None	request_gc (self)
None	emulate_media (self, Literal["null", "print", "screen"] media=None, ColorScheme colorScheme=None, ReducedMotion reducedMotion=None, ForcedColors forcedColors=None, Contrast contrast=None)
None	set_viewport_size (self, ViewportSize viewportSize)
Optional[ViewportSize]	viewport_size (self)
None	bring_to_front (self)
None	add_init_script (self, str script=None, Union[str, Path] path=None)
None	route (self, URLMatch url, RouteHandlerCallback handler, int times=None)
None	unroute (self, URLMatch url, Optional[RouteHandlerCallback] handler=None)
None	route_web_socket (self, URLMatch url, WebSocketRouteHandlerCallback handler)
None	unroute_all (self, Literal["default", "ignoreErrors", "wait"] behavior=None)
None	route_from_har (self, Union[Path, str] har, Union[Pattern[str], str] url=None, RouteFromHarNotFoundPolicy notFound=None, bool update=None, Literal["attach", "embed"] updateContent=None, HarMode updateMode=None)
bytes	screenshot (self, float timeout=None, Literal["jpeg", "png"] type=None, Union[str, Path] path=None, int quality=None, bool omitBackground=None, bool fullPage=None, FloatRect clip=None, Literal["allow", "disabled"] animations=None, Literal["hide", "initial"] caret=None, Literal["css", "device"] scale=None, Sequence["Locator"] mask=None, str maskColor=None, str style=None)
str	title (self)
None	close (self, bool runBeforeUnload=None, str reason=None)
bool	is_closed (self)
None	click (self, str selector, Sequence[KeyboardModifier] modifiers=None, Position position=None, float delay=None, MouseButton button=None, int clickCount=None, float timeout=None, bool force=None, bool noWaitAfter=None, bool trial=None, bool strict=None)
None	dblclick (self, str selector, Sequence[KeyboardModifier] modifiers=None, Position position=None, float delay=None, MouseButton button=None, float timeout=None, bool force=None, bool noWaitAfter=None, bool strict=None, bool trial=None)
None	tap (self, str selector, Sequence[KeyboardModifier] modifiers=None, Position position=None, float timeout=None, bool force=None, bool noWaitAfter=None, bool strict=None, bool trial=None)
None	fill (self, str selector, str value, float timeout=None, bool noWaitAfter=None, bool strict=None, bool force=None)
"Locator"	locator (self, str selector, Union[str, Pattern[str]] hasText=None, Union[str, Pattern[str]] hasNotText=None, "Locator" has=None, "Locator" hasNot=None)
"Locator"	get_by_alt_text (self, Union[str, Pattern[str]] text, bool exact=None)
"Locator"	get_by_label (self, Union[str, Pattern[str]] text, bool exact=None)
"Locator"	get_by_placeholder (self, Union[str, Pattern[str]] text, bool exact=None)
"Locator"	get_by_role (self, AriaRole role, bool checked=None, bool disabled=None, bool expanded=None, bool includeHidden=None, int level=None, Union[str, Pattern[str]] name=None, bool pressed=None, bool selected=None, bool exact=None)
"Locator"	get_by_test_id (self, Union[str, Pattern[str]] testId)
"Locator"	get_by_text (self, Union[str, Pattern[str]] text, bool exact=None)
"Locator"	get_by_title (self, Union[str, Pattern[str]] text, bool exact=None)
"FrameLocator"	frame_locator (self, str selector)
None	focus (self, str selector, bool strict=None, float timeout=None)
Optional[str]	text_content (self, str selector, bool strict=None, float timeout=None)
str	inner_text (self, str selector, bool strict=None, float timeout=None)
str	inner_html (self, str selector, bool strict=None, float timeout=None)
Optional[str]	get_attribute (self, str selector, str name, bool strict=None, float timeout=None)
None	hover (self, str selector, Sequence[KeyboardModifier] modifiers=None, Position position=None, float timeout=None, bool noWaitAfter=None, bool force=None, bool strict=None, bool trial=None)
None	drag_and_drop (self, str source, str target, Position sourcePosition=None, Position targetPosition=None, bool force=None, bool noWaitAfter=None, float timeout=None, bool strict=None, bool trial=None, int steps=None)
List[str]	select_option (self, str selector, Union[str, Sequence[str]] value=None, Union[int, Sequence[int]] index=None, Union[str, Sequence[str]] label=None, Union["ElementHandle", Sequence["ElementHandle"]] element=None, float timeout=None, bool noWaitAfter=None, bool force=None, bool strict=None)
str	input_value (self, str selector, bool strict=None, float timeout=None)
None	set_input_files (self, str selector, Union[str, Path, FilePayload, Sequence[Union[str, Path]], Sequence[FilePayload]] files, float timeout=None, bool strict=None, bool noWaitAfter=None)
None	type (self, str selector, str text, float delay=None, float timeout=None, bool noWaitAfter=None, bool strict=None)
None	press (self, str selector, str key, float delay=None, float timeout=None, bool noWaitAfter=None, bool strict=None)
None	check (self, str selector, Position position=None, float timeout=None, bool force=None, bool noWaitAfter=None, bool strict=None, bool trial=None)
None	uncheck (self, str selector, Position position=None, float timeout=None, bool force=None, bool noWaitAfter=None, bool strict=None, bool trial=None)
None	wait_for_timeout (self, float timeout)
JSHandle	wait_for_function (self, str expression, Serializable arg=None, float timeout=None, Union[float, Literal["raf"]] polling=None)
List["Worker"]	workers (self)
"APIRequestContext"	request (self)
None	pause (self)
bytes	pdf (self, float scale=None, bool displayHeaderFooter=None, str headerTemplate=None, str footerTemplate=None, bool printBackground=None, bool landscape=None, str pageRanges=None, str format=None, Union[str, float] width=None, Union[str, float] height=None, bool preferCSSPageSize=None, PdfMargins margin=None, Union[str, Path] path=None, bool outline=None, bool tagged=None)
Optional[Video]	video (self)
EventContextManagerImpl	expect_event (self, str event, Callable predicate=None, float timeout=None)
EventContextManagerImpl[ConsoleMessage]	expect_console_message (self, Callable[[ConsoleMessage], bool] predicate=None, float timeout=None)
EventContextManagerImpl[Download]	expect_download (self, Callable[[Download], bool] predicate=None, float timeout=None)
EventContextManagerImpl[FileChooser]	expect_file_chooser (self, Callable[[FileChooser], bool] predicate=None, float timeout=None)
EventContextManagerImpl[Response]	expect_navigation (self, URLMatch url=None, DocumentLoadState waitUntil=None, float timeout=None)
EventContextManagerImpl["Page"]	expect_popup (self, Callable[["Page"], bool] predicate=None, float timeout=None)
EventContextManagerImpl[Request]	expect_request (self, URLMatchRequest urlOrPredicate, float timeout=None)
EventContextManagerImpl[Request]	expect_request_finished (self, Callable[["Request"], bool] predicate=None, float timeout=None)
EventContextManagerImpl[Response]	expect_response (self, URLMatchResponse urlOrPredicate, float timeout=None)
EventContextManagerImpl["WebSocket"]	expect_websocket (self, Callable[["WebSocket"], bool] predicate=None, float timeout=None)
EventContextManagerImpl["Worker"]	expect_worker (self, Callable[["Worker"], bool] predicate=None, float timeout=None)
None	set_checked (self, str selector, bool checked, Position position=None, float timeout=None, bool force=None, bool noWaitAfter=None, bool strict=None, bool trial=None)
None	add_locator_handler (self, "Locator" locator, Union[Callable[["Locator"], Any], Callable[[], Any]] handler, bool noWaitAfter=None, int times=None)
None	remove_locator_handler (self, "Locator" locator)
List[Request]	requests (self)
List[ConsoleMessage]	console_messages (self)
List[Error]	page_errors (self)
Public Member Functions inherited from playwright._impl._connection.ChannelOwner
None	remove_listener (self, str event, Any f)
Public Member Functions inherited from pyee.asyncio.AsyncIOEventEmitter
bool	emit (Self self, str event, *Any args, **Any kwargs)
None	wait_for_complete (Self self)
None	cancel (Self self)
bool	complete (Self self)
Public Member Functions inherited from pyee.base.EventEmitter
Mapping[str, Any]	__getstate__ (Self self)
None	__setstate__ (Self self, Mapping[str, Any] state)
Callable[[Handler], Handler]	on (Self self, str event)
Handler	on (Self self, str event, Handler f)
Union[Handler, Callable[[Handler], Handler]]	on (Self self, str event, Optional[Handler] f=None)
Callable[[Handler], Handler]	listens_to (Self self, str event)
Handler	add_listener (Self self, str event, Handler f)
Set[str]	event_names (Self self)
Callable	once (Self self, str event, Optional[Callable] f=None)
None	remove_all_listeners (Self self, Optional[str] event=None)
List[Callable]	listeners (Self self, str event)

Public Attributes
	keyboard
	mouse
	touchscreen

Static Public Attributes
	Events
Keyboard	keyboard
Mouse	mouse
Touchscreen	touchscreen

Protected Member Functions
None	_on_frame_attached (self, Frame frame)
None	_on_frame_detached (self, Frame frame)
None	_on_route (self, Route route)
None	_on_web_socket_route (self, WebSocketRoute web_socket_route)
None	_on_binding (self, "BindingCall" binding_call)
None	_on_worker (self, "Worker" worker)
None	_on_close (self)
None	_on_crash (self)
None	_on_download (self, Any params)
None	_on_video (self, Any params)
None	_on_viewport_size_changed (self, Any params)
None	_unroute_internal (self, List[RouteHandler] removed, List[RouteHandler] remaining, Literal["default", "ignoreErrors", "wait"] behavior=None)
None	_dispose_har_routers (self)
None	_update_interception_patterns (self)
None	_update_web_socket_interception_patterns (self)
Video	_force_video (self)
TargetClosedError	_close_error_with_reason (self)
EventContextManagerImpl	_expect_event (self, str event, Callable predicate=None, float timeout=None, str log_line=None)
None	_on_locator_handler_triggered (self, str uid)
Protected Member Functions inherited from playwright._impl._connection.ChannelOwner
None	_dispose (self, Optional[str] reason)
None	_adopt (self, "ChannelOwner" child)
None	_set_event_to_subscription_mapping (self, Dict[str, str] mapping)
None	_update_subscription (self, str event, bool enabled)
None	_add_event_handler (self, str event, Any k, Any v)
Protected Member Functions inherited from pyee.asyncio.AsyncIOEventEmitter
None	_emit_run (Self self, Callable f, Tuple[Any,...] args, Dict[str, Any] kwargs)
Protected Member Functions inherited from pyee.base.EventEmitter
None	_emit_handle_potential_error (Self self, str event, Any error)
bool	_call_handlers (Self self, str event, Tuple[Any,...] args, Dict[str, Any] kwargs)
None	_remove_listener (Self self, str event, Callable f)

Protected Attributes
	_browser_context
	_frames
	_is_closed
	_opener
	_close_was_called
	_on_viewport_size_changed
	_routes
	_viewport_size
	_har_routers
	_close_reason
	_closed_or_crashed_future
	_video
	_loop
Protected Attributes inherited from playwright._impl._connection.ChannelOwner
	_type
	_initializer
	_was_collected
	_event_to_subscription_mapping
Protected Attributes inherited from pyee.asyncio.AsyncIOEventEmitter
	_waiting
Protected Attributes inherited from pyee.base.EventEmitter
	_lock
	_events

Constructor & Destructor Documentation

__init__()

None playwright._impl._page.Page.__init__	(		self,
		ChannelOwner	parent,
		str	type,
		str	guid,
		Dict	initializer
	)

Reimplemented from playwright._impl._connection.ChannelOwner.

Member Data Documentation

Events

playwright._impl._page.Page.Events

static

Initial value:

=  SimpleNamespace(
        Close="close",
        Crash="crash",
        Console="console",
        Dialog="dialog",
        Download="download",
        FileChooser="filechooser",
        DOMContentLoaded="domcontentloaded",
        PageError="pageerror",
        Request="request",
        Response="response",
        RequestFailed="requestfailed",
        RequestFinished="requestfinished",
        FrameAttached="frameattached",
        FrameDetached="framedetached",
        FrameNavigated="framenavigated",
        Load="load",
        Popup="popup",
        WebSocket="websocket",
        Worker="worker",
    )

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/playwright/_impl/_page.py