Exception is raised whenever a certain operation is terminated abnormally. Besides python Built-in Exceptions, we also define clicknium exceptions which all inherit from BaseError.
Clicknium Exceptions #
| Exception | Description |
|---|---|
| BaseError | All Clicknium exceptions inherit from this class. |
| ArgumentError | ArgumentError is raised when at least one of the arguments provided to a method is not valid. |
| ArgumentNullError | ArgumentNullError is raised when a null reference is passed to a method that does not accept it as a valid argument. |
| ArgumentOutOfRangeError | ArgumentOutOfRangeError is raised when the value of an argument is out of the allowable range of values as defined by the invoked method. |
| BrowserNotInstallError | BrowserNotInstallError is raised when the specified browser is not installed. |
| BrowserNotRunError | BrowserNotRunError is raised when the specified browser is not running. |
| ElementNotFoundError | ElementNotFoundError is raised when the target UI element can not be found by the given locator. |
| ExtensionOperationError | ExtensionOperationError is raised when an extension fails in operation “install”, “update” or “uninstall”. |
| InvalidOperationError | InvalidOperationError is raised when a method call is invalid for the object’s current state. |
| InvalidSelectedItemError | InvalidSelectedItemError is raised when the item to be selected is invalid for the object’s current state. |
| LocatorRequestError | LocatorRequestError is raised when the cloud locator cannot be acquired due to server request error. |
| LocatorUndefinedError | LocatorUndefinedError is raised when the specified locator can not be found in locator store. |
| NotSupportedError | NotSupportedError is raised when an invoked method is not supported, or when an attempt to read, seek, or write to a stream that does not support the invoked functionality. |
| NotSupportedOperationError | NotSupportedOperationError is raised when the method is invoked by a UI element which does not support the type of operation. |
| NotSupportedOperationOptionError | NotSupportedOperationOptionError is raised when the specified option value is not supported by the target UI element. |
| OperationTimeoutError | OperationTimeoutError is raised when a certain operation is not completed within given time. |
| ProjectSettingNotFoundError | ProjectSettingNotFoundError is raised when project setting file clicknium.yaml is missing. |
| ScreenOperationError | ScreenOperationError is raised when screen operations of Windows desktop UI element fail. |
| UiaPatternNotFoundError | UiaPatternNotFoundError is raised when a window UI element can not be found by UIA technology. |
| UnAuthorizedError | UnAuthorizedError is raised when user does not sign in or the sign in state is expired. |
| UnreachableBrowserExtensionError | UnreachableBrowserExtensionError is raised when the specified browser’s extension is not in ready state. Please check if the extension is installed and enabled. |
| WebElementNotRespondingError | WebElementNotRespondingError is raised when the web page is not responding. |
| WebError | WebError is raised for common web automation exceptions. |
| WindowError | WindowError is raised for common window exceptions. |
| WindowsNativeError | WindowsNativeError is raised when an underneath win32 method fails. |
