PyCharm中的那些实用功能

客官°小女子只卖身不卖艺 2022-06-11 01:22 235阅读 0赞

到目前为止，我用Eclipse已经有一些年头了，大部分的时间都是用来写Python(安装[Pydev][]插件)以及C++（安装[CDT][]插件）。

最近我从一个好友那听说了PyCharm以及它新的免费社区版[logr][]。我这个朋友用Eclipse也很长时间了，对PyCharm也是赞不绝口，所以我决定至少在家办公的时候试着用用PyCharm。目前为止，我已经深深的喜欢上了它，甚至于在日常工作时也用PyCharm（社区版采用Apache2授权）。

以下我将会介绍一些在我在使用PyCharm时感到惊奇的一些事情。

## 声明 ##

我无意批评Eclipse或者PyDev，我用了它们很多年，它们很棒！请记住，这是我的个人经验，你的或许有所不同。

## 实时比较 ##

PyCharm 对一个文件里你做的改动保持实时的跟踪，通过在编辑器的左侧栏显示一个蓝色的标记。  
![diff-1][]  
这一点非常方便，我之前一直是在Eclipse里面用命令“Compare against HEAD” 来比较一个文件前后的改动。

在PyCharm中，你可以对你的改动一览无余。同时，点击那个标记，会显示出之前的内容以及一个工具栏：  
![diff-2][]  
你可以很容易地回滚这些改动，在一个详尽的对话框中查看这些改动或是将之前的文本粘贴到剪切板上。

## 提交时的比较预览 ##

在Eclipse 中，当你提交改动时，会有一个提交对话框向你展示将要被提交的文件列表。![eclipse-commit-diff][]

你可以双击其中任意一项来查看改动的对比：这时候，如果你看到代码里一些想修改的地方（比如一个拼错的单词，一段

遗漏的文档，等等），那可就不爽了：你必须关闭所有的东西（包括带有你精心写好的提交注释的提交框），去找到那处惹人烦的代码，改正，然后从头再来一遍。

PyCharm 有同样的特性，但是你的改动是可编辑的。我简直不能再去强调可以当场修正那些错误有多么棒啦！

![pycharm-commit-diff][]

在提交过程中，我可以很容易地修复像上面那些类似的拼写错误。

一个额外好处是，无论你因为何种原因关闭了提交对话框，当再次尝试提交时，它会保留你刚才填写的那些提交注释。

## 提交时检查 ##

在提交过程中，我们还可以在实际提交前执行其他一些选项，像“优化导入（排序并移除未使用过的导入）“，检查变动集合中的待完成项等等。

![commit][]

一个有意思的地方是”执行代码分析“那一项。。。

## 代码审查 ##

你可以让PyCharm在一个文件，目录或整个项目里执行“代码审查”操作。它会在无需实际执行程序的情况下，

找出存在问题以及相应的改进办法，比如类型检查，可静态的方法，违反代码规范等等问题。

正如在上一节中解释过的，这也可以在提交时在发生改动的文件中自动完成。这是一个文件一次审查之后的结果：

![inspection][]

对于其中一些审查结果来说，你还可以应用一个修复建议。例如，对于“Function call can be replaced with set literal（）”这一建议，我们可以选择相应的选项来修复。

![inspection-2][]

PyCharm 会将这句：

Python

<table style="margin-left: 0px; font-size: 13px; border: none !important; margin-top: 0px !important; margin-right: 0px !important; margin-bottom: 0px !important; padding: 0px !important; border-collapse: collapse !important; border-spacing: 0px !important; width: auto !important; background-image: none !important; table-layout: auto !important;"> 
 <tbody style="border: 0px; margin: 0px; padding: 0px;"> 
  <tr style="background-image: none; border: none !important; margin: 0px !important; padding: 0px !important; vertical-align: top !important;"> 
   <td style="text-align: center; background-image: none; border: none !important; margin: 0px !important; padding: 0px !important; vertical-align: top !important; background-color: rgb(238, 238, 238) !important;"> 
    <div style="border: none; margin: 0px; padding-right: 0px; padding-left: 0px; background-image: none; text-align: left; white-space: nowrap; padding-top: 5px !important; padding-bottom: 3px !important; line-height: 15px !important;"> 
     <div style="border-top-style: none; border-bottom-style: none; border-left-style: none; margin: 0px; padding: 0px 5px; background-image: none; height: inherit; border-right-width: 1px !important; border-right-style: solid !important; border-right-color: rgb(222, 222, 222) !important; font-size: inherit !important; text-align: right !important; line-height: inherit !important; min-width: 1.2em !important; color: rgb(170, 170, 170) !important;">
       1 
     </div> 
    </div></td> 
   <td style="text-align: center; width: 581.40625px; background-image: none; border: none !important; margin: 0px !important; padding: 0px !important; vertical-align: top !important;"> 
    <div style="margin: 0px; padding-right: 0px; padding-left: 0px; text-align: left; white-space: pre; overflow: visible; tab-size: 4; border: none !important; padding-top: 5px !important; padding-bottom: 3px !important; background-image: none !important; line-height: 15px !important;"> 
     <div style="border: none; margin: 0px; padding: 0px 5px; background-image: none; height: inherit; font-size: inherit !important; line-height: inherit !important;"> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: rgb(0, 45, 122) !important;">extensions</span> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: rgb(0, 111, 224) !important;"> </span> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: rgb(0, 111, 224) !important;">=</span> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: rgb(0, 111, 224) !important;"> </span> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: teal !important;">set</span> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: rgb(51, 51, 51) !important;">(</span> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: rgb(51, 51, 51) !important;">[</span> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: rgb(221, 17, 68) !important;">'.avi'</span> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: rgb(51, 51, 51) !important;">,</span> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: rgb(0, 111, 224) !important;"> </span> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: rgb(221, 17, 68) !important;">'.mp4'</span> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: rgb(51, 51, 51) !important;">,</span> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: rgb(0, 111, 224) !important;"> </span> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: rgb(221, 17, 68) !important;">'.mpg'</span> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: rgb(51, 51, 51) !important;">,</span> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: rgb(0, 111, 224) !important;"> </span> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: rgb(221, 17, 68) !important;">'.mkv'</span> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: rgb(51, 51, 51) !important;">]</span> 
      <span style="border: 0px; margin: 0px; padding: 0px; height: inherit; font-size: inherit !important; line-height: inherit !important; color: rgb(51, 51, 51) !important;">)</span> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

