VSCode 配置python开发环境

时间 2019-11-10

原文原文链接

vscode来写python，配置灵活，界面美观，是个很是好的选择。我这里是在ubuntu系统下配置vscode的python3开发环境，固然也能够参照本文在其它操做系统下配置vscode的python开发环境。python

1 安装插件
2 配置
2.1 创建Python文件夹
2.2 配置launch.json 文件
2.3 配置tasks.json 文件
2.4 用户设置
1 安装插件
python

这个是vscode提供的python 官方插件，提供了python代码的调试，自动补全，代码格式化等功能
vscode-icons

这个也是vscode官方提供的插件，做用是给vscode编辑的文件增长图标。
Path Intellisense

这个插件的做用是当代码中读入文件名或者文件路径时，提供文件名或者文件路径的自动补全
topper

这个插件的做用是在.pyw文件的开头添加一些说明header
Guides

这个插件的做用是增长.py 中的指示线，用这个插件能让代码的层次结构更加清晰。
Bracket Pair Colorizer

这个插件的做用是给代码中的括号增长颜色，同一对括号是相同的颜色，尤为是在括号中还包着括号的时候，看起来更加的清晰。
2 配置
能够在这里下载个人配置文件，直接放在本身的python工做空间中。git

2.1 创建Python文件夹
vscode 是基于文件夹的编辑器，咱们能够首先创建一个文件夹叫作PYTHON，做为咱们的Python编程工做空间，只要一次配置好了这个工做空间，之后这个工做空间的配置就会对它之下的全部的.py 文件都起做用。github

打开vscode，点击左上角文件 —> 打开文件夹，而后打开刚刚创建的PYTHON 文件夹。
而后咱们点击PYTHON 文件夹右边的添加文件按钮：
web

添加一个.py 文件，名字叫作hellovscode.py . shell

2.2 配置launch.json 文件
点击菜单栏调试 —> 打开配置，就会弹出一个选择框，咱们在这里要选择Python，而后就打开了launch.json 文件： django

咱们看到的launch.json 文件中的内容如上图所示。同时咱们还发现，在python工做区PYTHON下面还多了一个文件夹.vscode, 并且launch.json 就在这个文件夹中。
对launch.json 文件的配置以下：编程

在"configurations": [] z中，对于第一个{ }内的内容修改以下：json

{
"version": "0.2.0",
"configurations": [
{
"name": "Python3",
"type": "python",
"request": "launch",
"stopOnEntry": false,
"pythonPath": "/usr/bin/python3", //python3的安装路径
"program": "${file}",
"cwd": "${workspaceFolder}",
"env": {},
"envFile": "${workspaceFolder}/.env",
"debugOptions": [
"RedirectOutput"
]
}
]
}

后面几个{ }中的内容修改以下：ubuntu

{
"name": "Python: Terminal (integrated)",
"type": "python",
"request": "launch",
"stopOnEntry": false,
"pythonPath": "/usr/bin/python3",
"program": "${file}",
"cwd": "",
"console": "integratedTerminal",
"env": {},
"envFile": "${workspaceFolder}/.env",
"debugOptions": []
},
{
"name": "Python: Terminal (external)",
"type": "python",
"request": "launch",
"stopOnEntry": false,
"pythonPath": "/usr/bin/python3",
"program": "${file}",
"cwd": "",
"console": "externalTerminal",
"env": {},
"envFile": "${workspaceFolder}/.env",
"debugOptions": []
},
{
"name": "Python: Django",
"type": "python",
"request": "launch",
"stopOnEntry": true,
"pythonPath": "/usr/bin/python3",
"program": "${workspaceFolder}/manage.py",
"cwd": "${workspaceFolder}",
"args": [
"runserver",
"--noreload",
"--nothreading"
],
"env": {},
"envFile": "${workspaceFolder}/.env",
"debugOptions": [
"RedirectOutput",
"Django"
]
},

其它地方都不用修改。编辑器

2.3 配置tasks.json 文件
点击菜单栏任务 —> 配置任务，就会弹出一个选择框，咱们在这里要选择使用模板建立tasks.json文件，而后又弹出一个选择框，这里选择Others，就打开了tasks.json 文件：

对tasks.json 文件的配置以下：

{
"version": "2.0.0",
"tasks": [
{
"label": "python3",
"type": "shell",
"command": "/usr/bin/python3",
"args": ["${file}"]
}
]
}

{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "python3",
            "type": "shell",
            "command": "/usr/bin/python3",
            "args": ["${file}"]
        }
    ]
}

2.4 用户设置
点击菜单栏文件 —> 首选项—> 设置，而后打开用户设置：

用户设置以下：

