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

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

فایل‌های پیکربندی چیستند؟

فایل‌های پیکربندی معمولاً فایل‌های متنی ساده‌ای هستند که شامل مجموعه‌ای از تنظیمات به صورت جفت کلید-مقدار هستند. این تنظیمات می‌توانند شامل اطلاعاتی مانند مسیر فایل‌ها، آدرس‌های سرور، تنظیمات پایگاه داده، و غیره باشند. فرمت رایج برای فایل‌های پیکربندی، فرمت INI است که توسط ماژول configparser پشتیبانی می‌شود.

فرمت INI

فایل‌های INI از بخش‌ها (Sections) و کلید-مقدارها (Key-Value pairs) تشکیل شده‌اند. هر بخش با نام خود در داخل براکت‌های مربعی ([]) مشخص می‌شود. کلید-مقدارها در داخل هر بخش با فرمت key = value تعریف می‌شوند. فایل INI می‌تواند شامل کامنت‌هایی باشد که با علامت # شروع می‌شوند.

مثال یک فایل INI:

[Database]
server = 192.168.1.100
port = 3306
user = myuser
password = mypassword

[API]
base_url = https://api.example.com
timeout = 10

آشنایی با ماژول ConfigParser

ماژول configparser یک کلاس به نام ConfigParser ارائه می‌دهد که برای خواندن، نوشتن و دستکاری فایل‌های پیکربندی استفاده می‌شود. برای استفاده از این ماژول، ابتدا باید آن را وارد (import) کنیم:

import configparser

خواندن فایل پیکربندی

برای خواندن یک فایل پیکربندی، ابتدا یک شیء از کلاس ConfigParser ایجاد می‌کنیم. سپس از متد read() برای خواندن فایل استفاده می‌کنیم.

config = configparser.ConfigParser()
config.read('config.ini')

متد read() یک لیست از نام فایل‌ها را به عنوان ورودی می‌گیرد. اگر فایل پیکربندی با موفقیت خوانده شود، اطلاعات آن در شیء config ذخیره می‌شود.

دسترسی به مقادیر پیکربندی

پس از خواندن فایل پیکربندی، می‌توانیم به مقادیر پیکربندی با استفاده از نام بخش و نام کلید دسترسی پیدا کنیم. برای این کار از متد get() استفاده می‌کنیم.

server = config.get('Database', 'server')
port = config.get('Database', 'port')
base_url = config.get('API', 'base_url')
timeout = config.get('API', 'timeout')

print(f"Server: {server}")
print(f"Port: {port}")
print(f"Base URL: {base_url}")
print(f"Timeout: {timeout}")

متد get() دو آرگومان می‌گیرد: نام بخش و نام کلید. این متد مقدار مربوط به کلید مشخص شده در بخش مشخص شده را برمی‌گرداند.

مدیریت خطاها

اگر کلید یا بخشی که به دنبال آن هستیم وجود نداشته باشد، متد get() یک استثنا (Exception) از نوع configparser.NoOptionError یا configparser.NoSectionError ایجاد می‌کند. برای جلوگیری از این خطاها، می‌توانیم از متد get() با آرگومان سوم به عنوان مقدار پیش‌فرض استفاده کنیم.

timeout = config.get('API', 'timeout', fallback=20)
print(f"Timeout: {timeout}")

در این مثال، اگر کلید timeout در بخش API وجود نداشته باشد، مقدار پیش‌فرض 20 استفاده خواهد شد.

نوشتن در فایل پیکربندی

ماژول configparser همچنین امکان نوشتن در فایل‌های پیکربندی را فراهم می‌کند. برای این کار، ابتدا باید یک بخش جدید ایجاد کنیم یا یک بخش موجود را ویرایش کنیم. سپس می‌توانیم با استفاده از متد set() مقادیر جدیدی را به بخش اضافه کنیم.

config['Database'] = {}
config['Database']['host'] = 'localhost'
config['Database']['database'] = 'mydatabase'

config['API']['new_setting'] = 'some_value'

پس از اعمال تغییرات، باید فایل پیکربندی را با استفاده از متد write() ذخیره کنیم.

with open('config.ini', 'w') as configfile:
    config.write(configfile)

متد write() یک شیء فایل (file object) را به عنوان ورودی می‌گیرد. این متد اطلاعات پیکربندی را در فایل مشخص شده می‌نویسد.

بررسی وجود بخش و کلید

برای بررسی وجود یک بخش یا کلید در فایل پیکربندی، می‌توانیم از متدهای has_section() و has_option() استفاده کنیم.

if config.has_section('Database'):
    print("بخش Database وجود دارد.")

if config.has_option('Database', 'server'):
    print("کلید server در بخش Database وجود دارد.")

حذف بخش و کلید

برای حذف یک بخش یا کلید از فایل پیکربندی، می‌توانیم از متدهای remove_section() و remove_option() استفاده کنیم.

config.remove_section('API')
config.remove_option('Database', 'password')

تبدیل نوع داده

متد get() همیشه مقادیر را به صورت رشته (string) برمی‌گرداند. اگر نیاز به تبدیل نوع داده به اعداد صحیح، اعداد اعشاری یا مقادیر بولی داشته باشیم، باید از توابع تبدیل نوع داده استفاده کنیم.

port = config.getint('Database', 'port')
timeout = config.getfloat('API', 'timeout')
debug = config.getboolean('General', 'debug')

متدهای getint()، getfloat() و getboolean() مقادیر را به ترتیب به اعداد صحیح، اعداد اعشاری و مقادیر بولی تبدیل می‌کنند.

نتیجه‌گیری

ماژول configparser ابزاری قدرتمند و انعطاف‌پذیر برای مدیریت فایل‌های پیکربندی در پایتون است. با استفاده از این ماژول، می‌توانیم تنظیمات برنامه را به راحتی تغییر دهیم و قابلیت نگهداری کد را افزایش دهیم. این ماژول برای برنامه‌هایی که نیاز به پیکربندی پویا دارند، بسیار مفید است. امیدوارم این مقاله به شما در درک و استفاده از ماژول configparser کمک کرده باشد.