使用vscode打造python開發環境

 1. 各位看客，由於本人寫的文章，有時候會修改，以便變得更好，更優秀，因此當你看到文章中先後有一些不對應的地方，那說明我正在大幅度修改。我通常會在一天內完成本次的修改。

 2. 新增一個vscode遠程開發，使用遠程服務器上的python開發環境。在第19條那裏。

 

1.安裝python解釋器，配置好path變量。

下載網址：https://www.python.org/downloads/release/python-374/

注意區分64位仍是32位的。

安裝python的時候，建議將python添加到path環境變量的複選框勾上，而且使用自定義安裝，由於能夠自定義安裝目錄，我是安裝在C:\Python37中的

 

2.安裝virtualenv

win+R輸入cmd後點肯定，而後執行：

pip install virtualenv

 

3.下載並安裝好vscode編輯器（安裝時，將複選框所有勾上）

下載地址：https://code.visualstudio.com/

4.在vscode中安裝python插件

按下快捷鍵Ctrl+Shift+X，進入插件管理頁面
在搜索框中搜索python關鍵字
點擊下載量最高的那個進行安裝，通常都是第一個。

vscode安裝了上面這個插件後，能幹什麼？

第一：這個插件不是python語言的解釋器，vscode想要運行python代碼，必須另外指定在windows上安裝的python解釋器路徑才能夠。

第二：這個插件被安裝上後，vscode就具備了調用python解釋器的功能。其實就是在setting.json和launch.json這兩個配置文件中，能夠添加python相關的配置了，好比經過python.pythonPath的值找到python解釋器的位置等等。

第三：能夠經過按下ctrl鍵，點擊函數，打開函數的所在文件和定義位置。

第四：具備代碼提示功能。

（這樣解釋是否是有點傻？）

5.準備一個項目並用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界面只能打開一個項目目錄）

6.爲項目運行時指定特定的python解釋器

第一步：爲新打開的項目生成setting.json配置文件

按下快捷鍵ctrl+shift+p，輸入interpreter，單擊篩選出來的結果「Python: Select Interpreter"，就會跳出windows系統上已經安裝的全部python解釋器，咱們這裏隨便選擇一個便可，由於咱們以後會自定義setting.json配置文件中的值，這一步只是爲了生成setting.json這個配置文件。

補充：你若是和我同樣，在打開項目以前已經在項目中建立了python虛擬環境，那麼在選擇interpreter時，vscode也會將本項目目錄下的虛擬環境中的python解釋器也列出來，此時，你能夠直接選擇這個解釋器便可。

第二步：修改setting.json配置文件，指定python.pythonPath的值爲opms項目目錄下python虛擬環境中的python解釋器路徑

7.爲項目運行時指定入口文件和參數

第一步：爲新打開的項目生成launch.json配置文件

點擊Debug，點擊Add Configuration，點擊Python，而後根據你的項目，在Python File、Django、Flask中選擇一個，我這裏只是爲了說明，選擇Python File，大家請根據本身的項目類型的進行選擇。

第二步：解釋launch.json配置文件中configurations列表的做用

program這個鍵，用來指定項目運行時的入口文件的，其中${file}表示當前文件，${workspaceFolder}表示項目根目錄，對於django項目來講，入口文件應該是項目根目錄下的manage.py文件，因此能夠配置爲"program": "${workspaceFolder}\\manage.py"。

args這個鍵，用來指定項目運行時，跟在入口文件後面的參數，對於django項目來講，運行參數應該是：runserver 0.0.0.0:8080 --noreload --nothreading  ，因此能夠配置爲：

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

name這個鍵，用來命名配置名稱的，由於在configurations列表中能夠定義多個配置，不一樣的配置命名要相互區分。

type和request這兩個鍵是必須項，在不一樣的配置中都要存在的，而它們的值也是固定的。"type": "python" , "request": "launch"。

8.測試一下

