PyCharm 快速入门指南

一、简介

PyCharm 是一款专为 Python 开发人员打造的集成开发环境（IDE），提供了丰富的工具，紧密集成，为高效的 Python、网络和数据科学开发创造了一个便捷的环境。

二、选择适合您的 PyCharm

PyCharm 提供两个版本：

• 社区版（免费开源） ：适用于智能和智能的 Python 开发，包括编码辅助、重构、可视化调试和版本控制集成。
• 专业版（付费） ：适用于专业的 Python、网络和数据科学开发，除了社区版的功能外，还支持远程配置、部署、流行网络框架（如 Django 和 Flask）、数据库支持、科学工具（包括 Jupyter 笔记本支持）和大数据工具。

三、支持的语言

要开始使用 PyCharm 进行 Python 开发，您需要根据您的平台从 python.org 下载并安装 Python。PyCharm 支持以下版本的 Python：

• Python 2: 版本 2.7
• Python 3: 从版本 3.6 到版本 3.13

此外，在专业版中，可以开发 Django、Flask 和 Pyramid 应用程序。它还完全支持 HTML（包括 HTML5）、CSS、JavaScript 和 XML，这些语言通过插件捆绑在 IDE 中，默认为您启用。您也可以通过插件添加对其他语言和框架的支持。

四、支持的平台

PyCharm 是一款跨平台的 IDE，适用于 Windows、macOS 和 Linux。安装 PyCharm 可以使用 Toolbox 或独立安装。如果您需要安装帮助，请参阅安装说明。

五、从项目开始

在 PyCharm 中，您所做的一切都在项目的上下文中进行。它作为编码辅助、批量重构、编码风格一致性等的基础。您有几种选择可以在 IDE 内开始项目：

• 打开现有项目
• 从版本控制中检出项目
• 创建新项目

您也可以不设置项目就创建 Python 文件或 Jupyter 笔记本：

在欢迎屏幕上，如果您想创建 Jupyter 笔记本，点击 “新建笔记本”；如果您想创建 Python 文件，点击 “新建脚本”。新文件将被添加到自动创建的 PyCharmMiscProject 中，您可以无需额外步骤编写和执行代码。

打开现有项目

首先，打开存储在计算机上的现有项目之一。您可以在欢迎屏幕上的最近项目列表中选择一个，或者点击 “打开”：

否则，您可以为现有的源文件创建一个项目。在 “文件” 菜单中选择 “打开” 命令，并指定源文件存在的目录。PyCharm 将为您从源文件创建一个项目。有关详细信息，请参阅从现有源文件创建项目。

从版本控制中检出现有项目

您还可以从 VCS 存储库或存储库下载源代码。在欢迎屏幕上，点击 “从 VCS 获取”，然后选择 Git（GitHub）、Mercurial、Subversion 或 Perforce（仅在 PyCharm 专业版中支持）。

然后，输入源代码的路径并将存储库克隆到本地主机：

创建新项目

要创建项目，可以执行以下任一操作：

• 转到 “文件” > “新建项目”
• 在欢迎屏幕上，点击 “新建项目”

在 PyCharm 社区版中，您只能创建 Python 项目，而使用 PyCharm 专业版，您有多种选项来创建网络框架项目。

社区版	专业版

当创建新项目时，您需要指定一个 Python 解释器来执行项目中的 Python 代码。您需要在机器上至少有一个 Python 安装可用。

对于新项目，PyCharm 会创建一个隔离的虚拟环境：venv、pipenv、poetry 或 Conda。在您工作时，您可以更改它或创建新的解释器。您还可以在 Python 包工具窗口中快速预览为您解释器安装的包并添加新包。

六、界面概览

当您第一次启动 PyCharm，或者没有打开项目时，您会看到欢迎屏幕。它为您提供了进入 IDE 的主要入口：创建或打开项目、从版本控制中检出项目、查看文档以及配置 IDE。

当项目打开时，您会看到主窗口被分成几个逻辑区域。让我们花点时间来看看这里的关键 UI 元素：

新 UI	经典 UI

