Facile à naviguer en ligne Manuel de référence Python?

Question

Je cherche des pages de référence pour Python similaires à la documentation de PHP.net. c'est-à-dire, quelque chose qui fournit une liste claire et simple de toutes les classes et méthodes dans un module que je peux cliquer pour obtenir plus d'informations, telles que les arguments. Avoir des descriptions en dessous de chaque classe/méthode rend plus difficile de trouver ce que vous cherchez.

Answer 1

>>> import datetime 
>>> help(datetime.time) 

Answer 2

premières lignes du haut-docs semblent bien me:

from datetime import time 
help(time) 

Prints:

class time(__builtin__.object) 
| time([hour[, minute[, second[, microsecond[, tzinfo]]]]]) --> a time object 
| 
| All arguments are optional. tzinfo may be None, or an instance of 
| a tzinfo subclass. The remaining arguments may be ints or longs. 

Answer 3

Personnellement, je trouve ces deux techniques utiles:

1. Importez le module datetime et puis en faisant help(datetime.time). La sortie est beaucoup mieux et donne surtout ce dont vous avez besoin.

2. En utilisant la référence effbot's. Vous pouvez consulter le datetime un here. J'ai généralement Google Effbot <module> pour une brève description du module et un exemple de travail. Très utile dans les temps.

Plus précisément, this est ce dont je parle.

Answer 4

Le manuel de référence en ligne standard has a search function fonctionne raisonnablement bien. La recherche de datetime liée à ci-dessus fournit une liste qui inclut le contenu du module datetime, les méthodes/propriétés de la classe datetime, plusieurs références à datetime d'ailleurs dans la bibliothèque et un tas de références d'API C. Si vous cherchez un , le manuel de référence suppose dans une certaine mesure que vous sachiez ce que vous cherchez.

Il semble que vous vouliez peut-être afficher une liste de méthodes/propriétés pour la classe dans la navigation de gauche? Si c'est le cas, il pourrait être utile d'en faire la demande aux docs pour voir si quelque chose pourrait être changé.

Answer 5

Vous pouvez essayer

python -m pydoc -p 8000 

vont alors http://localhost:8000

Probablement toujours pas ce que vous cherchez, mais il est une autre option.

Answer 6

Peut-être que quelqu'un doit simplement utiliser les iframes (ou des cadres réels) pour les mettre ensemble:

http://docs.python.org/library ./reference

vous prenez peut-être une heure avec BeautifulSoup, re et urllib2.

J'ai trouvé Ctrl-f appliqué à ./library fonctionne bien.

Answer 7

facile à naviguer manuel de référence python:

Aller à l'évidence lieu - Manuel bibliothèque Python, le module datetime (?): http://docs.python.org/library/datetime.html

Dans la table des matières dans le panneau à gauche , notez "8.1.5 Objets temporels". Clique sur le lien.

Lire le haut de la page:

classe datetime.time (heure [, minute [, deuxième [, microseconde [, tzinfo]]]])

Mise à jour OK, donc nous voulons "utcoffset" et ce n'est pas en haut de la page. Essayez ceci dans votre navigateur: <Ctrl-F>, tapez "utcoffset" (sans les guillemets), <Enter>

Alternative: (peut être disponible que sous Windows et Linux) - une version CHM de la documentation est fourni avec les distributions de Windows Python et J'ai entendu dire qu'il peut aussi être utilisé sur Linux. Démarrez-le, cliquez sur Index, tapez "utcoffset" (sans les guillemets), <Enter> et il affichera trois options - c'est une méthode de datetime. (Datetime | time | tzinfo)

Answer 8

@Mark - pour certains raison pour laquelle je ne peux pas poster de commentaires.

Je suis entièrement d'accord avec vous. J'ai codé en PHP pendant des années, et leur documentation est la meilleure que j'ai trouvée - Java est dans la même veine mais un peu plus compliqué à voir.

Je veux voir la même chose que vous - une liste scannable de fonctions et de méthodes, d'arguments plus les types, les valeurs par défaut et si elles sont facultatives et les types de retour.

Ce n'est pas sorcier. Honnêtement, je ne sais pas comment les gens font quelque chose rapidement en Python jusqu'à ce qu'ils le sachent. C'est ridicule de devoir utiliser Google au lieu d'utiliser le propre système de documentation de la langue.

L'ensemble de la configuration de docs python est ciblé sur les personnes qui savent déjà ce qu'ils recherchent, qu'il s'agisse du site web Python docs ou de pydoc lui-même. Et oublie d'ouvrir un shell python chaque fois que je veux faire quelque chose et utiliser 'help'. Sérieusement? Utilisez CTRL-F sur la page? Je ne sais pas précisément ce que je cherche.

Si je connaissais la classe d'une méthode, ou le nom spécifique de la méthode ou de la fonction que je recherche, les docs pourraient être presque utilisables, bien que toujours lents et désagréables. Mais quand je ne sais pas si je cherche join ou implode ou quoi que ce soit, c'est à peu près inutile.

Un cas d'espèce - J'essaie de trouver rapidement comment travailler avec et élever un OSError. Les docs mentionnent laborieusement dans une description textuelle qu'il existe un attribut errno. Où le constructeur est-il documenté? Pas sur the exceptions page. Pas lié à. Aucune idée des arguments qu'il faut prendre. Impossible de trouver facilement les méthodes ou les attributs. Je devrais voir des puces et du code pertinent dans une liste facilement scannable. Quelle perte de temps. Dommage car j'aime la langue. PS - donc ma réponse est pour quelqu'un de créer des docs python dans le style de PHP.

==== ==== MISE À JOUR

C'est exactement ce que je cherchais: Epydoc.WTF m'a-t-il fallu 2 jours de googling pour le trouver?