在項目目錄中，建立一個test.py文件，寫入代碼後，點擊文件上方的綠色三角形按鈕運行當前文件。

之因此可以點擊按鈕就能夠運行當前文件，是由於我使用了Python File這個configurations運行配置，參數"program": "${file}"，表示當前文件。

有時候vscode會報錯以下：

沒法加載文件 D:\CodeProjects\PythonProjects\opms\.venv\Scripts\activate.ps1，由於在此係統上禁止運行腳本。

解決辦法：

第一步：以管理員身份運行powershell
第二步：執行：get-ExecutionPolicy，回覆Restricted，表示狀態是禁止的。
第三步：執行：set-ExecutionPolicy RemoteSigned
第四步：選擇Y，回車。

9.關於python虛擬環境的解釋

python虛擬環境是一個很是好用的東西，之前我覺得只有activate激活這個虛擬環境，纔可使用這個虛擬環境中安裝的各個模塊。如今，我知道以前的認知是侷限的。

其實，你只須要使用虛擬環境中的python.exe解釋器的絕對路徑就可使用這個虛擬環境中安裝的python模塊了，根本不須要激活。不信的話，你試試：

好比我建立了一個venv虛擬環境：D:\CodeProjects\PythonProjects\opms\.venv\

而後，我運行下面的命令獲得的模塊列表和全局解釋器中的模塊列表是不同的（此時我並無激活這個虛擬環境）：

D:\CodeProjects\PythonProjects\opms\.venv\Scripts\pip   list

當使用activate激活一個虛擬環境時，咱們就從cmd或者terminal當前窗口中進入到了一個子窗口中了，在這個子窗口中，PATH這個環境變量被臨時更改了，當前這個虛擬環境中的Scripts路徑就被加入到PATH環境變量中了，那麼咱們在這個子窗口中運行的python命令、pip命令等也就經過PATH這個環境變量自動查找，而後指向了虛擬環境Scripts目錄中的解釋器了，這也就解釋了爲什麼激活了這個虛擬環境，在這個窗口中切換到任何一個目錄中，執行python或者pip命令都能使用和查看這個虛擬環境的全部模塊的緣由。

10.配置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，

而後點擊左邊綠色三角形的運行按鈕便可。

 

11.配置vscode的文件圖標和主題美化

按下快捷鍵Ctrl+Shift+X，進入插件管理頁面
在搜索框中搜索這兩個插件並安裝：Material Icon Theme 和 Son of Obsidian Theme
而後點擊左下角的齒輪圖標，選擇並點擊File Icon Theme,在出現的展現中，選擇並點擊Material Icon Theme便可。

 此時，咱們就會發現咱們的python文件的圖標已經變成了經典的頭尾相接的兩條蟒蛇了。

 12.安裝運行代碼片斷插件Code Runner（我已棄用它，緣由在下面）

Code Runner也稱爲萬能語言運行環境，它可讓你不用搭建各類語言的開發環境,直接經過此插件就能夠直接運行對應語言的代碼。咱們這裏使用這個插件，目的是爲了運行代碼片斷，方面調試。

按下快捷鍵Ctrl+Shift+X，進入插件管理頁面，在搜索框中搜索Code Runner，點擊安裝便可。

測試一下：

咱們先選中一段代碼，而後鼠標右擊，選擇Run Code，以下：

 

 

 咱們卸載掉這個插件吧。

通過測試，這個插件是使用系統PATH環境變量中配置的python解釋器去運行代碼片斷的，並不能使用咱們在settings.json文件中指定的python解釋器，以下：

 

因此卸載掉它吧，咱們uninstall這個插件後，有時候還須要點擊這個插件旁邊的Reload Required進行重載才能完全清除這個插件，以下：

 固然，咱們也找到了方法去解決這個解釋器的問題，但又何須使用這個Code Runner呢？解決方法以下：

