selenium-query 0.1.4__tar.gz → 0.1.5__tar.gz

{selenium_query-0.1.4 → selenium_query-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: selenium-query
-Version: 0.1.4
+Version: 0.1.5
 Summary: Python equivalent of jQuery, to write selenium tests.
 License: GPL-3.0-or-later
 Author: Frédéric Zinelli
@@ -13,8 +13,6 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Provides-Extra: pmt
-Requires-Dist: pmt-tools (>=0.1.2) ; extra == "pmt"
 Requires-Dist: selenium (>=4.36)
 Description-Content-Type: text/markdown
 

{selenium_query-0.1.4 → selenium_query-0.1.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "selenium-query"
-version = "0.1.4"
+version = "0.1.5"
 description = "Python equivalent of jQuery, to write selenium tests."
 license = { text = "GPL-3.0-or-later" }
 authors = [
@@ -12,9 +12,6 @@ dependencies = [
     "selenium (>=4.36)"
 ]
 
-[project.optional-dependencies]
-pmt = [ "pmt-tools>=0.1.2" ]
-
 
 [tool.setuptools]
 packages = ["selenium_query"]

{selenium_query-0.1.4 → selenium_query-0.1.5}/selenium_query/_asserter_getter.py

@@ -75,7 +75,7 @@ class AsserterGetter(Getter, accessor="check"):
     def exists(self, exp=True):
         """ Usable for non existing list of elements """
         actual = super().exists()   # Already handle the negation!
-        msg = self._with_msg(f"  {actual} should { ' not'*self._negate }be {exp}\n\nOn: {self}")
+        msg = self._with_msg(f"  {actual} should { 'not '*self._negate }be {exp}\n\nOn: {self}")
         assert actual == exp, msg
         return self
 
@@ -84,7 +84,7 @@ class AsserterGetter(Getter, accessor="check"):
         """ Usable for non existing list of elements """
         actual = super().count()    # Already handle the negation!
         msg = self._with_msg(
-            f"  {actual} should { ' not'*self._negate }be {n}\n\nWrong number of children on: {self}"
+            f"  {actual} should { 'not '*self._negate }be {n}\n\nWrong number of children on: {self}"
         )
         assert actual == n, msg
         return self

{selenium_query-0.1.4 → selenium_query-0.1.5}/selenium_query/_basics/action_getter.py

@@ -42,6 +42,12 @@ class ActionGetter(BaseGetter):
     Selenium default is 250 ms.
     """
 
+    AUTO_SHIFT: ClassVar[float] = 0
+    """
+    Systematic shift value to use for `scroll_to` (helps when the targeted element is inside an
+    iframe, for example).
+    """
+
 
     @staticmethod
     @contextmanager
@@ -249,7 +255,7 @@ class ActionGetter(BaseGetter):
         )
 
     def pause(self, seconds: Union[float, int, None]=None):
-        return self._apply("pause", self._duplicate_value(seconds or self.DURATION))
+        return self._apply("pause", self._duplicate_value(seconds or self.DURATION/1000))
 
     def release(self, other:Optional[GetterOrCss]=None, *, current=False):
         return self._apply("release", self._this_or_that(other, current))
@@ -291,16 +297,16 @@ class ActionGetter(BaseGetter):
         WARNING: this action CANNOT be chained with others, because it is applied directly with JS.
         """
         elt = self if other is None else self._getter_or_css(other)
+
         # Cannot scroll to different elements, considering how the actions are handled, so forbid it:
         elt.check("Getters.scroll_to usage requires instances with exactly one element").count(1)
-
         assert not self._actions and not ActionGetter._context_action, (
             "scroll_to(...) cannot be chained with other actions, because it interacts directly with "
             "the page, through the JS executor."
         )
 
         rect = elt.get.rect
-        center_y = rect['y'] + rect['height']/2 + shift
+        center_y = rect['y'] + rect['height']/2 + shift + self.AUTO_SHIFT
 
         self.run_js(f"""
             var centerY={ center_y }, H=innerHeight, Y=scrollY

{selenium_query-0.1.4 → selenium_query-0.1.5}/selenium_query/_basics/base_getter.py

@@ -1,10 +1,10 @@
 """
 Kind of jQuery like usage, but for Selenium logistic/elements...
 """
-
+import datetime as dt
 from dataclasses import dataclass, field
 from functools import wraps
-from typing import Callable, ClassVar, List, TYPE_CHECKING, Tuple
+from typing import Callable, ClassVar, List, TYPE_CHECKING, Tuple, Union
 
 from selenium.webdriver.common.by import By
 from selenium.webdriver.remote.webdriver import WebDriver
@@ -73,11 +73,13 @@ class BaseGetter:
         return ( self.__class__.from_(self, [elt]) for elt in self.elements )
 
 
-    def __getitem__(self, idx:int):
-        return self.__class__.from_(self, [self.elements[idx]])
+    def __getitem__(self, idx:Union[int,slice]):
+        if isinstance(idx, int):
+            return self.__class__.from_(self, [self.elements[idx]])
+        return self.__class__.from_(self, self.elements[idx])
 
 
-    def find(self, css_selector:str, *, in_page=False) -> 'Getter':
+    def find(self, css_selector:str, *, in_page=False, as_:str="") -> 'Getter':
         """
         Find all children element matching the given css selector.
         If @in_page is true, starts searching from the top of the page instead of starting
@@ -96,7 +98,8 @@ class BaseGetter:
                 children = elt.find_elements(By.CSS_SELECTOR, css_selector)
                 elements.extend(children)
 
-        full_css_path = f'{self._full_css} -> "{css_selector}"' if self._full_css else f'"{css_selector}"'
+        designation   = f'"{ as_ or css_selector }"'
+        full_css_path = f'{self._full_css} -> {designation}' if self._full_css else designation
 
         return self.__class__.from_(self, elements, css_selector, full_css_path)
 
@@ -127,17 +130,29 @@ class BaseGetter:
         return getattr(self.driver, method)(code, *args)
 
 
-    def wait_for_element(self, css_selector):
+    def wait_for_element(self, css_selector, as_=""):
         if self._actions:
             raise ValueError(f"Cannot use `wait_until(...)` on objects with defined ActionChains.")
 
+        date = None
+        delta = dt.timedelta(seconds=0.05)
+
         def finder(_):
-            elt = self.find(css_selector, in_page=True)
-            return elt.exists() and elt
+            nonlocal date
+
+            elt = self.find(css_selector, in_page=True, as_=as_)
+            found = elt.exists() and elt
+            if found:
+                if not date:
+                    date = dt.datetime.now()
+                if dt.datetime.now() - date > delta:
+                    return found
+            return False
 
         return self.waiter.until(finder)
 
 
+
     def wait_until(self, bool_provider):
         if self._actions:
             raise ValueError(f"Cannot use `wait_until(...)` on objects with defined ActionChains.")
@@ -157,6 +172,7 @@ class BaseGetter:
         """
         for elt in self.elements:
             elt.clear()
+        return self
 
 
     #-----------------------------------------------------

{selenium_query-0.1.4 → selenium_query-0.1.5}/selenium_query/_basics/generic_value_getter.py

@@ -28,7 +28,7 @@ def should_contain(exp:Expected, act:Actual, with_neg:bool):
     return f"{act!r} should { ' not'*with_neg }contain {exp!r}"
 
 def should_be(exp:Expected, act:Actual, with_neg:bool):
-    return f"{act!r} should { ' not'*with_neg }be {exp!r}"
+    return f"{act!r} should { 'not '*with_neg }be {exp!r}"
 
 
 

{selenium_query-0.1.4 → selenium_query-0.1.5}/selenium_query/_mapper_getter.py

@@ -3,7 +3,7 @@ from types import MethodType
 from typing import Any, Dict, List, Optional, Tuple
 
 
-from ._types_and_tools import MAPPER_GETTER_FOLLOW_UP, TGetter
+from ._types_and_tools import MAPPER_GETTER_FOLLOW_UP, _GetterSubClassesAsProperties, TGetter
 from ._basics.base_getter import forbid_negation
 from .getter import Getter
 
@@ -94,13 +94,18 @@ class MapperGetter(Getter, accessor="map"):
 
 
     @classmethod
-    def from_(cls, getter:Getter, _css_selector=None, _full_css=None):
-        return super().from_(getter, [*getter], _css_selector, _full_css)
+    def from_(cls, getter:Getter, elements=None, _css_selector=None, _full_css=None, merged=False):
+        if elements is not None and not merged:
+            raise ValueError("Cannot pass an @elements list to MapperGetter.from_, unless @merge is True")
+        elements_as_getters = elements or [*getter]
+        return super().from_(getter, elements_as_getters, _css_selector, _full_css)
 
 
-    def __call__(self, css_selector:str=None):
+    def __call__(self, css_selector:str=None, as_=""):
         if css_selector is not None:
-            self.elements = [g.find(css_selector) for g in self.elements]
+            self.elements = [g.find(css_selector, as_=as_) for g in self.elements]
+        if as_:
+            raise ValueError("Cannot use @as_ without @css_selector argument")
         return self
 
 
@@ -113,11 +118,13 @@ class MapperGetter(Getter, accessor="map"):
 
 
     def __getattribute__(self, k:str):
-        _getattr = super().__getattribute__
         if k in _FORBIDDEN_FOLLOW_UP:
             raise ValueError(f"Cannot use {k} on MapperGetter objects.")
 
-        if _getattr('subclass').is_getter_property(k):
+        _getattr = super().__getattribute__
+
+        sub_class:_GetterSubClassesAsProperties = _getattr('subclass')
+        if sub_class.is_getter_property(k):
             return MapperTransmitter(driver=None, waiter=None, _source=self, _prop=k)
 
         if k in MAPPER_GETTER_FOLLOW_UP:
@@ -147,7 +154,7 @@ class MapperGetter(Getter, accessor="map"):
     def _apply_caller(self, bound_methods:List[MethodType]):
         def call(*a, zip_args=True, non_existent_at_idxs=(), **kw):
             """
-            If @zip_args=False, directly transfer *args and ù**kwargs to the bound methods, without
+            If @zip_args=False, directly transfer *args and **kwargs to the bound methods, without
             applying any zipping/mapping logic on values given as lists.
 
             If @non_existent_at_idxs is given, it must be a tuple of indices. The bound method at these

{selenium_query-0.1.4 → selenium_query-0.1.5}/selenium_query/getter.py

@@ -1,4 +1,4 @@
-from typing import ClassVar
+from typing import ClassVar, List
 
 from ._basics.base_getter import BaseGetter
 from ._basics.boolean_getter import BooleanGetter
@@ -25,8 +25,39 @@ class Getter(ActionGetter, BooleanGetter, BaseGetter):
         if accessor:
             setattr(cls.subclass, accessor, cls)
 
+
+    @classmethod
+    def merge_cls(cls, *getters:'Getter', mapped=False, as_=None) -> 'Getter':
+        """
+        Merge collections of Getters together. Any MApperGetter object is "flattened" with the
+        other elements.
+
+        If @mapped is True, Build a MapperGetter if the source elements.
+        If @designation is given, it will replace the internal path/css selectors informations.
+        """
+        flat: List[Getter] = []
+        for g in getters:
+            if isinstance(g, cls.subclass.map):
+                flat.extend(g.elements)
+            else:
+                flat.append(g)
+
+        if mapped:
+            return cls.subclass.map.from_(flat[0], flat, as_, as_, merged=True)
+
+        elements = [e for g in flat for e in g.elements]
+        return cls.from_(flat[0], elements, as_, as_)
+
+    def merge(self, *others:'Getter', mapped=False, as_=None) -> 'Getter':
+        """
+        Merge collections of Getters together.
+        """
+        return self.merge_cls(self, *others, as_=as_, mapped=mapped)
+
+
     #------------------------------------------------------------------------------------------
 
+
     @property
     def all(self):
         return self.subclass.all.from_(self)