JSHandle

JSHandle represents an in-page JavaScript object. JSHandles can be created with the page.evaluate_handle(expression, **kwargs) method.

Sync

window_handle = page.evaluate_handle("window")
# ...

Async

window_handle = await page.evaluate_handle("window")
# ...

JSHandle prevents the referenced JavaScript object being garbage collected unless the handle is exposed with js_handle.dispose(). JSHandles are auto-disposed when their origin frame gets navigated or the parent context gets destroyed.

JSHandle instances can be used as an argument in page.eval_on_selector(selector, expression, **kwargs), page.evaluate(expression, **kwargs) and page.evaluate_handle(expression, **kwargs) methods.

• js_handle.as_element()
• js_handle.dispose()
• js_handle.evaluate(expression, **kwargs)
• js_handle.evaluate_handle(expression, **kwargs)
• js_handle.get_properties()
• js_handle.get_property(property_name)
• js_handle.json_value()

js_handle.as_element()

Added in: v1.8

• returns: <NoneType|ElementHandle>#

Returns either null or the object handle itself, if the object handle is an instance of ElementHandle.

js_handle.dispose()

Added in: v1.8

• returns: <NoneType>#

The jsHandle.dispose method stops referencing the element handle.

js_handle.evaluate(expression, **kwargs)

Added in: v1.8

• expression <str> JavaScript expression to be evaluated in the browser context. If the expresion evaluates to a function, the function is automatically invoked.#
• arg <EvaluationArgument> Optional argument to pass to expression.#
• returns: <Serializable>#

Returns the return value of expression.

This method passes this handle as the first argument to expression.

If expression returns a Promise, then handle.evaluate would wait for the promise to resolve and return its value.

Examples:

Sync

tweet_handle = page.query_selector(".tweet .retweets")
assert tweet_handle.evaluate("node => node.innerText") == "10 retweets"

Async

tweet_handle = await page.query_selector(".tweet .retweets")
assert await tweet_handle.evaluate("node => node.innerText") == "10 retweets"

js_handle.evaluate_handle(expression, **kwargs)

Added in: v1.8

• expression <str> JavaScript expression to be evaluated in the browser context. If the expresion evaluates to a function, the function is automatically invoked.#
• arg <EvaluationArgument> Optional argument to pass to expression.#
• returns: <JSHandle>#

Returns the return value of expression as a JSHandle.

This method passes this handle as the first argument to expression.

The only difference between jsHandle.evaluate and jsHandle.evaluateHandle is that jsHandle.evaluateHandle returns JSHandle.

If the function passed to the jsHandle.evaluateHandle returns a Promise, then jsHandle.evaluateHandle would wait for the promise to resolve and return its value.

See page.evaluate_handle(expression, **kwargs) for more details.

js_handle.get_properties()

Added in: v1.8

• returns: <[Map][str, JSHandle]>#

The method returns a map with own property names as keys and JSHandle instances for the property values.

Sync

handle = page.evaluate_handle("{window, document}")
properties = handle.get_properties()
window_handle = properties.get("window")
document_handle = properties.get("document")
handle.dispose()

Async

handle = await page.evaluate_handle("{window, document}")
properties = await handle.get_properties()
window_handle = properties.get("window")
document_handle = properties.get("document")
await handle.dispose()

js_handle.get_property(property_name)

Added in: v1.8

• property_name <str> property to get#
• returns: <JSHandle>#

Fetches a single property from the referenced object.

js_handle.json_value()

Added in: v1.8

• returns: <Serializable>#

Returns a JSON representation of the object. If the object has a toJSON function, it will not be called.

note

The method will return an empty JSON object if the referenced object is not stringifiable. It will throw an error if the object has circular references.