Installing debugging symbols for Python interpreters
To provide a full debugging experience, the mixed-mode Python debugger in Visual Studio needs debug symbols for the Python interpreter being used to parse numerous internal data structures. For python27.dll, for example, the corresponding symbol file is python27.pdb; for python36.dll, the symbol file is python36.pdb. Each version of the interpreter also supplies symbol files for a variety of modules.
With Visual Studio 2017, the "Python 3" and "Anaconda 3" interpreters automatically install their respective symbols and Visual Studio find those symbols automatically. For Visual Studio 2015 and earlier, or when using other interpreters, you need to download symbols separately and then point Visual Studio to them through the Tools > Options dialog in the Debugging > Symbols tab. These steps are detailed in the following sections.
Visual Studio may prompt you when it needs symbols, typically when starting a mixed-mode debugging session. In this case, it displays a dialog with two choices:
- Open symbol settings dialog opens the Options dialog to the Debugging > Symbols tab.
Download symbols for my interpreter opens this present documentation page, in which case, select Tools > Options and navigate to the Debugging > Symbols tab to continue.
Python 3.5 and later: acquire debug symbols through the Python installer. Select Custom installation, select Next to get to Advanced Options, then select the boxes for Download debugging symbols and Download debug binaries:
The symbol files (
.pdb) are then found in the root installation folder (symbol files for individual modules are in the
DLLsfolder as well). Because of this, Visual Studio finds them automatically, and no further steps are needed.
Python 3.4.x and earlier: symbols are available as downloadable .zip files from the official distributions or Enthought Canopy. After downloading, extract files to a local folder to continue, such as a
Symbolsfolder within the Python folder.
Symbols differ between minor builds of Python, and between 32-bit and 64-bit builds, so you want to exactly match the versions. To check the interpreter being used, expand the Python Environments node under your project in Solution Explorer and note the environment name. Then switch to the Python Environments window and note the install location. Then open a command window in that location and start
python.exe, which displays the exact version and whether it's 32-bit or 64-bit.
For any other third-party Python distribution such as ActiveState Python: contact the authors of that distribution and request them to provide you with symbols. WinPython, for its part, incorporates the standard Python interpreter without changes, so use symbols from the official distribution for the corresponding version number.
Pointing Visual Studio to the symbols
If you downloaded symbols separately, follow the steps below to make Visual Studio aware of them. If you installed symbols through the Python 3.5 or later installer, Visual Studio finds automatically.
Select the Tools > Options menu and navigate to Debugging > Symbols.
Select the Add button on the toolbar (outlined below), enter the folder where you expanded the downloaded symbols (which is where
python.pdbis located, such as
c:\python34\Symbols, shown below), and select OK.
During a debugging session, Visual Studio might also prompt you for the location of a source file for the Python interpreter. If you've downloaded source files (from python.org/downloads, for example), then you of course can point to them as well.
The symbol caching features shown in the dialog are used to create a local cache of symbols obtained from an online source. These features aren't needed with the Python interpreter symbols as symbols are already present locally. In any case, refer to Specify Symbols and Source Files in the Visual Studio Debugger for details.
|3.5 and later||Install symbols through the Python installer.|
|3.4.4||32-bit - 64-bit|
|3.4.3||32-bit - 64-bit|
|3.4.2||32-bit - 64-bit|
|3.4.1||32-bit - 64-bit|
|3.4.0||32-bit - 64-bit|
|3.3.5||32-bit - 64-bit|
|3.3.4||32-bit - 64-bit|
|3.3.3||32-bit - 64-bit|
|3.3.2||32-bit - 64-bit|
|3.3.1||32-bit - 64-bit|
|3.3.0||32-bit - 64-bit|
|2.7.11||32-bit - 64-bit|
|2.7.10||32-bit - 64-bit|
|2.7.9||32-bit - 64-bit|
|2.7.8||32-bit - 64-bit|
|2.7.7||32-bit - 64-bit|
|2.7.6||32-bit - 64-bit|
|2.7.5||32-bit - 64-bit|
|2.7.4||32-bit - 64-bit|
|2.7.3||32-bit - 64-bit|
|2.7.2||32-bit - 64-bit|
|2.7.1||32-bit - 64-bit|
Enthought Canopy provides symbols for its binaries starting from version 1.2. They are automatically installed alongside with the distribution, but you still need to manually add the folder containing them to symbol path as described earlier. For a typical per-user installation of Canopy, the symbols are located in
%UserProfile%\AppData\Local\Enthought\Canopy\User\Scripts for the 64-bit version and
%UserProfile%\AppData\Local\Enthought\Canopy32\User\Scripts for the 32-bit version.
Enthought Canopy 1.1 and earlier, as well as Enthought Python Distribution (EPD), do not provide interpreter symbols, and are therefore not compatible with mixed-mode debugging.