Back to docs

Thursday, January 2, 2025

Python argparse Moduli Command Line CLI

cover

Argparse moduli Python dasturlash tilida komandalarga asoslangan interfeyslar yaratish uchun keng tarqalgan va qulay vosita hisoblanadi.

Bu modul, foydalanuvchilarga komanda qatorida argumentlar kiritish imkonini beradi va bu argumentlar dasturda qanday ishlatilishini aniqlashga yordam beradi. argparse yordamida foydalanuvchidan ma'lumot olish, xatoliklarni aniqlash va ularni tushunarli tarzda ko'rsatish osonlashadi.

Argparse qanday ishlaydi?

1 - Argument parser yaratish: argparse.ArgumentParser yordamida dasturda qanday argumentlar bo'lishini aniqlaysiz.

2 - Argumentlarni qo'shish: Har bir argumentni qo'shib, uni ishlatish qoidalarini belgilaysiz.

3 - Argumentlarni o'qish: Foydalanuvchi tomonidan kiritilgan qiymatlarni dastur ichida ishlatasiz.

4 - Yordam matni: Foydalanuvchi noto'g'ri ishlatganda yoki yordam so'raganda, aniq tushuntirish beradi.

Misol orqali tushuntirish:

Dastur foydalanuvchi kiritgan fayl nomini o'qib, qatorlarni qayta ishlaydi.:

import argparse

# Argument parser yaratish
parser = argparse.ArgumentParser(description="Bu dastur fayllarni qayta ishlash uchun mo'ljallangan.")

# Argumentlarni qo'shish
parser.add_argument('filename', help="Qayta ishlash kerak bo'lgan fayl nomini kiriting")
parser.add_argument('--lines', type=int, help="Qayta ishlash kerak bo'lgan qatorlar soni")
parser.add_argument('--verbose', action='store_true', help="Jarayon haqida batafsil ma'lumot")

# Foydalanuvchi kiritgan argumentlarni o'qish
args = parser.parse_args()

# Argumentlarni qayta ishlash
print(f"Fayl: {args.filename}")
if args.lines:
    print(f"Qayta ishlanadigan qatorlar soni: {args.lines}")
if args.verbose:
    print("Jarayon batafsil rejimda ishlayapti.")

Kod qanday ishlaydi?

  • Terminalda ishga tushirish: Agar yuqoridagi kodni process.py deb nomlagan bo'lsangiz, uni quyidagicha ishga tushirish mumkin:
python process.py myfile.txt --lines 5 --verbose

Natija:

Fayl: myfile.txt
Qayta ishlanadigan qatorlar soni: 5
Jarayon batafsil rejimda ishlayapti.

Foydalanuvchi yordam ko'rishi uchun:

Agar foydalanuvchi noto'g'ri kiritgan bo'lsa yoki yordamni ko'rmoqchi bo'lsa, quyidagi buyruqni kiritsa bo'ladi:

python process.py --help
  • Natija:
usage: process.py [-h] [--lines LINES] [--verbose] filename

Bu dastur fayllarni qayta ishlash uchun mo'ljallangan.

positional arguments:
  filename          Qayta ishlash kerak bo'lgan fayl nomini kiriting

optional arguments:
  -h, --help        Ushbu yordam xabarini ko'rsatadi va chiqadi
  --lines LINES     Qayta ishlash kerak bo'lgan qatorlar soni
  --verbose         Jarayon haqida batafsil ma'lumot

Argparse yordamida dasturiy buyruqlarni sodda va samarali ishlatish mumkin.

🚀📁