Spec-Zone.ru › NumPy 1.13

numpy.lookfor

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

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

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

Параметры:

what : str

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

module : str или список, необязательно

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

import_modules : bool, необязательно

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

regenerate : bool, необязательно

Нужно ли перегенерировать кэш строки документации. По умолчанию 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.
...

© 2008–2017 NumPy Developers
Licensed under the NumPy License.
https://docs.scipy.org/doc/numpy-1.13.0/reference/generated/numpy.lookfor.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API