1. 窗口标题栏包含一组小部件，提供对最受欢迎操作的快速访问：项目小部件、VCS 小部件和运行小部件。它还允许您打开 “与我一起编码”、“随处搜索” 和 “设置”。
2. 左侧的项目工具窗口显示您的项目文件。
3. 右侧的编辑器是您实际编写代码的地方。它有标签，便于在打开的文件之间导航。
4. 右键单击界面元素或代码片段时会打开上下文菜单，并显示可用的操作。
5. 导航栏允许您快速导航项目文件夹和文件。
6. 编辑器旁边的空白处显示您设置的断点，并提供了一种方便的方法来导航代码层次结构，例如转到定义 / 声明。它还显示行号和按行的 VCS 历史记录。
7. 编辑器右侧的滚动条。PyCharm 不断监控您的代码质量，通过运行代码检查来实现。右上角的指示器显示整个文件的代码检查总体状态。
8. 工具窗口是附加在工作区底部和侧面的专用窗口。它们提供了对典型任务的访问，例如项目管理、源代码搜索和导航、版本控制系统的集成、运行、测试、调试等。
9. 状态栏指示您的项目和整个 IDE 的状态，并显示各种警告和信息消息，例如文件编码、行分隔符、检查配置文件等。它还提供了对 Python 解释器设置的快速访问。

七、智能辅助编码

当您创建了新项目或打开现有项目后，就可以开始编码了。

创建 Python 文件

1. 在项目工具窗口中，选择项目根（通常是项目树的根节点），右键单击它，然后选择 “文件” > “新建”。
   
2. 从上下文菜单中选择 “Python 文件”，然后输入新文件名。
   

PyCharm 创建一个新的 Python 文件并打开它以供编辑。

PyCharm 处理日常事务，以便您可以专注于重要的事情。使用以下编码功能来创建无错误的应用程序，而不会浪费宝贵的时间。

代码补全

无论您处理何种类型的文件，代码补全都是节省时间的好帮手。

基本补全在您输入时工作，并立即完成任何名称。

智能类型匹配补全分析您当前工作的上下文，并根据该分析提供更准确的建议。

意图操作

PyCharm 会关注您当前正在做的事情，并提出称为意图操作的智能建议，以节省更多时间。意图操作用灯泡表示，允许您对正确的代码应用自动更改（与为可能不正确的代码提供快速修复的代码检查不同）。您是否忘记在构造函数中添加一些参数和字段初始化器？有了 PyCharm，这不再是问题。点击灯泡（或按 Alt + Enter），然后选择其中一个建议的选项：

所有可用意图操作的完整列表可以在 “文件” > “设置” > “编辑器” > “意图操作”（对于 macOS 用户，选择 “PyCharm” > “设置” > “编辑器” > “意图操作”）中找到。

保持代码整洁

PyCharm 监控您的代码，并尝试保持其准确性和整洁性。它会检测潜在的错误和问题，并为这些问题建议快速修复。

每次 IDE 发现未使用的代码、无限循环以及其他可能需要您注意的事情时，您都会看到一个灯泡。点击它，或按 Alt + Enter，以应用修复。

所有可用检查的完整列表可以在 “设置” > “编辑器” > “检查操作”（对于 macOS 用户，选择 “PyCharm” > “设置” > “编辑器” > “检查操作”）下找到。您可以禁用其中一些检查，或启用其他检查，还可以调整每个检查的严重性。您可以决定它是被视为错误还是只是警告。

生成代码

使用 PyCharm 中可用的代码生成选项，可以让编写代码变得更加容易和快捷。“代码” > “生成” 菜单将帮助您从用法创建符号，以及建议覆盖或实现某些函数：

使用实时模板（选择 “代码” > “插入实时模板” 或按 Ctrl + J）来生成整个代码结构。您可以在设置对话框中（Ctrl + Alt + S）探索可用的现成实时模板（对于 macOS 用户，选择 “PyCharm” > “设置” > “编辑器” > “实时模板”）。

如果您发现缺少对您开发特别重要的某些内容，可以扩展这些模板集，添加您自己的模板。此外，考虑快速用完整的结构包围您的代码（选择 “代码” > “包围” 或按 Ctrl + Alt + T。例如，用 if 语句：

八、找到您的方式

当您的项目很大，或者当您需要处理其他人的代码时，能够快速找到您需要的内容并深入代码就显得尤为重要。这就是 PyCharm 为什么配备了一套导航和搜索功能，帮助您在任何代码中找到路径，无论代码多么复杂。

基本搜索

借助这些搜索功能，您可以使用​Ctrl+F​在当前打开的文件中，或在​Ctrl+Shift+F​整个项目中查找和替换代码片段。

搜索用法

要查找某个符号在何处使用，PyCharm 建议通过 “查找用法” 进行全面搜索（快捷键：​Alt+F7​）。

项目导航

从文件结构中可以获取很多信息，包括导入或调用层次结构：

此外，您可以导航到：

• 根据名称导航到类、文件或符号。
• 导航到声明（​Ctrl+B​）。
• 导航到基类 / 基函数（​Ctrl+U​）。

左侧空白处的图标也可以帮助您导航：