自动替换为：

你可以关闭任何你不希望的审查，包括在项目一级。

## 重构 ##

我一直在试图重命名一个模块，可在菜单项里一直找不到那一项。。。F2也无济于事。

突然我注意到文件子菜单下面的”重构/重命名“一项，就想。。。会是它吗？果然就是！

在你重命名一个模块时，PyCharm会询问你是否需要自动修改所有与之关联的项目。有福了！

还有很多其他的重构项目，但目前为止我还没有机会一一尝试。

## 关于过时代码的提示以及改进建议 ##

PyCharm可以告诉你代码里面过时的结构块，并且提出一些改进建议。比如，我有像下面一段这样的代码：

Python

<table style="margin-left:0px; font-size:13px; border:none!important; margin-top:0px!important; margin-right:0px!important; margin-bottom:0px!important; padding:0px!important; border-collapse:collapse!important; border-spacing:0px!important; width:auto!important; table-layout:auto!important"> 
 <tbody style="border:0px; margin:0px; padding:0px"> 
  <tr style="border:none!important; margin:0px!important; padding:0px!important; vertical-align:top!important"> 
   <td style="text-align:center; border:none!important; margin:0px!important; padding:0px!important; vertical-align:top!important; background-color:rgb(238,238,238)!important"> 
    <div style="border:none; margin:0px; padding-right:0px; padding-left:0px; text-align:left; white-space:nowrap; padding-top:5px!important; padding-bottom:3px!important; line-height:15px!important"> 
     <div style="border-top-style:none; border-bottom-style:none; border-left-style:none; margin:0px; padding:0px 5px; height:inherit; border-right-width:1px!important; border-right-style:solid!important; border-right-color:rgb(222,222,222)!important; font-size:inherit!important; text-align:right!important; line-height:inherit!important; min-width:1.2em!important; color:rgb(170,170,170)!important">
       1 
     </div> 
     <div style="border-top-style:none; border-bottom-style:none; border-left-style:none; margin:0px; padding:0px 5px; height:inherit; border-right-width:1px!important; border-right-style:solid!important; border-right-color:rgb(222,222,222)!important; font-size:inherit!important; text-align:right!important; line-height:inherit!important; min-width:1.2em!important; color:rgb(170,170,170)!important">
       2 
     </div> 
    </div> </td> 
   <td style="text-align:center; width:581.40625px; border:none!important; margin:0px!important; padding:0px!important; vertical-align:top!important"> 
    <div style="margin:0px; padding-right:0px; padding-left:0px; text-align:left; white-space:pre; overflow:visible; border:none!important; padding-top:5px!important; padding-bottom:3px!important; line-height:15px!important"> 
     <div style="border:none; margin:0px; padding:0px 5px; height:inherit; font-size:inherit!important; line-height:inherit!important"> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; font-weight:bold!important">with</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(0,111,224)!important"> </span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:teal!important">nested</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(51,51,51)!important">(</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:teal!important">open</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(51,51,51)!important">(</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(0,45,122)!important">filename1</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(51,51,51)!important">)</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(51,51,51)!important">,</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(0,111,224)!important"> </span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:teal!important">open</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(51,51,51)!important">(</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(0,45,122)!important">filename2</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(51,51,51)!important">)</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(51,51,51)!important">)</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(0,111,224)!important"> </span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; font-weight:bold!important">as</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(0,111,224)!important"> </span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(51,51,51)!important">(</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(0,45,122)!important">f1</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(51,51,51)!important">,</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(0,111,224)!important"> </span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(0,45,122)!important">f2</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(51,51,51)!important">)</span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(0,111,224)!important">:</span> 
     </div> 
     <div style="border:none; margin:0px; padding:0px 5px; height:inherit; font-size:inherit!important; line-height:inherit!important"> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(0,111,224)!important"></span> 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(0,111,224)!important">&lt;</span>代码块 
      <span style="border:0px; margin:0px; padding:0px; height:inherit; font-size:inherit!important; line-height:inherit!important; color:rgb(0,111,224)!important">&gt;</span> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

