Merge pull request #33 from applitools/develop

Release 4.0.7

Author: danielputerman

eyes_core/applitools/core/__init__.py

@@ -14,7 +14,7 @@
     GetFloatingRegion,
     GetRegion,
     GetSelector,
-    IgnoreRegionByRectangle,
+    RegionByRectangle,
 )
 from .match_window_task import MatchWindowTask
 from .positioning import (
@@ -58,7 +58,7 @@
     "GetRegion",
     "GetFloatingRegion",
     "FloatingRegionByRectangle",
-    "IgnoreRegionByRectangle",
+    "RegionByRectangle",
     "GetSelector",
     "ServerConnector",
     "AppOutputWithScreenshot",

eyes_core/applitools/core/fluent/__init__.py

@@ -4,7 +4,7 @@
     FloatingRegionByRectangle,
     GetFloatingRegion,
     GetRegion,
-    IgnoreRegionByRectangle,
+    RegionByRectangle,
 )
 from .selector import GetSelector
 
@@ -15,6 +15,6 @@
     "GetRegion",
     "GetFloatingRegion",
     "FloatingRegionByRectangle",
-    "IgnoreRegionByRectangle",
+    "RegionByRectangle",
     "GetSelector",
 )

eyes_core/applitools/core/fluent/check_settings.py

@@ -7,7 +7,7 @@
     FloatingRegionByRectangle,
     GetFloatingRegion,
     GetRegion,
-    IgnoreRegionByRectangle,
+    RegionByRectangle,
 )
 
 if typing.TYPE_CHECKING:
@@ -62,11 +62,13 @@ def __attrs_post_init__(self):
         # type: () -> None
         self.values = CheckSettingsValues()
 
-    def layout(self):
-        # type: ()  -> CheckSettings
+    def layout(self, *args):
+        # type: (*REGION_VALUES)  -> CheckSettings
         """ Shortcut to set the match level to :py:attr:`MatchLevel.LAYOUT`. """
         self.values.match_level = MatchLevel.LAYOUT
-        return self
+        if not args:
+            return self
+        return self._layout_regions(*args)
 
     def exact(self):
         # type: ()  -> CheckSettings
@@ -75,17 +77,21 @@ def exact(self):
         self.values.match_level = MatchLevel.EXACT
         return self
 
-    def strict(self):
-        # type: ()  -> CheckSettings
+    def strict(self, *args):
+        # type: (*REGION_VALUES)  -> CheckSettings
         """ Shortcut to set the match level to :py:attr:`MatchLevel.STRICT`. """
         self.values.match_level = MatchLevel.STRICT
-        return self
+        if not args:
+            return self
+        return self._strict_regions(*args)
 
-    def content(self):
-        # type: ()  -> CheckSettings
+    def content(self, *args):
+        # type: (*REGION_VALUES)  -> CheckSettings
         """ Shortcut to set the match level to :py:attr:`MatchLevel.CONTENT`. """
         self.values.match_level = MatchLevel.CONTENT
-        return self
+        if not args:
+            return self
+        return self._content_regions(*args)
 
     def match_level(self, match_level):
         # type: (MatchLevel)  -> CheckSettings
@@ -127,23 +133,23 @@ def ignore_regions(self, *regions):
 
     ignore = ignore_regions
 
-    def layout_regions(self, *regions):
+    def _layout_regions(self, *regions):
         # type: (*REGION_VALUES)  -> CheckSettings
         """ Adds one or more layout regions. """
         self.values.layout_regions = self.__regions(
             regions, method_name="layout_regions"
         )
         return self
 
-    def strict_regions(self, *regions):
+    def _strict_regions(self, *regions):
         # type: (*REGION_VALUES)  -> CheckSettings
         """ Adds one or more strict regions. """
         self.values.strict_regions = self.__regions(
             regions, method_name="strict_regions"
         )
         return self
 
