Ako zobraziť dokumentáciu k balíku Python

John Paul Mueller

Môžete použiť doc() funkcie, kedykoľvek je to potrebné na získanie rýchlej pomoci. Máte však lepší spôsob, ako študovať balíčky a knižnice umiestnené v ceste Pythonu - dokumentácia balíka Python. Táto funkcia sa často zobrazuje ako Package Docs v priečinku Python vo vašom systéme. Hovorí sa mu tiež Pydoc. Nech už to nazvete akokoľvek, dokumentácia k balíku Python vývojárom výrazne uľahčí život.



Otvorenie aplikácie Pydoc

Pydoc je len ďalšia aplikácia v Pythone. V skutočnosti sa zobrazuje v znakoch Python36Lib adresár vášho systému ako pydoc.py. Rovnako ako u iných .py Tento súbor môžete otvoriť v aplikácii Notebook a študovať, ako to funguje. Môžete ho spustiť pomocou odkazu na dokument Python 3.6 Module Docs, ktorý sa zobrazí v priečinku Python 3.6 vo vašom systéme, alebo pomocou príkazu na príkazovom riadku Anaconda.



Program Pydoc môžete používať v grafickom aj textovom režime. Pri otvorení výzvy Anaconda môžete zadať kľúčové slovo, napríklad JSON, a program Pydoc zobrazí textovú pomoc. Pomocou prepínača príkazového riadku -k, za ktorým nasleduje kľúčové slovo, ako keby, vám umožní zobraziť zoznam miest, kde sa vyskytujú konkrétne kľúčové slová. Ak chcete server skutočne spustiť, zadajte príkaz Pydoc -b a stlačte kláves Enter. Ak potrebujete pre svoj prehliadač použiť konkrétny port, pridajte prepínač príkazového riadku -p s číslom portu.

Grafický režim aplikácie Pydoc vytvorí lokalizovaný server, ktorý vo vašom prehliadači zobrazuje informácie o balíkoch a knižniciach Pythonu. Takže keď spustíte túto aplikáciu, uvidíte otvorené okno príkazu (terminálu).



Rovnako ako u iných serverov, aj tento vás môže požiadať o povolenie. Napríklad môžete vidieť varovanie z brány firewall, ktorá vám hovorí, že program Pydoc sa pokúša získať prístup k lokálnemu systému. Programu Pydoc musíte dať povolenie na prácu so systémom, aby ste videli jeho informácie. Akákoľvek nainštalovaná detekcia vírusov môže vyžadovať povolenie, aby mohol pokračovať aj Pydoc. Niektoré platformy, napríklad Windows, môžu na spustenie programu Pydoc vyžadovať zvýšenie oprávnení.

Za normálnych okolností server automaticky otvorí nové okno prehľadávača. Toto okno obsahuje odkazy na rôzne balíky, ktoré obsahuje váš systém, vrátane akýchkoľvek vlastných balíkov, ktoré vytvoríte a zahrnete do cesty Pythonu. Ak chcete zobraziť informácie o balíku, stačí kliknúť na jeho odkaz.

Indexová stránka Python

Prehliadač zobrazuje niekoľko odkazov, ktoré sa zobrazujú ako súčasť indexovej stránky.



Anaconda Prompt vám poskytuje dva príkazy na ovládanie servera. Jednoducho napíšete písmeno spojené s príkazom a aktivujete ho stlačením klávesu Enter. Tu sú dva príkazy:

  • b: Spustí novú kópiu predvoleného prehľadávača so načítanou indexovou stránkou.
  • q: Zastaví server.

Po dokončení prehľadávania informácií pomocníka zastavte server zadaním slova q a stlačením klávesu Enter na príkazovom riadku. Zastavenie servera uvoľní všetky zdroje, ktoré používa, a zatvorí všetky otvory, ktoré ste vytvorili vo svojom firewalle, aby vyhovoval Pydocu.

Môžete piť penicilín?

Pomocou odkazov na rýchly prístup

V hornej časti webovej stránky sú zobrazené tri odkazy. Tieto odkazy poskytujú rýchly prístup k funkciám stránky. Prehliadač vždy začína na indexe modulov. Ak sa potrebujete vrátiť na túto stránku, jednoducho kliknite na odkaz Modul Register.

Odkaz Témy vás presmeruje na stránku uvedenú nižšie. Táto stránka obsahuje odkazy na základné témy týkajúce sa Pythonu. Napríklad, ak sa chcete dozvedieť viac o boolovských hodnotách, kliknite na odkaz BOOLEAN. Stránka, ktorú uvidíte ďalej, popisuje, ako fungujú booleovské hodnoty v Pythone. V dolnej časti stránky sú súvisiace odkazy, ktoré vedú na stránky, ktoré obsahujú ďalšie užitočné informácie.

Téma stránka Python

Stránka Témy vám hovorí o základných témach v jazyku Python, napríklad o tom, ako fungujú booleovské hodnoty.

Odkazom Kľúčové slová sa dostanete na stránku nižšie. Uvidíte zoznam kľúčových slov, ktoré Python podporuje. Napríklad, ak sa chcete dozvedieť viac o vytváraní for slučky, kliknete na odkaz pre.

Stránka s kľúčovými slovami Python

Stránka Kľúčové slová obsahuje zoznam kľúčových slov, ktoré Python podporuje.

Zadanie hľadaného výrazu

Stránky tiež obsahujú dve textové polia v hornej časti. Prvý má vedľa seba tlačidlo Získať a druhý má vedľa seba tlačidlo Hľadať. Keď do prvého textového poľa zadáte hľadaný výraz a kliknete na tlačidlo Získať, zobrazí sa dokumentácia pre konkrétny balík alebo atribút. Toto vidíte pri písaní tlačiť a kliknite na tlačidlo Získať.

Získajte Python

Pomocou programu Získať získate konkrétne informácie o hľadanom výraze.

Keď zadáte hľadaný výraz do druhého textového poľa a kliknete na tlačidlo Hľadať, zobrazia sa všetky témy, ktoré by sa mohli týkať daného hľadaného výrazu. Obrázok nižšie zobrazuje typické výsledky pri písaní tlačiť a kliknite na tlačidlo Hľadať. V takom prípade kliknutím na odkaz, napríklad na kalendár, zobrazíte ďalšie informácie.

Vyhľadajte Python

Používaním Vyhľadávania získate zoznam tém týkajúcich sa hľadaného výrazu.

Prezeranie výsledkov

Výsledky, ktoré získate pri prezeraní stránky, závisia od témy. Niektoré témy sú stručné. Ostatné témy sú však rozsiahle. Ak by ste napríklad klikli na odkaz na kalendár, zobrazilo by sa vám značné množstvo informácií.

rozsiahle informácie Python

Niektoré stránky obsahujú rozsiahle informácie.

l484 biela podlhovastá pilulka hydrokodón

V tomto konkrétnom prípade sa zobrazia súvisiace informácie o balíku, informácie o chybách, funkcie, údaje a najrôznejšie ďalšie informácie o funkciách tlače kalendára. Množstvo informácií, ktoré uvidíte, závisí čiastočne od zložitosti témy a čiastočne od množstva informácií, ktoré vývojár poskytol s balíkom. Ak by ste napríklad vybrali BPPD_11_Packages na stránke Index balíkov, zobrazil by sa vám iba zoznam funkcií a vôbec žiadna dokumentácia.