VS Code无法实现“转到定义“?

导读:VS Code一度个人日常工作中必不可少的IDE之一,在前文中也提到,它和Jupyterlab+Pycharm构成了个人工作日常IDE​组合。然而,近日在新电脑中搭建Python环境中,发现VS Code的一个重要功能——"转到定义"无法使用,这俨然使VS Code的威力大打折扣,毕竟个人主要是使用其来查看第三方库源码,通过该功能可以方便的查找引用和定义。本文针对此问题进行完整的​问题复现和解决。
VS Code无法实现“转到定义“?_第1张图片

01 问题描述

新环境下新安装VS Code,已安装python插件,在Python代码文件中右键点击类或函数名,无转到代码定义选项(正常情况下,右键菜单中有该选项,可通过快捷键F12或ctrl+鼠标左键转到其定义源文件位置)。

VS Code无法实现“转到定义“?_第2张图片
VS Code无法实现“转到定义“?_第3张图片

无法跳转到定义,那么要VS Code还有何用?

为此,自然是在百度上搜索了一番,发现该问题已有很多人踩坑:

VS Code无法实现“转到定义“?_第4张图片
VS Code无法实现“转到定义“?_第5张图片
VS Code无法实现“转到定义“?_第6张图片
发现遇到该问题的不止我一人,我就放心了……

然而,逐一试验了上述方法,要么是无法完成指定流程,要么是无法解决问题。但从中,仍能细心的发现大家把解决这一问题的思路聚焦于Jedi上​。那么Jedi​是啥呢?

02 详解python.languageServer

经过一番查阅资料,了解到这样一组介绍:

Jedi 是一个可以在 IDEs 或者编辑器中使用的 Python
代码自动补齐和静态分析工具。它的历史重点是自动完成,但现在也进行静态分析。 Jedi 好用并且快速, 可以搜索相关的名称并列出 Python
文件中的所有名称并推断它们。 Jedi 理解 docstrings,你也可以在你的 REPL 中使用 Jedi 自动补齐完成。

虽然这段话一看就是机器翻译的英语介绍,但仍能从中get到Jedi的主体功能​:代码自动补全+名称关联和推断​。具体到VS Code中,​Jedi是如果产生作用的呢?这就不得不从VS Code安装Python插件后的一组设置说起​。正常情况下,VS Code中完成Python插件安装后,会自动在settings.json中增加这样一条设置​:

"python.languageServer": "Jedi"

表示python的语言服务器选用Jedi​。那么python的语言服务器又是指代的什么呢?除了Jedi还有哪些可选呢?经过了解,除了Jedi之外,该设置还有Microsoft、None以及Pylance等选项​。

所以打开settings.json设置文件,打开方法为在VS Code中键入ctrl+shift+P全局快捷键,打开命令搜索窗,输入settings.json​即可打开首选项。
VS Code无法实现“转到定义“?_第7张图片

打开发现该设置文件中并无此项(推断可能是设置为None),所以直接导致无法实现"转到定义"​功能​。于是,在json文件中手动加入上述配置代码​:

"python.languageServer": "Jedi"

保存后,VS Code提示reload,而后​再重新回到python源文件中,那个熟悉的带有F12功能的右键菜单回来​了。

VS Code无法实现“转到定义“?_第8张图片

经过尝试,发现将python语言服务器分别设置为Microsoft和None时,均存在该问题,即没有转到定义选项,而设置Jedi时则​功能正常。

03 更好的选择——Pylance

就在我反复测试之余,不仅解决了问题还能举一反三,这时VS Code​居然给我这样的提示:

VS Code无法实现“转到定义“?_第9张图片

即建议尝试一个基于Microsoft的速度更快、功能更为丰富的python语言服务器​——Pylance。ok,​那就Try it now。很快完成了插件安装,并再次reload,奇迹出现:不仅支持F12功能,还讲源码中的包名和类名的关键字进行颜色区分显示,真的是实力与颜值俱在​!
VS Code无法实现“转到定义“?_第10张图片

当然,此时已自动将settings.json中python语言服务器设置为Pylance:

"python.languageServer": "Pylance"

详细查看该插件,看到介绍中介绍了其主要特性,而后,在里面尝试敲了几句代码,发现在Pylance插件的作用下,VS Code竟变得如丝般顺滑​!微软诚不可欺我,果真是一款良心插件。

搜索了这款插件的风评,居然一致认为是微软Python团队的良心插件,发布于2020年6月,只是自己未曾了解而已。赞!

04 小结

  • VS Code中转到定义功能,核心是受settings.json中的python.languageServer参数控制,该参数合法取值有Jedi、Microsoft和None,安装Pylance插件后还支持Pylance​。当设置为Microsoft和None时,无法实现转到定义,而设置Jedi和Pylance时可以​。

  • VS Code中搭建Python环境,建议安装两个插件:即Python+Pylance,其中前者是VS Code支持Python编译的前提,后者是基于Python的扩展,支持自动补全、参数提示、转到定义等多项功能改进。

你可能感兴趣的:(python,vscode)