Using PyCharm with Pyramid

This tutorial is a very brief overview of how to use PyCharm with Pyramid. PyCharm 是针对Python程序员的集成开发环境（IDE）。它具有许多特性，包括代码完成、项目管理、版本控制系统（Git、Subversion等）、调试器等。

参见

另见保罗·埃弗里特的视频， Python 3 Web Development with Pyramid and PyCharm （大约1小时）。

本教程是一个不断发展的文档。Pycharm和Pyramid都在积极开发中，对其中一个的更改可能需要对此文档进行更改。此外，本文档中可能存在错误或遗漏，最欢迎通过请求进行更正和改进。

备注

本指南是为Pycharm 2.7.3编写的，尽管许多主题都适用于 current versions of PyCharm . 现在有 two editions for PyCharm ：专业版和免费社区版。Pycharm专业版包括对 Pyramid 的支持，使 Pyramid 的安装和配置更加容易。 Pyramid 集成在免费版本中不可用，因此本教程将帮助您在该版本中开始使用 Pyramid 。

还有一个免费的 PyCharm Edu 它旨在帮助程序员学习Python编程，并为教育者提供关于Python编程的课程。

为了开始Pycharm中的 Pyramid ，我们需要安装先决软件。

  • Python

  • pycharm和某些python包

  • Pyramid 及其要求

安装Python

您可以从下载Mac OS X和Windows的安装程序，或从下载Linux、Unix或Mac OS X的源tarballs python.org Download . Follow the instructions in the README files.

安装PyMalk

Pycharm是一个需要许可证的商业应用程序。 Several license types are available depending on your usage .

Pyramid 是一个开源项目，并且每年都要满足 Free Open Source License with JetBrains for the use of PyCharm to develop for Pyramid and other projects under the Pylons Project. If you are a contributor to Pyramid or the Pylons Project, and would like to use our annual license, please contact the license maintainer stevepiercy 在“ Pyramid ”频道 irc.freenode.net.

或者，您可以下载30天的Pycharm试用版或 purchase a license 用于任何其他许可证下的开发或培训目的。

Download PyCharm 并按照该网页上的安装说明进行操作。

Configure PyCharm

创建新项目

Launch the PyCharm application.

在启动屏幕中，单击创建新项目。

../_images/start_up_screen.png

如果没有出现“启动”屏幕，则可能有一个现有项目处于打开状态。关闭现有项目，将显示启动屏幕。

../_images/create_new_project.png

在“创建新项目”对话框窗口中，执行以下操作。

  • 输入项目名称。该位置应在键入时自动填充。你可以随心所欲地改变路径。通常使用路径`~/projects/`来包含项目。在本文件的其余部分，该位置应称为“项目目录”。

  • 项目类型应为空项目。

  • 对于解释器，单击省略号按钮创建新的虚拟环境。

一个新窗口出现，“python解释器”。

Create or Select a Python Interpreter

../_images/python_interpreters_1.png

  • 单击`+`按钮为python 2.7添加一个新的python解释器（python 2.7安装程序使用路径`/library/frameworks/python.framework/versions/2.7/bin`），或者为python 2.7使用现有的python解释器。Pycharm需要几秒钟来添加新的解释器。

../_images/python_interpreters_2.png

创建虚拟环境

  • 单击带有python徽标和绿色“v”的按钮。出现一个新窗口，“创建虚拟环境”。

../_images/create_virtual_environment.png

  • 输入虚拟环境名称。

  • 该位置应在键入时自动填充。你可以随心所欲地改变路径。

  • 应该已经选择了基本解释器，但如果没有，请选择`/library/frameworks/python.framework/versions/2.7/bin`或其他python 2.7解释器。

  • 不选中“继承全局站点包”框。

  • 点击“确定”。pycharm将设置库和包，并返回到python解释器窗口。

安装安装工具和 Pyramid 包

如果已经安装了安装工具，则可以跳过此步骤。