{
"git.ignoreLegacyWarning": true,
"workbench.iconTheme": "vscode-icons", //启用vscode图标
"python.pythonPath": "/usr/bin/python3", // python3路径
"editor.lineHeight": 26, // 编辑器中的行高
"editor.fontSize": 18, // 编辑器中的字体
"editor.wordWrap": "on",
"editor.formatOnSave": true, //编辑器自动保存
"python.linting.flake8Enabled": true, //启用flake8，首先须要pip3 install falke8
"python.formatting.provider": "yapf", ///启用yapf，首先须要pip3 install yapf
"editor.renderIndentGuides": false,
"path-intellisense.autoSlashAfterDirectory": true,
"path-intellisense.extensionOnImport": true,
"workbench.colorTheme": "Monokai", // 配色方案
"python.linting.pylintArgs": [
"--load-plugins",
"pylint_django",
"--disable-msg=C0111"
],// 忽略的警告信息
// 下面是topper的插入header配置
"topper.customTemplateParameters": [
{
"personalProfile": {
"author": "你的名字",
"website": "bulbasaur.github.bitbucket.yababbdadado.com",
"copyright": "None \n None",
"license": "None",
"email": "你的邮箱"
}
},
{
"officeProfile": {
"author": "John Doe",
"department": "Product Development",
"email": "john.doe@doejohn.com"
}
}
],
"topper.headerTemplates": [
{
"defaultCStyled": {
"headerBegin": "/**",
"headerPrefix": "*",
"headerEnd": "*/",
"template": [
"${headerBegin}",
"${headerPrefix} ${fileName}",
"${headerPrefix} @author ${author}",
"${headerPrefix} @description ${description}",
"${headerPrefix} @created ${createdDate}",
"${headerPrefix} @copyright ${copyright}",
"${headerPrefix} @last-modified ${lastModifiedDate}",
"${headerEnd}"
]
}
},
{
"python": {
"headerBegin": "# -*- coding: utf-8 -*-",
"headerPrefix": "#",
"headerEnd": "#",
"template": [
"${headerBegin}",
"${headerPrefix} ${fileName}",
"${headerPrefix} @author ${author}",
"${headerPrefix} @description ${description}",
"${headerPrefix} @created ${createdDate}",
"${headerPrefix} @last-modified ${lastModifiedDate}",
"${headerEnd}"
]
}
}
],
"editor.fontFamily": "monospace",
"terminal.integrated.fontFamily": "monospace",
"editor.fontWeight": "500",

{
    "git.ignoreLegacyWarning": true,
    "workbench.iconTheme": "vscode-icons", //启用vscode图标
    "python.pythonPath": "/usr/bin/python3", // python3路径
    "editor.lineHeight": 26, // 编辑器中的行高
    "editor.fontSize": 18, // 编辑器中的字体
    "editor.wordWrap": "on",
    "editor.formatOnSave": true, //编辑器自动保存
    "python.linting.flake8Enabled": true, //启用flake8，首先须要pip3 install falke8
    "python.formatting.provider": "yapf", ///启用yapf，首先须要pip3 install yapf
    "editor.renderIndentGuides": false,
    "path-intellisense.autoSlashAfterDirectory": true,
    "path-intellisense.extensionOnImport": true,
    "workbench.colorTheme": "Monokai", // 配色方案
    "python.linting.pylintArgs": [
        "--load-plugins",
        "pylint_django",
        "--disable-msg=C0111"
    ],// 忽略的警告信息
    // 下面是topper的插入header配置
    "topper.customTemplateParameters": [
        {
            "personalProfile": {
                "author": "你的名字",
                "website": "bulbasaur.github.bitbucket.yababbdadado.com",
                "copyright": "None \n None",
                "license": "None",
                "email": "你的邮箱"
            }
        },
        {
            "officeProfile": {
                "author": "John Doe",
                "department": "Product Development",
                "email": "john.doe@doejohn.com"
            }
        }
    ],
    "topper.headerTemplates": [
        {
            "defaultCStyled": {
                "headerBegin": "/**",
                "headerPrefix": "*",
                "headerEnd": "*/",
                "template": [
                    "${headerBegin}",
                    "${headerPrefix} ${fileName}",
                    "${headerPrefix} @author ${author}",
                    "${headerPrefix} @description ${description}",
                    "${headerPrefix} @created ${createdDate}",
                    "${headerPrefix} @copyright ${copyright}",
                    "${headerPrefix} @last-modified ${lastModifiedDate}",
                    "${headerEnd}"
                ]
            }
        },
        {
            "python": {
                "headerBegin": "# -*- coding: utf-8 -*-",
                "headerPrefix": "#",
                "headerEnd": "#",
                "template": [
                    "${headerBegin}",
                    "${headerPrefix} ${fileName}",
                    "${headerPrefix} @author ${author}",
                    "${headerPrefix} @description ${description}",
                    "${headerPrefix} @created ${createdDate}",
                    "${headerPrefix} @last-modified ${lastModifiedDate}",
                    "${headerEnd}"
                ]
            }
        }
    ],
    "editor.fontFamily": "monospace",
    "terminal.integrated.fontFamily": "monospace",
    "editor.fontWeight": "500",
}

配置完毕，能够在vscode中愉快的写python了。