From 0ab8c85c3d02c44d4d8022554f962190b5f7273d Mon Sep 17 00:00:00 2001 From: Amit Singh Sansoya Date: Thu, 26 Oct 2023 23:02:37 +0530 Subject: [PATCH] :bookmark: release-v2.0.2 (#75) Co-authored-by: Pradum Kumar --- README.md | 32 ++++++++++++++++++++------------ percy/version.py | 2 +- 2 files changed, 21 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 69fd724..4ef70ae 100644 --- a/README.md +++ b/README.md @@ -117,23 +117,31 @@ percy_screenshot_flutter(driver, name, **kwargs) - `driver` (**required**) - A appium driver instance - `name` (**required**) - The screenshot name; must be unique to each screenshot - `options` (**optional**) - There are various options supported by percy_screenshot to server further functionality. - - `freeze_animation` - Boolean value by default it falls back to `false`, you can pass `true` and percy will freeze image based animations. + - `freeze_animated_image` - Boolean value by default it falls back to `false`, you can pass `true` and percy will freeze image based animations. + - `freeze_image_by_selectors` -List of selectors. Images will be freezed which are passed using selectors. For this to work `freeze_animated_image` must be set to true. + - `freeze_image_by_xpaths` - List of xpaths. Images will be freezed which are passed using xpaths. For this to work `freeze_animated_image` must be set to true. - `percy_css` - Custom CSS to be added to DOM before the screenshot being taken. Note: This gets removed once the screenshot is taken. - - `ignore_region_xpaths` - Elements in the DOM can be ignored using xpath - - `ignore_region_selectors` - Elements in the DOM can be ignored using selectors. - - `ignore_region_appium_elements` - Elements can be ignored using appium_elements. - - `custom_ignore_regions` - Elements can be ignored using custom boundaries - - IgnoreRegion:- - - Description: This class represents a rectangular area on a screen that needs to be ignored for visual diff. - - Constructor: - ``` - init(self, top, bottom, left, right) - ``` - - Parameters: + - `ignore_region_xpaths` - List of xpaths. elements in the DOM can be ignored using xpath + - `ignore_region_selectors` - List of selectors. elements in the DOM can be ignored using selectors. + - `ignore_region_appium_elements` - List of appium web-element. elements can be ignored using appium_elements. + - `custom_ignore_regions` - List of custom objects. elements can be ignored using custom boundaries. Just passing a simple object for it like below. + - example: ```{"top": 10, "right": 10, "bottom": 120, "left": 10}``` + - In above example it will draw rectangle of ignore region as per given coordinates. - `top` (int): Top coordinate of the ignore region. - `bottom` (int): Bottom coordinate of the ignore region. - `left` (int): Left coordinate of the ignore region. - `right` (int): Right coordinate of the ignore region. + - `consider_region_xpaths` - List of xpaths. elements in the DOM can be considered for diffing and will be ignored by Intelli Ignore using xpaths. + - `consider_region_selectors` - List of selectors. elements in the DOM can be considered for diffing and will be ignored by Intelli Ignore using selectors. + - `consider_region_appium_elements` - List of appium web-element. elements can be considered for diffing and will be ignored by Intelli Ignore using appium_elements. + - `custom_consider_regions` - List of custom objects. elements can be considered for diffing and will be ignored by Intelli Ignore using custom boundaries + - example:```{"top": 10, "right": 10, "bottom": 120, "left": 10}``` + - In above example it will draw rectangle of consider region will be drawn. + - Parameters: + - `top` (int): Top coordinate of the consider region. + - `bottom` (int): Bottom coordinate of the consider region. + - `left` (int): Left coordinate of the consider region. + - `right` (int): Right coordinate of the consider region. ### Creating Percy on automate build Note: Automate Percy Token starts with `auto` keyword. The command can be triggered using `exec` keyword. diff --git a/percy/version.py b/percy/version.py index 0ab4904..668c344 100644 --- a/percy/version.py +++ b/percy/version.py @@ -1 +1 @@ -__version__ = '2.0.2-beta.0' +__version__ = '2.0.2'