PyCharm会明显的标注出nested:

![nested-obsolete][]

我用的是Python2.7，事实上你可以使用嵌套上下文管理器，但是，唉，我还得支持python的一些老版本，就保留了nested。

但PyCharm提醒了我，这个事情本身还是很酷的。

## 任务+特性 分支 ##

如同Eclipse一样（需要Mylin支持），PyCharm也支持基于任务的工作流（包括任务感知的上下文）。

然而PyCharm本身自带了很多直接可用的连接器（GitHub，Mantis，Jira，Bugzilla，等等）。

而且，当你开启一项任务时，它会询问你是否想要创建那个任务的一个特性分支，分支的名字可以配置。

![nested-obsolete][nested-obsolete 1]  
这就避免了必须手动创建一个新的分支，而这个操作确实挺繁琐的（拿到任务的ID，选择名称，等等）。

这个是加分项。

## 快速 ##

我观察到PyCharm在执行代码的自动完成时扫瞄代码的速度要远快于Eclipse，而且还不打断你当前的工作。

当你想保存一个文件时，Eclipse会阻止你这么做因为它正在后台执行一个任务，这有多惹人烦。。。

## 快速查看文档 ##

当你把光标挪到一个函数、方法，类或者别的什么上的时候，你会得到一个选项来浏览”快速文档“。看一眼：

![quick-doc][]

正如你看到的，它会用一种赏心悦目的格式展示方法的文档说明，还从代码使用说明中提示了参数的类型。。。即使该函数没有对应的文档说明，你还是会得到像下面这样的一个说明：

![quick-doc-2][]

很好！

## Docutils 支持 ##

PyCharm 还包括了对于doctils的一流支持，这让它很容易从集成开发环境中直接再生成文档。

另一方面，它还包括了一个非常好的富文本（译者注：ReST即reStructuredTexteditor）编辑器（比Eclipse的IMHO好用的多）：

![rst][]

## 完善的插件系统 ##

跟据我的使用经验，在Eclipse里面安装插件是件挺痛苦的事情：

*   很难找到你想要去的地方（提示: 帮助/安装新软件。。。）；

*  你没有一个单一的索引，所以你得去网上去找那些插件源；

*  系统有时会因为库的依赖问题而崩溃，结果我就没装上那些我想要的插件（工作中还有其他人也同样遇到这个问题，最后不得不放弃）；

PyCharm的插件体验则要流畅地多。

首先，它位于一个你认为它有可能会存在的地方：就在”设置”下面的一项：

![plugins][]  
你可以很容易地浏览插件：

![plugins-browse][]  
我快速安装了一个标记编辑器（和ReST一样），一个临时存放代码片段的插件，可以让我直接从选择的文本中快速地剪贴，并且预览代码，和SublimeText类似，还用一个漂亮的代码外观。

## 结语 ##

目前为止就这些了。我会向我的朋友尽力展示一切我认为“看这有多酷”的事情。我使用PyCharm的时间很短，如果我发现还有更多有趣的事情值得再写一篇发表的话，我会继续写。

[Pydev]: http://pydev.org/
[CDT]: http://www.eclipse.org/cdt/
[logr]: https://github.com/itghisi
[diff-1]: /images/20220611/c2dd6697bf344d16a699f522fa30de7e.png
[diff-2]: /images/20220611/a1dcad2560db429b96687ca46c1cd5c8.png
[eclipse-commit-diff]: /images/20220611/a70ef53443d34400bec4db6d085e72e3.png
[pycharm-commit-diff]: /images/20220611/58c26302d904409d86a0b11265fe0ced.png
[commit]: /images/20220611/b1f69786db004a239870b4ea1f884b7c.png
[inspection]: /images/20220611/ebaa6a3d901c40ce98ea893f625e845f.png
[inspection-2]: /images/20220611/cb5d49905a0046e1ac798f6bbbc88f1a.png
[nested-obsolete]: /images/20220611/d913a685016f4effb5c46756a63a30cb.png
[nested-obsolete 1]: /images/20220611/1385df5c7d9749318e0d58b462cf0b5b.png
[quick-doc]: /images/20220611/90726211550b4f75a45f966c5191144b.png
[quick-doc-2]: /images/20220611/e2e9be673341452fa7572d84d501cd84.png
[rst]: /images/20220611/d7179279b938462ba77d8a0e0e474331.png
[plugins]: /images/20220611/d9af6505f57d4ee2ac0c3236c60f7ffe.png
[plugins-browse]: /images/20220611/8b4f124353384f2084634ca39fbbe064.png