用VsCode写Python,代码提示代码规范方法

时间:2024-03-31 14:31:28


如果您碰到什么其他问题的话,欢迎来 我自己的一个 讨论群`559666429`来,大家一起找答案,共同进步


在使用Python 开发的时候,一款好的编辑器简直可以提高代码效率以及质量好几倍。而Vs Code 就是一个不错的选择。你值得拥有。

而且还支持markdown,其他各种各样的语言当然,最主要的还是好看
效果图:

用VsCode写Python,代码提示代码规范方法

VScode下载地址

安装python插件

  1. 打开VScode,Ctrl+p
  2. 输入 "ext install python",搜索时间可能会比较长
  3. 选择下载量最高的那个插件点击安装(根据网络情况,安装时间不确定,我当初装了挺久,我这边已经下载好了所以显示卸载)

用VsCode写Python,代码提示代码规范方法

到这边VScode就可以编辑python代码了,编辑完代码按F5即可运行。初次运行会让你选环境,选择python即可。

默认按F5后需要再按一次F5程序才会运行,如果要按F5马上运行需要将launch.json文件的 "stopOnEntry": true,改为 "stopOnEntry": false。

推介个插件,vscode-icons可以使VScode左侧的资源管理器根据文件类型显示图标

配置flake8

安装flake8之后写代码的时候编辑器就会提示哪里出错,代码格式不规范也会提示

  1. 打开命令行
  2. 输入 "pip install flake8"
  3. 安装flake8成功后,打开VScode,文件->首选项->用户设置,在settings.json文件中输入"python.linting.flake8Enabled": true

用VsCode写Python,代码提示代码规范方法

用VsCode写Python,代码提示代码规范方法

配置yapf

安装yapf之后在VScode中按Alt+Shift+F即可自动格式化代码

  1. 打开命令行
  2. 输入 "pip install yapf"
  3. 安装yapf成功后,打开VScode,文件->首选项->用户设置,在settings.json文件中输入"python.formatting.provider": "yapf"

用VsCode写Python,代码提示代码规范方法

用VsCode写Python,代码提示代码规范方法

几个小技巧

  1. 查看函数或者类的定义
    Ctrl+鼠标左键点击函数名或者类名即可跳转到定义处,在函数名或者类名上按F12也可以实现同样功能

  2. 更改变量名
    在变量名上按F2即可实现重命名变量

  3. python断点调试
    在行号的左边点击即可设置断点,在左边的调试界面可以查看变量的变化
    用VsCode写Python,代码提示代码规范方法

  4. 隐藏菜单栏
    这个属于个人习惯,如果你也感觉菜单栏很碍眼,可以点击查看->切换菜单栏,即可隐藏菜单栏。需要菜单栏的时候按Alt键即可查看

  5. 设置快捷键
    文件->首选项->键盘快捷方式,将需要的修改的快捷键的整个大括号里面的内容复制到右边keybindings.json文件中,然后修改“key”的值为你需要的快捷键即可。我这边只修改了复制一行和删除一行的快捷键。
    用VsCode写Python,代码提示代码规范方法也也可以:

  6. python插件中默认使用pylint的一个工具,专门用来检测python代码的书写是否有错误和是否符合良好的习惯。python官网(https://www.python.org/dev/peps/pep-0008/)专门有版块介绍推荐的python代码习惯,比如类,函数等的命名规则,遵守这些规则可以使自己的代码更加上档次。

        然后pylint在面对django框架时表现的有些不足,因为django使用了大量的元编程(metaprograming)思想以及鸭子模型,以至于在程序运行时会修改不少对象的属性和行为(妹的,我也不知道元编程是什么鬼),但是这样给pylint这样的语法检测程序带来了比较大的困难。典型的就是集成了django.db.models.Model的模型层对象在编译时没有objects属性,但是运行时却有,造成我们在编写代码时pylint会报"has no objects attributes"之类的错误,虽然不影响程序运行,但是很影响心情啊。所以有人专门开发了pylint的插件pylint-django,很详细的介绍的文章在这里(https://blog.landscape.io/using-pylint-on-django-projects-with-pylint-django.html),作者好像就是插件的开发者,像热心的程序员致敬哦。使用pip install pylint-django即可安装,命令行里可以通过 pylint --load-plugins pylint_django [other option]的方法来使用,一定要注意是pylint_django,不是pylint-django。

        但是,我现在说的是在vscode里面配置使用pylint-django,方法非常简单,在vscode中选择"文件"->"首选项"->"设置"打开vscode的设置文件,然后"python.linting.pylintArgs"处添加"--load-plugins", "pylint_django"即可。如图:

    用VsCode写Python,代码提示代码规范方法

        有必须要的话重启下vscode,然后pylint就不会在报错了。

  7. 也可以下载插件 Code - Python-isort 来进行代码排序规范
  8. 为了更加直观的查看代码规范。需要知道代码使用空格还是Tab来分行的。所以可以在设置“ 
    "editor.renderWhitespace":"all"
     ”
  9. "editor.insertSpaces":false
    insertSpace设置个为False可以使用Tab代替空格。