从RealPython

作者：Jahongir Rahmonov

编译机器之心

参与：魔鬼

PyCharm是一个Python IDE，可以帮助程序员节省时间并提高生产力。那么具体怎么用呢？本文介绍了PyCharm的安装、插件、外部工具和专业功能，希望能对您有所帮助。

在Machine Heart之前没有系统地介绍过PyCharm，如何配置环境、调试、同步GitHub等可能是通过经验或试错来学习的。在本文中，我们将不提供完整的指南，但我们将介绍PyCharm的一些关键功能，我们需要在实践中学习这些功能。

《机器之心》的读者应该熟悉由JetBrains开发的PyCharm，它或多或少是Django的支持和科学模式。本文假设您熟悉Python开发，并且在您的计算机上安装了一个Python版本。本教程将使用Python 3.6版本，屏幕截图和macOS演示。由于PyCharm可以在所有主流平台上运行，因此读者会在其他系统上看到略有不同的UI元素，并且可能需要调整一些命令。

PyCharm安装

本文使用PyCharm Community Edition 2019.1，它是免费的，可以在所有主要平台上使用。只有最后一节“PyCharm专业功能”使用PyCharm专业版2019.1。

工具箱App安装指南，参见JetBrains官方文档：https://www.jetbrains.com/help/pycharm/installation-guide.html#toolbox。

该应用程序将根据您的操作系统提供适当的安装说明。如果无法准确识别系统，可以在右上角的下拉列表中查找对应的系统。

安装成功后，启动应用程序并接受用户协议。在Tools选项下，您可以看到可用产品的列表。找到PyCharm社区并单击“安装”。

好的，现在PyCharm已经安装在您的机器上了。如果不想使用Toolbox应用程序，可以单独安装PyCharm。

启动PyCharm，您将看到导入设置弹出窗口。PyCharm自动检测到这是第一次安装，并为您选择“不导入设置”选项。单击OK, PyCharm将允许您选择keymap方案。保持默认设置，点击右下角的“下一步：UI主题”:

PyCharm将询问是否选择Darcula，暗模式还是光模式。你可以选择你喜欢的模式，然后点击“下一步：启动脚本”:

本教程将使用暗模式Darcula。

在下一页上，只需保留默认设置并单击“下一步：特色插件”，此时PyCharm将显示可用插件列表。点击“开始使用PyCharm”，现在你可以编写代码了!

在PyCharm中编写代码

0

安装并打开PyCharm后，您将看到欢迎页面。点击“新建项目”，弹出“新建项目”窗口：

指定一个项目位置，打开Project Interpreter列表，并选择创建一个新的项目解释器或使用现有的项目解释器。选择“New environment using”，打开右侧的下拉列表，选择Virtualenv、Pipenv或Conda。这些工具允许您为不同的项目创建单独的Python环境，从而单独保存每个项目所需的依赖项。

您可以选择其中任何一个，本教程使用Virtualenv。选中后，指定环境位置，并从Python解释器列表中选择要安装在系统上的基本解释器。一般来说，保留默认设置即可。有两种选择：在新环境中继承全局包环境，以及在当前环境中使所有其他项目都可用。

点击右下角的“创建”，创建一个新项目：

屏幕上出现“每日提示”弹出窗口，PyCharm每次启动时都会提供一个小技巧。关闭弹出窗口。

现在我们可以开始新的Python程序了。如果你用的是Mac电脑，使用Cmd N;如果您使用的是Windows或Linux，请使用Alt - Ins。选择“Python File”。您也可以从菜单中选择“文件新建”。将新文件命名为guess_game.py并单击OK。您应该看到以下PyCharm窗口：

对于测试代码，让我们快速编写一个简单的猜谜游戏，其中程序选择一个数字并要求用户猜测。在每次猜测时，程序都会告诉用户他猜的数字比神秘数字大还是小，当用户猜出数字时，游戏结束。以下是游戏代码：

直接键入上面的代码，而不是复制粘贴。你应该看到这样的内容：

如上图所示，PyCharm提供了智能编码辅助来执行代码完成、代码审查、错误高亮显示和快速修复建议。如果键入main并按tab键，PyCharm将自动完成main子句。

