使用vscode打造python开发环境

最新推荐文章于 2024-08-23 10:40:15 发布

dingzhang2585

最新推荐文章于 2024-08-23 10:40:15 发布

阅读量303

点赞数

文章标签： python 开发工具 json

原文链接：http://www.cnblogs.com/DesignerA/p/11604200.html

版权

1.安装python解释器，配置好path变量。

2.下载并安装好vscode编辑器（安装时，将复选框全部勾上）

3.在vscode中安装python插件

按下快捷键Ctrl+Shift+X，进入插件管理页面
在搜索框中搜索python关键字
点击第一个左上角出现⭐标识的安装

4.创建一个总项目目录

D:\VScodeProjects

5.创建一个python总项目目录

D:\VScodeProjects\PythonProjects

6.创建一个测试项目目录

D:\VScodeProjects\PythonProjects\test

7.右击test项目目录，使用vscode打开（一般情况下，一个vscode界面只能打开一个项目目录）

8.添加python解释器环境

按下快捷键ctrl + shift + p
在搜索框中搜索>python select interpreter ，双击搜出的内容后，选择一个已安装的python解释器版本。

9.点击debug按钮（左边栏目中的小乌龟），然后点击齿轮状的图标，在出现的选项中，点击python解析器，然后点击Python File

此时，会在打开的项目目录下，生成一个.vscode目录和两个json文件，如下：

说明：

settings.json文件用于指定程序使用的python解释器，代码格式化工具等。

launch.json文件用于配置Python解释器的运行参数

10.到这里，只用来学习的话，差不多已经够用了。

在项目目录中，创建一个test.py文件，写入代码后，点击文件上方的绿色三角形按钮即可运行当前文件。

之所以能够点击按钮就可以运行当前文件，是因为在launch.json文件中，默认的解释器运行参数就是"program": "${file}"，表示当前文件。

领悟：

python虚拟环境是一个非常好用的东西，以前我以为只有activate激活这个虚拟环境，才可以使用这个虚拟环境中安装的各个模块。现在，我知道之前的认知是局限的。

其实，你只需要使用虚拟环境中的python.exe解释器的绝对路径就可以使用这个虚拟环境中安装的python模块了，根本不需要激活。不信的话，你试试：

比如我创建了一个venv虚拟环境：C:\Users\test\PycharmProjects\DevOps\venv\

然后，我运行下面的命令得到的模块列表和全局解释器中的模块列表是不一样的：

C:\Users\test\PycharmProjects\DevOps\venv\Scripts\pip list

进一步的领悟：

当使用activate激活一个虚拟环境时，我们就从cmd或者terminal当前窗口中进入到了一个子窗口中了，在这个子窗口中，PATH这个环境变量被临时更改了，当前这个虚拟环境中的Scripts路径就被加入到PATH环境变量中了，那么我们在这个子窗口中运行的python命令、pip命令等也就通过PATH这个环境变量自动查找，然后指向了虚拟环境Scripts目录中的解释器了，这也就解释了为何激活了这个虚拟环境，在这个窗口中切换到任何一个目录中，执行python或者pip命令都能使用和查看这个虚拟环境的所有模块的原因。

11.配置vscode使用python虚拟环境

修改.vscode目录下的settings.json文件：
将python.pythonPath这个键的值更改为虚拟环境中的python解释器(使用绝对路径)

一般情况下，我们都喜欢在每一个python项目的根目录下创建一个python虚拟环境，所以，我们可以设置为：
{
"python.pythonPath": "${workspaceFolder}\\venv\\Scripts\\python.exe"
}
其中venv就是我们创建这个虚拟环境时命名的名称。

12.配置django项目的运行参数

一般我们运行django项目的命令是： python manage.py runserver 0.0.0.0:8080

这个命令分为两部分，第一部分是python解释器，我们在settings.json设置，剩下的参数manage.py runserver 0.0.0.0:8080我们需要在launch.json中设置。

我粘贴出我在launch.json文件中设置的内容：

    "configurations": [
        {
            "name": "Python: Current File",
            "type": "python",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal"
        },
        {
            "name":"Python: Django",
            "type":"python",
            "request":"launch",
            "program":"${workspaceFolder}\\manage.py",
            "console":"integratedTerminal",
            "args":[
                "runserver",
                "0.0.0.0:8080",
                "--noreload",
                "--nothreading"
            ],
            "django":true
        }
    ]

此时如果要运行我们使用vscode打开的django项目的话，方法如下：

点击debug按钮（左边栏目中的小乌龟），

点击齿轮图标旁边的下拉框，选择Python: Django，

然后点击左边绿色三角形的运行按钮即可。

13.配置vscode的文件图标和主题美化

按下快捷键Ctrl+Shift+X，进入插件管理页面
在搜索框中搜索这两个插件并安装：Material Icon Theme 和 Son of Obsidian Theme
然后点击左下角的齿轮图标，选择并点击File Icon Theme,在出现的展示中，选择并点击Material Icon Theme即可。

此时，我们就会发现我们的python文件的图标已经变成了经典的头尾相接的两条蟒蛇了。

14.安装语法检测和代码格式化工具

首先确定当前的python项目使用的是哪一个python解释器，确定好后，就需要在这个解释器中安装相应的模块了。
　　语法检测模块是：pylint
　　代码格式化模块是：yapf
　　对Django项目的代码进行语法检查的话，还需要安装一个专门的扩展模块：pylint_django
打开cmd，如果是虚拟环境的话，先激活它，然后执行下面的命令(一般执行前两个即可，django项目的话，还需要执行第三个)

　　pip install -i http://pypi.douban.com/simple --trusted-host pypi.douban.com pylint
　　pip install -i http://pypi.douban.com/simple --trusted-host pypi.douban.com yapf
　　pip install -i http://pypi.douban.com/simple --trusted-host pypi.douban.com pylint_django

最后，还需要在vscode配置一下，修改.vscode目录下的settings.json文件，我粘贴出我在settings.json文件中设置的内容：

{
    "python.pythonPath": "${workspaceFolder}\\venv\\Scripts\\python.exe",
    //默认对Python文件进行静态检查
    "python.linting.enabled": true,
    //默认在Python文件保存时进行静态检查
    "python.linting.lintOnSave": true,
    //默认使用pylint对Python文件进行静态检查
    "python.linting.pylintEnabled": true,
    //应用所有pylint检查规则
    "python.linting.pylintUseMinimalCheckers": false,
    //使用yapf进行代码格式化
    "python.formatting.provider": "yapf",
}

如果是django项目的话，settings.json文件中设置的内容如下：

{
    "python.pythonPath": "${workspaceFolder}\\venv\\Scripts\\python.exe",
    //默认对Python文件进行静态检查
    "python.linting.enabled": true,
    //默认在Python文件保存时进行静态检查
    "python.linting.lintOnSave": true,
    //默认使用pylint对Python文件进行静态检查
    "python.linting.pylintEnabled": true,
    //加载django代码检查的扩展插件
    "python.linting.pylintArgs": [
        "--load-plugins",
        "pylint_django",
    ],
    //应用所有pylint检查规则
    "python.linting.pylintUseMinimalCheckers": false,
    //使用yapf进行代码格式化
    "python.formatting.provider": "yapf",
}