2015-01-19 6 views
1

У меня возникли проблемы с пониманием предположений фона для чтения документации Python.Понимание документации на Python: как узнать, что возвращает функция?

Пример: Документацию по функции importlib.import_module можно найти по адресу https://docs.python.org/3/library/importlib.html#importlib.import_module. Документация по функциям не указывает возвращаемое значение для функции, но она (возможно, очевидно) возвращает модуль, который он только что загрузил.

Я чувствую, что на самом деле есть много функций, для которых возвращаемое значение не указано. Я пытаюсь решить, какой из следующих вариантов ближе всего к истине.

  1. Документация по этой функции является неполной. Не будь таким параноидальным.
  2. Всякий раз, когда нет указанного возвращаемого значения, предполагается, что функция является достаточно автоматическим документированием, что вы можете ее обработать. Просто присвойте имя возвращаемому значению: foo = f(bar), а затем print(foo).
  3. Существует обычный способ узнать, что такое возвращаемое значение, и мне нужно изучить соглашение.

Case 3, очевидно, тот, который меня действительно волнует!

Любой совет будет очень благодарен.

+0

1). Любая хорошая документация должна указывать возвращаемое значение на начальных строках, либо с возвращаемым значением слева от функции, либо с помощью «Возвраты:» outdented, а затем обсуждать, что такое аргументы. К сожалению, люди, которые являются хорошими программистами, как правило, являются полными идиотами в отношении объяснения своих изобретений. Однако вы должны быть благодарны: документы python в 10 раз лучше, чем рубиновые документы. – 7stud

+0

@ 7stud Итак, вы говорите, что программисты на Ruby более хороши, чем программисты на Python? –

ответ

2

documentation for import_lib.import_module() говорит, что он возвращает.

Наиболее важным отличием является то, что import_module() возвращает указанный пакет или модуль (например pkg.mod), в то время как _ __ _import() возвращает пакет верхнего уровня или модуль (например PKG).

В целом: Документация может быть неполной в местах, если она есть, не предполагайте, что это соглашение, о котором вы ничего не знаете.

+0

Очевидно, я потерпел неудачу. Как упоминалось в 7stud, я ожидал увидеть возвращаемое значение в более подчеркнутой позиции, но должен был внимательно прочитать все это. В любом случае, спасибо за ваше терпение. –

+0

Не беспокойтесь. Я также предпочел бы формализованное описание аргументов и возвращаемое значение в документации Python. По крайней мере, в этом случае чтение текста дает вам некоторое представление о том, как вы можете решить свою проблему по-другому. – Fabian

+0

@Downvoter, позаботьтесь, чтобы объяснить, что я сделал неправильно? – Fabian