通过时间线导航

记住项目中的所有活动，PyCharm 可以轻松地将您导航到 “最近文件”（​Ctrl+E​） 或 “最近更改的文件”（​Alt+Shift+C​）。

要浏览历史记录，请使用以下操作：

• 后退（​Ctrl+Alt+←​）
• 前进（​Ctrl+Alt+→​）
• 最后编辑位置（​Ctrl+Shift+Backspace​）

查找操作

利用 PyCharm 提供的许多智能操作。例如，使用 “查找操作” （​Ctrl+Shift+A​）搜索：只需输入操作名称的一部分，IDE 将显示所有可用选项的列表。然后，选择您需要的操作：

全局搜索

如果您对要查找的内容有一个大致的概念，您可以使用现有的导航功能之一来定位相应的元素。但如果您想在每个角落和缝隙中查找，答案是使用全局搜索！

要尝试它，点击窗口右上角的放大镜按钮，或通过双击 Shift（按两次 Shift）来调用它。

九、运行、调试和测试

现在，当您已经尝试了代码并发现了可以做的事情后，是时候运行、调试和测试您的应用程序了。

运行

运行应用程序最简单的方法是右键单击编辑器，然后从上下文菜单中选择 “运行”。

如果您的 Python 脚本包含 ​__main__​ 子句，那么您可以在空白处点击按钮，然后选择所需的命令。

您可以在运行工具窗口中看到脚本的执行情况。

当您在 PyCharm 中运行、调试或测试操作时，您总是基于现有的运行 / 调试配置之一启动一个进程，使用其参数。

当您第一次运行应用程序时，PyCharm 会自动创建临时的运行 / 调试配置。您可以修改它以指定或更改默认参数，并将其保存为永久的运行 / 调试配置。

有关如何调整运行 / 调试配置的详细信息，请参阅运行 / 调试配置。

调试

您的应用程序是否在运行时遇到错误？要找出原因，您需要进行一些调试。PyCharm 在所有平台上都支持调试器。

调试从在您希望暂停程序执行的行处设置断点开始。只需点击您希望出现断点的行的空白处即可。

要开始调试应用程序，请按 ​Shift + F9​。然后逐步浏览程序执行（参阅 “运行” 菜单或 “调试” 工具窗口中的可用选项），评估任意表达式，添加监视，并手动设置变量的值。

有关详细信息，请参阅调试。

测试

测试您的应用程序是一个好主意，PyCharm 尽可能简化了这一过程。

使用 PyCharm，您可以：

• 创建测试
• 创建专门的测试运行 / 调试配置。
• 直接从 IDE 中运行和调试测试，使用测试运行 / 调试配置。
• 最后但并非最不重要的一点是，您可以在运行工具窗口的测试运行程序选项卡中查看测试结果：
  

有关数字的详细信息，请参阅测试运行程序选项卡部分。

PyCharm 支持所有主要的 Python 测试框架：

• Unittest
• Doctest
• Nosetest
• pytest

对于这些框架中的每一个，PyCharm 都提供自己的运行 / 调试配置。

有关详细信息，请参阅测试您的第一个 Python 应用程序和运行测试。

使用 PyCharm 专业版，您可以远程运行、调试和测试 Python 代码。您可以将本地应用程序部署到远程服务器。有关部署服务器的详细信息，请参阅配置与 Web 服务器的同步。PyCharm 专业版还帮助比较本地和远程文件夹，并将本地副本与服务器上部署的副本进行同步。

十、将源代码置于版本控制之下

版本控制

如果您将源代码置于版本控制之下，您会很高兴知道 PyCharm 与许多流行的版本控制系统集成：Git（或 GitHub）、Mercurial、Perforce（仅专业版支持）、Subversion。要指定凭据和特定于特定 VCS 的设置，请转到 “设置” > “版本控制”（对于 macOS 用户，选择 “PyCharm” > “设置” > “版本控制”）。

VCS 菜单为您提供了可用命令的线索。例如，您可以查看所做的更改，提交它们，创建更改列表等，从本地更改视图：VCS > 显示更改（或只需按​ Alt + 9​）。

此外，您可以在主窗口中执行一些基本的 VCS 操作：

从 VCS 小部件：

新 UI	经典 UI
从 VCS 小部件中：	从编辑器上方的导航栏：

有关详细信息，请参阅版本控制。

本地历史记录

除了传统的版本控制之外，您还可以使用本地历史记录。通过本地历史记录，PyCharm 自动跟踪您对源代码所做的更改，重构的结果等。

