Vscode for python ide配置

1.文件頭添加

• 自定義代碼片段

1. 文件>首選項>用戶代碼片段
2. 搜索python
3. 添加代碼

"HEADER":{
		"prefix": "header",
		"body": [
			"# -*- encoding: utf-8 -*-",
			"",
			"# @File    : $TM_FILENAME",
			"# @Time    : $CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
			"# @Author  : H2o ",
			"# @Version : 1.0",
			"# @Contact : [e-mail]",
			"",
			"",
			""
		],
	}

• 添加文件頭

1. 新建文件
2. 輸入header
3. 選擇header

2.進入設置界面

1. 在vscode中打開一個文件
2. 點擊左下角"齒輪"圖標
3. 選中設置

3.為不同的項目配置python虛擬環境

1. 設置界面, 切換tab到工作區
2. 設置搜索框輸入:python.pythonPath
3. 將新建的虛擬環境地址添加即可, 如: D:\ENV\Testtools\Scripts\python.exe

4.自動函數生成注釋模板

1. 下載插件: autoDocstring
2. 快捷鍵: ctrl+shift+2, 或在函數定義后輸入: """

4.1.切換注釋生成模板

1. 設置界面, 搜索autoDocstring
2. 修改autoDocstring.docstringFormat欄即可

4.2.自定義模板樣式

1. 新建.mustache文件
2. 修改autoDocstring.docstringFormat欄為default
3. 修改autoDocstring.customTemplatePath為你新建的.mustache文件的地址

(詳細關鍵字配置請查看插件介紹)

個人使用google注釋模板,.mustache文件內容如下:

{{! Google Docstring Template }}
{{summaryPlaceholder}}
{{extendedSummaryPlaceholder}}
{{#parametersExist}}
Args:
{{#args}}
    {{var}} ({{typePlaceholder}}): {{descriptionPlaceholder}}
{{/args}}
{{#kwargs}}
    {{var}} ({{typePlaceholder}}, optional): {{descriptionPlaceholder}}. Defaults to {{&default}}.
{{/kwargs}}
{{/parametersExist}}

{{#exceptionsExist}}
Raises:
{{#exceptions}}
    {{type}}: {{descriptionPlaceholder}}
{{/exceptions}}
{{/exceptionsExist}}

{{#returnsExist}}
Returns:
{{#returns}}
    {{typePlaceholder}}: {{descriptionPlaceholder}}
{{/returns}}
{{/returnsExist}}

5.配置代碼格式化工具

(以black為例)

1. pip install black
2. 設置界面, 搜索python.formatting.provider, 選擇black
3. 設置界面, 搜索python.formatting.blackPath, 輸入你的black安裝路徑
   例如: C:\Program Files\Python36\Scripts\black.exe
4. (選配)配置black運行參數, 設置界面, 搜索python.formatting.blackArgs, 添加: --line-length=80
   
   (black每行允許的字符長度為88)

6.配置代碼靜態檢查工具

(以pylint為例)

1. pip install pylint (若是虛擬環境, 建議切換到虛擬環境后, 再pip安裝)
2. 設置界面, 搜索python.linting.pylintPath, 輸入你的pylint安裝的路徑
3. 設置界面, 搜索python.linting.enabled, 選中即可
4. 設置界面, 搜索python.linting.pylintEnabled, 選中即可

7.插件安裝

項目	說明	是否必需安裝
Python		是
vscode-icons	美化文件圖標	否
Better Comments	美化行注釋	否
Chinese (Simplified) Language Pack for Visual Studio Code	中文漢化包	否
autoDocstring	函數注釋模板生成	否

8.json文件內容

8.1 用戶json文件

{
    "files.autoSave": "afterDelay",
    "editor.renderWhitespace": "all",
    "editor.wordWrap": "wordWrapColumn",
    "workbench.startupEditor": "newUntitledFile",
    "workbench.iconTheme": "vscode-icons",
    "workbench.colorTheme": "Bluloco Light",
    "editor.fontFamily": "InputMono, Consolas, 'Courier New', monospace",
    "editor.fontSize": 15,
    "editor.lineHeight": 27,
    "python.formatting.provider": "black",
    "python.formatting.blackPath": "C:\\Program Files\\Python36\\Scripts\\black.exe",
    "python.formatting.blackArgs": [
        "--line-length=80"
    ],
    "editor.renderControlCharacters": false,
    "autoDocstring.customTemplatePath": "C:\\Program Files\\Microsoft VS Code\\data\\google.mustache"
}

8.2 工作區json文件

{
    "python.pythonPath": "D:\\ENV\\Testtools\\Scripts\\python.exe",
    "python.linting.pylintEnabled": true,
    "python.linting.enabled": true,
}