Images Python Eyes SDK classes
Platform: ImagesLanguage: Python SDK:
Enums
- Feature
- Enable optional Eyes features by passing values defined by this Enum to Configuration.set_features.
- AccessibilityLevel
- These values represent accessibility levels as defined by WCAG 2.
- AccessibilityRegionType
- The classification type of an accessibility region.
- AccessibilityGuidelinesVersion
- Defines which version of the accessibility standard is used when verifying accessibility.
- AccessibilityStatus
- This value classifies the results of an accessibility testing in the test results.
- MatchLevel
- Values that define different types of Image matching. These are used in various commands that set the match level. See How to use Eyes match levels for details.
- TestResultsStatus
- This enum defines literals that define the possible test results for a single test. It is returned by the status property.
Classes
- AccessibilityRegion
- An object that stores information about an accesibility region.
- AccessibilitySettings
- Use to create an object that is used to set up accessibility validation.
- ApiUrls
- An object of this class is contained in the StepInfo object, which is in itself an object in the TestResults object returned by the close method.The methods in this class are used to retrieve a URI that can be used with the REST API to obtain information about a particular step.
- AppUrls
- An object of this class is contained in the StepInfo object, which is in itself an object in the TestResults object returned by the close method.The properties in this class are used to retrieve a URI that can be used in a browser to open the Test Manager on a page that displays information about a particular step.
- BatchClose
- Use an object of this class to close a batch explicitly.
- BatchInfo
- Call the Configuration.set_batch method or Eyes.batch property with an object of this class to configure the batch for one or more tests.
- Configuration
- This class is used to create a configuration object that is used to configure an Eyes object by passing it to the Eyes.set_configuration method.
- Eyes
- This class provides the main methods used to execute tests and checkpoints.
- ImagesCheckSettings
- The methods in this class are used as part of the check Fluent API to configure and execute checkpoints.
- MatchResult
- This value is for internal use only.
- OCRRegion
- An object of this type is used to define where OCR text extraction should be done.
- Rectangle
- An object that describes a rectangular region.
- RectangleSize
- Provides an object that describes a rectangle. An object of this type is required as a parameter in some methods.
- Region
- Provides an object that describes a rectangular area at a coordinate. An object of this type is required as a parameter in some methods.
- SessionAccessibilityStatus
- Provides the overall result of an accessibility test.
- SessionUrls
- An object of this class is returned as part of the information in the TestResults class. This class provides URIs that can be used in a browser to display the Test manager batch and test results for this test.
- StepInfo
- When a test terminates, the close method returns an object with methods/properties defined by the TestResults class. Within the TestResults, there is an array of objects which have the properties defined by the class StepInfo. Each element of this array describes information for one step in the test.The properties in this class are used to retrieve information for a given step in the test results.
- Target
- This class provides methods that are used to define and configure the checkpoint target for the check method.
- TestResults
- Encapsulates the results of a visual test, including summary information and checkpoint-specific details. An object of this class is returned by the close method upon test completion.
- TextRegion
- Object returned as part of the results of Eyes.extract_text_regions.
- TextRegionSettings
- An object of this type is used to pass options to Eyes.extract_text_regions.