-    def content_regions(self, *regions):
+    def _content_regions(self, *regions):
         # type: (*REGION_VALUES)  -> CheckSettings
         """ Adds one or more content regions. """
         self.values.content_regions = self.__regions(
@@ -242,7 +248,7 @@ def _region_provider_from(self, region, method_name):
         logger.debug("calling _{}".format(method_name))
         if isinstance(region, Region):
             logger.debug("{name}: IgnoreRegionByElement".format(name=method_name))
-            return IgnoreRegionByRectangle(region)
+            return RegionByRectangle(region)
         raise TypeError("Unknown region type.")
 
     def _floating_provider_from(self, region, bounds):

eyes_core/applitools/core/fluent/region.py

@@ -16,7 +16,7 @@
 __all__ = (
     "GetFloatingRegion",
     "GetRegion",
-    "IgnoreRegionByRectangle",
+    "RegionByRectangle",
     "FloatingRegionByRectangle",
 )
 
@@ -35,7 +35,7 @@ def get_regions(self, eyes, screenshot):
 
 
 @attr.s
-class IgnoreRegionByRectangle(GetRegion):
+class RegionByRectangle(GetRegion):
     _region = attr.ib()  # type: Region
 
     def get_regions(self, eyes, screenshot):

eyes_core/applitools/core/match_window_task.py

@@ -167,6 +167,9 @@ def perform_match(
                 image_match_settings, regions, region_selectors
             )
 
+        if check_settings and check_settings.values.match_level is not None:
+            image_match_settings.match_level = check_settings.values.match_level
+
         user_inputs = user_inputs or []
         agent_setup = self._eyes.agent_setup
         return self._perform_match(

eyes_selenium/applitools/selenium/fluent/__init__.py

@@ -2,9 +2,9 @@
     FloatingRegionBy,
     FloatingRegionByCssSelector,
     FloatingRegionByElement,
-    IgnoreRegionBy,
-    IgnoreRegionByCssSelector,
-    IgnoreRegionByElement,
+    RegionBy,
+    RegionByCssSelector,
+    RegionByElement,
 )
 from .selector import SelectorByElement, SelectorByLocator
 from .selenium_check_settings import FrameLocator, SeleniumCheckSettings
@@ -14,9 +14,9 @@
     "Target",
     "SeleniumCheckSettings",
     "FrameLocator",
-    "IgnoreRegionBy",
-    "IgnoreRegionByElement",
-    "IgnoreRegionByCssSelector",
+    "RegionBy",
+    "RegionByElement",
+    "RegionByCssSelector",
     "FloatingRegionBy",
     "FloatingRegionByElement",
     "FloatingRegionByCssSelector",

eyes_selenium/applitools/selenium/fluent/region.py

@@ -14,9 +14,9 @@
     from applitools.selenium.selenium_eyes import SeleniumEyes
 
 __all__ = (
-    "IgnoreRegionBy",
-    "IgnoreRegionByElement",
-    "IgnoreRegionByCssSelector",
+    "RegionBy",
+    "RegionByElement",
+    "RegionByCssSelector",
     "FloatingRegionBy",
     "FloatingRegionByElement",
     "FloatingRegionByCssSelector",
@@ -70,15 +70,15 @@ def _element(self, driver):
 
 
 @attr.s
-class IgnoreRegionByElement(GetSeleniumRegion):
+class RegionByElement(GetSeleniumRegion):
     element = attr.ib()  # type: AnyWebElement
 
     def _element(self, driver):
         return self.element
 
 
 @attr.s
-class IgnoreRegionBy(GetSeleniumRegion):
+class RegionBy(GetSeleniumRegion):
     """
     :param by: The "by" part of a selenium selector for an element which
                represents the ignore region
@@ -94,7 +94,7 @@ def _element(self, driver):
 
 
 @attr.s
-class IgnoreRegionByCssSelector(GetSeleniumRegion):
+class RegionByCssSelector(GetSeleniumRegion):
     """
     :ivar selector: The css selector for an element which represents the inner region.
     :ivar bounds: The outer rectangle bounding the inner region.

eyes_selenium/applitools/selenium/fluent/selenium_check_settings.py

@@ -15,8 +15,8 @@
 from .region import (
     FloatingRegionByCssSelector,
     FloatingRegionByElement,
-    IgnoreRegionByCssSelector,
-    IgnoreRegionByElement,
+    RegionByCssSelector,
+    RegionByElement,
 )
 
 if typing.TYPE_CHECKING:
@@ -139,15 +139,15 @@ def frame(self, frame):
     def _region_provider_from(self, region, method_name):
         if isinstance(region, basestring):
             logger.debug("{name}: IgnoreRegionByCssSelector".format(name=method_name))
-            return IgnoreRegionByCssSelector(region)
+            return RegionByCssSelector(region)
         if is_list_or_tuple(region):
             by, val = region
             sel = _css_selector_from_(by, val)
             logger.debug("{name}: IgnoreRegionByCssSelector".format(name=method_name))
-            return IgnoreRegionByCssSelector(sel)
+            return RegionByCssSelector(sel)
         elif is_webelement(region):
             logger.debug("{name}: IgnoreRegionByElement".format(name=method_name))
-            return IgnoreRegionByElement(region)
+            return RegionByElement(region)
         return super(SeleniumCheckSettings, self)._region_provider_from(
             region, method_name
         )

eyes_selenium/applitools/selenium/frames.py

@@ -55,7 +55,7 @@ def return_to_original_overflow(self, driver):
 
     def _scroll_root_element(self, driver):
         scroll_root = self.scroll_root_element
-        if scroll_root is None:
+        if scroll_root is None or not scroll_root.is_attached_to_page:
             logger.debug("no scroll root element. selecting default.")
             scroll_root = driver.find_element_by_tag_name("html")
         return scroll_root

eyes_selenium/applitools/selenium/webelement.py

@@ -3,6 +3,7 @@
 import math
 import typing as tp
 
+from selenium.common.exceptions import WebDriverException
 from selenium.webdriver.common.by import By
 
 from applitools.common import logger
@@ -147,6 +148,14 @@ def bounds(self):
     def location(self):
         return self._element.location
 
+    @property
+    def is_attached_to_page(self):
+        try:
+            self.location
+            return True
+        except WebDriverException:
+            return False
+
     @property
     def size(self):
         return self._element.size