استفاده از sys برای آرگومان‌های خط فرمان در پایتون

در برنامه‌نویسی پایتون، اغلب نیاز داریم تا برنامه‌هایی بنویسیم که بتوانند ورودی‌هایی را از کاربر دریافت کنند. یکی از رایج‌ترین روش‌ها برای این کار، استفاده از آرگومان‌های خط فرمان است. آرگومان‌های خط فرمان، مقادیری هستند که هنگام اجرای برنامه از طریق خط فرمان (یا ترمینال) به آن ارسال می‌شوند. ماژول sys در پایتون ابزاری قدرتمند برای دسترسی به این آرگومان‌ها فراهم می‌کند. این مقاله به بررسی عمیق نحوه استفاده از ماژول sys برای مدیریت آرگومان‌های خط فرمان می‌پردازد.

ماژول sys چیست؟

ماژول sys یک ماژول داخلی پایتون است که دسترسی به برخی از متغیرها و توابع خاص سیستم را فراهم می‌کند. این ماژول اطلاعاتی مانند نسخه پایتون، مسیر جستجوی ماژول‌ها، و آرگومان‌های خط فرمان را در اختیار ما قرار می‌دهد. برای استفاده از این ماژول، ابتدا باید آن را با استفاده از دستور import sys وارد کنیم.

آرگومان‌های خط فرمان چگونه کار می‌کنند؟

هنگامی که یک برنامه پایتون را از خط فرمان اجرا می‌کنیم، می‌توانیم آرگومان‌هایی را بعد از نام فایل برنامه وارد کنیم. این آرگومان‌ها به صورت رشته‌ای به برنامه ارسال می‌شوند. به عنوان مثال، اگر برنامه‌ای به نام my_script.py داشته باشیم، می‌توانیم آن را به صورت زیر اجرا کنیم:

python my_script.py arg1 arg2 arg3

در این مثال، arg1، arg2 و arg3 آرگومان‌های خط فرمان هستند که به برنامه my_script.py ارسال می‌شوند.

دسترسی به آرگومان‌ها با استفاده از sys.argv

ماژول sys آرگومان‌های خط فرمان را در یک لیست به نام sys.argv ذخیره می‌کند. sys.argv یک لیست از رشته‌ها است که در آن اولین عنصر (sys.argv[0]) نام فایل اسکریپت پایتون است و عناصر بعدی (sys.argv[1]، sys.argv[2] و غیره) آرگومان‌های خط فرمان هستند.

برای مثال، اگر برنامه my_script.py زیر را داشته باشیم:

import sys

print("نام فایل اسکریپت:", sys.argv[0])
print("آرگومان اول:", sys.argv[1])
print("آرگومان دوم:", sys.argv[2])
print("آرگومان سوم:", sys.argv[3])

و آن را به صورت زیر اجرا کنیم:

python my_script.py hello world 123

خروجی برنامه به صورت زیر خواهد بود:

نام فایل اسکریپت: my_script.py
آرگومان اول: hello
آرگومان دوم: world
آرگومان سوم: 123

تبدیل آرگومان‌ها به انواع داده‌ای دیگر

همانطور که اشاره شد، آرگومان‌های خط فرمان به صورت رشته‌ای دریافت می‌شوند. اگر نیاز داشته باشیم که آرگومان‌ها را به انواع داده‌ای دیگری مانند عدد صحیح یا اعشاری تبدیل کنیم، باید این کار را به صورت دستی انجام دهیم. برای مثال:

import sys

try:
    number = int(sys.argv[1])
    print("عدد وارد شده:", number)
except ValueError:
    print("آرگومان اول باید یک عدد صحیح باشد.")

در این مثال، ما سعی می‌کنیم آرگومان اول را به یک عدد صحیح تبدیل کنیم. اگر آرگومان یک عدد صحیح نباشد، یک استثنای ValueError رخ می‌دهد و پیام خطا چاپ می‌شود.