另外，如果你忘记在条件之前键入if，在句子末尾添加。并按Tab键，PyCharm将修复if条件。同样的用法也适用于True.while。这是PyCharm的后缀补全功能，它可以帮助用户减少使用退格键的次数。

在PyCharm中运行代码

现在你已经编写了游戏代码，它就可以运行了。

游戏程序以三种方式运行：

在Mac上使用快捷键Ctrl + Shift R，在Windows或Linux上使用快捷键Ctrl + Shift + F10。右键单击后台，从菜单中选择“Run”guess_game”。因为程序有一个__main__子句，你可以点击__main__子句左边的绿色小箭头，然后选择“Run”guess_game”。以以下任何一种方式运行程序，窗口底部会出现一个Terminal窗格，显示代码的输出：

你可以玩这个游戏，看看你能不能猜出数字。(专业建议：从50岁开始。)

调试代码在PyCharm

你找到那个神秘号码了吗？如果您这样做了，您可能会看到一些奇怪的事情：程序没有打印出祝贺消息并显示退出按钮，而是重新开始。这就是bug出现的地方。要发现程序重新启动的原因，需要进行调试。

首先，通过单击第8行左侧的空白设置一个断点：

断点是程序自动停止的那一行。您可以在断点之外的代码中查找错误。接下来，从三种方式中选择一种开始调试：

在Mac操作系统下，按Ctrl + Shift d。在Windows或Linux操作系统下，按Shift + Alt + F9。右键单击后台，选择调试“guess_game”。点击__main__子句左边的绿色小箭头，选择“Debug”guess_game”。之后，你应该在底部看到Debug窗口：

按照以下步骤调试程序：

注意，当前行以蓝色突出显示。Debug窗口显示random_int及其值。记录号码。(上图为85。)单击F8执行当前行代码并继续执行下一行代码。如果有必要，还可以使用F7跳转到当前行的某个函数。当您继续执行该语句时，变量更改将自动显示在Debugger窗口中。注意，在Debugger标记的右侧有一个Console标记。控制台标签和调试器标签彼此独立。您可以从控制台与程序交互，并从调试器执行调试操作。转到控制台选项卡并进入猜测过程。在左边的Debugger选项卡中输入显示的数字，然后按Enter。返回到调试器选项卡。再次单击F8来计算if语句。注意，现在到了第14行。为什么不是第11行呢？因为第10行if语句的计算结果为False。那么为什么当你输入数字的时候它是假的呢？仔细看第10行，注意我们将user_guess与一个不正确的项进行比较。我们应该将用户猜测的数字与random_int进行比较，但这里我们比较的是randint(从random包导入的函数)。将randint更改为random_int，并按照相同的步骤重新启动调试。您会注意到此时到达了第11行，第10行结果为True:祝贺您，错误被修复了!

在PyCharm中的代码测试

没有单元测试的应用程序是不可靠的。PyCharm可以帮助您快速、舒适地编写和运行单元测试。默认情况下，使用unittest作为测试运行器，PyCharm支持其他测试框架，如pytest, nose, doctest, tox和trial。例如，您可以按照以下步骤为项目选择pytest测试运行器：

打开设置/首选项工具Python集成工具设置对话框。在默认的Test Runner字段中选择pytest。单击OK保存设置。本教程中的示例使用了默认的测试运行器unittest。

在同一个项目中，创建文件Calculator .py，并将以下Calculator类放入该文件：

PyCharm可以很容易地为现有代码创建测试。打开calculator.py文件并执行以下任何步骤：

在Mac上使用Shift Cmd T，在Windows或Linux上使用Ctrl Shift T。右键单击类的背景，选择Go To和Test。从主菜单中选择导航测试。选择Create New Test…获取以下窗口：

保留目标目录、测试文件名和测试类名的默认设置。在上图中选择您想要测试的两个方法并单击OK。好吧!PyCharm自动创建文件test_calculator.py，并在其中创建以下stub test:

使用以下任何一种方法运行测试：

在Mac上使用Ctrl R，在Windows或Linux上使用Shift F10。右键单击后台，选择“Run”Unittests for test_calculator.py”。单击测试类名称左侧的绿色小箭头，并选择“运行”Unittests for test_calculator.py”。您将看到底部出现一个测试窗口，其中所有测试都失败：

