如何让RobotFramework自定义Python库__init__方法的日志输出到日志文件

RobotFramework 自定义库的类__init__方法执行发生在测试套件预处理阶段，这个阶段的日志默认不会被写入测试执行的日志上下文，所以直接调用robot.api.logger输出的内容会被过滤，不会出现在最终的log.html中。

以下是三种可落地的处理方案，按优先级推荐：

方案1：添加force参数强制输出日志（优先推荐） #

RobotFramework 4.0及以上版本的logger方法原生支持force=True参数，可跳过上下文检测强制把日志写入输出流，直接修改__init__里的日志语句即可：

from robot.api import logger
import configparser
from sshtunnel import SSHTunnelForwarder

class CustomSSHManager:
    def __init__(self, config_path="./config.ini"):
        # 输出日志时添加force=True参数
        logger.info(f"开始加载配置文件: {config_path}", force=True)
        self.config = configparser.ConfigParser()
        self.config.read(config_path, encoding="utf-8")
        host_list = self.config.sections()
        logger.debug(f"加载到的主机列表: {host_list}", force=True)
        
        logger.info("开始初始化SSH连接池", force=True)
        self.ssh_pool = {}
        for host in host_list:
            self.ssh_pool[host] = SSHTunnelForwarder(
                (self.config[host]["ip"], int(self.config[host]["port"])),
                ssh_username=self.config[host]["username"],
                ssh_password=self.config[host]["password"]
            )
        logger.info("SSH连接池初始化完成，共创建%d个连接" % len(self.ssh_pool), force=True)

注意：运行测试时要保证日志级别匹配你输出的日志等级，比如输出了debug级别日志，需要在执行robot命令时添加-L DEBUG参数，否则低级别日志仍然会被过滤。

方案2：抽离初始化逻辑为显式调用关键字 #

如果使用的是RobotFramework 4.0以下的旧版本，或者需要初始化日志和后续测试步骤强关联，可以把__init__里的业务逻辑抽成单独的关键字，在测试套件的Suite Setup中显式调用：

Python代码示例 #

from robot.api import logger
import configparser
from sshtunnel import SSHTunnelForwarder

class CustomSSHManager:
    def __init__(self):
        self.config = None
        self.ssh_pool = None
    
    def 初始化SSH连接池(self, config_path="./config.ini"):
        # 所有初始化逻辑和日志都放到这个关键字里
        logger.info(f"开始加载配置文件: {config_path}")
        self.config = configparser.ConfigParser()
        self.config.read(config_path, encoding="utf-8")
        host_list = self.config.sections()
        logger.debug(f"加载到的主机列表: {host_list}")
        
        logger.info("开始初始化SSH连接池")
        self.ssh_pool = {}
        for host in host_list:
            self.ssh_pool[host] = SSHTunnelForwarder(
                (self.config[host]["ip"], int(self.config[host]["port"])),
                ssh_username=self.config[host]["username"],
                ssh_password=self.config[host]["password"]
            )
        logger.info("SSH连接池初始化完成，共创建%d个连接" % len(self.ssh_pool))

RobotFramework 用例配置示例 #

*** Settings ***
Library    CustomSSHManager
Suite Setup    初始化SSH连接池    config/prod_config.ini

这种方式的日志会被正常归类到Suite Setup的执行步骤下，可读性最高。

方案3：控制台输出捕获（仅兼容旧版本） #

如果使用的是RobotFramework 3.x及以下的旧版本，也不想修改现有代码结构，可以在输出日志时添加also_console=True参数，运行测试时控制台输出的内容会被自动捕获到log.html的系统日志区域：

logger.info("初始化SSH连接池", also_console=True)

这种方式的日志不会和测试步骤关联，仅会出现在日志文件的头部区域，可读性较差，仅作为兼容方案使用。

内容的提问来源于stack exchange，提问作者Amit Tendulkar