Argumenty příkazového řádku v Pythonu

autor:
Tweet
Share
Share
Pin

Python se stal oblíbenou volbou pro širokou škálu programátorských úloh, od jednoduchých skriptů až po sofistikované webové aplikace. Bez ohledu na to, zda se snažíte automatizovat rutinní úkoly, analyzovat rozsáhlá data nebo vytvářet uživatelské nástroje, často narazíte na potřebu interaktivně ovlivňovat chování vašeho programu. Právě zde se uplatňují argumenty příkazové řádky.

Argumenty příkazové řádky, často zkracované jako „args“, představují způsob, jak předávat data vašemu skriptu Python při jeho spuštění. Umožňují vám dynamicky přizpůsobovat chování programu vašim specifickým požadavkům. Představte si například skript generující náhodná čísla. S pomocí argumentů příkazové řádky byste mohli definovat počet generovaných čísel, rozsah jejich hodnot, nebo dokonce požadovaný formát výstupu.

Jak argumenty fungují?

Při spouštění skriptu Python z příkazového řádku můžete za názvem souboru skriptu uvést argumenty, oddělené mezerami. Python interpret tyto argumenty automaticky zpracuje a zpřístupní je vašemu skriptu pro další použití.

Příklad:


python muj_skript.py parametr1 parametr2

V tomto příkladu je muj_skript.py jméno vašeho skriptu a parametr1 a parametr2 představují argumenty, které jsou předány do skriptu.

Práce s argumenty v Pythonu: Modul argparse

Modul argparse je standardní knihovnou pro zpracování argumentů příkazové řádky v Pythonu. Nabízí vám jednoduchý a flexibilní způsob definování a zpracování argumentů, včetně automatického generování nápovědy a ověřování vstupů.

Základní použití:

1. Import modulu:


import argparse

2. Vytvoření parseru argumentů:


parser = argparse.ArgumentParser()

3. Definice argumentů:


parser.add_argument("jmeno", help="Zadejte vaše jméno")

Tento kód definuje argument s názvem „jmeno“.

4. Zpracování argumentů:


args = parser.parse_args()

Tento řádek kódu zpracuje zadané argumenty a uloží je do objektu args.

5. Přístup k hodnotám argumentů:


print(f"Ahoj, {args.jmeno}!")

Pomocí atributů objektu args (v tomto případě args.jmeno) můžete získat hodnoty argumentů a dále s nimi pracovat.

Speciální argumenty:

  • -h nebo --help: Zobrazí nápovědu k dostupným argumentům.
  • --version: Zobrazí verzi programu (pokud je definována).

Kompletní příklad:


import argparse

parser = argparse.ArgumentParser(description="Vítejte v mém programu!")
parser.add_argument("jmeno", help="Zadejte své jméno")
parser.add_argument("-v", "--verbose", action="store_true", help="Aktivuje detailní výstup")

args = parser.parse_args()

if args.verbose:
print(f"Ahoj, {args.jmeno}! Spuštěno v režimu verbose.")
else:
print(f"Ahoj, {args.jmeno}!")

Spuštění:


python muj_skript.py Karel -v

Výsledek:


Ahoj, Karel! Spuštěno v režimu verbose.

Typy argumentů:

  • Poziční argumenty: Argumenty, které jsou specifikovány v pořadí, v jakém jsou definovány.
  • Klíčové argumenty: Argumenty, které jsou specifikovány pomocí klíče (např. --help) a hodnoty.
  • Volby (-h, --help): Argumenty bez hodnoty, které ovlivňují chování programu (např. aktivace podrobného režimu).
  • Seznamy a slovníky: Modul argparse umožňuje definovat argumenty, které mohou přijímat více hodnot nebo páry klíč-hodnota.

Typy akcí:

  • store_true: Uloží hodnotu True, pokud je argument zadán.
  • store_false: Uloží hodnotu False, pokud je argument zadán.
  • append: Přidá hodnotu argumentu do seznamu.
  • store_const: Uloží konstantní hodnotu, pokud je argument zadán.

Výhody použití argumentů:

  • Flexibilita: Umožňují vám snadno přizpůsobovat chování programu různým situacím.
  • Interaktivita: Umožňují uživatelům ovlivňovat běh programu bez nutnosti zásahů do zdrojového kódu.
  • Čitelnost: Zlepšují srozumitelnost a strukturu vašich programů a zjednodušují jejich používání.
  • Automatická nápověda: Modul argparse automaticky generuje dokumentaci k vašim argumentům.

Využití argumentů v praxi:

  • Automatizace úloh: Spouštění skriptů s různými konfiguracemi.
  • Zpracování dat: Úprava parametrů pro zpracování dat, jako je specifikace vstupního souboru, formátu výstupu nebo počtu řádků.
  • Tvorba nástrojů: Vývoj uživatelsky přívětivých nástrojů s interaktivním rozhraním.

Závěr:

Argumenty příkazové řádky představují mocný nástroj pro tvorbu flexibilních a uživatelsky přívětivých skriptů v Pythonu. Modul argparse nabízí pohodlný a intuitivní způsob definování, zpracování a dokumentování argumentů. Naučte se využívat sílu argumentů příkazové řádky a maximalizujte potenciál vašich skriptů v Pythonu.

Často kladené otázky:

1. Jak zadat více argumentů najednou?

Můžete zadat více pozičních argumentů v pořadí, v jakém jsou definovány, nebo použít klíčové argumenty s jejich hodnotami, například --jmeno "Karel" --vek 35.

2. Jak definovat argument s výchozí hodnotou?

Použijte parametr default v metodě add_argument. Například: parser.add_argument("-v", "--verbose", action="store_true", default=False, help="Aktivuje detailní výstup").

3. Jak ověřit, zda byl argument zadán?

Zkontrolujte atribut args.jmeno pomocí podmínky if args.jmeno is None:.

4. Jak zkontrolovat datový typ zadané hodnoty?

Použijte parametr type v metodě add_argument. Například: parser.add_argument("-c", "--count", type=int, help="Počet opakování").

5. Jak zadat seznam hodnot pro argument?

Použijte parametr nargs v metodě add_argument a nastavte ho na + (alespoň jedna hodnota), * (libovolný počet hodnot) nebo číselnou hodnotu (pevný počet hodnot).

6. Jak definovat argument s omezeným seznamem povolených hodnot?

Použijte parametr choices v metodě add_argument. Například: parser.add_argument("-m", "--mode", choices=["read", "write"], help="Režim souboru").

7. Jak zadat slovník jako argument?

Modul argparse přímo nepodporuje zadávání slovníků. Můžete však vytvořit vlastní funkci pro zpracování argumentu a jeho konverzi na slovník.

8. Jak zobrazit nápovědu k argumentům?

Spusťte skript s argumenty -h nebo --help, například python muj_skript.py -h.

9. Existuje alternativa k modulu argparse?

Ano, například docopt, který umožňuje definovat argumenty přímo v dokumentačním řetězci (docstring) vašeho skriptu.

10. Kde najdu další informace o argumentech příkazové řádky v Pythonu?

Dokumentace k modulu argparse: https://docs.python.org/3/library/argparse.html

Dokumentace k modulu docopt: https://docopt.org/

Tagy: Python, argumenty příkazové řádky, argparse, docopt, skriptování, automatizace, zpracování dat, nástroje, nápověda, dokumentace, flexibilita, interakce, čitelnost