注意，左边是测试结果的层次结构，右边是终端的输出。现在，将代码修改如下，实现test_add:

重新运行测试，您将看到一个测试通过，另一个测试失败。浏览选项以显示通过和忽略的测试，按字母顺序对测试进行排序，并按长度对测试进行排序，如下所示：

请注意，上图中的sleep(0.1)方法用于减慢其中一个测试的速度，以便定期对测试进行排序。

在PyCharm中编辑现有项目

单文件项目是很好的例子，但你通常需要处理更大的项目。本节描述如何在大型项目中使用PyCharm。

为了探索PyCharm以项目为中心的性质，您将使用用于学习目的的Alcazar web框架。在本地复制repo(地址：https://realpython.com/optins/view/alcazar-web-framework/)。

当你已经在本地拥有项目时，使用以下任何一种方法在PyCharm中打开项目：

在主菜单中单击“文件打开”。单击欢迎页面上的Open。之后，在计算机上找到包含项目的文件夹并打开它。

如果项目包含虚拟环境，PyCharm将自动使用虚拟环境并将其用作项目解释器。

如果需要配置不同的虚拟环境(virtualenv)，在Mac上打开Preferences，或在Windows或Linux上使用Ctrl Alt S打开Settings，请找到Project: ProjectName。打开下拉列表，选择Project Interpreter:

在下拉列表中选择“virtualenv”。如果没有可选项，单击下拉列表右侧的“设置”按钮，选择“添加.”其余步骤与创建新项目的步骤相同。

在PyCharm中搜索和导航

在大型项目中，很难记住所有东西的位置，所以快速导航和搜索很重要。PyCharm提供了这些功能。接下来，让我们使用上一节打开的项目来练习以下快捷方式：

在当前文件中搜索代码片段：在Mac上使用Cmd F，在Windows或Linux上使用Ctrl F。在整个项目中搜索代码片段：在Mac上使用Cmd Shift F，在Windows或Linux上使用Ctrl Shift F。搜索类：Mac上使用Cmd 0, Windows或Linux上使用Ctrl N。搜索文件：在Mac上使用Cmd Shift O或在Windows或Linux上使用Ctrl Shift N。如果不知道要搜索的是文件、类还是代码片段，请搜索全部：按两次Shift键。使用以下快捷键进行导航：

进入变量的声明：在Mac上使用Cmd，在Windows或Linux上使用Ctrl，然后单击变量。查找类、方法或文件的用法：使用Alt F7。查看最近的更改：使用Shift Alt C或从主菜单中单击“查看最近的更改”。查看最近文件：在Mac上使用Cmd E，在Windows或Linux上使用Ctrl E，或在主菜单中单击“查看最近文件”。多次跳转后，在导航历史中前进和后退：Mac上使用Cmd [/Cmd]， Windows或Linux上使用Ctrl Alt Left/Ctrl Alt Right。详情请参考官方文档：https://www.jetbrains.com/help/pycharm/tutorial-exploring-navigation-and-search.html。

PyCharm中的版本控制

版本控制系统(如VCS)

要开启VCS集成，请进入VCSVCS操作弹出窗口…，在Mac上按Ctrl V，在Windows或Linux上按Alt。选择启用版本控制集成…，您将看到以下窗口：

从下拉列表中选择Git，单击OK，这样就为项目设置好了VCS。(注意，如果你打开一个已经有版本控制系统的现有项目，PyCharm将发现并自动使用版本控制系统。)

如果你去VCS操作弹出窗口…你会发现一个不同的弹出窗口，里面有git add, git stash, git branch, git commit, git push等选项：

如果你找不到你需要的选项，点击顶部菜单中的VCS并选择Git，在这里你可以创建和查看拉取请求。

提交和冲突处理

这是我个人经常使用并喜欢的PyCharm中VCS集成的两个特性。如果你已经完成了你的工作，想提交它，去VCSVCS操作弹出…提交…，或者在Mac上使用Cmd K，在Windows或Linux上使用Ctrl K。您应该看到以下窗口：

在此窗口中，您可以：

选择要提交的文件记录提交信息提交前检查查看更改单击右下角“提交”按钮旁边的箭头，选择“提交并推送…”一次完成提交和推。是不是感觉很神奇，很快？特别是如果您习惯于从命令行手动执行这些任务。

合并冲突发生在团队合作中。当一个人向您正在处理的文件提交更改时，如果你们两人更改了同一行，导致更改重叠，VCS无法决定是选择您的更改还是选择您的队友的更改。然后你可以使用下面的箭头和符号来解决这个问题：

虽然看起来很奇怪，但很难区分哪些更改要删除，哪些要保留。别害怕，PyCharm来了!它可以以更好、更简洁的方式解决冲突。在顶部菜单中，进入VCS，选择“Git”，选择“Resolve conflicts.”选择冲突的文件并单击Merge。出现如下窗口：

在左列中，您可以查看所做的更改。在右列中，您可以查看团队成员所做的更改。中间一列显示结果。有冲突的代码行被高亮显示，您可以在它们旁边看到X和/。单击箭头接受更改，并单击X拒绝更改。一旦解决了所有冲突，单击Apply按钮：

在上图中，对于第一个冲突行，作者选择拒绝自己的更改，接受队友的更改。在第二条冲突线中，作者接受自己的改变，拒绝队友的改变。

使用PyCharm中的VCS集成，您还可以做许多其他事情。详情请参考https://www.jetbrains.com/help/pycharm/version-control-integration.html。

使用插件和外部工具在PyCharm

在PyCharm中，您可以找到开发所需的几乎所有功能。如果没有，可能有一个插件可以提供PyCharm所需的功能。例如，他们可以：

增加多语言和多框架支持，提高您的工作效率，使用快捷提示，文件监视器等。利用代码练习来帮助你学习一门新的编程语言。例如，IdeaVim插件将Vim仿真添加到PyCharm中。如果你喜欢Vim，这个插件是一个很好的组合。

Material Theme UI插件将PyCharm的外观更改为Material Design的外观：

Vue.js插件使PyCharm能够支持Vue.js项目。Markdown插件使得在IDE中编辑Markdown文件和实时预览呈现的HTML成为可能。

点击首选项Mac上的插件和设置Windows或Linux上的插件。您可以在Marketplace选项卡中找到并安装所有可用的插件：

如果你仍然找不到你需要的东西，你甚至可以开发自己的。

如果您找不到合适的插件，并且不想自己开发它，因为PyPI已经有一个可用的包，您可以将此包作为外部工具添加到PyCharm中。以代码分析器Flake8为例。

首先，在选择的终端应用程序中输入pip install flake8，在虚拟环境中安装flake8。或者，您可以使用PyCharm集成终端：

在Mac操作系统中，选择“首选项工具”。在Windows或Linux操作系统下，进入“设置工具”，选择“外部工具”。然后点击底部的按钮(1)，在弹出的窗口中输入详细信息，在两个Windows中都点击OK，如下图所示：

在上图中，Program(2)指的是Flake8，你可以在虚拟环境文件夹(bin)中找到它。参数(3)表示要用Flake8解析的文件。工作目录工程目录。

您可以在这里写出所有项目的绝对路径，但这意味着您不能在其他项目中使用这个外部工具，只能在一个项目中的一个文件中使用。

所以你需要使用宏。它是一个格式为$name$的变量，根据上下文的不同而不同。例如，当你编辑first.py时，$FileName$将是first.py，当你编辑second.py时，$FileName$将是second.py。若要查看它们的列表，请单击“插入宏…”按钮插入其中一个。在这里，您使用的是宏，它们的值将根据您当前正在处理的项目而变化，并且Flake8将继续准确地执行其工作。

要使用它，创建文件example.py并在其中写入以下代码：

上面的代码故意打破了Flake8的一些规则。右键单击文件背景，选择外部工具Flake8。Flake8分析结果将出现在窗口底部：

为了使它更好，您可以添加快捷方式。在Mac上选择首选项，在Windows或Linux上选择设置。然后单击“Keymap外部工具外部工具”。双击Flake8，选择“添加键盘快捷方式”，弹出如下窗口：

在上图中，快捷键是Ctrl Alt A(在本教程中使用)。您可以将您喜欢的快捷方式添加到文本框中，然后在两个Windows中单击“确定”。然后，您可以使用快捷方式来分析您在Flake8的帮助下正在处理的文件。

PyCharm专业功能

PyCharm Professional是PyCharm的付费版本，具有更多开箱即用的功能和集成。本节提供主要特性的概述，以及详细描述每个特性的官方文档的链接。请记住，PyCharm Community版本中没有以下功能。

Django 支持

Django 是最流行和最受喜爱的Python web 框架，PyCharm 对Django 提供广泛的支持。要确保对Django 的支持，需要执行以下步骤：

在Mac 系统中打开Preferences，在Windows 或Linux 系统中打开Settings。选择Languages and Frameworks。选择Django。检查复选框Enable Django support。应用更改。现在确保了对Django 的支持，你在PyCharm 中的Django 开发之旅将轻松很多。具体而言在创建项目时，你会得到一个专用的Django 项目类型。这表示，当你选择该类型时，你将拥有所有必要文件和设置。这等同于使用django-admin startproject mysite。

你也可以在PyCharm 内直接运行manage.py 命令。目前支持的Django 模板，包括以下一些：

语法和错误高亮显示代码补全导航block 名称补全自定义标签和过滤器补全标签和过滤器的快速文档模板debug 能力除此之外，我们还可以在其他Django 部分（如视图、URL 和模型）中执行代码补全、对Django ORM 提供代码追踪支持（code insight support）、对Django 模型提供模型依赖项关系图。

更多细节，参见官方文档：https://www.jetbrains.com/help/pycharm/django-support7.html。

数据库支持

现代数据库开发是一个复杂的任务，需要多个支持系统和工作流。这也是JetBrains 开发独立IDE DataGrip 的原因。DataGrip 是独立于PyCharm 的产品，二者的应用场景和授权都不相同。

但幸运的是，通过Database tools and SQL 插件（该插件默认开启），PyCharm 可以支持DataGrip 中的所有特性。在该插件的帮助下，你可以查询、创建和管理数据库，不管数据库在本地、服务器，还是在云端。该插件支持MySQL、PostgreSQL、Microsoft SQL Server、SQLite、MariaDB、Oracle、Apache Cassandra 等。

关于该插件的更多用途，请查看文档：https://www.jetbrains.com/help/pycharm/relational-databases.html。

线程并发可视化（Thread Concurrency Visualization）

Django Channels、asyncio 和近期框架（如Starlette (https://www.starlette.io/)）表明异步Python 编程正逐渐成为趋势。异步编程具备很多好处，但很难写，也很难debug。在此类案例中，Thread Concurrency Visualization 就是医生，帮助你全面管理多线程应用并进行优化。

更多细节，参见文档：https://www.jetbrains.com/help/pycharm/thread-concurrency-visualization.html。

Profiler

说到优化，profiling 是另一种代码优化方法。profiling 可以帮助你查看代码的哪一部分占用了最多的执行时间。profiler 运行的优先级如下：

1. vmprof

2. yappi

3. cProfile

如果你没有安装vmprof 或yappi，则运行标准cProfile。更多细节，参见：https://www.jetbrains.com/help/pycharm/profiler.html。

科学模式

Python 不仅是通用和web 编程语言，由于NumPy、SciPy、scikit-learn、Matplotlib、Jupyter 等库和工具的加持，Python 成为数据科学和机器学习领域的最优工具。有了这些强大工具，你还需要一个强大的IDE 来支持这些库所具备的绘图、分析等所有功能。

关于科学模式的更多详情，参见https://www.jetbrains.com/help/pycharm/matplotlib-support.html。

远程开发

很多应用出现bug 的一个常见原因是，开发环境和生产环境不同。尽管在大多数情况下，开发时完美复制生产环境并不现实，但力求实现完美复刻是值得追寻的目标。

在PyCharm 的帮助下，你可以使用另一台计算机（如Linux VM）上的解释器对应用进行debug。这样，你就可以拥有与生产环境一样的解释器了，从而避免很多因开发环境和生产环境差异导致的bug。

详情参见：https://www.jetbrains.com/help/pycharm/remote-debugging-with-product.html。

结论

PyCharm 是最好的Python 开发IDE 之一。它提供大量优势，帮助执行例行任务，从而节约大量时间。学完本教程，现在你知道如何利用PyCharm 提高生产效率了吗？

原文地址：https://realpython.com/pycharm-guide/