Eyes class

Platform: ImagesLanguage: Python SDK:
This class provides the main methods used to execute tests and checkpoints.

Import statement

from applitools.images import Eyes
	

Constructor

Eyes()
This is the constructor for the Eyes class.

Properties

debug_screenshots_pathType:Text
Use this property to set and retrieve the folder path where locally saved checkpoint images should be stored (if enabled).
debug_screenshots_prefixType:Text
Use this property to set and retrieve the prefix that should be added to the file names for locally stored checkpoint images (if enabled).
is_openType:bool
Use this to know if the Eyes instance is currently open.
match_levelType:MatchLevel
Use this property to set and retrieve the default match level to be used for subsequent checkpoints in the test.
save_debug_screenshotsType:bool
Use this property to set and retrieve whether or not checkpoint images should be copied to a local file (typically for troubleshooting).
scale_ratioType:float
Use this property to set and retrieve the scale ratio to be applied to images before matching.
configureType:Configuration
Use this to directly configure the eyes object using any of the methods exposed by the Configuration class.

Methods

abort()
When a test is aborted, and it may be that not all of its checkpoints have excuted, call this method instead of close methods so that it will have an Aborted status in the Eyes Test Manager.
abort_if_not_closed()
When a test is aborted, and it may be that not all of its checkpoints have excuted, call this method instead of close methods so that it will have an Aborted status in the Eyes Test Manager.
add_property()
Adds a user-defined key name/value property that will be associated with tests.
check()
Run a checkpoint. Uses Fluent arguments to specify the various parameters.
check_image()
Run a checkpoint on an image that you provide as a parameter.
check_region()
Checks a particular region of the checkpoint image.
clear_properties()
Clears any custom key name/value properties.
close()
Call this method at the end of the test. This terminates the sequence of checkpoints, and then waits synchronously for the test results and returns them.
get_configuration()
Use this method to retrieve the current configuration object. This will be the most recent configuration object set using set_configuration, or the initial default configuration object.
open()
Call this method to start a test, before calling any of the check methods.
set_configuration()
Use this method to configure Eyes based on a configuration object.