點擊File，點擊Preferences，點擊Settings，點擊Extensions，點擊Run Code configuration，點擊Executor Map下方的Edit in settings.json，在打開的settings.json文件中，添加：

"code-runner.executorMap"，不要複製它，要本身敲擊，根據提示回車後，會自動生成剩下的內容，以下：

而後咱們須要更改其中的python鍵值，改成"python": "C:\\Python27\\python.exe"，你們參照這個，能夠自行更改成其它的python解釋器路徑，好比虛擬環境中python解釋器。

咱們再運行test.py看下python解釋器版本：

 

 我不推薦的緣由是，若是反覆的切換運行不一樣的項目，那麼就須要反覆的更改settings.json文件，比較麻煩，而咱們一開始安裝的python插件，只須要一次配置就能夠了。

 

 13.啓用自動格式化代碼工具yapf

第一步：在項目指定的python解釋器中安裝yapf模塊

cd D:\CodeProjects\PythonProjects\opms\.venv\Scripts
activate
pip install yapf
deactivate.bat

第二步：在項目中的settings.json配置文件中，添加："python.formatting.provider": "yapf"，以下：

第三步：按Alt+Shift+F便可自動格式化代碼

 測試一下：

未經代碼格式化以前的代碼以下：

 按Alt+Shift+F後，代碼以下：

14.啓用pylint進行代碼編寫時格式規範檢查

第一步：在項目指定的python解釋器中安裝pylint模塊

cd D:\CodeProjects\PythonProjects\opms\.venv\Scripts
activate
pip install pylint
deactivate.bat

第二步：啓用pylint功能，在settings.json文件中添加："python.linting.pylintEnabled": true，以下：

第三步：關於pylint檢查項的一些定製

"python.linting.pylintArgs": ["--disable=C,broad-except,unused-variable",],

 

檢查項按大類分，大約有四個：C、R、E、W，C類應該是與變量、函數名等命名有關的規範，咱們把C類檢查所有禁用，E類應該是檢查模塊、類、函數等是否存在，這個是最有用的，W類應該是與聲明的變量是否被使用、使用的異常捕捉類是否細化等檢查相關，這個能夠根據具體的狀況具體禁用。R類還不太清楚。

 

那麼如何禁用具體的檢查項呢？

首先，咱們將鼠標停留在報出異常的代碼上，以下：

 而後，就能夠看到異常是unused-variable了，咱們將這個異常檢查項在settings.json中禁用掉便可。其它的異常檢查項也是這麼查看和禁用。

 

第四步：Django項目須要安裝額外的規範檢查模塊

pip install pylint_django

第五步：在settings.json配置文件中爲django項目添加加載檢查模塊

"python.linting.pylintArgs": [
"--load-plugins",
"pylint_django",
],

 15.記錄一下vscode中的一些快捷鍵

