Nápověda k modulům

S některými moduly není dodávána žádná dokumentace. Nápověda je dělána pouze ve formě dokumentačních řetězců a komentářů v samotných souborech modulu. No a je na vás, abyste se s tím nějak poprali. Naštěstí existují další moduly, které dokáží tyto dokumentační řetězce se souborů vysbírat a v přehledné formě zobrazit. Jedním z nich je pydoc, který je dodávám přímo v distribuci.

pydoc

pydoc.py se pod Windows spouští spouštěcím linkem ze Startu, .., Python24. Module Docs. Kdo ve Startu tento link nenajde, může modul spustit z adresáře Python24/Lib, kde pydoc.py standardně leží; v grafickém režimu se tento spouští s parametrem -g: python pydoc.py -g. Další možné parametry získáte, spustíte-li pydoc bez ničeho.

Naběhne vám následující okno

pydoc.png

kde do vstupního řádku napíšete název vašeho modulu nebo jen část (bez .py). Z výsledků, kterých je většinou dost, si vyberete ten váš. Spustí se vám prohlížet a v něm, typicky pro pydoc, zformátované dokumentační řetězce metod i tříd a dalších ....

Konkrétně pro modul path.py dostávám:

pydoc-path2.png