1.6. Obteniendo ayuda y buscando en la documentación

Mejor que conocer todas las funciones existentes en Numpy y en Scipy sería más importante e interesante encontrar de forma rápida a través de la documentación y de la ayuda disponible. Aquí encontrarás algunas formas de encontrar información:

  • En Ipython, help function abre el docstring de la función. Solo has de teclear el principio del nombre de la función y después pulsar tab para que se muestre en pantalla las posibles funciones que estamos buscando.

    In [204]: help np.v
    
    np.vander np.vdot np.version np.void0 np.vstack
    np.var np.vectorize np.void np.vsplit
    In [204]: help np.vander

En Ipython no es posible abrir una ventana aparte para mostrar la ayuda y la documentación; sin embargo siempre podríamos abrir una segunda consola Ipython para mostrar únicamente la ayuda y docstrings...

Finalmente, también serían útiles dos posibilidades más “técnicas”:

  • En Ipython, la función mágica %psearch busca objetos que coincidan con los patrones de búsqueda. Esto es útil, por ejemplo, cuando desconocemos el nombre exacto de una función.

    In [3]: import numpy as np
    
    In [4]: %psearch np.diag*
    np.diag
    np.diagflat
    np.diagonal
  • numpy.lookfor busca por palabras clave dentro de los docstrings de módulos específicos.

    In [45]: numpy.lookfor('convolution')
    
    Search results for 'convolution'
    --------------------------------
    numpy.convolve
    Returns the discrete, linear convolution of two one-dimensional
    sequences.
    numpy.bartlett
    Return the Bartlett window.
    numpy.correlate
    Discrete, linear correlation of two 1-dimensional sequences.
    In [46]: numpy.lookfor('remove', module='os')
    Search results for 'remove'
    ---------------------------
    os.remove
    remove(path)
    os.removedirs
    removedirs(path)
    os.rmdir
    rmdir(path)
    os.unlink
    unlink(path)
    os.walk
    Directory tree generator.
  • Si todo lo anterior falla (y Google no tiene la respuesta)... ¡no hay que desesperarse! Escribe a la lista de correo que se ajuste a tu problema: obtendrás una rápida respuesta si defines correctamente tu problema. A menudo, expertos en python científico ofrecen explicaciones muy clarificadoras en las listas de correo.