[Pycharm] Magic editor in Pycharm

　　如你所见，这里规定的缩进尺寸为4个空格，Pycharm按照这个规则来进行代码的自动生成以及格式检查reformatting。固然咱们更改缩进规则（就和修改其余代码规则同样）。假设你但愿缩进个数为5个空格，即生成的全部新的代码相对于上层代码的缩进个数均为5个空格。浏览Smart Keys页面得到更详细的信息。

(2) 语法自动补全

　　接下来咱们测试一个更复杂的状况——编辑一个Django模板。对于语法很是复杂的Django模板，语法自动补全功能就显得相当重要。OK，开始输入一个Django标签

　　一旦你键入一个花括号，Pycharm就会自动补全另一个：

　　而且光标会停在两个%之间，方便咱们输入代码：

　　相似的，对于{{标志Pycharm一样会自动补全另一半。

　　语法自动补全功能的相关设置位于编辑器设置的Smart Keys页面：Ctrl+Alt+S→IDE Settings→Editor→Smart Keys:

　　举个例子，若是但愿Pycharm可以自动补全圆括号、方括号等，须要勾选Insert pair bracket复选框；

　　要想自动补全引号则须要勾选Insert pair quote复选框。

　　对于Django模板，有一个专门的复选框Auto-insert closing }} and %} in Django templates以供选择。

(3) 代码自动补全

　　首先，咱们实例化一个类，Pycharm会当即显示一个红色灯泡来给出快速补全的建议：

i. 自动建立一个"类"

这里咱们但愿建立一个类，选择对应的提示命令，Pycharm会根据名称自动建立一个类。

ii. 类的成员函数

　　接下来咱们调用这个类的成员函数（通常状况下，一旦你在类名后面输入一个点号，Pycharm的代码补全机制就会列出当前可用的函数名称，然而在这里咱们所用的成员函数尚未在类中进行建立）。

　　一样的情形，选择建立该方法，而后观察PyCharm如何生成成员函数：

　　iii. 类的成员变量

　　接下来咱们准备向类中添加一个成员变量"color"，Pycharm会提示咱们建立一个成员变量：

　　iv. 类的构造函数

　　OK，Pycharm智能的完成了变量的建立添加——建立了一个构造函数：

　　v. 类的全局函数

　　最后，也能够经过Pycharm智能建立一个全局函数：

　　vi. 自动导入模块

　　a) 关闭自动导入功能

　　按下Alt+Enter，采起快捷菜单中的建议，此时import命令会被添加到导入模块的代码部分，而且输入光标仍留在原位，方便咱们继续输入而无需重定位：

　　这里有一个小问题，若是这个窗口出现让你很烦恼，不要着急，单击右下角那个帅哥就能够关闭它了：

　　单击那个帅哥头像会弹出一个窗口，取消Import popup复选框，此时就取消了自动导入的功能。固然在配置对话框的Auto-Import page页面也能够进行一样操做（Settings → Editor → Auto-Import）：

　　固然，若是你但愿关闭导入助手，直接取消这一项的勾选便可（Settings → Editor → Auto-Import）。

　　当导入助手关闭时，没必要惊慌。

　　此时Pycharm不会直接给出提示，但会以红色波浪线标记缺失模块的代码位置，同时在左侧显示一个红色灯泡，单击这个灯泡，或者按下Alt+Enter快捷键。

　　b) 优化自动导入功能

　　当你在完善代码的过程当中，总会中止使用一些导入声明（例如调试代码所对应的库，在调试完成后就再也不起做用）。然而这些import声明仍然存在于你的工程中，你不得不停下来从头搜索，找出并删除这些声明语句，这种作法不只效率低并且容易出错，极可能会多删或者漏删。

　　Pycharm可以帮助咱们处理掉这些冗余的import声明语句，也就是所谓的 Optimize Imports功能，这个功能可以帮助你随时删除工程中的冗余import声明语句。

　　注意到，在Pycharm编辑环境中那些冗余的imports语句都是灰色显示的：

