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

configureType:Configuration: Use this to directly configure the eyes object using any of the methods exposed by the Configuration class.

ignore_caretType:bool: Use this property to retrieve and set whether or not Eyes eliminates mismatches due to blinking cursor artifacts.

is_openType:bool: Use this to know if the Eyes instance is currently open.

agent_idType:Text: Use this property to set and retrieve the name and version of the SDK.

api_keyType:Text: Use this property to set and retrieve your Eyes license key.

app_nameType:Text: Use this property to set and retrieve the value of the application name property. The application name is one of the 5 properties that define the baseline.

baseline_branch_nameType:Text: Use this property to set and retrieve the name of the branch the baseline reference will be taken from and where new and accepted steps will be saved to.

baseline_env_nameType:Text: Use this property to set and retrieve the name of the environment that will be used to determine the baseline.

batchType:BatchInfo: Use this property to set and retrieve the batch information for this test.

branch_nameType:Text: Use this property to set and retrieve the branch used for the baseline of this run.

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).

featuresType:Set[Feature]: Use this method to enable various Eyes features.

host_appType:Text: Use this property to set and retrieve the name of the hosting application property.

host_osType:Text: Use this property to set and retrieve the name of the hosting operating system property.

is_disabledType:bool: Use this property to set and retrieve whether or not interactions with Eyes will be silently ignored.

match_levelType:MatchLevel: Use this property to set and retrieve the default match level to be used for subsequent checkpoints in the test.

parent_branch_nameType:Text: Use this property to set and retrieve the parent branch from which newly created branches get their initial baseline.

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).

save_diffsType:bool: Use this property to set and retrieve if steps that have mismatches should be automatically saved to the baseline or not.

save_new_testsType:bool: Use this property to set and retrieve whether or not 'new' tests are saved to the baseline by default.

scale_ratioType:float: Use this property to set and retrieve the scale ratio to be applied to images before matching, to compensate for different vertical and horizontal pixels density on some devices.

server_urlType:Text: Use this property to set and retrieve the URL of the Eyes server used to process the captured images.

viewport_sizeType:RectangleSize: Set the default viewport size property. Eyes will use this if a subsequent call to open is done without a viewport size.

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 custom key name/value property that will be associated with tests. You can view these properties and filter and group by these properties in the Test Manager.

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.

extract_text(): This method allows you to search for the occurrence of text in an image using OCR.

extract_text_regions(): Search an image for instances of text that match a pattern using OCR and return their location, dimensions and the text found.

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.