tutorial - ¿Buscar documentos de Python fuera de línea?

the django project

Question

En Python puedo obtener documentación rudimentaria para cualquier objeto usando la help(<object>) . Pero para poder buscar en la documentación, tengo que ir en línea. Esto no es realmente útil si estoy en un lugar donde no se puede acceder a Internet.

En R, hay una característica práctica de doble signo de interrogación ( ??<topic> ) que me permite buscar en la documentación de todas las bibliotecas instaladas cualquier función que incluya <topic> en su nombre o cadena de documentación. ¿Hay algo similar para python? Tal vez incluso solo para los objetos cargados?

Answer 1

Aunque ciertamente hay mejores documentaciones integradas en su computadora que la ayuda () como Windows inactivo, otra opción para algunos de los temas más comunes sería guardar parte de la documentación en línea en su computadora. Para los módulos que usa mucho y desea acceder a la conexión sin conexión, simplemente puede descargar una versión de archivo de texto de la documentación oficial en línea de Python, que es el mejor lugar para obtener la documentación. (archivo> guardar página como> seleccione el formato de archivo .txt)

Answer 2

Busque en la carpeta de python en la carpeta: Doc . Esta carpeta contiene toda la documentación descargada de los documentos de Python de python.org . Sé que esta es una respuesta MUY tardía, pero trae una solución fácil.

Answer 3

Deberías probar con ipython .

¿nombre del objeto? imprimirá todo tipo de detalles sobre cualquier objeto, incluidas cadenas de documentos, líneas de definición de funciones (para argumentos de llamada) y detalles de constructor para clases.

Los comandos mágicos% pdoc,% pdef,% psource y% pfile imprimirán respectivamente la cadena de documentos, la línea de definición de la función, el código fuente completo y el archivo completo para cualquier objeto (cuando se puedan encontrar). Si automagic está activado (está predeterminado), no es necesario que escriba ''%'' explícitamente.

Answer 4

En caso de que esté trabajando en una Mac, hay Dash , que le permite descargar conjuntos de documentos y luego explorar / buscar sin conexión. A pesar de su funcionalidad de documentación, Dash también es un administrador de fragmentos.

Answer 5

Es posible que no haya estado disponible en el momento en que se hizo y contestó la pregunta, pero python.org ahora hace que toda la documentación esté disponible en línea como un archivo de archivos HTML que se puede navegar y buscar en línea: https://docs.python.org/2/download.html

(El enlace se dirige a los documentos para la última versión de 2.x, pero puede elegir versiones 3.x y anteriores 2.x de esa página)

Answer 6

Esto ya se mencionó en los comentarios: Zeal es similar a Dash pero para Windows / Linux. Utiliza las mismas fuentes que Dash. Está construido con Qt y está disponible en los repositorios para varias distribuciones, para Ubuntu hay un PPA. Descárgalo here .

Zeal es un sencillo navegador de documentación de API fuera de línea inspirado en Dash (aplicación OS X), disponible para Linux y Windows.

• Busque rápidamente la documentación utilizando las teclas de acceso rápido Alt + Espacio (o personalizadas) para mostrar Zeal desde cualquier lugar en su área de trabajo.
• Buscar en varios conjuntos de documentación a la vez.
• No seas dependiente de tu conexión a internet.
• Integrar Zeal con Emacs, Sublime Text o Vim. Consulte Usage »Editor de complementos para más detalles.

Es de código abierto (GPL), el desarrollo sucede en GitHub . Zeal usa las mismas hojas de estilo / HTML que los documentos en línea, por lo que todo debería resultar familiar.

Una alternativa en el navegador es devdocs.io . Puede acceder al sitio web incluso si está desconectado, siempre que los haya marcado para almacenamiento local fuera de línea. Tendrá que habilitar los documentos de Python 2 y luego marcarlos para el almacenamiento sin conexión here . Sin embargo, como usuario de larga data de los documentos de Python en línea, encuentro que la hoja de estilo personalizada que DevDocs usa un poco distrae.

Answer 7

Solo para agregar otra opción para el acceso sin conexión de documentos de Python (en su mayoría, núcleo):

No tengo acceso a una computadora con Linux en este momento, pero en Windows, puedes navegar a your_python_dist_folder/doc para encontrar algunos archivos de ayuda. Particularmente python275.chm por ejemplo.

Si no hay una carpeta de documentos en su máquina Linux, puede descargar el archivo here y buscar un visor de Linux chm en Google:

https://www.google.com/search?q=linux+chm+viewer

::Nota:

Algunas distribuciones también incluyen documentos para otros paquetes allí ... vale la pena verificarlos. Aparte de eso, la help(module) generalmente devuelve buena información.

Editar :

Puede obtener algo que pueda estar un poco más cerca de lo que desea mediante el uso de pydoc . Por ejemplo, estás buscando algo acerca del sin en el módulo de matemáticas:

import math
import pydoc
[i for i in dir(math) if ''sin'' in pydoc.getdoc(getattr(math,i))]

Esto devolvería los métodos cuyas cadenas de documentación incluyen el sin :

[''acos'', ''acosh'', ''asin'', ''asinh'', ''cos'', ''cosh'', ''isinf'', ''sin'', ''sinh'']

para lo que entonces podría ejecutar la función de help()

Answer 8

Windows Idle: F1 desde la ventana de shell o la ventana de edición le ofrece un archivo de ayuda de Windows de todos los documentos. Creo que es mejor que la versión en línea, es más fácil encontrar cosas.

Answer 9

pydoc viene con python y puede realizar búsquedas, pero solo en las líneas de sinopsis de los módulos disponibles. Cotizando pydoc --help

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

Tenga en cuenta que en pydoc puede realizar búsquedas usando "/".