Как искать справку с помощью консоли Python

Question

Есть ли способ поиска определенного пакета / функции по ключевым словам в консоли Python?

Например, я могу поискать в «pdf» задачи, связанные с pdf.

Answer 1

Флаг pydoc -k ищет документацию.

pydoc -k <keyword>
    Search for a keyword in the synopsis lines of all available modules.

Из терминала запустите ..

$ pydoc -k pdf

.. например:

$ pydoc -k pdf
PdfImagePlugin 
wx.lib.pdfwin 
PIL.PdfImagePlugin

Он не ищет содержимое документации, но ищет все имена модулей - если этого недостаточно, я бы предложил использовать Google или StackOverflow для поиска «Python PDF module» или аналогичного

Answer 2

Вы можете использовать справку для доступа к строкам документов различных импортированных вами модулей, например, попробуйте следующее:

help(math)

и вы получите ошибку,

import math
help(math)

и вы получите список доступных методов в модуле, но только ПОСЛЕ того, как вы его импортировали. Он также работает с отдельными функциями, например, после импорта математики попробуйте:

help(math.sin)

Для работы с pdf вам, вероятно, придется установить сторонний модуль. Быстрый поиск привел меня к этому результату, который я не пробовал:

http://www.devshed.com/c/a/Python/Python-for-PDF-Generation/

Answer 3

help ("модули")

>>> help( "modules" )

Please wait a moment while I gather a list of all available modules...

C:\Program Files\Python26\lib\pkgutil.py:110: DeprecationWarning: The wxPython compatibility package is no longer automatically generated or actively maintained.  Please switch to the wx package as soon
  __import__(name)
