2010-01-25 7 views
15

È solo per me, o la documentazione della libreria standard Python è estremamente difficile da consultare?Modi alternativi per esplorare python api

Java ha la sua brillante Javadocs, Ruby ha il suo utile Ruby-Docs, solo in pitone non riesco a trovare un buon modo per navigare attraverso la documentazione libreria standard.

C'è il progetto Epydoc, che sembra bello, ma qualcuno sa se è effettivamente utilizzato nella libreria standard, quindi possiamo esaminarlo? In caso contrario, quali sono le alternative che le persone stanno utilizzando per consultare la documentazione di Python.

+5

Python e molte delle grandi librerie utilizzano la Sfinge per la documentazione. Dal punto di vista dell'usabilità, i documenti generati sono piuttosto orribili (anche se usano dei CSS di bell'aspetto). Un esempio di ciò sono le pagine estremamente lunghe, che rendono la navigazione molto difficile. – nikow

+3

Wow ... Python potrebbe non essere il documento più meraviglioso, ma confrontarlo sfavorevolmente con * javadoc *? Il doc è praticamente la mia cosa preferita su Java: di solito ottieni un piccolo tutorial superficiale e poi dopo c'è solo il javadoc: un labirinto inutile di dettagli tecnici di classe e metodo senza indicazioni per trovare come è organizzato tutto e cosa tu? ri aspettarsi di usare. – bobince

+7

Trovo che javadocs sia un ottimo strumento per esplorare le API. La qualità della documentazione stessa non è responsabilità dello strumento, ma dell'autore della documentazione. Quindi IMHO, sì, javadoc sono molto meglio di quello che sta usando il sito ufficiale della documentazione di Python. – ivo

risposta

8

Io di solito uso il pydoc integrato, se si è su Windows dovrebbe essere chiamato Module Docs se si utilizza linux pydoc -p 8000 e connettersi tramite browser.

2

si può andare a here e scaricare la versione chm di Python 3.1. Con questo, la ricerca attraverso i documenti dovrebbe essere facile.

3

pydoc dalla riga di comando, help() dal prompt dell'interprete interattivo.

3

pydoc -p 8080

La comunità pitone è semi-ostile a generare automaticamente la documentazione, soprattutto se è orientata agli oggetti. Python non è solo orientato agli oggetti (è un linguaggio multi-paradigma), quindi gli sviluppatori Python generalmente preferiscono la documentazione scritta da umani. A volte le funzioni sono importanti, a volte la struttura della classe è importante.

+0

Sì, ho assaporato l'ostilità ... – ivo

0

Ho usato il python sidebar da Edgewall molto tempo fa.

In questi giorni, io google per la funzione python (i documenti standard vengono visualizzati quasi sempre come il primo link). Se desidero sfogliare il codice sorgente del modulo (utile a volte), utilizzo questa piccola funzione di shell che ho scritto .

epy() { 
    cmd="import $1 as a ; print a.__file__.endswith('.pyc') and a.__file__[:-1] or a.__file__" 
    file=$(/usr/bin/env python -c $cmd) 
    echo $file 
    emacsclient --no-wait $file 
} 
0

immagino che ho intenzione di ottenere downvoted ma trovo niente di sbagliato con i documenti Sfinge e li trovo modo il modo migliore di Java alternativo.

+0

Sono d'accordo. Sfinge è un buon strumento e genera buoni documenti. Almeno per Python :) –