在“Python解释器”窗口中，在顶部窗格中选择刚创建的虚拟环境，在下面的窗格中选择“包”选项卡，然后单击“安装”按钮。出现“Available Packages（可用程序包）”窗口。

../_images/install_package.png

在“可用软件包”窗口的搜索栏中，输入“设置工具”。选择普通的“设置工具”包，然后单击“安装包”按钮，等待状态消息消失。pycharm将安装包和任何依赖项。

../_images/install_package_setuptools.png

重复上一步，除了使用“ Pyramid ”进行搜索和选择。

../_images/install_package_pyramid.png

当Pycharm安装完软件包后，关闭“可用软件包”窗口。

在“Python解释器”窗口中，单击“确定”按钮。

在“创建新项目”窗口中，单击“确定”按钮。

如果Pycharm显示警告，请单击“是”按钮。Pycharm打开了新项目。

克隆 Pyramid 存储库

通过克隆 Pyramid 存储库，您可以对代码或文档进行更改。我们建议您将 Pyramid 存储库分叉到自己的GitHub帐户，然后克隆分叉的存储库，这样您就可以将更改提交到GitHub存储库，并向 Pyramid 项目提交请求。

在pycharm中，选择*vcs>Enable version control integration…*，然后选择git作为VCS并单击OK按钮。

见 Cloning a Repository from GitHub 有关在pycharm中使用github和git的详细信息，请参阅pycharm文档。

我们将您计算机上克隆的 Pyramid 存储库称为“本地 Pyramid 存储库”。

Install development and documentation requirements

为了为Pyramid提供错误修复、特性和文档更改，必须将开发和文档需求安装到虚拟环境中。Pyramid uses Sphinx and reStructuredText for documentation.

  • 在PyCharm中，选择*运行>编辑配置…*。出现“Run/Debug Configurations（运行/调试配置）”窗口。

    ../_images/edit_run_debug_configurations.png

  • 单击“+”按钮，然后选择python以添加新的python运行配置。

  • 将配置命名为“安装程序开发”。

  • 手动输入 setup.py script or click the ellipsis button to navigate to the pyramid/setup.py 路径并选择它。

  • 对于脚本参数，输入 develop.

  • 单击“应用”按钮保存运行配置。

在这里，让我们复制这个运行配置来安装文档需求。

  • 单击“复制配置”按钮。它的图标看起来像两个狗耳朵的页面，灰色的页面上有一个蓝色的页面。

  • 将配置命名为“安装文档”。

  • 保持原样。

  • 对于脚本参数，输入 docs.

  • 单击“应用”按钮保存运行配置。

  • 单击“确定”按钮返回到项目窗口。

在pycharm工具栏中，您将看到一个python图标和您的运行配置。

../_images/run_configuration.png

首先选择“设置dev”，然后单击“运行”按钮（绿色三角形）。安装这些要求可能需要一些时间。Second select "setup docs", and click the "run" button again.

要构建DOCS，让我们创建一个新的运行配置。

  • 在PyCharm中，选择*运行>编辑配置…*。

  • 单击“+”按钮，然后选择 Python docs > Sphinx Task 添加新的文档生成运行配置。

  • 选择命令 HTML.

  • 应该已经选择了项目和项目解释程序。

  • 为源目录、生成目录和当前工作目录输入适当的值。

现在你将准备好入侵并为Pyramid贡献力量。

模板语言

要配置模板语言Mako、Jinja 2和Chameleon，请首先查看pycharm文档 Python Template Languages 要为项目选择模板语言，请参见 Configuring Template Languages to both configure the template language and mark folders as Sources and Templates for your project.

Creating a Pyramid project

此部分的信息来源于 Creating a Pyramid Project 并且适合用于Pycharm。

使用脚手架创建 Pyramid 项目

