api帮助文档_查询 Python Api 文档的常见姿势[视频]

48 阅读 0 评论 32 点赞

我是靠谱客的博主自然画笔，最近开发中收集的这篇文章主要介绍api帮助文档_查询 Python Api 文档的常见姿势[视频]，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

查询 Python Api 文档的常见姿势https://www.zhihu.com/video/1122659284672102400

这次介绍几个查询Python api 文档（不限于 Python）的常用姿势，经常有人私信问我视频中用到的工具，简单介绍下。通常我使用如下几种方式来查询api 文档：

使用 IDE/编辑器插件提供的跳转功能，比如 Pycharm，Vim 的 Python-mode/jedi
在 Ipython 里使用问号(?)来查询docstring，双问号查询源码。这个技巧很多初学者不知道。如果频繁使用 Ipython，还是挺方便的
使用搜索引擎 google/baidu 等，推荐直接使用英文关键词用 google 查询，搜索正确率会高一些
使用专门的api 查询软件，比如 mac 下的 Dash(dash甚至提供了很多编辑器插件)，windows和linux尝试下 Zeal。或者网页版 https://devdocs.io/

对于使用 python-mode 无法查找定义的朋友注意下：

python-mode 使用 rope 插件实现的补全和跳转，如果找不到定义，你编辑下项目里的 .ropeproject/config.py 。加入这个 prefs.add('python_path', '/usr/local/lib/python2.7/site-packages/') 就可以了。当然这个路径需要根据你的系统而定。一般是在项目根目录里配置这个 .ropeproject/config.py

视频里我会针对每一种方式来进行演示，希望对你有帮助。如果你有一些好用的工具软件可以留言分享交流呦。