理解Python文档:如何知道函数返回的内容?

时间:2015-01-19 09:33:46

标签: python conventions

我无法理解阅读Python文档的背景假设。

示例:importlib.import_module功能的文档可在https://docs.python.org/3/library/importlib.html#importlib.import_module找到。函数文档没有为函数指定返回值,但它(显然可能)返回刚刚加载的模块。

我觉得实际上有很多函数没有指定返回值。我试图决定下列哪个选项最接近事实。

  1. 此功能的文档恰好不完整。不要那么偏执。
  2. 每当没有指定的返回值时,假定该函数足以自动记录您可以解决的问题。只需为返回值指定一个名称:foo = f(bar)然后print(foo)
  3. 有一种传统的方法可以知道返回值是什么,我需要学习惯例。
  4. 案例3显然是真正让我担心的事情!

    非常感谢任何建议。

1 个答案:

答案 0 :(得分:2)

documentation for import_lib.import_module()说出它返回的内容。

  

最重要的区别是import_module()返回   指定的包或模块(例如pkg.mod),而_ _import __()返回   顶级包或模块(例如pkg)。

一般来说:文档可能在某些地方不完整,如果是,请不要认为这是一个你一无所知的惯例。