استفاده از ماژول subprocess در پایتون: راهنمای جامع

ماژول subprocess در پایتون ابزاری قدرتمند برای اجرای دستورات سیستم عامل، مدیریت فرآیندها و تعامل با برنامه‌های خارجی است. این ماژول به شما امکان می‌دهد تا از قابلیت‌های سیستم عامل خود مستقیماً از داخل اسکریپت‌های پایتون استفاده کنید. این مقاله به بررسی عمیق ماژول subprocess، کاربردهای آن و نحوه استفاده از آن در سناریوهای مختلف می‌پردازد. این آموزش در دسته بندی ‘مبانی پایتون’ قرار می‌گیرد و برای برنامه نویسان مبتدی و متوسط مناسب است.

چرا از ماژول subprocess استفاده کنیم؟

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

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

مفاهیم کلیدی

قبل از شروع، مهم است که با برخی از مفاهیم کلیدی مرتبط با ماژول subprocess آشنا شوید:

• فرآیند (Process): یک نمونه در حال اجرا از یک برنامه است.
• دستور (Command): یک دستور خط فرمان که به سیستم عامل داده می‌شود.
• ورودی استاندارد (stdin): جریانی که داده‌ها از طریق آن به برنامه ارسال می‌شوند.
• خروجی استاندارد (stdout): جریانی که داده‌ها از طریق آن از برنامه دریافت می‌شوند.
• خطای استاندارد (stderr): جریانی که پیام‌های خطا از طریق آن از برنامه دریافت می‌شوند.
• کد بازگشت (Return Code): یک عدد صحیح که نشان‌دهنده وضعیت اتمام فرآیند است. مقدار 0 معمولاً نشان‌دهنده اجرای موفقیت‌آمیز است.

تابع run()

تابع run() ساده‌ترین و توصیه شده‌ترین راه برای اجرای دستورات سیستم عامل با استفاده از ماژول subprocess است. این تابع دستور را اجرا می‌کند، منتظر می‌ماند تا فرآیند به پایان برسد و سپس یک شیء CompletedProcess را برمی‌گرداند که حاوی اطلاعاتی در مورد فرآیند اجرا شده است.

import subprocess

result = subprocess.run(['ls', '-l'], capture_output=True, text=True)

print("کد بازگشت:", result.returncode)
print("خروجی استاندارد:", result.stdout)
print("خطای استاندارد:", result.stderr)

در این مثال، دستور ls -l اجرا می‌شود. آرگومان capture_output=True باعث می‌شود که خروجی استاندارد و خطای استاندارد در شیء CompletedProcess ذخیره شوند. آرگومان text=True باعث می‌شود که خروجی به صورت رشته (text) برگردانده شود، نه بایت.

تابع Popen()

تابع Popen() انعطاف‌پذیری بیشتری نسبت به run() ارائه می‌دهد. این تابع یک فرآیند جدید را ایجاد می‌کند، اما منتظر نمی‌ماند تا فرآیند به پایان برسد. شما می‌توانید با استفاده از متدهای مختلف شیء Popen، با فرآیند تعامل داشته باشید، مانند ارسال ورودی، خواندن خروجی و منتظر ماندن برای اتمام فرآیند.

import subprocess

process = subprocess.Popen(['ping', '8.8.8.8'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)

while True:
    output = process.stdout.readline()
    if output == '' and process.poll() is not None:
        break
    if output:
        print(output.strip())

return_code = process.poll()
print("کد بازگشت:", return_code)

در این مثال، دستور ping 8.8.8.8 اجرا می‌شود. آرگومان‌های stdout=subprocess.PIPE و stderr=subprocess.PIPE باعث می‌شوند که خروجی استاندارد و خطای استاندارد به لوله‌هایی (pipes) هدایت شوند که می‌توانید از آن‌ها برای خواندن خروجی استفاده کنید. حلقه while به طور مداوم خروجی را از لوله می‌خواند و چاپ می‌کند تا زمانی که فرآیند به پایان برسد.

ارسال ورودی به فرآیند

شما می‌توانید با استفاده از آرگومان input در تابع run() یا با استفاده از متد communicate() در شیء Popen، ورودی را به فرآیند ارسال کنید.

import subprocess

# با استفاده از run()
result = subprocess.run(['wc', '-c'], input='Hello, world!', capture_output=True, text=True)
print("تعداد کاراکترها:", result.stdout.strip())

# با استفاده از Popen()
process = subprocess.Popen(['wc', '-c'], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
output, error = process.communicate(input='Hello, world!')
print("تعداد کاراکترها:", output.strip())

مدیریت خطاها

هنگام استفاده از ماژول subprocess، مهم است که خطاها را به درستی مدیریت کنید. اگر فرآیند با خطا مواجه شود، کد بازگشت غیر صفر خواهد بود. شما می‌توانید با بررسی کد بازگشت، وجود خطا را تشخیص دهید.

import subprocess

result = subprocess.run(['nonexistent_command'], capture_output=True, text=True)

if result.returncode != 0:
    print("خطا:", result.stderr)
else:
    print("اجرا موفقیت‌آمیز")

نکات امنیتی

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

# ناامن:
subprocess.run('ls ' + user_input)

# امن:
subprocess.run(['ls', user_input])

سناریوهای کاربردی

ماژول subprocess در طیف گسترده‌ای از سناریوها کاربرد دارد، از جمله:

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

نتیجه‌گیری

ماژول subprocess ابزاری قدرتمند و انعطاف‌پذیر برای تعامل با سیستم عامل و برنامه‌های خارجی از داخل اسکریپت‌های پایتون است. با استفاده از این ماژول، می‌توانید قابلیت‌های سیستم عامل خود را گسترش دهید و برنامه‌های پایتون خود را با سایر ابزارها و برنامه‌ها ادغام کنید. با درک مفاهیم کلیدی و استفاده از توابع run() و Popen()، می‌توانید به طور موثر از این ماژول در پروژه‌های خود استفاده کنید.