创建并应用实时模板(代码片段)
本教程介绍什么?
PyCharm 随附相当多的各类实时模板……有多个为 Python 预定义的实时模板。 本教程旨在引导您创建用于 Python 类声明的实时模板,并使用该实时模板。
Python 编程不在本教程范围内。 有关详细信息,请参阅 Python 文档。
本文也不涉及实时模板的基础知识和用法。 您可以在 实时模板 部分找到有关实时模板的类型、缩写、变量和存储的所有必要信息。

先决条件
请确保您使用的是 PyCharm 2.7 或更高版本。 如果您尚未安装 PyCharm,请从 此页面 下载。 要安装 PyCharm,请根据您的平台遵循相应的说明。
本教程使用 PyCharm Pro 2016.1 版本创建。
创建您自己的实时模板
1. 创建一个存根实时模板
打开设置对话框(主工具栏上的
,或 Ctrl+Alt+S ),展开 编辑器 节点,然后点击 活动模板:

点击
。 首先,选择 模板组... 并指定其名称(在本例中为
user)。 创建的组获得焦点。再次点击
。 这次选择 实时模板。 新模板将出现在当前具有焦点的组中,即
user。
接下来会发生什么?
首先,在组
user下,有一个存根实时模板,目前名为<abbreviation>。其次,用于输入模板缩写、描述、正文文本和上下文的字段会显示:

2. 定义模板缩写和上下文
那么,我们来输入 模板缩写。 在本例中,我们将在 缩写 字段中键入单词 class ,然后输入描述(可选,但仍然……)。
接下来,选择新模板将应用的上下文。 此时,您会看到尚未定义上下文——因此点击链接 定义 ,并选择上下文(本例为 Python)。 以后,当上下文已定义时,该链接会变为 更改。

默认指定的展开键为 Tab。
3. 定义模板文本
在 模板文本 字段中输入以下代码:
用 $ 符号括起的模板文本部分为 模板变量。 它们以颜色突出显示,您可以轻松将其与整个模板文本区分开:

这些模板变量尚为空,因此我们先来定义它们……除了一个(稍后会知道原因)。
4. 编辑模板变量
点击按钮 编辑变量:

在 编辑模板变量 对话框中,您会看到所有变量(除了一个!)的列表:

对于变量 $object$ ,定义其默认值 object ,并点击 确定:

关于 $END$ 的说明
您可能已经注意到,模板变量 $END$ 并未显示为可编辑项。 这是因为模板变量 $END$ 是 预定义 的,因此不可编辑。 它始终表示模板展开并填写完所有必填字段后插入符号的位置。 因此,在我们的示例中,插入符号将停留在新类声明的末尾。
5. 记住新的实时模板
您只需在 设置 对话框(Ctrl+Alt+S )中点击 确定。 可展开为 Python 存根类的新实时模板(或代码片段)已准备就绪。 我们来试一下……
使用您自己的实时模板
首先,创建一个 Python 文件(Alt+Insert - Python 文件),并将其命名为 sample.py 。
新的 Python 文件会打开供编辑。 接下来,在其中创建一个类声明。 为此,输入模板缩写 class。
哇……我们的新实时模板现在出现在建议列表中——您可以通过我们以防万一输入的描述来识别它:

按 Tab 选择此选项。
如预期,该缩写会展开为一个 Python 存根类。 红线标记下一个输入点:当您键入类名(变量 class )时,它将被输入到此位置。
顺便注意,变量 class 被多次使用——在类声明中、在类构造函数的注释中。 在这种情况下, class 的字段已自动填充。
输入类名后,按 Enter ,您会看到红线(框)移动到下一个字段。 因此,您需要填写所有必填字段,最后按 Enter。

在不同 IDE 之间共享模板的示例
在 PyCharm 中创建 user 模板后,您可以在其他 IDE 中重用它以处理 Python 脚本,例如 IntelliJ IDEA。 您只需 导出 PyCharm 实时模板配置,并在 IntelliJ IDEA 中 导入 它。