終止程序運行：ctrl + `

側邊欄顯示和隱藏：ctrl + B

格式化代碼：Alt+Shift+F

格式化選中部分的代碼：Ctrl + K Ctrl + F

打開Git可視管理：Ctrl + Shift + G

補充：

格式化代碼的快捷鍵用起來太麻煩了，將它更改成經常使用的ctrl+alt+l（L的小寫）的方式。

按ctrl+k  ctrl+s打開快捷鍵修改的界面，搜索框中搜索shift+alt+f，快速定位到要修改的快捷鍵：

修改完成後，以下所示，記得更換搜索關鍵詞：

 

16.新建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了），以下：

 

17.vscode配置git管理代碼

第一步：先到git官網下載並安裝windows 64位版的git，git官網下載地址：https://git-scm.com/downloads，注意，安裝Git的過程當中，選擇VS Code做爲git的默認編輯器，其它都默認便可，以下圖：

第二步：爲git配置環境變量，默認狀況下，git被安裝在C:\Program Files\Git\目錄下，咱們須要將這個目錄下的bin目錄添加到Path環境變量中。以下圖

 

第三步：設置vscode與git關聯，依次打開：File -> Preferences  -> Settings  -> Extensions  -> Git  ->Path (Edit in settings.json)

在打開的settings.json文件中，配置git的可執行文件路徑，以下：

//啓用git
"git.enabled": true, 
//啓用自動刷新
"git.autorefresh": true,
//啓用自動提取
"git.autofetch": true,
//同步前進行確認
"git.confirmSync": true,
//配置git可執行文件路徑
"git.path":"C:\\Program Files\\Git\bin\\git.exe",
"terminal.integrated.shell.windows": "C:\\Program Files\\Git\\bin\\bash.exe",

第四步：配置git用戶名與郵箱（git暫存時須要用到它們）

git config --global user.name "xxxxxxx"
git config --global user.email "xxxxxxx@qq.com"

第五步：在github上新建一個倉庫，而後使用命令git clone "倉庫地址" ，將倉庫克隆到本地目錄中。 若是是私有倉庫，這步執行後，會要求你輸入github帳戶密碼。

第六步：讓git記住密碼，這樣不用每次都填寫

git config --global credential.helper store

第七步：找到git下來的倉庫目錄，而後右擊目錄，選擇使用vscode打開

第八步：你編輯這個項目中的文件後，你要先點擊小勾暫存全部更改，輸入你的提交消息（隨便輸點你本次提交的說明信息）

說明：這裏的commit並非提交到github，而是提交到本地的暫存區，並且必需要先提交到本地的暫存區，以後纔可使用push將暫存區中的內容推送到github倉庫中。

 第九步：將更改提交到github倉庫中，從圖中能夠看到第八步執行完後，本次的更改已經寫入到暫存區了。點擊Push後，能夠到github倉庫中看下倉庫中的內容是否已經更改

 

18.vscode添加瀏覽器預覽html代碼功能

 第一步：按下快捷鍵Ctrl+Shift+X，進入插件管理頁面，搜索並安裝插件open in browser

 第二步：修改vscode預覽html文件默認使用的瀏覽器，不修改的話，默認使用IE。固然，這一步能夠不執行，由於右擊html文件的時候能夠選擇Open In Other Browers

               依次打開：File -> Preferences  -> Settings  -> Extensions  -> plugin open-in-brower  ->Auto Complete: Extra Paths (Edit in settings.json)而後在打開的settings.json配置文件中添加：

//若是是火狐，就設置firefox
"open-in-browser.default": "chrome",

 19.vscode利用遠程服務器環境調試項目

這個仍是很好用的，能夠不須要在windows服務器上安裝python執行環境了。並且，python中的一些與系統操做相關的模塊，windows上安裝起來也很是麻煩。

第一步：按下快捷鍵Ctrl+Shift+X，進入插件管理頁面，搜索並安裝插件Remote Development

第二步：windows上安裝openssh客戶端，這裏提供一個使用powershell安裝的方法

首先，以管理員身份打開powershell

而後，輸入命令在線查詢可獲取的安裝包 Get-WindowsCapability -Online | ? Name -like 'OpenSSH*'

最後，若是狀態顯示NotPresent的話，可使用命令進行安裝，命令爲Add-WindowsCapability -Online -Name OpenSSH.Client~~~~0.0.1.0

提示：隨着 Windows 10 2018 年 4 月更新的發佈，OpenSSH 客戶端已正式推出並在 Windows 10 中默認安裝。

補充：有些人的電腦系統多是windows7的，這裏再提供一個在windows7上安裝openssh客戶端的方法

首先，下載cygwin，下載網址爲: https://www.cygwin.com/

 

而後，安裝它，安裝過程當中，當出現選擇要安裝的包時，咱們將View切換爲Full，並在搜索框中搜索openssh，在出現的搜索結果中，咱們將openssh中的skip改成8.1p1-1，而後再點擊下一步完成安裝。以下圖，下圖中由於我已經安裝過了，因此openssh這裏沒有顯示skip：

 

 再而後，咱們須要將Cygwin安裝目錄下的bin目錄的絕對路徑添加到Path環境變量中。Cygwin默認的安裝路徑爲：C:\cygwin64，因此咱們須要將C:\cygwin64\bin添加到Path環境變量中，以下圖所示：

 

 最後，驗證一下。咱們打開cmd，輸入ssh回車看看是否有輸出，有輸出信息就表示openssh客戶端安裝成功了：

備註：這個Cygwin軟件被安裝上後，不但可使用ssh客戶端了，另外不少linux上的命令咱們也均可以在cmd中使用了，好比ls和pwd等。緣由就是這些命令工具都被提供在C:\cygwin64\bin目錄下。你能夠到這個目錄下看看。挺好的軟件，給個大大的贊。

第三步：準備一臺centos虛擬機或者ubuntu虛擬機，確保虛擬機上的ssh server服務已經開啓，並容許遠程鏈接。好比我準備的是centos7虛擬機，IP地址爲192.168.247.133

第四步：按下快捷鍵ctrl+shift+p  搜索Remote-SSH:Settings，在打開的頁面中，點擊Edit in settings.json，在其中添加"remote.SSH.showLoginTerminal": true,以下圖:

 第五步：點擊左下角的綠色圖標，選擇Remote-SSH：Connect to Host  而後點擊 Configure SSH Hosts  而後選擇點第一個config，默認應該是一個空白的文件，在其中添加以下的配置：

Host Centos7.5_python3
    HostName 192.168.247.133
    Port 22
    User root

備註：其中Host後面的名稱，能夠隨便命名，HostName後面的IP地址是準備的虛擬機IP地址，Port後跟的是ssh server服務監聽的端口號，默認是22，User後跟的是遠程鏈接的用戶名，我這裏使用超級用戶鏈接。

這裏補充一點：

每次鏈接遠程服務器，打開項目都要輸入一次密碼，是否很煩？（固然我並無以爲煩）若是有人以爲煩的話，能夠先在本地windows系統和遠程服務器之間作好ssh免密登錄，而後在上面這個config文件中，在User配置下一行（縮進和User要一致），添加IdentityFile C:\Users\...\.ssh\id_rsa便可，其中IdentityFile參數後面跟的是windows上的rsa私鑰文件。

第六步：點擊vscode左邊欄的遠程鏈接圖標，以下：

第七步：點擊配置後的遠程虛擬機名稱旁邊的那個按鈕，輸入密碼進行登錄到服務器上，以下：

備註，若是vscode初次鏈接這臺虛擬機的話，那麼須要等待幾分鐘，由於vscode要作一些初始化工做。

第八步：連上虛擬機後，能夠經過下圖中標識的順序打開遠程服務器上的項目，固然每次打開項目都是須要再次輸入密碼的。這也是爲了安全考慮。

在打開的項目中新建文件，刪除文件，修改文件等操做，不須要再次輸入密碼。

第九步：運行項目或測試腳本的方法

感受這個功能，在必定程度上，均可以代替secure crt或xshell遠程鏈接工具和ftp上傳下載客戶端了。很強大。

補充：

沒有語法檢查，代碼自動提示和補全功能，開發真的是一個很難受的事情，那麼怎麼在遠程服務器上使用這些功能呢？下面就是補全這一點的方法：

首先：按下快捷鍵Ctrl+Shift+X，進入插件管理頁面，搜索python，而後，點擊Install in SSH:Centos7.5_python3，以下圖：

而後：在打開的項目中，生成launch.json和settings.json這兩個配置文件，方法在最上面，和配置windows本地開發環境同樣，咱們在settings.json中配置一個遠程服務器上的python解釋器，以下圖：

最後：運行python文件的方法

第十步：從新打開遠程服務器上項目的方法

點擊File，點擊Close Folder，這個操做，會從新鏈接服務器。

也沒找到其它的方法，就這麼作吧。