1. This document describes how to set up remote debugging in VSCode for Python. 2. It involves installing Python, VSCode, and extensions on both the local and remote PCs. The Python debugger PTVSD must also be installed on both. 3. The Python script is run on the remote PC and breakpoints are set. VSCode on the local PC is then configured to attach to the remote PC using the launch.json file. Debugging can then occur across the connection.

1. Author:KevinZhang
ThisdocumentdescribesDebugging:RemoteDebuging indetail
1. Download/Install Python
2. Install MS VSCode
Downloadfromits official website
It supportswindows,Linuxandmac OS
3. Install the extension
RestartVS code isrequiredafterthe extension installationdone.
4. Configure Python extension
a. Launch MS VS Code
b. Press‘Ctrl + Shift + P’,and entered‘setting’
c. Suggested configurations

2. "editor.renderWhitespace":"boundary",
"editor.renderControlCharacters":true,
"editor.renderIndentGuides":true,
If you didnot addpythonfoldertoyour OS path environment,update
‘python.pythonPath’
"python.pythonPath":"D:/ProgramFiles(x86)/python3.5/python.exe"
- My configurationfile
Note:Installed flake8Enabled,lintingby’pipinstall xx’commandbefore youconfigured
theminconfigurationfile.
5. Local debug
a. Opena folderwhichcontainsyourPyfiles//MSVScode debuggingdependsonProject
b. Setbreakpoints
c. Debugging
Press‘F5’ andselect‘Python’

3. It prompts youto set uplaunch.jsonfirst
Locate launch.jsonfile fromthe rootof youfolder
Just ignore the prompt if #4.C : python.pythonPathis configuredproperly.
PressF5 again:
6. Remote Debugging
Environmentdescription:
Remote PC:
Run Py script
Windows 2008 R2, IP 10.10.5.16
Py file path:C:/Users/Administrator/Desktop/QA_PyScript/uitestkz.py
VSCode is not necessary, Python/PTVSD is required.
Local PC:
Attach to remote PCfordebug

4. windows10,IP: 10.10.4.30
Py file path:D:/temp/Dropbox (NT)/KevinSelf/ST/uitestkz.py
VS code/Pythonis required
a. Install PTVSDonbothLocal/Remote PC
pipinstall ptvsd
b. EditPythonscriptand importthe library
importptvsd
ptvsd.enable_attach("my_secret",address=('0.0.0.0', 3000))
ptvsd.wait_for_attach() #Enable the below line of code onlyif youwantthe application
to waituntil the debuggerhasattachedto it
Note:
Make the above change inboth scriptfiles(i.e.scriptsonboththe local andremote PC).
However, onthe clientside,ensure the above three linesare commentedoutI.e.thisis
necessarytoensure we have the same line numbersonthe serverandtheymatch.
Sample:
 Py file onRemote PC
 Py file onLocal PC
c. Editlaunch.json onLocal PCas follows:

5. {
"name":"remote",
"type":"python",
"request":"attach",
"localRoot":"${workspaceRoot}",
"remoteRoot":"C:/Users/Administrator/Desktop/QA_PyScript/",
"port":3000,
"secret":"my_secret",
"host":"10.10.5.16"
}
d. Debugging
Start Pythonscripton remote PC

6. Adda breakpointandattachlocal PC to remote PC

7. Debuggingworks,For‘Source UnkownSource isnot available.’,ithasbeen
mentionedin #302, #507