Robot Framework调用Python类处理API的实例与数据传递问题

核心规则 #

• 不需要在类方法之间手动传递实例对象，完全可以按照常规Python面向对象的编码习惯，通过self绑定实例属性实现跨方法数据共享。
• Robot Framework 导入Python类作为测试库时，会自动完成类的实例化，所有关键字调用默认都绑定到对应实例上，不需要手动实例化、回传实例对象。
• 多实例场景下可以通过库别名机制实现完全的实例隔离，不需要自己维护实例映射关系。

常见用法说明 #

1. 单实例场景（绝大多数常规场景） #

当你通过Library 路径/foo.py导入类库时，RF默认会为当前测试套件创建一个唯一的类实例。你在类方法中给self绑定的所有属性，会在整个实例生命周期内保留，其他类方法可以直接通过self读取，不需要额外传参。

你提供的示例代码存在几处Python语法错误：get_api方法缺少self参数、类方法定义缺少括号，修正后的类代码如下：

class foo:
    def __init__(self):
        self.api_item = None

    def intialize(self, api):
        self.api_item = api 

    def get_api(self):
        return self.api_item
    
    def do_something_with_api(self):
        # 直接通过self访问之前初始化的api_item，无需传参
        if not self.api_item:
            raise RuntimeError("请先调用initialize完成初始化")
        # 编写API交互逻辑
        return f"调用接口{self.api_item}的执行结果"
    
    def do_something_else_with_api(self):
        # 同样直接访问self.api_item即可
        return f"对接口{self.api_item}执行其他操作的结果"

对应的Robot用例不需要接收initialize的返回值，直接调用后续关键字即可访问初始化存入的数据：

*** Settings ***
Library             /path/foo.py

*** Variables ***
${api_url}   https://apiurl.com/

*** Tasks ***
接口调用测试
     # 不需要接收返回值，方法直接修改当前实例的self属性
     intialize     ${api_url}
     ${result}=    do_something_with_api
     log    ${result}
     ${current_api}=    get_api
     Should Be Equal    ${current_api}    ${api_url}

你之前写的MgsRestApiHandler.intialize调用方式是错误的：导入类库后，类下的公共方法会直接注册为关键字，不需要加类名前缀。

2. 多实例隔离场景 #

如果需要同时维护多个独立的类实例（比如同时对接生产、测试两套不同的API），只需要在导入类库时通过WITH NAME给同一个类指定不同别名即可，每个别名对应一个完全独立的类实例，实例间的属性互不干扰：

*** Settings ***
# 导入两次同一个类，分别指定不同别名，对应两个独立实例
Library             /path/foo.py    WITH NAME    prod_client
Library             /path/foo.py    WITH NAME    test_client

*** Variables ***
${prod_api_url}   https://prod-api.com/
${test_api_url}   https://test-api.com/

*** Tasks ***
多实例接口测试
     # 分别初始化两个实例
     prod_client.intialize     ${prod_api_url}
     test_client.intialize     ${test_api_url}
     # 调用对应实例的方法，数据完全隔离
     ${prod_result}=    prod_client.do_something_with_api
     ${test_result}=    test_client.do_something_with_api
     log    生产环境调用结果：${prod_result}
     log    测试环境调用结果：${test_result}

如果需要运行时动态创建不确定数量的实例，可以通过工厂关键字手动实例化类，将实例对象作为RF变量传递给后续关键字即可——RF原生支持传递任意Python对象作为参数，不过这种方式灵活性更高，不如别名方式符合RF的关键字设计规范。

补充配置说明 #

你可以通过在Python类中定义ROBOT_LIBRARY_SCOPE类属性，控制实例的生命周期：

• ROBOT_LIBRARY_SCOPE = 'GLOBAL'：整个测试执行全局唯一实例，所有测试套件共用
• ROBOT_LIBRARY_SCOPE = 'TEST SUITE'：默认值，每个测试套件一个独立实例
• ROBOT_LIBRARY_SCOPE = 'TEST CASE'：每个测试用例一个独立实例，用例执行完自动销毁，不会出现用例间数据污染

内容的提问来源于stack exchange，提问作者Mike Q