Visual Studio 中的 Python 项目

通常仅使用文件夹和文件定义 Python 应用程序，但如果程序变大，并且可能会涉及自动生成文件、适用于 Web 应用程序的 JavaScript 等，这种结构就会变得复杂。 Visual Studio 项目帮助管理复杂性问题。 该项目（ .pyproj 文件）标识与项目关联的所有源文件和内容文件，包含每个文件的生成信息，维护这些信息并与源代码管理系统集成，并帮助你将应用程序组织为逻辑组件。

此外，项目始终在 Visual Studio 解决方案 内进行管理，而解决方案中可包含任意数量可相互引用的项目。 例如，Python 项目可能引用实现扩展模块的 C++ 项目。 在此关系的基础上，开始调试 Python 项目时，Visual Studio 会自动生成 C++ 项目（如有需要）。 （有关综合讨论，请参阅 Visual Studio 中的解决方案和项目。）

Visual Studio 提供多种 Python 项目模板用于快速设置多个应用程序结构，包括用于根据现有文件夹树创建项目的模板和用于创建干净的空项目的模板。 若要查看索引，请参阅项目模板。

	深入了解：将源代码管理用于 Python 项目（youtube.com，8 分 55 秒）。

添加文件、分配启动文件和设置环境

开发应用程序时，通常需要将不同类型的新文件添加到项目。 通过以下两种方式可以添加此类文件：右键单击项目并选择“添加” > “现有项” ，然后浏览到要添加的文件；或选择“添加” > “新建项” ，随后将打开包含各种项模板的对话框。 如项模板引用所述，选项包括空的 Python 文件、Python 类、单元测试以及与 Web 应用程序相关的各种文件。 可使用测试项目研究这些选项以了解所用 Visual Studio 版本中可用的选项。

每个 Python 项目都有一个分配的启动文件，均以粗体显示在解决方案资源管理器中 。 开始调试（F5 或“调试” > “开始调试” ）时，或在交互 窗口中运行项目（Shift +Alt +F5 或“调试” > “在 Python 交互中执行项目” ）时，启动文件便是要运行的文件。 若要对其进行更改，请右键单击新文件并选择“设置为启动项” （或者在较旧版本的 Visual Studio 中，选择“设置为启动文件”） 。

若要更改活动的环境，请在“解决方案资源管理器” 中右键单击所需的环境，并选择“激活环境”，如下所示 。 有关详细信息，请参阅选择项目环境。

项目模板

Visual Studio 提供多种方法用于从零开始，或根据现有代码设置 Python 项目。 要使用模板，请选择“文件” > “新建” > “项目”菜单命令，或右键单击解决方案资源管理器中的解决方案，选择“添加” > “新建项目”，这两种方法都会打开下方的“新建项目”对话框 。 若要查看特定于 Python 的模板，请搜索“Python”或选择“已安装” > “Python” 节点：

下表总结了 Visual Studio 2017 及更高版本中提供的模板（并非以前的所有版本都提供了这些模板）：

备注

由于 Python 是解释型语言，因此 Visual Studio 中的 Python 项目不会生成类似其他编译型语言项目（例如 C#）的独立可执行文件。 有关详细信息，请参阅问题和解答。

根据现有文件创建项目

1. 启动 Visual Studio，然后选择“文件” > “新建” > “项目” 。

2. 在“新建项目”对话框中，搜索“Python”，选择“从现有的 Python 代码”模板，为项目提供名称和位置，然后选择“确定” 。

3. 在出现的向导中，设置现有代码的路径，设置文件类型筛选器，并指定项目需要的任何搜索路径，然后选择“下一步” 。 如果不知道搜索路径是什么，则将该字段留空。

   

4. 在下一个对话框中，选择项目的启动文件，然后选择“下一步” 。 （如果需要，选择一个环境；否则接受默认设置。）请注意，对话框仅显示根文件夹中的文件；如果所需的文件在子文件夹中，请将启动文件保留为空，稍后在解决方案资源管理器中对其进行设置（如下所述） 。

   

5. 选择要在其中保存项目文件（磁盘上的 .pyproj 文件）的位置 。 如果适用，还可以包括虚拟环境的自动检测以及针对不同 Web 框架自定义项目。 如果不确定这些选项，请保持它们设置为默认值。

   