ArgImagePlugin      WmfImagePlugin      dbhash              pyclbr
BaseHTTPServer      XVThumbImagePlugin  decimal             pydoc
Bastion             XbmImagePlugin      difflib             pydoc_topics
BdfFontFile         XpmImagePlugin      dircache            pyexpat
BmpImagePlugin      _LWPCookieJar       dis                 quopri
BufrStubImagePlugin _MozillaCookieJar   distutils           random
CGIHTTPServer       __builtin__         doctest             re
Canvas              __future__          dumbdbm             repr
ConfigParser        _abcoll             dummy_thread        rexec
ContainerIO         _ast                dummy_threading     rfc822
Cookie              _bisect             email               rlcompleter
CurImagePlugin      _bsddb              encodings           robotparser
DcxImagePlugin      _bytesio            errno               runpy
Dialog              _codecs             exceptions          sched
DocXMLRPCServer     _codecs_cn          filecmp             select
EpsImagePlugin      _codecs_hk          fileinput           sets
ExifTags            _codecs_iso2022     fnmatch             sgmllib
FileDialog          _codecs_jp          formatter           sha
FitsStubImagePlugin _codecs_kr          fpformat            shelve
FixTk               _codecs_tw          fractions           shlex
FliImagePlugin      _collections        ftplib              shutil
FontFile            _csv                functools           signal
FpxImagePlugin      _ctypes             future_builtins     site
GbrImagePlugin      _ctypes_test        gc                  smtpd
GdImageFile         _elementtree        genericpath         smtplib
GifImagePlugin      _fileio             getopt              sndhdr
GimpGradientFile    _functools          getpass             socket
GimpPaletteFile     _hashlib            gettext             sqlite3
GribStubImagePlugin _heapq              glob                sre
HTMLParser          _hotshot            gzip                sre_compile
Hdf5StubImagePlugin _imaging            hashlib             sre_constants
IcnsImagePlugin     _imagingft          heapq               sre_parse
IcoImagePlugin      _imagingmath        hmac                ssl
ImImagePlugin       _imagingtk          hotshot             stat
Image               _json               htmlentitydefs      statvfs
ImageChops          _locale             htmllib             string
ImageColor          _lsprof             httplib             stringold
ImageDraw           _md5                idlelib             stringprep
ImageDraw2          _msi                ihooks              strop
ImageEnhance        _multibytecodec     imageop             struct
ImageFile           _multiprocessing    imaplib             subprocess
ImageFileIO         _random             imghdr              sunau
ImageFilter         _sha                imp                 sunaudio
ImageFont           _sha256             imputil             symbol
ImageGL             _sha512             inspect             symtable
ImageGrab           _socket             io                  sys
ImageMath           _sqlite3            itertools           tabnanny
ImageMode           _sre                json                tarfile
ImageOps            _ssl                keyword             telnetlib
ImagePalette        _strptime           lib2to3             tempfile
ImagePath           _struct             linecache           test
ImageQt             _subprocess         locale              textwrap
ImageSequence       _symtable           logging             this
ImageStat           _testcapi           macpath             thread
ImageTk             _threading_local    macurl2path         threading
ImageTransform      _tkinter            mailbox             time
ImageWin            _warnings           mailcap             timeit
ImtImagePlugin      _weakref            markupbase          tkColorChooser
IptcImagePlugin     _winreg             marshal             tkCommonDialog
JpegImagePlugin     abc                 math                tkFileDialog
McIdasImagePlugin   aifc                md5                 tkFont
MicImagePlugin      anydbm              mhlib               tkMessageBox
MimeWriter          array               mimetools           tkSimpleDialog
MpegImagePlugin     ast                 mimetypes           toaiff
MspImagePlugin      asynchat            mimify              token
OleFileIO           asyncore            mmap                tokenize
PIL                 atexit              modulefinder        trace
PSDraw              audiodev            msilib              traceback
PaletteFile         audioop             msvcrt              tty
PalmImagePlugin     base64              multifile           turtle
PcdImagePlugin      bdb                 multiprocessing     types
PcfFontFile         binascii            mutex               unicodedata
PcxImagePlugin      binhex              netrc               unittest
PdfImagePlugin      bisect              new                 update_manifest
PixarImagePlugin    bsddb               nntplib             urllib
PngImagePlugin      bz2                 nt                  urllib2
PpmImagePlugin      cPickle             ntpath              urlparse
PsdImagePlugin      cProfile            nturl2path          user
Queue               cStringIO           numbers             uu
ScrolledText        calendar            opcode              uuid
SgiImagePlugin      cgi                 operator            warnings
SimpleDialog        cgitb               optparse            wave
SimpleHTTPServer    chunk               os                  weakref
SimpleXMLRPCServer  cmath               os2emxpath          webbrowser
SocketServer        cmd                 parser              whichdb
SpiderImagePlugin   code                pdb                 winsound
StringIO            codecs              pickle              wsgiref
SunImagePlugin      codeop              pickletools         wx
TarIO               collections         pipes               wxPython
TgaImagePlugin      colorsys            pkgutil             wxversion
TiffImagePlugin     commands            platform            xdrlib
TiffTags            compileall          plistlib            xml
Tix                 compiler            popen2              xmllib
Tkconstants         contextlib          poplib              xmlrpclib
Tkdnd               cookielib           posixfile           xxsubtype
Tkinter             copy                posixpath           zipfile
UserDict            copy_reg            pprint              zipimport
UserList            csv                 profile             zlib
UserString          ctypes              pstats
WalImageFile        curses              pty
WbmpImagePlugin     datetime            py_compile

Enter any module name to get more help.  Or, type "modules spam" to search
for modules whose descriptions contain the word "spam".

>>>

Answer 4

Вы можете искать модули, содержащие «pdf» в своем описании, выполнив команду help("modules pdf").

Answer 5

пункт - отличный ресурс. Если pip установлен (если у вас его нет, инструкции здесь ), то с помощью командной оболочки Windows вы можете сделать следующее:

pip search pdf

Возвращает множество опций.

C:\Python27\Scripts>pip search pdf
mwlib.rl                  - generate pdfs from mediawiki markup
slc.publications          - A content type to store and parse pdf publications
PyPDFLite                 - Simple PDF Writer.
pdfminer                  - PDF parser and analyzer
zopyx.convert             - A Python interface to XSL-FO libraries (Conversion
                            HTML to PDF, RTF, DOCX, WML and ODT)
WeasyPrint                - WeasyPrint converts web documents to PDF.
zopyx.convert2            - A Python interface for the conversion of HTML to
                            PDF, RTF, DOCX, WML and ODT) - belongs to
                            zopyx.smartprintng.core
