mops 3.4.2__tar.gz → 3.4.3__tar.gz

{mops-3.4.2 → mops-3.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mops
-Version: 3.4.2
+Version: 3.4.3
 Summary: Wrapper of Selenium, Appium and Playwright with single API
 Author-email: Podolian Vladimir <vladimir.podolyan64@gmail.com>
 License: MIT

{mops-3.4.2 → mops-3.4.3}/mops/__init__.py

@@ -1,2 +1,2 @@
-__version__ = '3.4.2'
+__version__ = '3.4.3'
 __project_name__ = 'mops'

{mops-3.4.2 → mops-3.4.3}/mops/abstraction/driver_wrapper_abc.py

@@ -207,6 +207,106 @@ class DriverWrapperABC(ABC):
         """
         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.

{mops-3.4.2 → mops-3.4.3}/mops/base/driver_wrapper.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import json
 from typing import Union, Type, List, Tuple, TYPE_CHECKING
 
 from PIL import Image
@@ -11,6 +12,7 @@ from playwright.sync_api import (
     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
@@ -332,6 +334,112 @@ class DriverWrapper(InternalMixin, Logging, DriverWrapperABC):
 
         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

{mops-3.4.2 → mops-3.4.3}/mops/js_scripts.py

@@ -2,6 +2,20 @@ get_inner_height_js = 'return window.innerHeight'
 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();

{mops-3.4.2 → mops-3.4.3}/mops/playwright/play_driver.py

@@ -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
 
@@ -193,15 +194,15 @@ class PlayDriver(Logging, DriverWrapperABC):
         :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:
@@ -262,17 +263,9 @@ class PlayDriver(Logging, DriverWrapperABC):
         :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:
         """

{mops-3.4.2 → mops-3.4.3}/mops/selenium/core/core_driver.py

@@ -7,7 +7,7 @@ from typing import Union, List, Any, TYPE_CHECKING
 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
@@ -235,13 +235,8 @@ class CoreDriver(Logging, DriverWrapperABC):
         :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:

{mops-3.4.2 → mops-3.4.3}/mops/selenium/driver/mobile_driver.py

@@ -263,6 +263,20 @@ class MobileDriver(CoreDriver):
 
         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:
     """

{mops-3.4.2 → mops-3.4.3}/mops.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mops
-Version: 3.4.2
+Version: 3.4.3
 Summary: Wrapper of Selenium, Appium and Playwright with single API
 Author-email: Podolian Vladimir <vladimir.podolyan64@gmail.com>
 License: MIT