Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,25 @@

<br>

## v3.4.3
*Release date: 2026-04-21*

### Added
- `set_local_storage_item(items)` / `set_session_storage_item(items)` — set one or more key/value pairs in localStorage / sessionStorage
- `get_local_storage_item(key)` / `get_session_storage_item(key)` — retrieve a single item by key (`None` if missing)
- `get_local_storage_items()` / `get_session_storage_items()` — retrieve all items as a dict
- `remove_local_storage_item(key)` / `remove_session_storage_item(key)` — remove a single item by key
- `clear_local_storage()` / `clear_session_storage()` — clear all items from the respective storage
- `MobileDriver.clear_cookies` override — on iOS real devices iterates and deletes each cookie individually via `delete_cookie` instead of a bulk clear
- `storage_set_item_js`, `storage_get_items_js`, `set_cookies_as_batch_js` JS helpers added to `js_scripts.py`

### Changed
- `CoreDriver.set_cookies` — replaced per-cookie `driver.add_cookie()` loop with a single batched `execute_script` call
- `PlayDriver.set_cookies` — domain extracted via `urlparse` instead of manual string splitting; cookie defaults applied via list comprehension
- `PlayDriver.execute_script` — unified script wrapping to `(args) => (function() { … }).apply(null, args)` for consistent argument passing across all call patterns

---

## v3.4.2
*Release date: 2026-03-28*

Expand Down
2 changes: 1 addition & 1 deletion mops/__init__.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
__version__ = '3.4.2'
__version__ = '3.4.3'
__project_name__ = 'mops'
100 changes: 100 additions & 0 deletions mops/abstraction/driver_wrapper_abc.py
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,106 @@ def get_cookies(self) -> List[dict]:
"""
raise NotImplementedError()

def set_local_storage_item(self, items: List[dict]) -> DriverWrapper:
"""
Set one or more items in localStorage.

Each dict must contain ``key`` and ``value`` fields.

:param items: A list of dicts with ``key`` and ``value``.
:type items: typing.List[dict]
:return: :obj:`.DriverWrapper` - The current instance of the driver wrapper.
"""
raise NotImplementedError()

def set_session_storage_item(self, items: List[dict]) -> DriverWrapper:
"""
Set one or more items in sessionStorage.

Each dict must contain ``key`` and ``value`` fields.

:param items: A list of dicts with ``key`` and ``value``.
:type items: typing.List[dict]
:return: :obj:`.DriverWrapper` - The current instance of the driver wrapper.
"""
raise NotImplementedError()

def get_local_storage_item(self, key: str) -> Union[str, None]:
"""
Retrieve a single item from localStorage by key.

:param key: The key to look up.
:type key: str
:return: The value string, or :obj:`None` if the key does not exist.
:rtype: typing.Union[str, None]
"""
raise NotImplementedError()

def get_session_storage_item(self, key: str) -> Union[str, None]:
"""
Retrieve a single item from sessionStorage by key.

:param key: The key to look up.
:type key: str
:return: The value string, or :obj:`None` if the key does not exist.
:rtype: typing.Union[str, None]
"""
raise NotImplementedError()

def get_local_storage_items(self) -> dict:
"""
Retrieve all items from localStorage as a dictionary.

:return: A dict mapping every key to its value.
:rtype: dict
"""
raise NotImplementedError()

def get_session_storage_items(self) -> dict:
"""
Retrieve all items from sessionStorage as a dictionary.

:return: A dict mapping every key to its value.
:rtype: dict
"""
raise NotImplementedError()

def remove_local_storage_item(self, key: str) -> DriverWrapper:
"""
Remove a single item from localStorage by key.

:param key: The key to remove.
:type key: str
:return: :obj:`.DriverWrapper` - The current instance of the driver wrapper.
"""
raise NotImplementedError()

def remove_session_storage_item(self, key: str) -> DriverWrapper:
"""
Remove a single item from sessionStorage by key.

:param key: The key to remove.
:type key: str
:return: :obj:`.DriverWrapper` - The current instance of the driver wrapper.
"""
raise NotImplementedError()

def clear_local_storage(self) -> DriverWrapper:
"""
Remove all items from localStorage.

:return: :obj:`.DriverWrapper` - The current instance of the driver wrapper.
"""
raise NotImplementedError()

def clear_session_storage(self) -> DriverWrapper:
"""
Remove all items from sessionStorage.