　　为了移除这些冗余语句，按下Ctrl+Alt+O（或者选择Code → Optimize Imports菜单命令），Pycharm弹出以下对话框，提示你选择须要清理的文件（当前文件仍是当前目录下的全部文件）：

　　单击OK，清理完成：

　　vii. 自动拼写提示

固然若是你想关闭拼写提示功能，能够经过Ctrl+Alt+S → Settings → Editor → Code Completion命令打开拼写提示功能对话框，取消Autopopup code completion in (ms)复选框的勾选便可。

而后你就须要将选中的名称插入到当前位置，Pycharm提供了两种插入方法：

按下回车，对应变量会添加到当前光标的位置。
按下Tap键，选中的名称会替换掉当前光标右侧的字符串。 // <-- 不错哦

　　按下Ctrl+Alt+S打开设置对话框，展开Editor节点，单击 Code Completion页：

　　如你所见，Pycharm容许咱们对拼写提示功能作各类各样的更改以知足需求，若是你不清楚某些选项的具体功能，单击Help按钮获取帮助信息。

　　更多拼写提示功能相关信息参见this link。

(4) Warming提醒

　　i. 灯泡提醒

　　咱们常常发如今程序中会弹出一个亮着的灯泡，它是用来干什么的？

黄色灯泡意味着Pycharm对你当前编写的代码提出了一些建议，此时的程序并无什么错误，可是能够对其进行一些改进，例如添加几行说明文档等等。另一个做用就是建立使用源，好比当你使用了一个尚不存在的函数，Pycharm会经过这种方式来提醒你去建立它。
红色灯泡则意味着Pycharm发现当前代码中存在错误而给出的修正建议，例如须要导入缺失的第三方库、源文件丢失等等。Pycharm会给出快捷方便的纠错提醒。

　　Pycharm将给出的各类各样的修改建议显示在建议列表中，能够经过如下方式打开建议列表：

　　　　单击灯泡图标。

　　　　按下Alt+Enter快捷键。

　　更多相关信息参见Intention Actions。

　　ii. 代码错误提示

　　若是Pycharm在对代码分析的过程当中发现了错误，则会按照如下方式给出提示：

　　用红色波浪线标记错误代码，鼠标悬停在波浪线上时会给出详细的错误信息。

　　标题栏的文件名也会用红色波浪线标记，在项目窗口中的目录也会有一样的标记。

　　在右槽的对应位置显示错误标识，鼠标指针悬停在上方时会给出详细错误信息。

　　这些错误标识也能够起到导航做用，帮助咱们快速定义错误发生的位置。

　　在右槽顶端显示整个文件的状态标识。

　　绿色带便一切正常，
　　黄色表明存在一些警告，
　　红色表明存在错误。

　　固然这种错误提示机制的配色方案也是能够更改的，在字体及颜色设置对话框中的General页面进行设置（Ctrl+Alt+S→IDE Settings→Editor→Colors and Fonts→General）：

　　注意窗口左下角的帅哥头像：

　　他的名字叫Hector-the-Inspector，负责代码的纠错检查，单击这个头像，会弹出一个窗口，里面有代码的高亮程度调节器：

　　若是你对本身的编程水平颇有自信，那么你能够向左拖动到Syntax或者Hector头像None。

　在Syntax位置，系统只会对语法错误给出高亮提示，Hector头像只剩一半。
　在None位置，代码纠错功能彻底关闭，编程速度更快，但也更容易出错，对应Hector头像消失。

　　不过这种更改只对当前文件有效。

　　若是你想更改代码纠错机制，单击Configure inspections连接，更多有关代码纠错机制的信息参见Code Inspections中的code inspection tutorial。

代码折叠 + 环绕注释

　　四、默认代码块的折叠规则

　　　　默认状况下折叠先会标记类和函数的实现部分，折叠也是针对这部分代码块进行的，即默认折叠一个类、一个函数。

　　五、折叠任意代码片

　　　　假设，你但愿折叠几句零散的程序，而这些语句并不属于默承认折叠的代码块（不是一个完整的类或函数），如何作到？

　　　　首先选中你但愿折叠的代码片

　　　　而后进行如下操做（三选一便可）：

