Hej, lidi! V tomto článku se budeme věnovat důležité vysvětlující funkci v jazyce Python – funkci Python help().

Potřeba metody help()

Při kódování v určitém programovacím jazyce je pro nás velmi důležité znát základní dokumentaci k rámcovanému jazyku. Tehdy přichází ke slovu funkce help().

Tato funkce nám poskytuje základní dokumentaci jazyka Python. Poskytuje nám informace o metodách a instancích spojených s konkrétní metodou nebo třídou.

Metoda help() pracuje s klíčovými slovy, třídami, funkcemi a moduly a pomáhá nám získat základní terminologii, instance a práci s nimi spojenou v tomto pořadí.

Obvykle se help() methodpoužívá vedle interpretu jazyka Python, aby získala přístup k základním podrobnostem o objektech jazyka Python, které jí byly předány jako parametr.

Práce metody help() jazyka Python

Jak bylo uvedeno výše, metoda help() poskytuje informace o objektech jazyka Python, které jí byly předány.

Pokud je help() function uvedena bez jakéhokoli parametru, spustí se konzola interpretu, v níž můžeme uvést libovolný modul, objekty, třídy atd. a získat tak dokumentaci o nich.

Příklad :

help()

Výstup:

Funkce help() Pythonu s třídou

Funkci help lze zadat vlastní nebo předem definované parametry, se kterými bude pracovat. Můžeme vytvořit vlastní třídu a předat ji funkci help(), abychom mohli prozkoumat dokumentaci poskytovanou funkcí.

Příklad:

class Info: lang = "Python" name = "JournalDev"obj = Info()help(Info)

Vytvořili jsme uživatelsky definovanou třídu a předali ji funkci help(). Funkce help() nám vrátila potřebnou dokumentaci třídy ‚Info‘.

Výstup:

Help on class Info in module __main__:class Info(builtins.object) | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | lang = 'Python' | | name = 'JournalDev'

Pythonovská funkce help() s funkcí

Funkce help() nám pomůže získat přístup k syntaxi, seznamu parametrů a popisu o libovolné funkci, kterou jí předáme pomocí níže uvedeného příkazu.

Syntaxe:

help('function-name')

Příklad 1:

help('getattr')

Výstup:

Příklad 2:

help('map')

Výstup:

Funkce help() Pythonu s modulem

Pomocí funkce help() můžeme získat informace o modulu. Je-li funkci help() předán modul, poskytne dokumentaci v podobě verze, umístění souboru, obsahu modulu a dat s ním spojených.

Syntaxe:

help('module-name')

Příklad:

help('seaborn')

Výstup:

Funkce help() s klíčovým slovem

Při předání klíčového slova v Pythonu jako parametru funkci help() funkce vrátí dokumentaci ve smyslu třídy klíčového slova, metod s ním spojených atd.

Syntaxe:

help('keyword-name')

Příklad 1:

help(True)

Výstup:

Příklad 2:

help(int)

Výstup:

Závěr

Tímto jsme se dostali na konec tohoto tématu. Pochopili jsme potřebu a fungování funkce help(). Doufám, že tento koncept je všem čtenářům jasný.