如何在python中查找库的功能?

时间:2018-11-07 02:18:22

标签: python documentation-generation inspect pydoc

我刚刚安装了这个库,用于抓取Twitter数据:https://github.com/kennethreitz/twitter-scraper

我想找出库的功能和方法,以便可以开始与库进行交互。我已经围绕StackOverflow进行了研究,并尝试了以下方法:

  • pydoc twitter_scraper

  • help(twitter_scraper)

  • dir(twitter_scraper)

  • 导入的检查并运行函数= inspect.getmembers(module,inspect.isfunction)

到目前为止,在我尝试过的四件事中,我仅从inspect选项得到了输出。我也不确定(不检查)这些代码是否应该放在终端或临时文件中。

在这方面还是很新的。非常感谢您阅读大家!

2 个答案:

答案 0 :(得分:1)

很好的问题!尝试使用(完全理解)新库时有几种选择。对于您的特定情况 twitter-scraper ,唯一的功能是get-tweets(),整个库的长度都在80行之内。

在一般情况下,有用性从高到低。

  1. 在GitHub上仔细阅读项目的描述。 ReadMe通常是最仔细编写的文档。
  2. 更大的库在 http://(package-name).readthedocs.org 中格式化了文档。
  3. pydoc module_name在安装模块时有效。 ``help(module_name)works in an interactive Python session after you have done an导入module_name . These both work from the "docstrings" or strategically placed comments in the source code. This is also what module_name?`在iPython中完成。
  4. dir(module_name)也需要导入。它列出了模块的所有入口点,包括许多奇数“ dunder”或双下划线,通常您不会调用或更改。
  5. 阅读源代码。通常,这比文档更容易,更完整。如果您可以在IDE中显示代码,则可以快速跳转。

您还询问了脚本中可以使用的内容:

import os

print("Welcome, human.")
print("dir() is a function, returning a list.")
print("This has no output")
a_list = dir(os)
print("but this does", dir(os))
print("The help() command uses pydoc to print to stdout")
help(os)
print("This program is gratified to be of use.")

答案 1 :(得分:0)

该库似乎缺少适当的文档,但是GitHub页面提供了一些用法示例来帮助您入门。

>>> from twitter_scraper import get_tweets

>>> for tweet in get_tweets('kennethreitz', pages=1):
>>>     print(tweet['text'])
P.S. your API is a user interface
s3monkey just hit 100 github stars! Thanks, y’all!
I’m not sure what this /dev/fd/5 business is, but it’s driving me up the wall.
…

要获取更多信息,只需查看https://github.com/kennethreitz/twitter-scraper/blob/master/twitter_scraper.py上的源代码。似乎唯一的功能是get_tweets,在查看源代码时,它带有两个参数,即用户名和页数(可选,默认为25)。