pytest-testkit 1.0.2b1__tar.gz → 1.0.3__tar.gz

{pytest_testkit-1.0.2b1/pytest_testkit.egg-info → pytest_testkit-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest_testkit
-Version: 1.0.2b1
+Version: 1.0.3
 Summary: Pytest plugin for Infra logging framework and environment management
 Author: Huawei
 License: MIT License
@@ -43,14 +43,12 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pytest==8.3.2
+Requires-Dist: pytest>=8.3.2
 Requires-Dist: requests
 Requires-Dist: paramiko
 Requires-Dist: xlrd>=2.0.0
 Requires-Dist: PyYaml
 Requires-Dist: scp
-Requires-Dist: execnet
-Requires-Dist: pybind11
 Provides-Extra: dev
 Requires-Dist: build; extra == "dev"
 Requires-Dist: twine; extra == "dev"
@@ -126,6 +124,8 @@ docker run -d --name <name> -p 2222:22 <image>:<tag>
 ```
 ### logger 使用
 
+> **⚠️ 安全提醒：该`logger`为 `pytest-testkit` 插件提供的基础日志能力，请勿在测试用例中打印敏感信息（如密码、密钥、Token 等），以免造成信息泄露。**
+
 导入 logger：
 
 ```python
@@ -135,7 +135,7 @@ from pytest_testkit.lib.common.log import logger
 使用 logger 记录日志：
 
 ```python
-logger.info(f"[Device._login] Successfully connected to device")
+logger.info("Successfully connected to device")
 ```
 
 #### 日志目录结构
@@ -152,12 +152,30 @@ logs/
 
 **目录结构说明**：
 - **TestCases**: 测试用例日志根目录
-- **日期目录**: 按执行日期组织（格式：`YYYY-MM-DD`）
-- **用例子目录**: 按用例名和执行时间命名（格式：`用例名_HH-MM-SS`）
+- **日期目录**: 按执行日期组织（格式：`YYYY-MM-DD`，使用本机时区）
+- **用例子目录**: 按用例名和执行时间命名（格式：`用例名_HH-MM-SS`，使用本机时区）
 - **HTML 文件**: 插件生成的测试报告，文件名与用例名一致
 
 通过 `logger.path` 属性可以获取当前用例的日志归档目录路径，方便在测试用例中创建自定义文件。
 
+#### HTML 报告渲染
+
+> **⚠️ 安全提醒：HTML 报告会完整渲染日志中记录的命令文本、回显输出及登录 banner 等内容，请勿在命令或日志中携带敏感信息（如密码、密钥、Token 等），以免在报告中明文暴露。**
+
+测试用例的 HTML 日志报告支持以下渲染特性：
+
+- **op_type 标签**: 命令与连接日志通过 `logging` 的 `extra={"op_type": ...}` 标记操作类型，HTML 报告 Location 列显示该标签（未标记记录回退为 `文件名:行号`）。内置标签包括：
+  - `sendcmd[<设备短名>]`: 发送命令，消息带最近 shell 提示符前缀（如 `root@host:~#ls -la`），设置 `cwd` 时追加 `(cwd: ...)`
+  - `recvcmd[<设备短名>]`: 命令文本回显（stdout+stderr 合并，不打印 dict），末尾带最新提示符；无输出时显示 `(empty)`
+  - `login[<设备短名>]` / `loginresult[<设备短名>]`: 登录开始与结果（登录失败为 ERROR 级别）
+  - `loginecho[<设备短名>]`: 登录 banner（交互 channel 首次创建时吸收，在第一条 sendcmd 之前打印）
+  - `disconnect[<设备短名>]`: 连接关闭
+  - `<设备短名>` 取设备名最后一段（按 `-` 或 `/` 分割），如 `rack1/node_3` → `node_3`
+- **ANSI 颜色渲染**: 报告自动把 ANSI 前景色码（30-37、90-97）转换为带颜色的 `<span>` 标签。例如命令日志中的蓝色码（`\x1b[34m`）渲染为蓝色（`#2196F3`）
+- **错误词高亮**: `recvcmd` 回显中的常见错误词（error、failed、fatal、panic、traceback、timeout、"No such file or directory" 等）会以粗体红色显示，便于快速定位失败。命令行（sendcmd）与普通日志不高亮，避免误伤命令本身
+- **列宽调整**: Level 列 70px、Thread 列 50px、Location 列 128px，Message 列获得更多空间
+- **本地时间**: 会话目录、日期目录、用例子目录均使用本机时区时间，与报告表内日志时间戳一致
+
 日志级别：
 
 | 级别 | 值 | 方法                      | 说明 |
@@ -411,9 +429,9 @@ def test_environment(logger):
 
 ### quiet_stdout 功能
 
-pytest-testkit 插件支持全局静默 `sendcmd` / `sendcmd_interactive` 的 stdout 输出，避免大量回显淹没日志。
-**开启后，stdout 内容不会出现在日志中，即使调用方显式传 `echo_output=True` 也会被全局压制。**
-exit_code、prompt、stderr 等信息不受影响。
+pytest-testkit 插件支持全局静默 `sendcmd` / `sendcmd_oneshot` / `sendcmd_interactive` 的命令与回显日志，避免大量回显淹没日志。
+**开启后，sendcmd / recvcmd 日志都不会打印，即使调用方显式传 `echo_output=True` 也会被全局压制。**
+命令返回值（stdout / stderr / exit_code 等）不受影响，仅影响日志输出。
 
 **支持CLI 参数 和 ini 配置，默认为禁用**
 
@@ -528,23 +546,27 @@ def test_use_ci_metadata():
 
 - **environment/environments**: 提供单设备/多设备对象
 
-  - **sendcmd(cmd, timeout=None, env_vars=None, cwd=None, ignore_err=False, only_stdout=True)**：执行命令(非交互式)
+  - **sendcmd(cmd, timeout=None, env_vars=None, cwd=None, ignore_err=False, only_stdout=True, echo_output=True)**：在持久化交互 shell channel 上执行命令
     - `cmd`: 要执行的命令字符串
-    - `timeout`: 命令执行超时时间（秒）
-    - `env_vars`: 环境变量字典
+    - `timeout`: 命令执行超时时间（秒），支持 int 或 str，默认 600s
+    - `env_vars`: 环境变量字典，内联为单命令前缀（`VAR=value cmd`），仅对本次命令生效，不污染持久化 shell
     - `cwd`: 工作目录，命令将在该目录下执行（可选）
     - `ignore_err`: 是否忽略命令执行错误，默认 False。设为 True 时即使命令失败 success 也为 True
     - `only_stdout`: 为 True 时只返回 stdout 字符串，为 False 时返回完整字典
+    - `echo_output`: 是否打印 sendcmd/recvcmd 日志，默认 True
+    - 行为说明: 同一线程内 shell 状态（`cd`、`export`）跨调用持久化；PTY 合并 stderr 到 stdout，返回 dict 的 `stderr` 通常为空；退出码通过 `$?` 哨兵尽力捕获。需要独立进程执行时请用 `sendcmd_oneshot`
     - 返回值: 默认返回 stdout 字符串；当 `only_stdout=False` 时返回 `{'success': bool, 'stdout': str, 'stderr': str}`
 
-  - **sendcmd_interactive(cmd, expect_prompt=None, timeout=600, cwd=None, ignore_err=False, only_stdout=True)**：执行命令(交互式)
-    - `cmd`: 要执行的命令字符串
-    - `expect_prompt`: 期望匹配的提示符正则表达式（可选）
-    - `timeout`: 命令执行超时时间（秒）。默认值600s
-    - `cwd`: 工作目录，命令将在该目录下执行（可选）
-    - `ignore_err`: 是否忽略提示符匹配失败，默认 False。设为 True 时即使未匹配到提示符 success 也为 True
-    - `only_stdout`: 为 True 时只返回 stdout 字符串，为 False 时返回完整字典
-    - 返回值: 默认返回 stdout 字符串；当 `only_stdout=False` 时返回 `{'success': bool, 'stdout': str, 'stderr': str}`
+  - **sendcmd_oneshot(cmd, timeout=None, env_vars=None, cwd=None, ignore_err=False, only_stdout=True, echo_output=True)**：独立进程执行命令（原 sendcmd 行为）
+    - 每次调用启动独立的 `exec_command` / `subprocess.run` 进程，无持久 shell 状态，与交互 channel 互相独立
+    - SSH 路径: 以 `bash -l -c` 包装执行，原生环境变量支持，退出码为 channel 权威退出状态，stderr 为独立流
+    - `local_exec` 路径: 通过 `subprocess.run` 执行
+    - 参数与返回值与 `sendcmd` 一致（`env_vars` 通过原生环境注入而非内联前缀）
+
+  - **sendcmd_interactive(cmd, expect_prompt=None, timeout=600, cwd=None, ignore_err=False, only_stdout=True)**：等同于 `sendcmd`（保留向后兼容）
+    - 现直接代理给 `sendcmd`，在持久化交互 shell channel 上执行
+    - `expect_prompt`: 保留签名兼容但不再生效（被忽略）
+    - 参数与返回值与 `sendcmd` 一致
     - **输出清理**: 返回的 stdout 会自动清理以下内容，便于用户直接使用：
       - CSI 控制序列（如 `\x1b[32m` 颜色代码、`\x1b[?2004h` bracketed paste mode 等）
       - OSC 控制序列（如 `\x1b]0;title\x07` 窗口标题设置等）
@@ -608,8 +630,10 @@ def test_use_ci_metadata():
 - **DockerProxy 容器代理对象**：通过 `environment["container_name"]` 获取
   - 代理对象提供与 Device 一致的接口，自动包装 `docker exec` 命令
 
-  - **sendcmd(cmd, timeout=None, ignore_err=False, only_stdout=True)**：非交互式命令
-    - 每次独立执行 `docker exec {docker_name} {cmd}`
+  - **sendcmd(cmd, timeout=None, ignore_err=False, only_stdout=True)**：非交互式命令（docker session 感知）
+    - 已在该容器交互式 session 中: 直接在当前 session 执行命令
+    - 其他容器持有交互式 session: 直接返回失败（提示"请退出上一个交互对话"）
+    - 否则: 包装为 `docker exec {docker_name} {cmd}` 执行（不创建持久 session）
     - 返回值: stdout 字符串或完整字典
 
   - **sendcmd_interactive(cmd, expect_prompt=None, timeout=600, cwd=None, ignore_err=False, only_stdout=True)**：交互式命令

{pytest_testkit-1.0.2b1 → pytest_testkit-1.0.3}/README.md

@@ -68,6 +68,8 @@ docker run -d --name <name> -p 2222:22 <image>:<tag>
 ```
 ### logger 使用
 
+> **⚠️ 安全提醒：该`logger`为 `pytest-testkit` 插件提供的基础日志能力，请勿在测试用例中打印敏感信息（如密码、密钥、Token 等），以免造成信息泄露。**
+
 导入 logger：
 
 ```python
@@ -77,7 +79,7 @@ from pytest_testkit.lib.common.log import logger
 使用 logger 记录日志：
 
 ```python
-logger.info(f"[Device._login] Successfully connected to device")
+logger.info("Successfully connected to device")
 ```
 
 #### 日志目录结构
@@ -94,12 +96,30 @@ logs/
 
 **目录结构说明**：
 - **TestCases**: 测试用例日志根目录
-- **日期目录**: 按执行日期组织（格式：`YYYY-MM-DD`）
-- **用例子目录**: 按用例名和执行时间命名（格式：`用例名_HH-MM-SS`）
+- **日期目录**: 按执行日期组织（格式：`YYYY-MM-DD`，使用本机时区）
+- **用例子目录**: 按用例名和执行时间命名（格式：`用例名_HH-MM-SS`，使用本机时区）
 - **HTML 文件**: 插件生成的测试报告，文件名与用例名一致
 
 通过 `logger.path` 属性可以获取当前用例的日志归档目录路径，方便在测试用例中创建自定义文件。
 
+#### HTML 报告渲染
+
+> **⚠️ 安全提醒：HTML 报告会完整渲染日志中记录的命令文本、回显输出及登录 banner 等内容，请勿在命令或日志中携带敏感信息（如密码、密钥、Token 等），以免在报告中明文暴露。**
+
+测试用例的 HTML 日志报告支持以下渲染特性：
+
+- **op_type 标签**: 命令与连接日志通过 `logging` 的 `extra={"op_type": ...}` 标记操作类型，HTML 报告 Location 列显示该标签（未标记记录回退为 `文件名:行号`）。内置标签包括：
+  - `sendcmd[<设备短名>]`: 发送命令，消息带最近 shell 提示符前缀（如 `root@host:~#ls -la`），设置 `cwd` 时追加 `(cwd: ...)`
+  - `recvcmd[<设备短名>]`: 命令文本回显（stdout+stderr 合并，不打印 dict），末尾带最新提示符；无输出时显示 `(empty)`
+  - `login[<设备短名>]` / `loginresult[<设备短名>]`: 登录开始与结果（登录失败为 ERROR 级别）
+  - `loginecho[<设备短名>]`: 登录 banner（交互 channel 首次创建时吸收，在第一条 sendcmd 之前打印）
+  - `disconnect[<设备短名>]`: 连接关闭
+  - `<设备短名>` 取设备名最后一段（按 `-` 或 `/` 分割），如 `rack1/node_3` → `node_3`
+- **ANSI 颜色渲染**: 报告自动把 ANSI 前景色码（30-37、90-97）转换为带颜色的 `<span>` 标签。例如命令日志中的蓝色码（`\x1b[34m`）渲染为蓝色（`#2196F3`）
+- **错误词高亮**: `recvcmd` 回显中的常见错误词（error、failed、fatal、panic、traceback、timeout、"No such file or directory" 等）会以粗体红色显示，便于快速定位失败。命令行（sendcmd）与普通日志不高亮，避免误伤命令本身
+- **列宽调整**: Level 列 70px、Thread 列 50px、Location 列 128px，Message 列获得更多空间
+- **本地时间**: 会话目录、日期目录、用例子目录均使用本机时区时间，与报告表内日志时间戳一致
+
 日志级别：
 
 | 级别 | 值 | 方法                      | 说明 |
@@ -353,9 +373,9 @@ def test_environment(logger):
 
 ### quiet_stdout 功能
 
-pytest-testkit 插件支持全局静默 `sendcmd` / `sendcmd_interactive` 的 stdout 输出，避免大量回显淹没日志。
-**开启后，stdout 内容不会出现在日志中，即使调用方显式传 `echo_output=True` 也会被全局压制。**
-exit_code、prompt、stderr 等信息不受影响。
+pytest-testkit 插件支持全局静默 `sendcmd` / `sendcmd_oneshot` / `sendcmd_interactive` 的命令与回显日志，避免大量回显淹没日志。
+**开启后，sendcmd / recvcmd 日志都不会打印，即使调用方显式传 `echo_output=True` 也会被全局压制。**
+命令返回值（stdout / stderr / exit_code 等）不受影响，仅影响日志输出。
 
 **支持CLI 参数 和 ini 配置，默认为禁用**
 
@@ -470,23 +490,27 @@ def test_use_ci_metadata():
 
 - **environment/environments**: 提供单设备/多设备对象
 
-  - **sendcmd(cmd, timeout=None, env_vars=None, cwd=None, ignore_err=False, only_stdout=True)**：执行命令(非交互式)
+  - **sendcmd(cmd, timeout=None, env_vars=None, cwd=None, ignore_err=False, only_stdout=True, echo_output=True)**：在持久化交互 shell channel 上执行命令
     - `cmd`: 要执行的命令字符串
-    - `timeout`: 命令执行超时时间（秒）
-    - `env_vars`: 环境变量字典
+    - `timeout`: 命令执行超时时间（秒），支持 int 或 str，默认 600s
+    - `env_vars`: 环境变量字典，内联为单命令前缀（`VAR=value cmd`），仅对本次命令生效，不污染持久化 shell
     - `cwd`: 工作目录，命令将在该目录下执行（可选）
     - `ignore_err`: 是否忽略命令执行错误，默认 False。设为 True 时即使命令失败 success 也为 True
     - `only_stdout`: 为 True 时只返回 stdout 字符串，为 False 时返回完整字典
+    - `echo_output`: 是否打印 sendcmd/recvcmd 日志，默认 True
+    - 行为说明: 同一线程内 shell 状态（`cd`、`export`）跨调用持久化；PTY 合并 stderr 到 stdout，返回 dict 的 `stderr` 通常为空；退出码通过 `$?` 哨兵尽力捕获。需要独立进程执行时请用 `sendcmd_oneshot`
     - 返回值: 默认返回 stdout 字符串；当 `only_stdout=False` 时返回 `{'success': bool, 'stdout': str, 'stderr': str}`
 
-  - **sendcmd_interactive(cmd, expect_prompt=None, timeout=600, cwd=None, ignore_err=False, only_stdout=True)**：执行命令(交互式)
-    - `cmd`: 要执行的命令字符串
-    - `expect_prompt`: 期望匹配的提示符正则表达式（可选）
-    - `timeout`: 命令执行超时时间（秒）。默认值600s
-    - `cwd`: 工作目录，命令将在该目录下执行（可选）
-    - `ignore_err`: 是否忽略提示符匹配失败，默认 False。设为 True 时即使未匹配到提示符 success 也为 True
-    - `only_stdout`: 为 True 时只返回 stdout 字符串，为 False 时返回完整字典
-    - 返回值: 默认返回 stdout 字符串；当 `only_stdout=False` 时返回 `{'success': bool, 'stdout': str, 'stderr': str}`
+  - **sendcmd_oneshot(cmd, timeout=None, env_vars=None, cwd=None, ignore_err=False, only_stdout=True, echo_output=True)**：独立进程执行命令（原 sendcmd 行为）
+    - 每次调用启动独立的 `exec_command` / `subprocess.run` 进程，无持久 shell 状态，与交互 channel 互相独立
+    - SSH 路径: 以 `bash -l -c` 包装执行，原生环境变量支持，退出码为 channel 权威退出状态，stderr 为独立流
+    - `local_exec` 路径: 通过 `subprocess.run` 执行
+    - 参数与返回值与 `sendcmd` 一致（`env_vars` 通过原生环境注入而非内联前缀）
+
+  - **sendcmd_interactive(cmd, expect_prompt=None, timeout=600, cwd=None, ignore_err=False, only_stdout=True)**：等同于 `sendcmd`（保留向后兼容）
+    - 现直接代理给 `sendcmd`，在持久化交互 shell channel 上执行
+    - `expect_prompt`: 保留签名兼容但不再生效（被忽略）
+    - 参数与返回值与 `sendcmd` 一致
     - **输出清理**: 返回的 stdout 会自动清理以下内容，便于用户直接使用：
       - CSI 控制序列（如 `\x1b[32m` 颜色代码、`\x1b[?2004h` bracketed paste mode 等）
       - OSC 控制序列（如 `\x1b]0;title\x07` 窗口标题设置等）
@@ -550,8 +574,10 @@ def test_use_ci_metadata():
 - **DockerProxy 容器代理对象**：通过 `environment["container_name"]` 获取
   - 代理对象提供与 Device 一致的接口，自动包装 `docker exec` 命令
 
-  - **sendcmd(cmd, timeout=None, ignore_err=False, only_stdout=True)**：非交互式命令
-    - 每次独立执行 `docker exec {docker_name} {cmd}`
+  - **sendcmd(cmd, timeout=None, ignore_err=False, only_stdout=True)**：非交互式命令（docker session 感知）
+    - 已在该容器交互式 session 中: 直接在当前 session 执行命令
+    - 其他容器持有交互式 session: 直接返回失败（提示"请退出上一个交互对话"）
+    - 否则: 包装为 `docker exec {docker_name} {cmd}` 执行（不创建持久 session）
     - 返回值: stdout 字符串或完整字典
 
   - **sendcmd_interactive(cmd, expect_prompt=None, timeout=600, cwd=None, ignore_err=False, only_stdout=True)**：交互式命令

{pytest_testkit-1.0.2b1 → pytest_testkit-1.0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pytest_testkit"
-version = "1.0.2b1"
+version = "1.0.3"
 description = "Pytest plugin for Infra logging framework and environment management"
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -30,14 +30,12 @@ classifiers = [
 ]
 keywords = ["pytest", "plugin", "logging", "html", "infra", "test", "automation"]
 dependencies = [
-    "pytest==8.3.2",
+    "pytest>=8.3.2",
     "requests",
     "paramiko",
     "xlrd>=2.0.0",
     "PyYaml",
     "scp",
-    "execnet",
-    "pybind11",
 ]
 
 [project.optional-dependencies]

{pytest_testkit-1.0.2b1 → pytest_testkit-1.0.3}/pytest_testkit/lib/base/sftp.py

@@ -58,7 +58,7 @@ class Sftp:
                 hostname=self.jump_ip,
                 port=self.jump_port,
                 username=self.jump_user,
-                password=self.jump_passwd,
+                password=self.target_pwd,
                 pkey=self.private_k,
                 timeout=10,
             )

{pytest_testkit-1.0.2b1 → pytest_testkit-1.0.3}/pytest_testkit/lib/common/environment/device.py

@@ -594,10 +594,11 @@ class Device:
             return True
 
         # 登录动作日志: HTML location 列显示 login[设备短名]
-        logger.info(
-            f"Logging in to device: {self.name}",
-            extra={"op_type": f"login[{_short_name(self.name)}]"},
-        )
+        # 改成框架日志，不在此处打印
+        # logger.info(
+        #     f"Logging in to device: {self.name}",
+        #     extra={"op_type": f"login[{_short_name(self.name)}]"},
+        # )
 
         # Implement actual SSH connection logic
         # 由于有跳板机，需要先登录跳板机，再登录目标设备
@@ -617,24 +618,27 @@ class Device:
         )
         login_result = self._thread_local.sshConnect.login()
         if login_result is False:
