WebStorage

WebStorage exposes the page's localStorage or sessionStorage for the current origin via an async, browser-consistent API.

Instances are accessed through page.local_storage and page.session_storage.

page.goto("https://example.com")
page.local_storage.set_item("token", "abc")
token = page.local_storage.get_item("token")
all = page.local_storage.items()
page.local_storage.remove_item("token")
page.local_storage.clear()

await page.goto("https://example.com")
await page.local_storage.set_item("token", "abc")
token = await page.local_storage.get_item("token")
all = await page.local_storage.items()
await page.local_storage.remove_item("token")
await page.local_storage.clear()

Methods

clear

Removes all items from the storage.

Usage

web_storage.clear()

Returns

• NoneType#

get_item

Returns the value for the given name if present.

Usage

web_storage.get_item(name)

Arguments

• name str#

  Name of the item to retrieve.

Returns

• NoneType | str#

items

Returns all items in the storage as name/value pairs.

Usage

web_storage.items()

Returns

• List[Dict]#

  • name str

  • value str

remove_item

Removes the item with the given name. No-op if the item is absent.

Usage

web_storage.remove_item(name)

Arguments

• name str#

  Name of the item to remove.

Returns

• NoneType#

set_item

Sets the value for the given name. Overwrites any existing value for that name.

Usage

web_storage.set_item(name, value)

Arguments

• name str#

  Name of the item to set.

• value str#

  New value for the item.

Returns

• NoneType#