numpy.lookfor

numpy.lookfor(what, module=None, import_modules=True, regenerate=False, output=None) [source]

Произвести поиск по ключевым словам в строках документации.

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

Параметры

whatstr

Строка, содержащая слова для поиска.

modulestr or list, optional

Имя модуля(ей), строки документации которого(ых) нужно проверить.

import_modulesbool, optional

Флаг, указывающий на импорт подмодулей в пакетах. По умолчанию True.

regeneratebool, optional

Флаг, указывающий на необходимость повторной генерации кэша документации. По умолчанию False.

outputfile-like, optional

Объект типа «поток» для записи вывода. Если опущено, используется просмотрщик страниц.

См. также

source, info

Примечания

Релевантность определяется приблизительно, проверяя, встречаются ли ключевые слова в имени функции, в начале строки документации и т.п.

Примеры

>>> np.lookfor('binary representation') 
Search results for 'binary representation'
------------------------------------------
numpy.binary_repr
    Return the binary representation of the input number as a string.
numpy.core.setup_common.long_double_representation
    Given a binary dump as given by GNU od -b, look for long double
numpy.base_repr
    Return a string representation of a number in the given base system.
...