-            logger.error(
-                f"ssh login failed for {self.__str__()}",
-                extra={"op_type": f"loginresult[{_short_name(self.name)}]"},
-            )
+            # 改成框架日志，不在此处打印 这个是否不用修改
+            # logger.error(
+            #     f"ssh login failed for {self.__str__()}",
+            #     extra={"op_type": f"loginresult[{_short_name(self.name)}]"},
+            # )
             return False
         self._set_logged_in(True)
-        logger.info(
-            f"Successfully connected to {self.__str__()}",
-            extra={"op_type": f"loginresult[{_short_name(self.name)}]"},
-        )
+        # 改成框架日志，不在此处打印
+        # logger.info(
+        #     f"Successfully connected to {self.__str__()}",
+        #     extra={"op_type": f"loginresult[{_short_name(self.name)}]"},
+        # )
         # 登录后立即预创建交互 channel 并吸收 banner,
         # 保证 loginecho 出现在第一条 sendcmd 之前
         login_echo = self._thread_local.sshConnect.prepare_interactive_channel()
         if login_echo:
-            logger.info(
-                login_echo,
-                extra={"op_type": f"loginecho[{_short_name(self.name)}]"},
-            )
+            # 改成框架日志，不在此处打印
+            # logger.info(
+            #     login_echo,
+            #     extra={"op_type": f"loginecho[{_short_name(self.name)}]"},
+            # )
             self._thread_local.sshConnect._login_echo_logged = True
         return True
 
