Skript check_method_docstrings

Dokumentace skriptu docs/check_method_docstrings.py.

Přehled modulu

Kontrola docstringů tříd, metod a funkcí dle projektového style guide.

Třídy

class MethodDocstringChecker

AST návštěvník, který kontroluje přítomnost a kvalitu docstringů.

Metody:

__init__()

visit_ClassDef()

Zkontroluje docstring třídy a navštíví její potomky.

Parametry:

node – AST uzel definice třídy.

visit_FunctionDef()

Zpracuje běžnou definici funkce nebo metody.

Parametry:

node – AST uzel definice funkce.

visit_AsyncFunctionDef()

Zpracuje asynchronní definici funkce nebo metody.

Parametry:

node – AST uzel asynchronní definice funkce.

_handle_function_like()

_should_skip()

_collect_args()

_has_meaningful_return()

_check_docstring()

Funkce

env_flag(name, default)

Vyhodnotí hodnotu proměnné prostředí jako booleovský příznak.

Parametry:

• name – Název proměnné prostředí.

• default – Výchozí hodnota použitá při neexistenci proměnné.

Vrací:

`True`, pokud hodnota odpovídá pravdivému příznaku.

iter_python_files(paths, bypass_exclusions)

Iteruje Python soubory ve vstupních cestách.

Parametry:

• paths – Seznam souborů nebo adresářů ke kontrole.

• bypass_exclusions – Pokud True, nepoužije se filtr ignorovaných adresářů.

Vrací:

Generátor cest k nalezeným `.py` souborům.

main()

Spustí kontrolu docstringů nad zadanými Python soubory.

Vrací:

Návratový kód procesu (0 při úspěchu, 1 při nalezení nedostatků).