Add ignore_displacement

Author: eirenik0

eyes_common/applitools/common/match.py

@@ -97,6 +97,7 @@ class ImageMatchSettings(object):
     send_dom = attr.ib(default=False, metadata={JsonInclude.THIS: True})
     use_dom = attr.ib(default=False, metadata={JsonInclude.THIS: True})
     enable_patterns = attr.ib(default=False, metadata={JsonInclude.THIS: True})
+    ignore_displacement = attr.ib(default=False, metadata={JsonInclude.THIS: True})
 
     ignore = attr.ib(
         factory=list, type=typing.List[Region], metadata={JsonInclude.THIS: True}

eyes_core/applitools/core/eyes_base.py

@@ -703,6 +703,10 @@ def _match_window(self, region_provider, tag, ignore_mismatch, check_settings):
             check_settings = check_settings.ignore_caret(
                 get_config_value("enable_patterns")
             )
+        if check_settings.values.ignore_displacement is None:
+            check_settings = check_settings.ignore_displacement(
+                self.configuration.default_match_settings.ignore_displacement
+            )
 
         region = region_provider.get_region()
         logger.debug("params: ([{}], {}, {})".format(region, tag, retry_timeout_ms))

eyes_core/applitools/core/fluent/check_settings.py

@@ -31,14 +31,16 @@ class CheckSettingsValues(object):
     target_region = attr.ib(init=False, default=None)  # type: Optional[Region]
     timeout = attr.ib(init=False, default=-1)  # type: Num  # milliseconds
 
-    ignore_caret = attr.ib(init=False, default=False)  # type: bool
-    stitch_content = attr.ib(init=False, default=False)  # type: bool
+    ignore_caret = attr.ib(init=False, default=None)  # type: bool
+    stitch_content = attr.ib(init=False, default=None)  # type: bool
     match_level = attr.ib(init=False, default=None)  # type: Optional[MatchLevel]
     name = attr.ib(init=False, default=None)  # type: Optional[Text]
 
-    send_dom = attr.ib(init=False, default=False)  # type: bool
-    use_dom = attr.ib(init=False, default=False)
-    enable_patterns = attr.ib(init=False, default=False)
+    send_dom = attr.ib(init=False, default=None)  # type: bool
+    use_dom = attr.ib(init=False, default=None)
+    enable_patterns = attr.ib(init=False, default=None)
+    ignore_displacement = attr.ib(init=False, default=None)
+
     ignore_regions = attr.ib(init=False, factory=list)  # type: List[GetRegion]
     layout_regions = attr.ib(init=False, factory=list)  # type: List[GetRegion]
     strict_regions = attr.ib(init=False, factory=list)  # type: List[GetRegion]
@@ -224,6 +226,11 @@ def enable_patterns(self, enable=True):
         self.values.enable_patterns = enable
         return self
 
+    def ignore_displacement(self, should_ignore=True):
+        # type: (bool) -> CheckSettings
+        self.values.ignore_displacement = should_ignore
+        return self
+
     def __regions(self, regions, method_name):
         if not regions:
             raise TypeError(

eyes_core/applitools/core/match_window_task.py

@@ -279,6 +279,7 @@ def _try_take_screenshot(
             send_dom=check_settings.values.send_dom,
             use_dom=check_settings.values.use_dom,
             enable_patterns=check_settings.values.enable_patterns,
+            ignore_displacement=check_settings.values.ignore_displacement,
         )
         self._match_result = self.perform_match(
             app_output,