مدیریت تعداد آرگومان‌ها

هنگام استفاده از آرگومان‌های خط فرمان، مهم است که تعداد آرگومان‌های مورد انتظار را بررسی کنیم. اگر برنامه به تعداد مشخصی آرگومان نیاز داشته باشد، باید بررسی کنیم که آیا کاربر تعداد آرگومان‌های صحیح را وارد کرده است یا خیر. می‌توانیم این کار را با استفاده از تابع len() انجام دهیم:

import sys

if len(sys.argv) != 3:
    print("استفاده: python my_script.py arg1 arg2")
else:
    print("آرگومان اول:", sys.argv[1])
    print("آرگومان دوم:", sys.argv[2])

در این مثال، ما بررسی می‌کنیم که آیا کاربر دقیقاً دو آرگومان وارد کرده است یا خیر. اگر تعداد آرگومان‌ها صحیح نباشد، یک پیام راهنما چاپ می‌شود. در غیر این صورت، آرگومان‌ها چاپ می‌شوند.

استفاده از ماژول argparse برای مدیریت پیچیده‌تر آرگومان‌ها

برای برنامه‌هایی که نیاز به مدیریت آرگومان‌های خط فرمان پیچیده‌تری دارند، ماژول argparse یک ابزار قدرتمندتر و انعطاف‌پذیرتر است. argparse به ما امکان می‌دهد تا آرگومان‌های اختیاری و اجباری، انواع داده‌ای مختلف، پیام‌های راهنما و سایر ویژگی‌های پیشرفته را تعریف کنیم.

برای مثال، برنامه زیر از argparse برای تعریف دو آرگومان اختیاری به نام‌های --name و --age استفاده می‌کند:

import argparse

parser = argparse.ArgumentParser(description="یک برنامه ساده برای دریافت نام و سن.")
parser.add_argument("--name", help="نام کاربر")
parser.add_argument("--age", type=int, help="سن کاربر")

args = parser.parse_args()

if args.name:
    print("نام:", args.name)
if args.age:
    print("سن:", args.age)

این برنامه را می‌توان به صورت‌های مختلفی اجرا کرد:

python my_script.py --name John --age 30
python my_script.py --name Jane
python my_script.py --age 25
python my_script.py

argparse به طور خودکار آرگومان‌ها را تجزیه می‌کند و مقادیر آن‌ها را در شی args ذخیره می‌کند. ما می‌توانیم با استفاده از نام آرگومان‌ها (مانند args.name و args.age) به این مقادیر دسترسی پیدا کنیم.

مزایای استفاده از آرگومان‌های خط فرمان

استفاده از آرگومان‌های خط فرمان مزایای متعددی دارد:

• انعطاف‌پذیری: آرگومان‌های خط فرمان به ما امکان می‌دهند تا رفتار برنامه را بدون نیاز به تغییر کد منبع آن تغییر دهیم.
• قابلیت استفاده مجدد: برنامه‌هایی که از آرگومان‌های خط فرمان استفاده می‌کنند، می‌توانند برای انجام وظایف مختلف با ورودی‌های مختلف استفاده شوند.
• اتوماسیون: آرگومان‌های خط فرمان به ما امکان می‌دهند تا برنامه‌ها را به صورت خودکار با استفاده از اسکریپت‌ها و ابزارهای دیگر اجرا کنیم.

نتیجه‌گیری

ماژول sys و به ویژه لیست sys.argv ابزاری ساده و قدرتمند برای دسترسی به آرگومان‌های خط فرمان در پایتون هستند. برای برنامه‌های پیچیده‌تر، ماژول argparse یک راه حل انعطاف‌پذیرتر و پیشرفته‌تر ارائه می‌دهد. با استفاده از این ابزارها، می‌توانیم برنامه‌هایی بنویسیم که به راحتی با ورودی‌های مختلف سازگار شوند و قابلیت استفاده مجدد بالایی داشته باشند.