使用vscode打造python开发环境

左手的ㄟ右手 2023-02-15 07:54 62阅读 0赞

## **1、准备一个项目并用vscode打开** ##

第一步：创建一个总项目目录

D:\CodeProjects

第二步：创建一个python总项目目录

D:\CodeProjects\PythonProjects

第三步：创建一个测试项目目录

D:\CodeProjects\PythonProjects\opms

第四步：在指定项目中创建python虚拟环境  
win+R输入cmd后点确定，依次执行下面三条命令：（-p后面的参数，可以换成其它python解释器的路径）

D:
    cd D:\CodeProjects\PythonProjects\opms
    virtualenv .venv -p "C:\Python37\python.exe"

第五步：右击opms项目目录，使用vscode打开（一般情况下，一个vscode界面只能打开一个项目目录）

## 2.为项目运行时指定特定的python解释器 ##

#### 第一步：为新打开的项目生成setting.json配置文件 ####

按下快捷键ctrl+shift+p，输入interpreter，单击筛选出来的结果“Python: Select Interpreter"，就会跳出windows系统上已经安装的所有python解释器，我们这里随便选择一个即可，因为我们之后会自定义setting.json配置文件中的值，这一步只是为了生成setting.json这个配置文件。  
![在这里插入图片描述][20200604184735425.png]  
补充：你如果和我一样，在打开项目之前已经在项目中创建了python虚拟环境，那么在选择interpreter时，vscode也会将本项目目录下的虚拟环境中的python解释器也列出来，此时，你可以直接选择这个解释器即可。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70]

#### 第二步：修改setting.json配置文件，指定python.pythonPath的值为opms项目目录下python虚拟环境中的python解释器路径 ####

![在这里插入图片描述][20200604184815919.png]

## 3.为项目运行时指定入口文件和参数 ##

### 第一步：为新打开的项目生成launch.json配置文件 ###

点击Debug，点击Add Configuration，点击Python，然后根据你的项目，在Python File、Django、Flask中选择一个，我这里只是为了说明，选择Python File，你们请根据自己的项目类型的进行选择。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 1]  
**第二步：解释launch.json配置文件中configurations列表的作用**

**1、program**这个键，用来指定项目运行时的入口文件的，其中 f i l e 表 示 当 前 文 件 ， \{file\}表示当前文件， file表示当前文件，\{workspaceFolder\}表示项目根目录，对于django项目来说，入口文件应该是项目根目录下的manage.py文件，所以可以配置为"program": “$\{workspaceFolder\}\\manage.py”。

**2、args**这个键，用来指定项目运行时，跟在入口文件后面的参数，对于django项目来说，运行参数应该是：runserver 0.0.0.0:8080 --noreload --nothreading ，所以可以配置为：

"args":["runserver","0.0.0.0:8080","--noreload","--nothreading"] 。

**3、name**这个键，用来命名配置名称的，因为在configurations列表中可以定义多个配置，不同的配置命名要相互区分。  
type和request这两个键是必须项，在不同的配置中都要存在的，而它们的值也是固定的。“type”: “python” , “request”: “launch”。

## 4.测试一下 ##

在项目目录中，创建一个test.py文件，写入代码后，点击文件上方的绿色三角形按钮运行当前文件。  
之所以能够点击按钮就可以运行当前文件，是因为我使用了Python File这个configurations运行配置，参数"program": “$\{file\}”，表示当前文件。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 2]  
有时候vscode会报错如下：

无法加载文件 D:\\CodeProjects\\PythonProjects\\opms.venv\\Scripts\\activate.ps1，因为在此系统上禁止运行脚本。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 3]  
**解决办法：**

第一步：以管理员身份运行powershell
    第二步：执行：get-ExecutionPolicy，回复Restricted，表示状态是禁止的。
    第三步：执行：set-ExecutionPolicy RemoteSigned
    第四步：选择Y，回车。

## 5.配置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
            }
        ]

此时如果要运行django项目的话，方法如下：

*  点击左边栏目中的小乌龟，
 *  点击齿轮图标旁边的下拉框，选择Python: Django，
 *  然后点击左边绿色三角形的运行按钮即可。  
    ![在这里插入图片描述][20200604185236238.png]

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

按下快捷键Ctrl+Shift+X，进入插件管理页面  
在搜索框中搜索这两个插件并安装：Material Icon Theme 和 Son of Obsidian Theme  
然后点击左下角的齿轮图标，选择并点击File Icon Theme,在出现的展示中，选择并点击Material Icon Theme即可。  
![在这里插入图片描述][2020060418531899.png]  
此时，我们就会发现我们的python文件的图标已经变成了经典的头尾相接的两条蟒蛇了。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 4]

## 7、新建python文件时自动添加头部信息 ##

**第一步：**

点击File，点击Preferences，点击User Snippets，输入python，点击跳出来的"python.json(Python)"，在打开的python.json文件中，先清空文件原内容，然后添加：

请看：下面的内容，适合python2，在python3中，请将\#!/usr/bin/python3(或者用虚拟环境中的python解释器）和\#encoding:utf-8替换对应位置的内容。

{
        "HEADER":{
            "prefix": "header",
            "body": [
            "#!/usr/bin/python",
            "# -*- encoding: utf-8 -*-",
            "'''",
            "@File    :   $TM_FILENAME",
            "@Time    :   $CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
            "@Author  :   DesignerA ",
            "@Version :   1.0",
            "@Contact :   DesignerA@qq.com",
            "@WebSite :   www.cnblogs.com/DesignerA",
            "'''",
            "# Start typing your code from here",
            "$0"
        ],
        }   
    }

**第二步：**

在新建的python文件开头输入header，然后回车，就会自动出现上面定义的头部信息了(我已经替换对应位置的内容为python3了），如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 5]

[20200604184735425.png]: https://img-blog.csdnimg.cn/20200604184735425.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/2020060418474991.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2,size_16,color_FFFFFF,t_70
[20200604184815919.png]: https://img-blog.csdnimg.cn/20200604184815919.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200604184914812.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200604185053367.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/2020060418510638.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2,size_16,color_FFFFFF,t_70
[20200604185236238.png]: https://img-blog.csdnimg.cn/20200604185236238.png
[2020060418531899.png]: https://img-blog.csdnimg.cn/2020060418531899.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20200604185328983.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20200604185627170.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5ODUyNjc2,size_16,color_FFFFFF,t_70