- 在主菜单选择Code | Folding | Fold Selection/Remove Region菜单命令。
- 右击选中的代码片，在快捷菜单中选择Folding | Fold Selection/Remove Region
- 按下Ctrl+Period快捷键

　　　　此时选中的代码片被折叠隐藏。

　　　　须要注意的就是所选代码片应该位于类体或者函数体内，若是咱们选择了类或函数开头的定义部分，是没法对这部分代码进行折叠隐藏的。

　　六、使用双行注释来注释代码

　　Pycharm提供了两种逻辑代码块环绕注释方式surround：

　　VisualStudio模式：

　　NetBeans模式：

　　具体操做以下：

　　（1）选中待环绕注释的代码块

　　（2）如下操做二选一

　　　　使用Code | Surround with主菜单命令

　　　　按下Ctrl+Alt+T

　　（3）在弹出的快捷菜单中选择须要的注释风格：

　　（4）输入一些必要的注释描述

　　当经过这种方法对代码片进行环绕注释以后，折叠开关会显示在注释行左侧：

　　单击折叠开关可折叠对应代码片，只显示添加的环绕注释信息：

　　更多有关代码折叠功能的信息参见here。

模板应用

Pycharm自带了不少灵活的模板，但针对python自己的模板只有一个。这里咱们将详细介绍如何针对Python类来建立模板并使用。

　　对于Python编程以及基本模板的使用咱们这里再也不赘述。关于模板的类型、缩写、变量名、以及存储的相关信息参见Live Templates；模板的使用方法参见 Creating Code Constructs by Live Templates。

　　四、建立一个根模板

　　打开设置对话框（单击工具栏的设置按钮，或者按Ctrl+Alt+S快捷键），在IDE Settings设置下单击Live Templates：

　　单击绿色加号，等待奇迹。

　　首先，注意到在user下面出现了一个新的分组。

　　其次，选中user组后出现一个名为<abbreviation>的根模板

　　最后，界面上有缩写、描述说明、模板内容等输入窗口。

　　五、指定模板的缩写和上下文环境

　　　　(1) 第一步，输入模板缩写 template abbreviation，这里定义为class。

　　　　(2) 而后输入描述说明description（可选），指定模板应用的上下文环境（这里选择Python）：

　　　　(3) 最上方expansion值选择默认的Tap便可。

　　六、定义模板文本

　　在模板文本栏中输入如下代码：

　　其中使用$标记包围的部分为模板变量template variables，Pycharm将其标记为红色方便咱们辨认：

　　这些模板变量目前为空，接下来咱们对其进行定义。

　　四、编辑(模板文中的)模板变量

　　点击Edit variables按钮：

　　在Edit template variables对话框中显示了当前的模板变量列表：

　　对于变量$object$，咱们给出其缺省值（object），单击OK按钮：

　　上面列表中所显示的变量并不包含 $END$，可见Pyhcarm不但愿咱们对其进行更改。

　　这是由于 $END$已经进行了预约义，所以是不可编辑状态。它用来指示模板展开后输入光标的默认位置，方便咱们对模板对应的代码进行完善。咱们这里这个光标会默认置于类声明以后。

　　五、保存自定义模板

　　很是简单，单击设置窗口中的OK按钮便可。

　　六、使用自定义模板

　　首先，建立一个Python文件，这里命名为myPythonFile：

　　编辑这个新建的Python文件。接下来咱们在其中建立一个类声明。输入模板缩写class，会发现咱们自定义的模板已经出如今提示列表中了，没错，就是咱们刚才定义的那个：

　　按下Tap键选择该项。

　　正如指望的那样，缩写名成功扩展成为了一个基本的Python类。红色下划线标记了接下来指望输入的位置，当你输入类名时（对应模板变量class），就会插入到当前红色波浪线所在位置：

　　注意这里的模板变量class已经应用两次了：在类的声明语句和构造函数中。在构造函数中Pycharm对其进行了自动填充（填充为self）。

　　输入类名，回车，红色波浪线移动到下一行，输入对应内容，最后回车：

　　最终，光标定位在类末尾。

　　更多自定义模板信息参见Creating Code Constructs by Live Templates。