@@ -750,10 +754,11 @@ class Device:
             if getattr(ssh_connect, "login_echo", "") and not getattr(
                 ssh_connect, "_login_echo_logged", False
             ):
-                logger.info(
-                    ssh_connect.login_echo,
-                    extra={"op_type": f"loginecho[{_short_name(self.name)}]"},
-                )
+                # 改成框架日志，不在此处打印
+                # logger.info(
+                #     ssh_connect.login_echo,
+                #     extra={"op_type": f"loginecho[{_short_name(self.name)}]"},
+                # )
                 ssh_connect._login_echo_logged = True
 
             param = SshCmdInteractiveParam(
@@ -771,6 +776,8 @@ class Device:
         if echo_output and not _SESSION_QUIET_STDOUT:
             node_tag = f"[{_short_name(self.name)}]"
             prompt = getattr(ssh_connect, "last_prompt", "") if ssh_connect else ""
+            # root@lease-env1792052573-5446-nodes1-device1792052573-2811:~#ls -l
+            # 打印回显如上 需要带上 shell 提示符吗
             send_msg = f"{prompt}{cmd}" if prompt else cmd
             if cwd is not None:
                 send_msg += f"    (cwd: {cwd})"
@@ -792,11 +799,11 @@ class Device:
                 new_prompt = (
                     getattr(ssh_connect, "last_prompt", "") if ssh_connect else ""
                 )
-                recv_msg = (
-                    result_echo
-                    if result_echo.endswith(new_prompt)
-                    else (f"{result_echo}\n{new_prompt}" if new_prompt else result_echo)
-                )
+                # 回显结果以shell提示符结尾移除它, 没有提示符则直接打印不拼装
+                if new_prompt and result_echo.endswith(new_prompt):
+                    recv_msg = result_echo[: -len(new_prompt)].rstrip("\n")
+                else:
+                    recv_msg = result_echo
                 logger.info(recv_msg, extra={"op_type": f"recvcmd{node_tag}"})
             else:
                 logger.info("(empty)", extra={"op_type": f"recvcmd{node_tag}"})

{pytest_testkit-1.0.2b1 → pytest_testkit-1.0.3/pytest_testkit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest_testkit
-Version: 1.0.2b1
+Version: 1.0.3
 Summary: Pytest plugin for Infra logging framework and environment management
 Author: Huawei
 License: MIT License
@@ -43,14 +43,12 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pytest==8.3.2
+Requires-Dist: pytest>=8.3.2
 Requires-Dist: requests
 Requires-Dist: paramiko
 Requires-Dist: xlrd>=2.0.0
 Requires-Dist: PyYaml
 Requires-Dist: scp
-Requires-Dist: execnet
-Requires-Dist: pybind11
 Provides-Extra: dev
 Requires-Dist: build; extra == "dev"
 Requires-Dist: twine; extra == "dev"
@@ -126,6 +124,8 @@ docker run -d --name <name> -p 2222:22 <image>:<tag>
 ```
 ### logger 使用
 
+> **⚠️ 安全提醒：该`logger`为 `pytest-testkit` 插件提供的基础日志能力，请勿在测试用例中打印敏感信息（如密码、密钥、Token 等），以免造成信息泄露。**
+
 导入 logger：
 
 ```python
@@ -135,7 +135,7 @@ from pytest_testkit.lib.common.log import logger
 使用 logger 记录日志：
 
 ```python
-logger.info(f"[Device._login] Successfully connected to device")
+logger.info("Successfully connected to device")
 ```
 
 #### 日志目录结构
@@ -152,12 +152,30 @@ logs/
 
 **目录结构说明**：
 - **TestCases**: 测试用例日志根目录
-- **日期目录**: 按执行日期组织（格式：`YYYY-MM-DD`）
-- **用例子目录**: 按用例名和执行时间命名（格式：`用例名_HH-MM-SS`）
+- **日期目录**: 按执行日期组织（格式：`YYYY-MM-DD`，使用本机时区）
+- **用例子目录**: 按用例名和执行时间命名（格式：`用例名_HH-MM-SS`，使用本机时区）
 - **HTML 文件**: 插件生成的测试报告，文件名与用例名一致
 
 通过 `logger.path` 属性可以获取当前用例的日志归档目录路径，方便在测试用例中创建自定义文件。
 
+#### HTML 报告渲染
+
+> **⚠️ 安全提醒：HTML 报告会完整渲染日志中记录的命令文本、回显输出及登录 banner 等内容，请勿在命令或日志中携带敏感信息（如密码、密钥、Token 等），以免在报告中明文暴露。**
+
+测试用例的 HTML 日志报告支持以下渲染特性：
+
+- **op_type 标签**: 命令与连接日志通过 `logging` 的 `extra={"op_type": ...}` 标记操作类型，HTML 报告 Location 列显示该标签（未标记记录回退为 `文件名:行号`）。内置标签包括：
+  - `sendcmd[<设备短名>]`: 发送命令，消息带最近 shell 提示符前缀（如 `root@host:~#ls -la`），设置 `cwd` 时追加 `(cwd: ...)`
+  - `recvcmd[<设备短名>]`: 命令文本回显（stdout+stderr 合并，不打印 dict），末尾带最新提示符；无输出时显示 `(empty)`
+  - `login[<设备短名>]` / `loginresult[<设备短名>]`: 登录开始与结果（登录失败为 ERROR 级别）
+  - `loginecho[<设备短名>]`: 登录 banner（交互 channel 首次创建时吸收，在第一条 sendcmd 之前打印）
+  - `disconnect[<设备短名>]`: 连接关闭
+  - `<设备短名>` 取设备名最后一段（按 `-` 或 `/` 分割），如 `rack1/node_3` → `node_3`
+- **ANSI 颜色渲染**: 报告自动把 ANSI 前景色码（30-37、90-97）转换为带颜色的 `<span>` 标签。例如命令日志中的蓝色码（`\x1b[34m`）渲染为蓝色（`#2196F3`）
+- **错误词高亮**: `recvcmd` 回显中的常见错误词（error、failed、fatal、panic、traceback、timeout、"No such file or directory" 等）会以粗体红色显示，便于快速定位失败。命令行（sendcmd）与普通日志不高亮，避免误伤命令本身
+- **列宽调整**: Level 列 70px、Thread 列 50px、Location 列 128px，Message 列获得更多空间
+- **本地时间**: 会话目录、日期目录、用例子目录均使用本机时区时间，与报告表内日志时间戳一致
+
 日志级别：
 
 | 级别 | 值 | 方法                      | 说明 |
@@ -411,9 +429,9 @@ def test_environment(logger):
 
 ### quiet_stdout 功能
 
-pytest-testkit 插件支持全局静默 `sendcmd` / `sendcmd_interactive` 的 stdout 输出，避免大量回显淹没日志。
-**开启后，stdout 内容不会出现在日志中，即使调用方显式传 `echo_output=True` 也会被全局压制。**
-exit_code、prompt、stderr 等信息不受影响。
+pytest-testkit 插件支持全局静默 `sendcmd` / `sendcmd_oneshot` / `sendcmd_interactive` 的命令与回显日志，避免大量回显淹没日志。
+**开启后，sendcmd / recvcmd 日志都不会打印，即使调用方显式传 `echo_output=True` 也会被全局压制。**
+命令返回值（stdout / stderr / exit_code 等）不受影响，仅影响日志输出。
 
 **支持CLI 参数 和 ini 配置，默认为禁用**
 
@@ -528,23 +546,27 @@ def test_use_ci_metadata():
 
 - **environment/environments**: 提供单设备/多设备对象
 
-  - **sendcmd(cmd, timeout=None, env_vars=None, cwd=None, ignore_err=False, only_stdout=True)**：执行命令(非交互式)
+  - **sendcmd(cmd, timeout=None, env_vars=None, cwd=None, ignore_err=False, only_stdout=True, echo_output=True)**：在持久化交互 shell channel 上执行命令
     - `cmd`: 要执行的命令字符串
-    - `timeout`: 命令执行超时时间（秒）
-    - `env_vars`: 环境变量字典
+    - `timeout`: 命令执行超时时间（秒），支持 int 或 str，默认 600s
+    - `env_vars`: 环境变量字典，内联为单命令前缀（`VAR=value cmd`），仅对本次命令生效，不污染持久化 shell
     - `cwd`: 工作目录，命令将在该目录下执行（可选）
     - `ignore_err`: 是否忽略命令执行错误，默认 False。设为 True 时即使命令失败 success 也为 True
     - `only_stdout`: 为 True 时只返回 stdout 字符串，为 False 时返回完整字典
+    - `echo_output`: 是否打印 sendcmd/recvcmd 日志，默认 True
+    - 行为说明: 同一线程内 shell 状态（`cd`、`export`）跨调用持久化；PTY 合并 stderr 到 stdout，返回 dict 的 `stderr` 通常为空；退出码通过 `$?` 哨兵尽力捕获。需要独立进程执行时请用 `sendcmd_oneshot`
     - 返回值: 默认返回 stdout 字符串；当 `only_stdout=False` 时返回 `{'success': bool, 'stdout': str, 'stderr': str}`
 
-  - **sendcmd_interactive(cmd, expect_prompt=None, timeout=600, cwd=None, ignore_err=False, only_stdout=True)**：执行命令(交互式)
-    - `cmd`: 要执行的命令字符串
-    - `expect_prompt`: 期望匹配的提示符正则表达式（可选）
-    - `timeout`: 命令执行超时时间（秒）。默认值600s
-    - `cwd`: 工作目录，命令将在该目录下执行（可选）
-    - `ignore_err`: 是否忽略提示符匹配失败，默认 False。设为 True 时即使未匹配到提示符 success 也为 True
-    - `only_stdout`: 为 True 时只返回 stdout 字符串，为 False 时返回完整字典
-    - 返回值: 默认返回 stdout 字符串；当 `only_stdout=False` 时返回 `{'success': bool, 'stdout': str, 'stderr': str}`
+  - **sendcmd_oneshot(cmd, timeout=None, env_vars=None, cwd=None, ignore_err=False, only_stdout=True, echo_output=True)**：独立进程执行命令（原 sendcmd 行为）
+    - 每次调用启动独立的 `exec_command` / `subprocess.run` 进程，无持久 shell 状态，与交互 channel 互相独立
+    - SSH 路径: 以 `bash -l -c` 包装执行，原生环境变量支持，退出码为 channel 权威退出状态，stderr 为独立流
+    - `local_exec` 路径: 通过 `subprocess.run` 执行
+    - 参数与返回值与 `sendcmd` 一致（`env_vars` 通过原生环境注入而非内联前缀）
+
+  - **sendcmd_interactive(cmd, expect_prompt=None, timeout=600, cwd=None, ignore_err=False, only_stdout=True)**：等同于 `sendcmd`（保留向后兼容）
+    - 现直接代理给 `sendcmd`，在持久化交互 shell channel 上执行
+    - `expect_prompt`: 保留签名兼容但不再生效（被忽略）
+    - 参数与返回值与 `sendcmd` 一致
     - **输出清理**: 返回的 stdout 会自动清理以下内容，便于用户直接使用：
       - CSI 控制序列（如 `\x1b[32m` 颜色代码、`\x1b[?2004h` bracketed paste mode 等）
       - OSC 控制序列（如 `\x1b]0;title\x07` 窗口标题设置等）
@@ -608,8 +630,10 @@ def test_use_ci_metadata():
 - **DockerProxy 容器代理对象**：通过 `environment["container_name"]` 获取
   - 代理对象提供与 Device 一致的接口，自动包装 `docker exec` 命令
 
-  - **sendcmd(cmd, timeout=None, ignore_err=False, only_stdout=True)**：非交互式命令
-    - 每次独立执行 `docker exec {docker_name} {cmd}`
+  - **sendcmd(cmd, timeout=None, ignore_err=False, only_stdout=True)**：非交互式命令（docker session 感知）
+    - 已在该容器交互式 session 中: 直接在当前 session 执行命令
+    - 其他容器持有交互式 session: 直接返回失败（提示"请退出上一个交互对话"）
+    - 否则: 包装为 `docker exec {docker_name} {cmd}` 执行（不创建持久 session）
     - 返回值: stdout 字符串或完整字典
 
   - **sendcmd_interactive(cmd, expect_prompt=None, timeout=600, cwd=None, ignore_err=False, only_stdout=True)**：交互式命令

{pytest_testkit-1.0.2b1 → pytest_testkit-1.0.3}/pytest_testkit.egg-info/SOURCES.txt

@@ -15,7 +15,6 @@ pytest_testkit/lib/__init__.py
 pytest_testkit/lib/base/__init__.py
 pytest_testkit/lib/base/excel.py
 pytest_testkit/lib/base/ftp.py
-pytest_testkit/lib/base/http.py
 pytest_testkit/lib/base/local_exec.py
 pytest_testkit/lib/base/sftp.py
 pytest_testkit/lib/base/ssh.py

{pytest_testkit-1.0.2b1 → pytest_testkit-1.0.3}/pytest_testkit.egg-info/requires.txt

@@ -1,11 +1,9 @@
-pytest==8.3.2
+pytest>=8.3.2
 requests
 paramiko
 xlrd>=2.0.0
 PyYaml
 scp
-execnet
-pybind11
 
 [dev]
 build

{pytest_testkit-1.0.2b1 → pytest_testkit-1.0.3}/requirements.txt

@@ -1,9 +1,7 @@
-pytest==8.3.2
+pytest>=8.3.2
 pytest-timeout>=2.3.1,<3.0
 requests
-paramiko
+paramiko>=3.5.1
 xlrd>=2.0.0
 PyYaml
 scp
-execnet
-pybind11

pytest_testkit-1.0.2b1/pytest_testkit/lib/base/http.py

@@ -1,431 +0,0 @@
-# Copyright (C) 2024 Intel Corporation
-# SPDX-License-Identifier: MPL-2.0
-
-import json
-import requests
-from pytest_testkit.lib.common import log
-
-HTTP_METHOD_GET = "GET"
-HTTP_METHOD_PUT = "PUT"
-HTTP_METHOD_POST = "POST"
-HTTP_METHOD_PATCH = "PATCH"
-HTTP_METHOD_DELETE = "DELETE"
-HTTP_METHOD_HEAD = "HEAD"
-
-
-class Http:
-    """Base class of Restful"""
-
-    # 1xx: Informational
-    # 2xx: Success
-    # 3xx: Redirection
-    # 4xx: Client Error
-    # 5xx: Server Error
-    HttpErrorCode = {
-        200: "OK. The request has succeeded.",
-        201: "Created. The request has been fulfilled and resulted in a new "
-        "resource being created.",
-        202: "Accepted as an async process",
-        204: "OK no content returned",
-        400: "Bad Request. Badly formed URI, parameters, headers, or body content.",
-        401: "Unauthorized. The request requires user authentication.",
-        403: "Forbidden. The request was valid, but the server is refusing action.",
-        404: "Not Found. Resource doesn't exist.",
-        405: "Method Not Allowed.",
-        406: "Not Acceptable. Accept headers are not satisfiable.",
-        409: "Conflict. The request could not be completed due to a conflict "
-        "with the current state of the resource.",
-        412: "Precondition Failed. The precondition given in the "
-        "request-header fields evaluated to false on the server.",
-        422: "Unprocessable Entity, Semantically invalid content on a POST.",
-        500: "Internal Server Error.",
-        503: "Service Unavailable.",
-    }
-
-    def __init__(self, max_retry=0):
-        self.logger = log.get_logger(str(self.__module__))
-        # pgxun: 此赋值用于指定对外公开哪些函数。
-        self.method_release_requirement = []
-        self.session = requests.Session()
-
-        # 设置HTTP命令重试的次数。0的缺省值表示不更改HTTP模块的重试次数
-        # （requests模块的缺省值是：0，不重试）。
-        """
-        max_retries: The maximum number of retries each connection
-        should attempt. Note, this applies only to failed DNS lookups, socket
-        connections and connection timeouts, never to requests where data has
-        made it to the server. By default, Requests does not retry failed
-        connections.
-        """
-        if max_retry != 0:
-            retry_counts = requests.adapters.HTTPAdapter(max_retries=max_retry)
-            self.session.mount("http://", retry_counts)
-            self.session.mount("https://", retry_counts)
-
-    def __convert_json_list_to_table(self, json_list):
-        """Convert json list to table"""
-
-        # calculate column width
-        headers = self.__calculate_column_width(json_list)
-        text_string = "-------------- Title --------------\n"
-        pattern = "{0:{width}s}"
-
-        # format headers
-        for name, width in headers.items():
-            text_string = text_string + pattern.format(name, width=width)
-
-        text_string = text_string + "\n"
-        for _, width in headers.items():
-            split = "-" * (
-                width - 4
-            )  # 4 space char, the same to __calculateColumnWidth
-            text_string = text_string + pattern.format(split, width=width)
-
-        # format values
-        for item in json_list:
-            text_string = text_string + "\n"
-            for name, width in headers.items():
-                text_string = text_string + pattern.format(
-                    str(item.get(name)), width=width
-                )
-
-        return text_string + "\n"
-
-    @staticmethod
-    def __calculate_column_width(json_list):
-        """Calculate table column width according to json's key-value"""
-
-        headers = {}
-        if not isinstance(json_list, list):
-            return headers
-
-        # at least 5 chars for each column, in the commonParser, he set
-        # splitter must has 5 '-'s, i don't why
-        min_header_with = 5
-        fixed_space_width = 4  # add 4 space by default
-        for js in json_list:
-            for key, value in js.items():
-                value_length = len(str(value)) + fixed_space_width
-                if key in headers.keys():
-                    headers[key] = max(value_length, headers[key])
-                else:
-                    key_length = len(str(key)) + fixed_space_width
-                    headers[key] = max(
-                        key_length, value_length, min_header_with + fixed_space_width
-                    )
-
-        return headers
-
-    @staticmethod
-    def __convert_dict_items_to_json(params):
-        """Convert dict type parameters in given Http parameters to json type"""
-        for key, value in params.items():
-            if key.lower() not in ["data", "params"]:
-                continue
-
-            if isinstance(value, dict):
-                params[key] = json.dumps(value)
-        return params
-
-    def __log_request(self, method=None, url=None, **params):
-        """log out user's request parameters"""
-        self.logger.info(
-            "-----> Http request method: %s, url: %s <-----" % (method, url)
-        )
-        if len(str(params["data"])) > 100:
-            self.logger.info(
-                "Request params(data too long, only headers shown): %s"
-                % params["headers"]
-            )
-        else:
-            self.logger.info("Request params: %s" % params)
-
-    def __handle_http_error_code(self, status_code):
-        """Return error message according to Http status code"""
-        status_code = int(status_code)
-        if self.HttpErrorCode.has_key(status_code):
-            return self.HttpErrorCode[status_code]
-        else:
-            return "<Error Info Absent>."
-
-    def __log_response(self, response):
-        """log out response message according to response status code
-        pgxun: 打印返回消息的日志。
-        """
-
-        # 1xx: Informational
-        # 2xx: Success
-        # 3xx: Redirection
-        # 4xx: Client Error
-        # 5xx: Server Error
-
-        if not response.ok:
-            msg = "Response error. Status code: %s, elapsed: %s, message: %s" % (
-                response.status_code,
-                response.elapsed,
-                self.__handle_http_error_code(response.status_code),
-            )
-            self.logger.warning(str(msg))
-        else:
-            self.logger.info(
-                "-----> Http response success, status code: "
-                + str(response.status_code)
-                + " <-----"
-            )
-
-            # 规避一个下载文件接口的问题
-            if response.text.find("{") < 0:
-                msg = "Response elapsed: %s, message: %s" % (
-                    response.elapsed,
-                    "This interface is used to download file, no json response data",
-                )
-            else:
-                # 说明：如果转换为dict再打印，会使得打印的key排序和得到的响应的原始顺序
-                # 不一样，导致用户观察结果不方便。
-                msg = "Response elapsed: {}, message: \n{}".format(
-                    response.elapsed, response.text
-                )
-
-            # 部分告警信息中有中文句号，要特殊处理一下
-            self.logger.info(str(msg))
-
-    def convert_json_to_table(self, json_obj):
-        """Convert json object to table text string
-
-        Args:
-            jsonList            (list) : Json list to be convert
-
-        Returns:           A pretty formatted table text string.
-
-        Raises:
-            InvalidParamException
-
-        Examples:
-            In:
-                [{u'COUNT': u'19034', u'ISONLINE': u'1',
-                u'DESCRIPTION': u'Default user', u'LEVEL': u'1',
-                u'LOCKSTATUS': u'0', u'CREATETIME': u'1440243958',
-                u'SCOPE': u'0', u'TYPE': 202, u'ID': u'admin',
-                u'NAME': u'admin'}]
-            Out:
-                -------------- Title --------------
-                COUNT ISONLINE DESCRIPTION  LOCKSTATUS LEVEL  ID    SCOPE TYPE CREATETIME NAME
-                ----- -------- ------------ ---------- -----  ----- ----- ---- ---------- -----
-                19083 1        Default user 0          1      admin 0     202  1440243958 admin
-
-        """
-
-        json_list = json_obj
-        if isinstance(json_obj, dict):
-            json_list = [json_obj]
-
-        # json is an array, means it contains many tables
-        if len(json_list) > 0:
-            if not all(isinstance(x, dict) for x in json_list):
-                self.logger.warning(
-                    "Can not deal with json object which contains array, "
-                    "contact us please. data:" + json
-                )
-                return []
-            return self.__convert_json_list_to_table(json_list)
-        else:
-            return []
-
-    def encode_json_to_utf8(self, unicode_json):
-        """Convert unicode json encoding to utf-8"""
-
-        if isinstance(unicode_json, dict):
-            return {
-                self.encode_json_to_utf8(key): self.encode_json_to_utf8(value)
-                for key, value in unicode_json.iteritems()
-            }
-        elif isinstance(unicode_json, list):
-            return [self.encode_json_to_utf8(item) for item in unicode_json]
-        elif isinstance(unicode_json, unicode):
-            # deal with special character in the response
-            return (
-                unicode_json
-                .encode("utf-8")
-                .replace("&#40;", "(")
-                .replace("&#41;", ")")
-                .replace("&gt;", ">")
-                .replace("&lt;", "<")
-                .replace("&amp;", "&")
-                .replace("\r", "")
-                .replace("\n", "")
-            )
-        else:
-            return unicode_json
-
-    """
-    pgxun说明：
-    requests的request函数定义如下：
-    requests.request(method, url, **kwargs)[source]
-        method：是HTTP动作的名字，如GET、PUT等。
-        url -- URL for the new Request object.
-        kwargs -- (optional) Dictionary or bytes to be sent in the query string for the Request.
-            kwargs包括以下12个可选的内容，常用的有：
-            data -- 这是请求的body部分，可以是：Dict, bytes, or file-like object to send in the body of the Request.
-            json -- 这是请求的body部分，JSON格式。json data to send in the body of the Request.
-            headers -- 这是请求的Headers部分，dict格式。 Dictionary of HTTP Headers to send with the Request.
-            等等
-        返回值：request命令的响应response。
-    注意：
-        1、你也可以不使用params，而是直接将12个可选内容写在request的调用参数列表中。
-        2、params中可以直接写入"key=value"的字段格式，如果不是12个可选的内容，则会作为url的参数，例如：
-            payload = {'key1': 'value1', 'key2': 'value2'}
-
-        3、params传入的示例：
-
-    """
-
-    def request(self, method, url, **kwargs):
-        """Make a Http request according to given method
-
-        Args:
-            method               (str) : Http method, values: get/post/put/delete
-            url:                 (str) : Url for the request
-            kwargs:             (dict) : (Optional). Parameters see bellow
-
-                Field                   Type     Optional       Description
-                ==============================================================================
-                其它非12个关键字        dict     True           Dictionary to be sent in the query string for the request.
-                data                    dict     True           Dictionary to send in the body of the request.
-                headers                 dict     True           Dictionary of HTTP Headers to send with the request.
-                timeout                 float
-
-            def request(self, method, url,
-                        params=None, data=None, headers=None, cookies=None, files=None,
-                        auth=None, timeout=None, allow_redirects=True, proxies=None,
-                        hooks=None, stream=None, verify=None, cert=None, json=None):
-                :param method: method for the new :class:`Request` object.
-                :param url: URL for the new :class:`Request` object.
-                :param params: (optional) Dictionary or bytes to be sent in the query
-                    string for the :class:`Request`.
-                :param data: (optional) Dictionary, bytes, or file-like object to send
-                    in the body of the :class:`Request`.
-                :param json: (optional) json to send in the body of the
-                    :class:`Request`.
-                :param headers: (optional) Dictionary of HTTP Headers to send with the
-                    :class:`Request`.
-                :param cookies: (optional) Dict or CookieJar object to send with the
-                    :class:`Request`.
-                :param files: (optional) Dictionary of ``'filename': file-like-objects``
-                    for multipart encoding upload.
-                :param auth: (optional) Auth tuple or callable to enable
-                    Basic/Digest/Custom HTTP Auth.
-                :param timeout: (optional) How long to wait for the server to send
-                    data before giving up, as a float, or a :ref:`(connect timeout,
-                    read timeout) <timeouts>` tuple.
-                    :type timeout: float or tuple
-                :param allow_redirects: (optional) Set to True by default.
-                    :type allow_redirects: bool
-                :param proxies: (optional) Dictionary mapping protocol or protocol and
-                    hostname to the URL of the proxy.
-                :param stream: (optional) whether to immediately download the response
-                    content. Defaults to ``False``.
-                :param verify: (optional) Either a boolean, in which case it controls whether we verify
-                    the server's TLS certificate, or a string, in which case it must be a path
-                    to a CA bundle to use. Defaults to ``True``.
-                :param cert: (optional) if String, path to ssl client cert file (.pem).
-                    If Tuple, ('cert', 'key') pair.
-                :rtype: requests.Response
-
-        Returns:
-            Http response   (Response) : A response object.
-            Usage:
-                r.ok            (bool) : Whether the request is ok. Return True/False
-                r.status_code    (int) : Http response code. Int
-                r.elapsed       (time) : Request used time. e.g. 0:00:01.662000
-                r.json()        (json) : Response content as json format
-                r.text           (str) : Response content as text string format
-
-        Raises:
-            None
-
-        Examples:
-
-        """
-        # 请注意在参数中指定Timout参数，否则可能会等很久才会异常结束。
-        kwargs["verify"] = False
-        # 下面的函数将每个字段的值都转化成了json格式。
-        kwargs = self.__convert_dict_items_to_json(kwargs)
-        method = str(method).lower()
-
-        def send_request():
-            self.__log_request(method, url, **kwargs)
-
-            if method == "get":
-                r = self.session.get(url, **kwargs)
-            elif method == "post":
-                r = self.session.post(url, **kwargs)
-            elif method == "put":
-                r = self.session.put(url, **kwargs)
-            elif method == "delete":
-                r = self.session.delete(url, **kwargs)
-            elif method == "patch":
-                r = self.session.patch(url, **kwargs)
-            elif method == "head":
-                r = self.session.head(url, **kwargs)
-            else:
-                self.logger.warning("method not implemented: " + method)
-                return None
-
-            self.__log_response(r)
-            return r
-
-        try:
-            result = send_request()
-        except Exception as err:
-            self.logger.warning("Send request failed: ", err)
-
-        return result
-
-    def get(self, url, **kwargs):
-        return self.request("get", url, kwargs)
-
-    def put(self, url, **kwargs):
-        return self.request("put", url, kwargs)
-
-    def post(self, url, **kwargs):
-        return self.request("post", url, kwargs)
-
-    def patch(self, url, **kwargs):
-        return self.request("patch", url, kwargs)
-
-    def delete(self, url, **kwargs):
-        return self.request("delete", url, kwargs)
-
-    def head(self, url, **kwargs):
-        return self.request("head", url, kwargs)
-
-    def get_headers(self):
-        """Get restful request headers"""
-        return self.session.headers
-
-    def update_headers(self, params):
-        """Update restful request headers
-
-        Args:
-        params      (dict) : Http header options.
-            More information please see
-
-
-        E.g.
-            Field             Type  Optional Description
-            ==============================================================================
-            accept-encoding   str   True List of acceptable encodings. See HTTP compression
-            content-type str True The MIME type of body of the request. E.g.application/json
-
-        Returns:
-        None
-
-        Raises:
-        None
-
-        Examples:
-        restSession.updateHeaders({'content-type': 'application/json'})
-
-        """
-
-        self.session.headers.update(params)