如何在VSCode中自动生成带类型标注的函数/类模板
在VSCode中实现带可跳转类型占位符的Python函数模板生成
从零生成带占位符的函数模板
直接用VSCode自定义代码片段快速创建:
- 按
Ctrl+Shift+P(Windows/Linux)或Cmd+Shift+P(Mac),输入Configure User Snippets,选择python.json。 - 粘贴以下配置到文件中:
"Typed Python Function": { "prefix": "tfunc", "body": [ "def ${1:func_name}(${2:a}:$3, ${4:b}:$5) -> $6:", " $0" ], "description": "函数模板:带可通过Tab跳转的类型占位符" }
- 在Python文件里输入
tfunc并按Tab,就能生成模板,按Tab可以依次切换到函数名、参数、类型占位符位置,直接填写即可。
转换已有无类型函数为带占位符模板
如果已经写好无类型函数,用正则替换快速处理:
- 选中目标函数,按
Ctrl+H打开替换面板,勾选「正则表达式」选项。 - 查找规则:
def (\w+)\((.*?)\): - 替换规则:
def $1(${2/([^, ]+)/$1:$/g}) -> $: - 点击「替换」,所有参数会自动加上
:$占位符,返回值位置也会加上-> $:,之后按Ctrl+D选中第一个$,输入类型后按Ctrl+D跳转到下一个,也可以用多光标模式批量编辑。
另外,VSCode Python扩展自带的Add Type Annotations命令(Ctrl+Shift+P搜索该命令)能自动生成基于类型推断的标注,要是你更倾向于手动填写,把自动生成的标注改成$就能用Tab跳转编辑了。
内容的提问来源于stack exchange,提问作者Xudong
相关产品推荐
相关产品推荐