宏操做

　　一、为何使用宏

　　加入你须要重复某种操做不少次，例如选中源码并将其发送到控制台端调试，咱们能不能将着一系列重复的操做简化为一步，甚至用一组快捷键来代替呢？

　　三、录制宏

　　在主菜单上选择Edit→Macros→Start Macro Recording命令，在窗口底部出现Macro recording started的提示信息。

　　打开你想要执行的脚本文件（注意Using Macros in the Editor中所描述得列表限制），而后进行对应的需求操做：

　　（1）全选编辑器中的代码（例如在编辑窗口中按下Ctrl+A）

　　（2）右击，在弹出的快捷菜单中选择Execute selection in console命令

　　而后单击主菜单的Edit→Macros→Stop Macro Recording命令，Pycharm会提示你保存当前记录的宏。

　　此时若是未指定宏明，Pycharm会将其设定为一个临时的宏命令，这里咱们将这个宏命名为 "Run in console"：

　　此时，再次查看Edit→Macros菜单，咱们会在列表中发现咱们刚刚定义的宏命令。

　　四、为宏命令指定快捷键

　　接下来咱们为这条宏命令指定一个快捷键组合，作法以下。

　　在设置对话框中，打开Keymap页，展开Macros节点，找到咱们新添加的宏命令"Run in console"，右击，在弹出的快捷菜单中选择Add keyboard shortcut：

　　接下来，在Enter keyboard shoctrut dialog对话框中指按期望的快捷键组合。注意此时咱们只能经过鼠标指针来单击对话框中的控件，任何键盘操做都会被认为是快捷键的设置内容。

　　如你所见，系统并未提示相关快捷键冲突，咱们的设置可用，单击应用并关闭对话框。此时新增的快捷键会显示在菜单中：

　　五、宏命令的使用

　　如今咱们完成了一个宏命令的私人订制。

　　此时咱们能够在控制台端运行任何已打开的脚本文件。咱们能够经过菜单命令Edit→Macros→Run in console来实现，也能够经过快捷键Alt+R来更为快捷的完成这个功能。咱们尝试一下：

　　在编辑器中打开另一个脚本文件，按下Alt+R，OK，脚本被自动加载到了控制台中并运行：

帮助文档

　　二、快速查看定义

　　当你只是想知道相关的声明信息时，不妨使用Quick definition，而无需跳转到实际的定义位置。

　　例如，将光标定位在一个表达式上，而后在主菜单中选择View→Quick Definition：

　　你能够在弹出的窗口中看到相关的快速定义信息，而后经过方向键来移动浏览整个提示信息。

　　单击按钮，在Find tool window窗口中找到快速定义信息：

　　三、快速查看帮助文档

　　快捷（帮助）文档显示了当前符号的文档注释以及相关注释符。咱们再次将光标定位在某个表达式上，此次咱们使用View→Quick Documentation的菜单命令。

　　在弹出的窗口中咱们一样能够经过左右方向键来浏览这个文档信息：

　　固然咱们能够调整弹出窗口的大小。单击弹出尺寸调节滚动条，拖动滑块来改变当前尺寸：

　　单击按钮，在Documentation tool window窗口中打开快速帮助文档：

　　单击恢复到原来的窗口形式。

　　四、查看外部文档

　　这个命令容许你经过默认浏览器查看详细帮助文档信息：

　　顺便提一句，你能够经过quick documentation pop-up window来打开外部帮助文档，能够单击或者按下Shift+F1快捷键。

　　外部文档用到的PyQt4，PySide，gtk，wx，numpy，scipy，和kivy等第三方库都是默认版本的，若是你想查看其它版本下的帮助文档，例如Pyramid，请到 Python External Documentation对应位置参考。

　　五、浏览参数信息

　　这个命令能够显示函数方法的形参信息：

　　六、浏览环境上下文信息

　　最后，你能够经过弹出窗口来浏览代码块开始部分的特定的符号信息。举个例子，咱们将光标定位在一个exception上，而函数的声明位于当前可视编辑范围以外，而后按下Alt+Q或者View→Context Info菜单命令：