robot.api 包公开的公共api机器人框架
除非另有声明,公开的api在这个包中被认为是稳定的, 从而构建外部工具时,安全使用的机器人框架。
目前暴露api:
-
logger -
deco -
TestCaseFile,TestDataDirectory,ResourceFile类解析测试 数据文件和目录。 此外,方便工厂方法TestData()要么创造TestCaseFile或TestDataDirectory基于输入的对象。 -
TestSuite类来创建可执行 测试套件以编程方式和TestSuiteBuilder类 用于创建这些套件基于现有的文件系统上的测试数据。 -
SuiteVisitor抽象类testdata进行处理 之前执行。 这可以用作基础实现跑前 为使用修饰符——prerunmodifier命令行选项。 -
ExecutionResult()工厂方法 阅读从XML输出文件和执行结果ResultVisitor抽象类来缓解 进一步的处理结果。ResultVisitor也可以用作基础 对于pre-Rebot纳入使用修饰符——prerebotmodifier命令行选项。 -
ResultWriter类写作 报告、日志、XML输出,XUnit文件。 可以编写基于结果 文件系统上的XML输出,以及基于对象的结果 返回的ExecutionResult()或 一个执行TestSuite。
在命令行api相关的入口点直接接触 通过robot根包。
Submodules
robot.api.deco模块
-
robot.api.deco.keyword -
修饰符来设置自定义关键字名称和标记函数和方法。这个修饰符创建
robot_name和robot_tags属性 装饰的关键字方法或函数。 机器人框架检查他们 分别确定关键字的名字和标签。library.py:
@keyword(name='Login Via User Panel')
def login(username, password):
# ... @keyword(name='Logout Via User Panel', tags=['example', 'tags'])
def logout():
# ...tests.robot:
Login Via User Panel myusername mypassword
如果
的名字没有得到的实际名称关键字不 影响,但robot_name属性仍将被创建。 这可以用于将方法标记为关键字在动态库。 在这种用法可以在使用时也省略括号 装饰:@keyword
def func():
# ...
robot.api.logger日志模块
公共日志API测试库。
这个模块提供了一个公共API的信息写入日志文件 和控制台。 测试库可以使用这个API:
logger.info('My message')
而不是通过标准输出的日志:
print '*INFO* My message'
除了编程接口被使用,这个API 有一个好处,日志消息有精确的时间。
如果日志方法的时使用robotFramework被没有运行, 消息重定向到标准的Python日志记录模块使用logger命名 RobotFramework 。
日志级别
使用水平是可能的日志消息 跟踪 , 调试 , 信息 , 警告 和 错误 要么使用 write() 函数,或者更 通常,与特定的日志级别 trace() , 调试() , 信息() , 警告() , 错误() 功能。 的支持 在robotframework2.9错误级别和功能是新的。
默认情况下,跟踪和调试消息不但是可以记录 改变了的 ——loglevel 命令行选项。 警告和错误 自动写控制台和 测试执行错误 部分在日志文件中。
日志的HTML
所有方法用于写入到日志文件中有一个信息 可选 html 论点。 如果一条消息记录应该是 显示为HTML,应该设置为这个论点 真正的 。 另外, write() 接受一个伪日志级别 HTML 。
例子
from robot.api import logger def my_keyword(arg):
logger.debug('Got argument %s.' % arg)
do_something()
logger.info('<i>This</i> is a boring example.', html=True)
-
robot.api.logger.write(msg, level='INFO', html=False) -
将消息写入日志文件使用给定的标准。
有效的日志级别
跟踪,调试,信息(默认robotframework 2.9.1),警告,错误在robotframework2.9(新)。 此外它是 可以使用HTML伪日志级别,日志消息为HTML 使用信息的标准。而不是使用这种方法,通常最好使用标准具体方法如
信息和调试有单独的html参数控制消息格式。
-
robot.api.logger.trace(msg, html=False) -
将消息写入日志文件使用
跟踪的标准。
-
robot.api.logger.debug(msg, html=False) -
将消息写入日志文件使用
调试的标准。
-
robot.api.logger.info(msg, html=False, also_console=False) -
将消息写入日志文件使用
信息的标准。如果
also_console参数设置为真正的,消息是 写日志文件和控制台。
-
robot.api.logger.warn(msg, html=False) -
将消息写入日志文件使用
警告的标准。
-
robot.api.logger.error(msg, html=False) -
将消息写入日志文件使用
错误的标准。2.9新机器人框架。
-
robot.api.logger.console(msg, newline=True, stream='stdout') -
写消息到控制台。
如果
换行符参数是真正的一个换行符 自动添加到消息。默认情况下,消息写入到标准输出流。 使用标准错误流可能是提供
流参数值“stderr”。