2016-02-02 5 views
-3

Каков оптимальный способ получения документации о конкретной функции в Python? Я пытаюсь загрузить данные о ценах акций, чтобы я мог просматривать их в своей IDE Spyder.Документация по конкретным функциям в Python

Функция Я интересует:

ystockquote.get_historical_prices 

Как узнать, сколько входов функция принимает, типы входов он принимает, и формат даты, например?

+2

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

+0

Прошу прощения, я новичок. Как использовать функцию помощи Python? – jessica

+2

Это метод. Вы просто указываете параметры справки, такие как функция: help (ystockquote.get_historical_prices). Вы также можете попробовать googling: https://pypi.python.org/pypi/ystockquote –

ответ

0

Просто найти документацию

Я подозреваю, этот вопрос был супер-downvoted, потому что очевидный ответ на look at the documentation. Это зависит от того, откуда была ваша функция, но поиск в Интернете - это, как правило, хороший способ ее найти (я нашел класс here за несколько секунд поиска в Интернете).

Это также очень trivialy просто проверить исходный код

Для того, чтобы импортировать функцию, вы должны знать, где исходный файл, он приходит из вне; откройте этот файл: в python, docstrings are what generate the documentation и можно найти в тройных кавычках под объявлением функции. Аргументы могут быть выведены из сигнатуры функции, но из-за того, что python динамически типизирован, любые требования к типу - это просто предложения. Некоторые хорошие документаторы также предоставят оптимальные типы.

В то время как «как мне Google для документации» не является подходящим вопросом, вопрос о том, как с динамически выводить документацию является более разумным. Ответ

  1. help функция, построенная в here
  2. файл __doc__ доступны на любом объекте питона, как строка
  3. Использование inspection

вопрос еще разумно, если вы работаете с расширениями python, например, из внешних пакетов. Я не хочу, чтобы пакет, о котором вы специально спросили, имеет какие-либо из них, но с ними может быть сложно работать, если авторы не определили docstrings в модуле. Проблема в том, что в этих случаях печатать может быть жестко проинформированным. В этом случае нет отличного способа получить требования tpye, как inspection will fail. Однако, если вы можете получить исходный код (возможно, по поисковому запросу), this is where the documentation would be provided

Смежные вопросы