Robot Framework API documentation¶
This documentation describes the public API of Robot Framework. Installation, basic usage and wealth of other topics are covered by the Robot Framework User Guide.
Main API entry points are documented here, but the lower level
implementation details are not always that well documented. If the
documentation is insufficient, it is possible to view the source code
[source] link in the documentation. In case viewing the
source is not helpful either, questions may be sent to the
robotframework-users mailing list.
Command line entry points are implemented as Python modules and they also provide programmatic APIs. Following entry points exist:
robot.runentry point for executing tests.
robot.rebotentry point for post-processing outputs (Rebot).
robot.libdocentry point for Libdoc tool.
robot.testdocentry point for Testdoc tool.
See built-in tool documentation for more details about Rebot, Libdoc, and Testdoc tools.
robot.api package exposes the public APIs of Robot Framework.
Unless stated otherwise, the APIs exposed in this package are considered stable, and thus safe to use when building external tools on top of Robot Framework. Notice that all parsing APIs were rewritten in Robot Framework 3.2.
Currently exposed APIs are:
loggermodule for libraries’ logging purposes.
decomodule with decorators libraries can utilize.
exceptionsmodule containing exceptions that libraries can utilize for reporting failures and other events. These exceptions can be imported also directly via
from robot.api import SkipExecution.
parsingmodule exposing the parsing APIs. This module is new in Robot Framework 4.0. Various parsing related functions and classes were exposed directly via
robot.apialready in Robot Framework 3.2, but they are effectively deprecated and will be removed in the future.
TestSuiteclass for creating executable test suites programmatically and
TestSuiteBuilderclass for creating such suites based on existing test data on the file system.
SuiteVisitorabstract class for processing testdata before execution. This can be used as a base for implementing a pre-run modifier that is taken into use with
ExecutionResult()factory method for reading execution results from XML output files and
ResultVisitorabstract class to ease further processing the results.
ResultVisitorcan also be used as a base for pre-Rebot modifier that is taken into use with
ResultWriterclass for writing reports, logs, XML outputs, and XUnit files. Can write results based on XML outputs on the file system, as well as based on the result objects returned by the
ExecutionResult()or an executed
Languageclasses for external tools that need to work with different translations. The latter is also the base class to use with custom translations.
All of the above names can be imported like:
from robot.api import ApiName
See documentations of the individual APIs for more details.
APIs related to the command line entry points are exposed directly
robot root package.
robot packages are listed below. Typically you should not
need to import anything from them directly, but the above public APIs may
return objects implemented in them.