本地历史记录始终处于启用状态。要查看文件或文件夹的本地历史记录，请通过选择 VCS > 本地历史记录 > 显示历史记录来调用本地历史记录。在这里，您可以查看更改，回滚它们，或创建补丁。

十一、处理数据

PyCharm 拥有一个交互式的 Python 控制台，可以在数据上执行智能操作，具有实时语法检查、检查、括号和引号匹配以及当然还有代码补全功能。您还可以受益于对 Anaconda 的内置支持。

使用 PyCharm 专业版，您可以分析和可视化各种科学和统计数据。Jupyter Notebook 集成允许编辑、执行和调试笔记本源代码并查看执行输出，包括流数据、图像和其他媒体。

在 PyCharm 中安装 R 插件后，您可以使用 R 语言进行各种统计计算，并使用编码辅助、可视化调试、智能运行和预览工具以及其他流行的 IDE 功能。

如您已经注意到的，创建各种类型（例如 Django）的项目需要数据源。您也可能在源代码中注入 SQL 语句。

PyCharm 专业版虽然不能创建数据库，但提供了管理数据库和查询数据库的工具。一旦您获得对某个数据库的访问权限，您可以在 PyCharm 中配置一个或多个数据源，以反映数据库的结构并存储数据库访问凭据。基于这些信息，PyCharm 建立与数据库的连接，并提供检索或更改其中包含的信息的能力。

通过数据库窗口（视图 > 工具窗口 > 数据库）访问数据库。此工具窗口允许您操作数据库。它允许您查看和修改数据库中的数据结构，并执行与之相关的其他任务。

有关详细信息，请参阅数据库工具和 SQL。

十二、自定义您的环境

请随意调整 IDE，使其完全符合您的需求，并尽可能地提供帮助和舒适。转到设置以查看可用的自定义选项列表。

外观

首先要微调的是总体的 “外观和感觉”。转到文件 > 设置 > 外观和行为 > 外观（对于 macOS 用户，选择 PyCharm > 设置 > 外观和行为 > 外观）以选择 IDE 主题：浅色主题或 Darcula，如果您更喜欢较暗的设置。

编辑器

在文件 > 设置 > 编辑器下有许多页面（对于 macOS 用户，选择 PyCharm > 设置 > 编辑器），可帮助您调整编辑器行为的每个方面。这里有很多可用选项，从常规设置（如启用拖放、滚动配置等），到每种可用语言和使用情况的颜色配置，再到标签和代码折叠设置，以及代码补全行为，甚至后缀模板。

有关详细信息，请参阅配置 PyCharm 设置。

代码风格

可以为每种语言定义代码风格，在文件 > 设置 > 编辑器 > 代码风格下（对于 macOS 用户，选择 PyCharm > 设置 > 编辑器 > 代码风格）。您还可以创建并保存自己的编码风格方案。

有关详细信息，请参阅配置代码风格和代码质量辅助提示与技巧，或如何让代码更美观。

键盘映射

PyCharm 采用以键盘为中心的方法，意味着在 IDE 中几乎所有的操作都映射到键盘快捷键。

您习惯使用的一组键盘快捷键是您最亲密的习惯之一 —— 您的手指 “记住” 了某些键的组合，改变这个习惯说起来容易做起来难。PyCharm 为您提供了默认的键盘映射（选择帮助 > 键盘快捷键 PDF 从主菜单），让您的编码真正高效和方便。但是，您总是可以转到文件 > 设置 > 键盘映射（对于 macOS 用户，选择 PyCharm > 设置 > 键盘映射）来更改它。

还有一些预定义的键盘映射（如 Emacs、Visual Studio、Eclipse、NetBeans 等），您也可以基于现有的键盘映射创建自己的键盘映射。

如果您使用 vi/Vim 最高效，仿真模式将为您带来两全其美的体验。在 IDE 中启用 IdeaVim 插件并选择 vim 键盘映射。

有关详细信息，请参阅配置键盘快捷键。

十三、开始愉快地开发吧

希望这份 PyCharm 必备功能的简要概述能帮助您快速上手。有许多重要的功能可以让开发人员的生活更轻松、更有趣，并且让源代码更整洁。现在就迈出第一步，然后在您觉得合适的时候再深入研究：

• 创建并运行您的第一个项目
• 调试您的第一个 Python 应用程序
• 测试您的第一个 Python 应用程序
• 创建并运行您的第一个 Django 项目

享受 PyCharm 吧！如有任何问题，请访问我们的讨论论坛、推特和博客，在那里您可以找到新闻、更新和有用的提示与技巧。另外，如果遇到任何问题，不要犹豫向我们的支持团队或 PyCharm 问题跟踪器报告。