Ответ 1
Посмотрите папку python в папке: Doc
. Эта папка содержит всю загруженную документацию документов python из python.org. Я знаю, что это ОЧЕНЬ поздний ответ, но он предлагает легкое решение.
В python я могу получить некоторую рудиментарную документацию для любого объекта, используя help(<object>)
. Но чтобы иметь возможность искать документацию, мне нужно выйти в интернет. Это не очень полезно, если я где-то там, где интернет недоступен.
В R имеется удобная функция двойного вопросительного знака (??<topic>
), которая позволяет мне искать документацию обо всех установленных библиотеках для любой функции, которая включает <topic>
в ее название или строку документации. Есть ли что-то подобное для python? Возможно, даже для загруженных объектов?
Посмотрите папку python в папке: Doc
. Эта папка содержит всю загруженную документацию документов python из python.org. Я знаю, что это ОЧЕНЬ поздний ответ, но он предлагает легкое решение.
pydoc поставляется с python и может выполнять поиск, но только в синтаксисе доступных модулей. Цитирование pydoc --help
:
pydoc -k Search for a keyword in the synopsis lines of all available modules.
Обратите внимание, что в pydoc вы можете выполнять поиск с помощью "/".
Просто добавьте еще один вариант для автономного доступа к документам python (главным образом ядро):
В настоящий момент у меня нет доступа к Linux-компьютеру, но в окнах вы можете перейти к your_python_dist_folder/doc
, чтобы найти файлы справки. Особенно python275.chm
, например.
Если на вашей Linux-машине нет папки doc, вы можете загрузить файл здесь и google для просмотра в режиме linux chm:
https://www.google.com/search?q=linux+chm+viewer
:: Примечание:
Некоторые дистрибутивы также включают документы для других пакетов там... может стоить проверить. Кроме того, help(module)
обычно возвращает хорошую информацию.
Edit
Вы можете получить что-то, что может быть немного ближе к тому, что вы хотите, используя pydoc
. Например. вы ищете что-то о sin
в математическом модуле:
import math
import pydoc
[i for i in dir(math) if 'sin' in pydoc.getdoc(getattr(math,i))]
Это вернет методы, docstrings которых включают sin
:
['acos', 'acosh', 'asin', 'asinh', 'cos', 'cosh', 'isinf', 'sin', 'sinh']
для которого вы могли бы запустить функцию help()
В случае, если вы работаете на Mac, Dash, который позволяет загружать docsets, а затем исследовать/искать в автономном режиме. Несмотря на функциональность документации, Dash также является Менеджером фрагментов.
Это уже упоминалось в комментариях: Zeal похож на Dash, но для Windows/Linux. Он использует те же источники, что и Dash. Он построен с использованием Qt и доступен в репозиториях для нескольких дистрибутивов, для Ubuntu существует PPA. Скачайте здесь.
Zeal - это простой автономный браузер документации API, основанный на Dash (OS X app), доступный для Linux и Windows.
- Быстрый поиск документации с помощью Alt + Space (или настроенной) горячей клавиши для отображения Zeal из любого места в вашей рабочей области.
- Искать в нескольких наборах документации сразу.
- Не зависимо от вашего интернет-соединения.
- Интегрируйте Zeal с Emacs, Sublime Text или Vim. См. Использование "Редактор плагинов для деталей.
Это с открытым исходным кодом (GPL), разработка происходит на GitHub. Zeal использует те же таблицы стилей /HTML, что и онлайн-документы, поэтому все должно выглядеть знакомым.
Альтернатива в браузере - devdocs.io. Вы можете получить доступ к веб-сайту, даже если вы в автономном режиме, при условии, что вы пометили их для локального автономного хранилища. Вам нужно включить документы Python 2, а затем пометить их для автономного хранилища здесь. Однако, будучи давним пользователем онлайн-документов Python, я нахожу пользовательскую таблицу стилей, которая DevDocs использует немного отвлекающую.
Windows Idle - F1 из окна оболочки или окна редактирования получает файл справки Windows всех документов. Я думаю, что это лучше, чем онлайн-версия - легче найти материал.
Несмотря на то, что в вашем компьютере, безусловно, есть более качественная документация, чем help(), например, бездействовать в Windows, другой вариант для некоторых из наиболее распространенных тем - просто сохранить часть онлайн-документации на вашем компьютере. Для модулей, которые вы используете много, и вы хотите получить доступ к офлайн, вы можете просто загрузить текстовую версию официальной онлайн-документации python, которая является лучшим местом для получения документации. (файл > сохранить страницу как > выбрать формат файла .txt)
Вам следует попробовать ipython.
имя_объекта будет печатать всевозможные сведения о любом объекте, включая docstrings, строки определения функций (для аргументов вызова) и детали конструктора для классов.
Магические команды% pdoc,% pdef,% psource и% pfile будут соответственно печатать docstring, строку определения функции, полный исходный код и полный файл для любого объекта (когда они могут быть найдены). Если автомат включен (по умолчанию), вам не нужно набирать "% явно".
Возможно, это не было доступно в момент запроса и ответа на вопрос, но теперь python.org делает всю документацию доступной в Интернете в виде архива файлов HTML, которые можно перемещать и искать в автономном режиме: https://docs.python.org/2/download.html
(ссылка ссылается на документы для последней версии 2.x, но вы можете выбрать версии 3.x и более ранних версий 2.x с этой страницы)