collective.pdfpeek        - A Plone 4 product that generates image thumbnail
                            previews of PDF files stored on ATFile based
                            objects.
pisa                      - PDF generator using HTML and CSS

и т.д.

Answer 6

(годы спустя) я сейчас использую pip search
и yolk -M или -H имя_пакета: -M для метаданных, -H для просмотра веб-страницы.

---

Для локального поиска информации о пакете PyPI (индекс пакета Python) попробуйте pypi-grep. Пример: pypi-grep 'pyqt' ->

# day  status  packagename  version  homepage  summary
2009-06-07  3  "pydee"  0.4.11  http://code.google.com/p/pydee/
    Pydee development environment and its PyQt4-based IDE tools: ...
2009-06-05  4  "Sandbox"  0.9.5  http://www.qtrac.eu/sandbox.html
    A PyQt4-based alternative to IDLE
...

pypi-grep - это просто файл с одной длинной строкой для каждого пакета PyPI, с информацией, которую вы видите выше, плюс тривиальный скрипт bash для egrep файла.
Зачем ? Поиск локального файла очень быстрый и очень простой, для старых Unix парни и простые поиски: "что такое XYZ?"

hg clone http://bitbucket.org/denisb/pypi-grep/ следует загрузить pypi-grep и pypi-grepfile-2009-06-08 или т.п .; переместите их в каталог в вашем PATH. (Сначала easy_install hg, если у вас нет hg.)

Примечания:

pypi-grepfile имеет только одну версию для каждого пакета, самую новую; многострочные резюме складываются в одну длинную строку (который я рублю с pypi-grep | less -iS).

pypi-grep -h перечисляет несколько вариантов

Данные поступают с http://pypi.python.org/pypi xmlrpc, но будьте осторожны: некоторые пакеты в list_packages не имеют package_releases или не выпущены данные, и несколько тайм-аутов освобожденных данных (Timeout_xmlrpclib); то, что вы видите, - это все, что вы получаете.

Обратная связь приветствуется.

Answer 7

В справке типа консоли (объект):

Python 2.6.2 (r262:71600, Apr 21 2009, 15:05:37) [MSC v.1500 32 bit (Intel)] on
win32
Type "help", "copyright", "credits" or "license" for more information.
>>> help(dir)
Help on built-in function dir in module __builtin__:

dir(...)
    dir([object]) -> list of strings
....    

К сожалению, нет помощи для pdf:

>>> help(pdf)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'pdf' is not defined
>>>

Как сказал paffnucy, попробуйте поискать в Интернете (ТАК очень хорошо работает:)

Этот сайт также может быть полезен: http://www.gotapi.com/python

Answer 8

Мышление рекурсивно:

>>> help(help)

Help on _Helper in module site object:

class _Helper(builtins.object)
 |  Define the builtin 'help'.
 |  This is a wrapper around **pydoc.help** (with a twist).
 |  

...

отсюда:

>>> import pydoc
>>> help(pydoc)
Help on module pydoc: ....

много важной информации о поиске в документации по Python.

Answer 9

1. help (название функции)
2. если вы используете ноутбук jupyter или ipython, то добавьте «?» принес бы собачью строку для кода. это полезно, если вы хотите увидеть справку по конкретной функции. Например, pandas.read_csv?.
3. , нажав «Tab», вы можете увидеть, что вам нужно ввести в качестве параметров, хотя это не даст информацию о том, что делает функция, но обеспечит способ ввода входных параметров.

Answer 10

Попробуйте help() или dir(). AFAIR нет встроенной поддержки задач, связанных с PDF в простой установке Python. Еще один способ найти помощь для модулей Python - это Google;)

Документы:

http://docs.python.org/library/functions.html#help

http://docs.python.org/library/functions.html#dir

EDIT:

>>> import os
>>> def search_help(keyword):
...     os.system('python Lib/pydoc.py -k %s' % keyword)
...
>>> search_help('math')
cmath - This module is always available. It provides access to mathematical
math - This module is always available.  It provides access to the
test.test_cmath
test.test_math
>>> search_help('pdf')
>>> _

На вашем пути должен быть основной каталог Python. И это не будет работать под IDLE. НТН.