:return: :obj:`.DriverWrapper` - The current instance of the driver wrapper.
"""
raise NotImplementedError()

def switch_to_frame(self, frame: Element) -> DriverWrapper:
"""
Switch to a specified frame.
Expand Down
108 changes: 108 additions & 0 deletions mops/base/driver_wrapper.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from __future__ import annotations

import json
from typing import Union, Type, List, Tuple, TYPE_CHECKING

from PIL import Image
Expand All @@ -11,6 +12,7 @@
BrowserContext as PlaywrightContext,
)

from mops.js_scripts import storage_set_item_js, storage_get_items_js
from mops.mixins.objects.box import Box
from mops.mixins.objects.driver import Driver
from mops.mixins.objects.visual_comaprison_mixin import hide_before_screenshot, reveal_after_screenshot
Expand Down Expand Up @@ -332,6 +334,112 @@ def soft_assert_screenshot(

return True, f'No visual mismatch found for entire screen'

def set_local_storage_item(self, items: List[dict]) -> DriverWrapper:
"""
Set one or more items in localStorage.

Each dict must contain ``key`` and ``value`` fields.

:param items: A list of dicts with ``key`` and ``value``.
:type items: typing.List[dict]
:return: :obj:`.DriverWrapper` - The current instance of the driver wrapper.
"""
self.execute_script(storage_set_item_js, items, 'localStorage')
return self

def set_session_storage_item(self, items: List[dict]) -> DriverWrapper:
"""
Set one or more items in sessionStorage.

Each dict must contain ``key`` and ``value`` fields.

:param items: A list of dicts with ``key`` and ``value``.
:type items: typing.List[dict]
:return: :obj:`.DriverWrapper` - The current instance of the driver wrapper.
"""
self.execute_script(storage_set_item_js, items, 'sessionStorage')
return self

def get_local_storage_item(self, key: str) -> Union[str, None]:
"""
Retrieve a single item from localStorage by key.

:param key: The key to look up.
:type key: str
:return: The value string, or :obj:`None` if the key does not exist.
:rtype: typing.Union[str, None]
"""
return self.execute_script(f'return localStorage.getItem({json.dumps(key)})')

def get_session_storage_item(self, key: str) -> Union[str, None]:
"""
Retrieve a single item from sessionStorage by key.

:param key: The key to look up.
:type key: str
:return: The value string, or :obj:`None` if the key does not exist.
:rtype: typing.Union[str, None]
"""
return self.execute_script(f'return sessionStorage.getItem({json.dumps(key)})')

def get_local_storage_items(self) -> dict:
"""
Retrieve all items from localStorage as a dictionary.

:return: A dict mapping every key to its value.
:rtype: dict
"""
return self.execute_script(storage_get_items_js, 'localStorage')

def get_session_storage_items(self) -> dict:
"""
Retrieve all items from sessionStorage as a dictionary.

:return: A dict mapping every key to its value.
:rtype: dict
"""
return self.execute_script(storage_get_items_js, 'sessionStorage')

def remove_local_storage_item(self, key: str) -> DriverWrapper:
"""
Remove a single item from localStorage by key.

:param key: The key to remove.
:type key: str
:return: :obj:`.DriverWrapper` - The current instance of the driver wrapper.
"""
self.execute_script(f'localStorage.removeItem({json.dumps(key)})')
return self

def remove_session_storage_item(self, key: str) -> DriverWrapper:
"""
Remove a single item from sessionStorage by key.

:param key: The key to remove.
:type key: str
:return: :obj:`.DriverWrapper` - The current instance of the driver wrapper.
"""
self.execute_script(f'sessionStorage.removeItem({json.dumps(key)})')
return self

def clear_local_storage(self) -> DriverWrapper:
"""
Remove all items from localStorage.

:return: :obj:`.DriverWrapper` - The current instance of the driver wrapper.
"""
self.execute_script('localStorage.clear()')
return self

def clear_session_storage(self) -> DriverWrapper:
"""
Remove all items from sessionStorage.

:return: :obj:`.DriverWrapper` - The current instance of the driver wrapper.
"""
self.execute_script('sessionStorage.clear()')
return self

def __init_base_class__(self) -> None:
"""
Get driver wrapper class in according to given driver source, and set him as base class
Expand Down
14 changes: 14 additions & 0 deletions mops/js_scripts.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@
get_inner_width_js = 'return window.innerWidth'
js_click = 'arguments[0].click();'

storage_set_item_js = """
arguments[0].forEach(item => {
window[arguments[1]].setItem(item.key, item.value);
});
"""

storage_get_items_js = "return Object.assign({}, window[arguments[0]])"

set_cookies_as_batch_js = """
arguments[0].forEach(c => {
document.cookie = `${c.name}=${c.value}; path=${c.path}`;
});
"""

get_element_position_on_screen_js = """
function getPositionOnScreen(elem) {
let box = elem.getBoundingClientRect();
Expand Down
33 changes: 13 additions & 20 deletions mops/playwright/play_driver.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from __future__ import annotations

from dataclasses import asdict
from urllib.parse import urlparse
from functools import cached_property
from typing import List, Union, Any, TYPE_CHECKING

Expand Down Expand Up @@ -193,15 +194,15 @@ def set_cookie(self, cookies: List[dict]) -> PlayDriver:
:type cookies: typing.List[dict]
:return: :obj:`.PlayDriver` - The current instance of the driver wrapper.
"""
for cookie in cookies:

if 'path' not in cookie:
cookie.update({'path': '/'})

if 'domain' not in cookie:
cookie.update({'domain': f'.{self.current_url.split("://")[1].split("/")[0]}'})

self.context.add_cookies(cookies)
domain = f'.{urlparse(self.current_url).netloc}'
processed = [
{
**c,
'path': c.get('path', '/'),
'domain': c.get('domain', domain)
} for c in cookies
]
self.context.add_cookies(processed) # noqa
return self

def clear_cookies(self) -> PlayDriver:
Expand Down Expand Up @@ -262,17 +263,9 @@ def execute_script(self, script: str, *args: Any) -> Any:
:type args: :obj:`typing.Any`
:return: :obj:`typing.Any` - The result of the JavaScript execution.
"""
script = script.replace('return ', '')

if 'arguments[0]' in script:
args = [getattr(arg, 'element', arg) for arg in args]
script = f'arguments => {{{script}}}'

for index, arg in enumerate(args):
if isinstance(arg, Locator):
args[index] = arg.first.element_handle()

return self.driver.evaluate(script, args)
args = [getattr(arg, 'element', arg) for arg in args]
args = [arg.first.element_handle() if isinstance(arg, Locator) else arg for arg in args]
return self.driver.evaluate(f'(args) => (function() {{ {script} }}).apply(null, args)', list(args))

def evaluate(self, expression: str, arg: Any = None) -> Any:
"""
Expand Down
11 changes: 3 additions & 8 deletions mops/selenium/core/core_driver.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from PIL import Image
from appium.webdriver.webdriver import WebDriver as AppiumDriver

from mops.js_scripts import get_inner_height_js, get_inner_width_js
from mops.js_scripts import get_inner_height_js, get_inner_width_js, set_cookies_as_batch_js
from mops.mixins.objects.size import Size
from mops.shared_utils import _scaled_screenshot
from selenium.common.exceptions import WebDriverException as SeleniumWebDriverException, NoAlertPresentException
Expand Down Expand Up @@ -235,13 +235,8 @@ def set_cookie(self, cookies: List[dict]) -> CoreDriver:
:type cookies: typing.List[dict]
:return: :obj:`.CoreDriver` - The current instance of the driver wrapper.
"""
for cookie in cookies:

if 'path' not in cookie:
cookie.update({'path': '/'})

self.driver.add_cookie(cookie)

processed = [{**c, 'path': c.get('path', '/')} for c in cookies]
self.driver.execute_script(set_cookies_as_batch_js, processed)
return self

def clear_cookies(self) -> CoreDriver:
Expand Down
14 changes: 14 additions & 0 deletions mops/selenium/driver/mobile_driver.py
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,20 @@ def click_by_coordinates(self, x: int, y: int, silent: bool = False) -> MobileDr

return self

def clear_cookies(self) -> MobileDriver:
"""
Delete all cookies in the current session.

:return: :obj:`.MobileDriver` - The current instance of the driver wrapper.
"""
if self.is_ios and self.is_real_device:
for cookie_name in [cookie['name'] for cookie in self.get_cookies()]:
self.delete_cookie(cookie_name)
else:
CoreDriver.clear_cookies(self)

return self


def _set_static(obj) -> None:
"""
Expand Down
Loading
Loading