robot API笔记1

robot.api 包公开的公共api机器人框架

除非另有声明,公开的api在这个包中被认为是稳定的, 从而构建外部工具时,安全使用的机器人框架。

目前暴露api:

logger 模块测试库的日志的目的。
deco 模块使用decorator测试库可以使用。
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 ( name =None , 标签=() )

修饰符来设置自定义关键字名称和标记函数和方法。这个修饰符创建 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” 。