numpy.lookfor

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

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

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

Параметры

whatstr

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

modulestr или список, необязательно

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

import_modulesbool, необязательно

Нужно ли импортировать подмодули в пакетах. По умолчанию True.

regeneratebool, необязательно

Нужно ли перегенерировать кэш строк документации. По умолчанию False.

outputобъект типа файла, необязательно

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

См. также

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.
...