在Pycharm中，您可以通过执行以下操作来使用脚手架启动项目。

  • 选择*运行>编辑配置…*。

  • 单击“+”按钮，然后选择python以添加新的python运行配置。

  • 将配置命名为“pcreate”。

  • 手动输入 pcreate script or click the ellipsis button to navigate to the $VENV/bin/pcreate path and select it.

  • 对于脚本参数，输入“-s starter myproject”。“starter”是 Pyramid 中一个脚手架的名称，但您可以使用任何脚手架。myproject”是您的项目名称。

  • Select the directory into which you want to place MyProject. 常见的做法是`~/projects/`。

  • Click the OK button to save the run configuration.

  • 选择“运行>运行”pcreate“*以运行运行配置。将创建您的项目。

  • 选择 File > Open directory, select the directory where you created your project MyProject, and click the Choose button. You will be prompted to open the project, and you may find it convenient to select "Open in current window", and check "Add to currently open projects".

  • 最后，将项目解释器设置到您的虚拟环境中，或者对其进行验证。选择 PyCharm > Preferences... > Project Interpreter, 并验证该项目是否使用与父项目相同的虚拟环境。

  • 如果黄色条警告您安装需求，请单击“链接”进行安装。

安装新创建的用于开发的项目

我们将像以前一样创建另一个运行配置。

  • 在pycharm中，选择 setup.py 脚本在 MyProject 文件夹。This should populate some fields with the proper values.

  • 选择*运行>编辑配置…*。

  • 单击“+”按钮，然后选择python以添加新的python运行配置。

  • 将配置命名为“MyProject安装开发”。

  • 手动输入 setup.py 脚本在 MyProject 文件夹或单击省略号按钮导航到路径并选择它。

  • 对于脚本参数，输入 develop.

  • For Project, select "MyProject".

  • 对于工作目录，输入或选择路径 MyProject.

  • 单击“应用”按钮保存运行配置。

  • 最后运行运行配置“myproject setup develop”。将安装您的项目。

Running the tests for your application

我们将创建另一个运行配置。[如果您在Pycharm时知道更简单的方法，请提交拉取请求。]

  • 选择*运行>编辑配置…*。

  • 选择上一个运行配置“MyProject安装程序开发”，然后单击复制配置按钮。

  • 将配置命名为“MyProject安装测试”。

  • 通往那条路的路 setup.py 脚本在 MyProject 应已输入文件夹。

  • 对于脚本参数，输入 test -q.

  • 对于项目，应选择“MyProject”。

  • 对于工作目录，路径为 MyProject 应选择。

  • 单击“应用”按钮保存运行配置。

  • 最后运行运行配置“MyProject安装测试”。您的项目将运行其单元测试。

Running the project application

When will creation of run configurations end? 今天不行！

  • 选择*运行>编辑配置…*。

  • 选择上一个运行配置“MyProject安装程序开发”，然后单击复制配置按钮。

  • Name the configuration "MyProject pserve".

  • 手动输入 pserve script or click the ellipsis button to navigate to the $VENV/bin/pserve path and select it.

  • 对于脚本参数，输入 development.ini.

  • 对于项目，应选择“MyProject”。

  • 对于工作目录，路径为 MyProject 应选择。

  • 单击“应用”按钮保存运行配置。

  • 最后运行运行配置“myproject pserver”。您的项目将运行。单击python控制台中的链接或在Web浏览器中访问url http://0.0.0.0:6543/。

还可以使用脚本参数自动重新加载对项目的.py或.ini文件所做的任何更改。 development.ini --reload.

调试

Working with Run/Debug Configurations for details on how to debug your Pyramid app in PyCharm.

首先，您不能同时运行和调试应用程序。如果应用程序正在运行，请在调试前终止它。

要调试应用程序，请在应用程序中打开要调试的文件，然后单击装订线（行号和代码之间的空格）以设置断点。然后在pycharm工具栏中选择“myproject pserver”，然后单击调试图标（看起来像绿色瓢虫）。您的应用程序将运行到第一个断点。