check_region method

Class: EyesPlatform: Selenium 3Language: Python SDK:

Checks a particular region of the checkpoint window.

Syntax


value = eyes.check_region(region, tag, match_timeout, target, stitch_content)

value = eyes.check_region(region, tag, match_timeout, target)

value = eyes.check_region(region, tag, match_timeout)

value = eyes.check_region(region, tag)

value = eyes.check_region(region)

Parameters

region
Type:Region
A non-empty region representing the screen region to check in screenshot pixel coordinates.
tag
Type:Text [Optional : default = None ]

The tag defines a name for the checkpoint in the Eyes Test Manager. The name may be any string and serves to identify the step to the user in the Test manager. You may change the tag value without impacting testing in any way since Eyes does not use the tag to identify the baseline step that corresponds to the checkpoint - Eyes matches steps based on their content and position in the sequences of images of the test. See How Eyes compares checkpoints and baseline images for details.

match_timeout
Type:int [Optional : default = -1 ]
The retry time in milliseconds. If there is a mismatch, then Eyes will recapture and recheck the checkpoint until the timeout limit. This can help avoid mismatches in cases where the capture was done before the page was fully rendered. This parameter overrides any global timeout set using match_timeout. Passing a value of -1 will force the default timeout.
target
Type:Target [Optional : default = None ]
An object that defines floating and ignores regions and other configuration options.
stitch_content
Type:bool [Optional : default = False ]
If the application window is larger than the viewport, and this parameter is True, then the entire page content is rendered. If this parameter is False, then only the viewport is rendered.

Return value

Type: None