VSCode怎么自定义测试用例的悬停结果

小枫酱_4255

小枫酱_4255

2026-10-30

289人浏览

原创

悬停不显示pytest信息,需确认右下角语言模式为Python(Pylance)、已执行“Python: Configure Tests”启用pytest、设置中pytestEnabled为true且unittestEnabled为false、文件保存为.py并位于工作区根目录;原生不支持pytest命令悬停,需借助Test Explorer等扩展或自定义插件实现。

vscode怎么自定义测试用例的悬停结果

测试用例悬停不显示 pytest 信息?先确认语言服务是否接管

VSCode 默认不会给 test_*.py 文件里的函数自动注入测试元数据(比如运行状态、命令行参数、覆盖率提示),除非对应语言扩展明确支持并注册了 HoverProvider。Python 官方扩展 + Pylance 默认只返回 JSDoc-style docstring 和类型信息,pytest 相关内容需额外条件触发:

  • 确保右下角语言模式是 python,不是 Plain Text 或 Python Test(后者不存在)
  • 已执行过 Python: Configure Tests 并成功选中 pytest —— 这步会激活测试发现逻辑,部分扩展借此注册 hover 行为
  • 检查设置中 python.testing.pytestEnabled 为 true,且 python.testing.unittestEnabled 为 false(避免冲突)
  • 文件必须保存(.py 后缀)、位于工作区根目录或被 python.defaultInterpreterPath 覆盖的环境中

想在悬停里显示 pytest 命令或运行结果?得靠扩展或自定义 HoverProvider

原生 VSCode 和 Python 扩展不提供“悬停显示 pytest test_sample.py::test_add -v”这类功能。要实现,只有两条路:

  • 装支持测试 hover 的第三方扩展,比如 Test Explorer UI 配合 Python Test Explorer,它们会在测试函数上悬停时显示“Run Test”“Debug Test”按钮(本质是渲染带 command: 协议的 MarkdownString)
  • 自己写插件:在 provideHover 中匹配 def test_ 开头的函数定义行,用正则提取函数名,拼出可执行命令,返回 new vscode.MarkdownString(`\`pytest ${file}::${funcName}\``)
  • 注意:不能直接执行命令,只能展示;若想点击运行,需用 [Run](command:python.testing.runSelectedTest) 这类已注册的 command URI

为什么改了 docstring 还不显示在悬停里?Pytest 不读它

你写再多 """Run with --tb=short and check coverage""",Pylance 也不会把它当 pytest 专用提示——它只认标准 docstring 结构(Args:, Returns:),且 pytest 本身不参与 hover 渲染链。真正影响悬停内容的是:

  • 函数上方是否紧邻 """ 开头的 docstring(中间不能有空行)
  • Pylance 是否启用(检查状态栏是否有闪电图标)
  • 当前文件是否被识别为 Python(右下角语言 ID 必须是 python)
  • 没禁用 python.languageServer(设为 Pylance 而非 None)

最省事的“伪自定义”:用 JSDoc 风格注释骗过 Pylance

虽然不原生支持 pytest,但你可以把测试函数当普通函数来注释,让悬停至少显示意图:

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载
def test_add():
    """Verify `add()` handles positive and negative integers.
<pre class="brush:php;toolbar:false;">@pytest.mark.parametrize("a,b,expected", [
    (2, 3, 5),
    (-1, 1, 0),
])
"""
assert add(2, 3) == 5
assert add(-1, 1) == 0

这样悬停时能看到第一行描述和 parametrize 注释(Pylance 会原样渲染 docstring 内容)。但注意:@pytest 不是标准 JSDoc tag,别指望它被解析成交互元素——只是文本展示。

真要动态注入命令、状态或日志,必须走插件开发路径,且得处理缓存失效(比如测试文件修改后 hover 不刷新)和 languageId 匹配(python 不能写成 py)这两个最容易漏掉的点。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1495

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

3172

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

2069

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1747

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2627

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1858

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1282

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1136

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

534

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程