Posts vscode python环境配置
Post
Cancel

vscode python环境配置

插件安装与配置

快捷键Ctrl+Shift+X打开扩展安装界面,安装插件

  • Python

    安装完插件后,打开python文件会自动提示选择Python解析器。也可以通过Ctrl+Shift+P打开命令面板输入Select Interpreter来选择需要的解析器。

    配置header模板

    • 文件-首选项-用户代码-python

      之后选择python后会生成python.json,将原来内容替换为一下内容:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    
    {
        "HEADER":{
            "prefix": "header",
            "body": [
            "#!/usr/bin/env python",
            "# -*- encoding: utf-8 -*-",
            "'''",
            "@File    :   $TM_FILENAME",
            "@Time    :   $CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
            "@Author  :   Rao Guangxiang ",
            "@Version :   1.0",
            "@Contact :   [email protected]",
            "@License :   (C)Copyright 2017-2018, Liugroup-NLPR-CASIA",
            "@Desc    :   None",
              
            "'''",
            "",
            "# here put the import lib",
            "$0"
        ],
        }
          
    }
    

    在.PY文件上面输入header回车就会自动生成文件头。一般输入hea就会自动联想出来。

  • Pylance

    强烈建议使用Pylance替代默认的Python语言服务器,它支持一些很棒的功能,比如:

    1. Docstrings
    2. 自动导入
    3. 类型检查
    4. Code Lens
    5. IntelliCode 兼容性

    推荐配置

    1. 可以打开保存时和键入一行后立即进行代码格式化,设置选项为
    1
    2
    3
    4
    
    {
        "editor.formatOnSave": true,
        "editor.formatOnType": true
    }
    
    1. 设置静态代码linter为flake8

      Flake8是由Python官方发布的一款辅助检测Python代码是否规范的工具,它包含PEP8编码风格检查,代码静态检查则是依托PyFlakes,相对于Pylint,其检查规则灵活,扩展性更强一些。

      同时最好关闭Pylint,json设置如下:

      1
      2
      3
      4
      
      {
          "python.linting.flake8Enabled": true,
          "python.linting.pylintEnabled": false,
      }
      
    2. 添加垂直参考线

      Python的代码风格要求代码一行不超过79字符,所以我们可以给代码编辑器设置一条垂直参考线,直观判断代码是否太长,并且可以自定义参考线的颜色:

      1
      2
      3
      4
      5
      6
      7
      8
      
      { 
          "editor.rulers": [
              80,
          ],
          "workbench.colorCustomizations": {
              "editorRuler.foreground": "#ff4081"
          }
      }
      

    常用操作

    1. 自动导入

    2. 代码重构

      光标放到在函数名、参数名上按F2重构变量名。

    3. 提取变量或方法

    4. 触发参数提示

      在调用函数的时候,vscode会自动弹出参数提示,可以通过ESC关闭,关闭后可以通过快捷键Ctrl+Shift+Space唤出。 但是这个快捷键可能会被输入法占用,可以修改绑定快捷键,通过快捷键Ctrl+K Ctrl+S打开快捷键设置窗口,搜索editor.action.triggerParameterHints,修改快捷键即可。

    5. 终端运行代码

      按F5用debug模式运行,按ctrl+F5非debug模式运行。

      debug中python的launch.json配置:”console”: “internalConsole”

      用#%%也可调试代码

    6. 快捷键

      1
      2
      
      折叠所有代码:ctrl + k, ctrl + 0
      展开所有代码:ctrl + k, ctrl + j
      
    7. 常见问题

      在VS Code中编写python文件时,import自定义module报错 “could not be resolved”

      1
      2
      3
      4
      
      "python.analysis.extraPaths": [
          "./src",        // 自定义模块的相对路径,可多个,可绝对路径  
          "./modules"
      ]
      
This post is licensed under CC BY 4.0 by the author.