6. 选择“完成”，Visual Studio 将创建项目并在解决方案资源管理器中打开该项目 。 若要将 .pyproj 文件移动到其他位置，请在解决方案资源管理器中选中它，并依次选择“文件” > “另存为” 。 此操作更新项目中的文件引用，但不移动任何代码文件。

7. 要设置不同的启动文件，请在解决方案资源管理器中找到该文件，右键单击，然后选择“设置为启动文件” 。

链接文件

链接文件是指放入项目，但通常位于应用程序项目文件夹外的文件。 这些文件在“解决方案资源管理器”中显示为普通文件，具有重叠的快捷方式图标 ：

链接文件通过 <Compile Include="..."> 元素在 .pyproj 文件中指定 。 如果链接文件使用目录结构之外的相对路径，则为隐式链接文件，如果使用解决方案资源管理器内的路径，则为显式链接文件 ：

<Compile Include="..\test2.py">
    <Link>MyProject\test2.py</Link>
</Compile>

在以下任何情况下，会忽略链接文件：

• 链接文件包含链接元数据，并且在 Include 特性中指定的路径存在于项目目录中
• 链接文件复制存在于项目层次结构中的文件
• 链接文件包含链接元数据，并且链接路径是项目层次结构外的相对路径
• 链接路径是根路径

使用链接文件

要将现有项添加为链接，请右键单击项目中要添加文件所在的文件夹，然后选择“添加” > “退出项” 。 在出现的对话框中，选择一个文件，然后从“添加”按钮上的下拉列表中选择“添加为链接” 。 如果没有冲突文件，此命令会在所选文件夹中创建一个链接。 但是，如果已存在具有相同名称的文件或项目中已存在该文件的链接，将不会添加链接。

如果尝试链接到项目文件夹中已存在的文件，会添加该文件作为普通文件而不是作为链接。 要将文件转换为链接，请选择“文件” > “另存为”，将文件保存到项目层次结构外的位置；Visual Studio 会自动将其转换为链接 。 同样，通过使用“文件” > “另存为”将文件保存在项目层次结构内的某个位置，可以将链接转换回文件 。

如果在解决方案资源管理器中移动链接文件，则链接会移动，但实际文件不会受到影响 。 同样，删除链接仅会删除该链接，而不会影响文件。

不能重命名链接文件。

reference

Visual Studio 项目支持将引用添加到项目和扩展，添加的引用将显示在解决方案资源管理器中的“引用”节点下 ：

扩展引用通常指示项目之间的依赖项，在设计时用于提供 IntelliSense，在编译时用于提供链接。 Python 项目以类似的方式使用引用，但由于 Python 的动态特性，引用主要用于在设计时提供改进的 IntelliSense。 此外，还可以用于部署到 Microsoft Azure 以安装其他依赖项。

扩展模块

对 .pyd 文件的引用可为生成的模块启用 IntelliSense 。 Visual Studio 会将 .pyd 文件加载到 Python 解释器并检查其类型和函数 。 它还将尝试分析函数的文档字符串以提供签名帮助。

如果磁盘上更新了扩展模块，Visual Studio 会在后台重新分析模块。 此操作对运行时行为没有任何影响，但分析完成之前，某些完成功能不可用。

你可能还需要将搜索路径添加到包含该模块的文件夹。

.NET 项目

使用 IronPython 时，可以向 .NET 程序集添加引用，启用 IntelliSense。 对于解决方案中的 .NET 项目，请右键单击 Python 项目中的“引用” 节点，选择“添加引用” ，选择“项目” 选项卡，然后浏览到所需项目。 对于已单独下载的 DLL，请改为选择“浏览” 选项卡，然后浏览到所需的 DLL。

因为只有调用 clr.AddReference('<AssemblyName>') 才可以使用 IronPython 中的引用，因此还需要将相应的 clr.AddReference 调用添加到程序集，通常位于代码的开头。 例如，在 Visual Studio 中通过“IronPython Windows 窗体应用程序”项目模板创建的代码在文件顶部包含两个调用：

import clr
clr.AddReference('System.Drawing')
clr.AddReference('System.Windows.Forms')

from System.Drawing import *
from System.Windows.Forms import *

# Other code omitted

WebPI 项目

可以向 WebPI 产品条目添加引用以部署到 Microsoft Azure 云服务，可在其中通过 WebPI 源安装其他组件。 默认情况下，显示的源特定于 Python，包括 Django、CPython和其他核心组件。 还可以选择自己的源，如下所示。 发布到 Microsoft Azure 时，安装任务将安装所有引用的产品。