Jak zobrazit dokumentaci k balíčku Pythonu

John Paul Mueller

Můžete použít doc() funkce, kdykoli je potřeba získat rychlou pomoc. Máte však lepší způsob, jak studovat balíčky a knihovny umístěné v cestě Pythonu - dokumentace k balíčku Pythonu. Tato funkce se často zobrazuje jako Package Docs ve složce Python ve vašem systému. Označuje se také jako Pydoc. Ať už tomu říkáte jakkoli, dokumentace k balíčku Python usnadňuje vývojářům život.

Otevření aplikace Pydoc

Pydoc je jen další aplikace v Pythonu. Ve skutečnosti se objeví v Python36Lib adresář vašeho systému jako pydoc.py. Stejně jako u jiných .py Tento soubor můžete otevřít pomocí Notebooku a prostudovat si, jak to funguje. Můžete jej spustit pomocí zástupce Python 3.6 Module Docs, který se zobrazí ve složce Python 3.6 ve vašem systému, nebo pomocí příkazu na příkazovém řádku Anaconda.



Pydoc můžete použít v grafickém i textovém režimu. Při otevírání výzvy Anaconda můžete zadat klíčové slovo, například JSON, a Pydoc zobrazí textovou nápovědu. Pomocí přepínače příkazového řádku -k a následného klíčového slova, například if, můžete zobrazit seznam míst, kde se konkrétní klíčová slova objevují. Chcete-li skutečně spustit server, zadejte Pydoc -b a stiskněte klávesu Enter. Pokud potřebujete pro svůj prohlížeč použít konkrétní port, přidejte přepínač příkazového řádku -p s číslem portu.

Grafický režim aplikace Pydoc vytváří lokalizovaný server, který ve vašem prohlížeči zobrazuje informace o balíčcích a knihovnách Pythonu. Když tedy spustíte tuto aplikaci, uvidíte otevřené okno příkazu (terminálu).

Stejně jako u jiných serverů může váš systém vyžadovat oprávnění. Například se může zobrazit varování brány firewall, které vás informuje o tom, že se Pydoc pokouší o přístup k místnímu systému. Abyste mohli vidět informace, které poskytuje, musíte Pydocu povolit práci se systémem. Jakákoli detekce virů, kterou jste nainstalovali, může potřebovat povolení, aby mohl Pydoc pokračovat také. Některé platformy, například Windows, mohou ke spuštění Pydoc vyžadovat zvýšení oprávnění.

Za normálních okolností server automaticky otevře nové okno prohlížeče. Toto okno obsahuje odkazy na různé balíčky obsažené ve vašem systému, včetně všech vlastních balíčků, které vytvoříte a zahrnete do cesty Pythonu. Chcete-li zobrazit informace o libovolném balíčku, jednoduše klikněte na jeho odkaz.

Rejstřík stránky Python

Váš prohlížeč zobrazuje řadu odkazů, které se zobrazují jako součást indexové stránky.

Anaconda Prompt vám poskytuje dva příkazy pro ovládání serveru. Jednoduše zadáte písmeno spojené s příkazem a stisknutím klávesy Enter jej aktivujete. Tady jsou dva příkazy:

  • b: Spustí novou kopii výchozího prohlížeče s načtenou indexovou stránkou.
  • q: Zastaví server.

Po dokončení procházení informací nápovědy zastavte server zadáním q a stisknutím klávesy Enter na příkazovém řádku. Zastavení serveru uvolní všechny zdroje, které používá, a zavře všechny díry, které jste vytvořili ve firewallu, aby vyhovovaly Pydoc.

Watson 853 bílá podlouhlá pilulka

Pomocí odkazů pro rychlý přístup

V horní části webové stránky vidíte tři odkazy. Tyto odkazy poskytují rychlý přístup k funkcím webu. Prohlížeč vždy začíná indexem modulu. Pokud se potřebujete vrátit na tuto stránku, jednoduše klikněte na odkaz Rejstřík modulů.

Odkaz Témata vás přesměruje na níže uvedenou stránku. Tato stránka obsahuje odkazy na základní témata Pythonu. Například pokud se chcete dozvědět více o booleovských hodnotách, klikněte na odkaz BOOLEAN. Stránka, kterou uvidíte dále, popisuje, jak logické hodnoty fungují v Pythonu. Ve spodní části stránky jsou související odkazy, které vedou na stránky, které obsahují další užitečné informace.

Stránka s tématy Python

Stránka Témata vám řekne o základních tématech Pythonu, například o tom, jak fungují booleovské hodnoty.

Odkaz Klíčová slova vás přesměruje na níže uvedenou stránku. Uvidíte seznam klíčových slov, která Python podporuje. Například pokud se chcete dozvědět více o vytváření for smyčky, kliknete na odkaz pro.

Stránka s klíčovými slovy Python

Stránka Klíčová slova obsahuje seznam klíčových slov, která Python podporuje.

Zadání hledaného výrazu

Stránky také obsahují dvě textová pole v horní části. První má vedle sebe tlačítko Získat a druhé má vedle sebe tlačítko Hledat. Když zadáte hledaný výraz do prvního textového pole a kliknete na Získat, zobrazí se dokumentace k danému balíčku nebo atributu. Toto vidíte při psaní tisk a klikněte na Získat.

Získejte Python

Použití Get získá konkrétní informace o hledaném výrazu.

Když do druhého textového pole zadáte hledaný výraz a kliknete na Hledat, uvidíte všechna témata, která by se mohla vztahovat k tomuto hledanému výrazu. Obrázek níže ukazuje typické výsledky při psaní tisk a klikněte na Hledat. V takovém případě zobrazíte další informace kliknutím na odkaz, například na kalendář.

Hledat v Pythonu

Pomocí Hledat získáte seznam témat o hledaném výrazu.

Prohlížení výsledků

Výsledky, které získáte při prohlížení stránky, závisí na daném tématu. Některá témata jsou stručná. Další témata jsou však rozsáhlá. Pokud byste například klikli na odkaz na kalendář, zobrazilo by se vám značné množství informací.

rozsáhlé informace Python

Některé stránky obsahují rozsáhlé informace.

valium vs xanax reddit

V tomto konkrétním případě uvidíte související informace o balíčku, informace o chybě, funkce, data a všechny druhy dalších informací o funkcích tisku kalendáře. Množství informací, které vidíte, závisí částečně na složitosti tématu a částečně na množství informací, které vývojář poskytl s balíčkem. Pokud byste například vybrali BPPD_11_Packages ze stránky Index balíčku, zobrazil by se vám pouze seznam funkcí a vůbec žádná dokumentace.