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

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

چرا کد پایتون را بازسازی کنیم؟

بازسازی کد مزایای متعددی را ارائه می‌دهد، از جمله:

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

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

چه زمانی بازسازی کنیم؟

دانستن زمان بازسازی بسیار مهم است. در اینجا چند سناریو رایج آورده شده است:

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

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

بوهای بد کد نشانه‌های سطحی هستند که معمولاً مربوط به یک مشکل عمیق‌تر در سیستم هستند. آنها همیشه نشان دهنده یک مشکل نیستند، اما اغلب نیاز به بررسی بیشتر دارند.

بوهای بد رایج کد پایتون:

• کد تکراری: کد یکسان یا بسیار مشابه که در چندین مکان ظاهر می‌شود.
• متد/تابع طولانی: متدها یا توابعی که بیش از حد طولانی و پیچیده هستند.
• کلاس بزرگ: کلاس‌هایی که مسئولیت‌های زیادی دارند.
• لیست پارامتر طولانی: متدها یا توابعی با پارامترهای زیاد.
• توده‌های داده: گروه‌هایی از داده‌ها که اغلب با هم ظاهر می‌شوند.
• وسواس ابتدایی: استفاده از انواع داده‌های ابتدایی به جای ایجاد اشیاء.
• عبارات Switch: زنجیره‌های طولانی عبارات if/elif/else یا عبارات switch.
• جراحی با تفنگ ساچمه‌ای: ایجاد یک تغییر واحد نیاز به ایجاد تغییرات کوچک زیادی در کلاس‌های مختلف دارد.
• تغییر واگرا: یک کلاس معمولاً به روش‌های مختلف برای دلایل مختلف تغییر می‌کند.
• حسادت ویژگی: یک متد به داده‌های یک شی دیگر بیشتر از داده‌های خودش دسترسی پیدا می‌کند.
• زنجیره‌های پیام: یک مشتری از یک شی می‌خواهد که از یک شی دیگر بخواهد که از یک شی دیگر درخواست کند...

تکنیک‌های بازسازی کد پایتون: یک راهنمای عملی

این بخش به تفصیل چندین تکنیک رایج بازسازی کد پایتون را با مثال‌های عملی شرح می‌دهد.

1. استخراج متد/تابع

این تکنیک شامل گرفتن یک بلوک کد در یک متد یا تابع و انتقال آن به یک متد یا تابع جداگانه جدید است. این کار پیچیدگی متد اصلی را کاهش می‌دهد و کد استخراج شده را قابل استفاده مجدد می‌کند.

مثال:

            
def print_invoice(customer, details):
    print("***********************")
    print(f"Customer: {customer}")
    print("***********************")

    total_amount = 0
    for order in details["orders"]:
        total_amount += order["amount"]

    print(f"Amount is : {total_amount}")

    if total_amount > 1000:
        print("You earned a discount!")

            

              
                Copy
              
            
          

بازسازی شده:

            
def print_header(customer):
    print("***********************")
    print(f"Customer: {customer}")
    print("***********************")


def calculate_total(details):
    total_amount = 0
    for order in details["orders"]:
        total_amount += order["amount"]
    return total_amount


def print_invoice(customer, details):
    print_header(customer)
    total_amount = calculate_total(details)
    print(f"Amount is : {total_amount}")

    if total_amount > 1000:
        print("You earned a discount!")

            

              
                Copy
              
            
          

2. استخراج کلاس

وقتی یک کلاس مسئولیت‌های زیادی دارد، برخی از آنها را به یک کلاس جدید منتقل کنید. این اصل مسئولیت واحد را ترویج می‌کند.

مثال:

            
class Person:
    def __init__(self, name, phone_number, office_area_code, office_number):
        self.name = name
        self.phone_number = phone_number
        self.office_area_code = office_area_code
        self.office_number = office_number

    def get_name(self):
        return self.name

    def get_phone_number(self):
        return f"({self.office_area_code}) {self.office_number}"

            

              
                Copy
              
            
          

بازسازی شده:

            
class PhoneNumber:
    def __init__(self, area_code, number):
        self.area_code = area_code
        self.number = number

    def get_phone_number(self):
        return f"({self.area_code}) {self.number}"


class Person:
    def __init__(self, name, phone_number):
        self.name = name
        self.phone_number = phone_number

    def get_name(self):
        return self.name


            

              
                Copy
              
            
          

3. متد/تابع درون خطی

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

مثال:

            
def get_rating(driver):
    return more_than_five_late_deliveries(driver) ? 2 : 1


def more_than_five_late_deliveries(driver):
    return driver.number_of_late_deliveries > 5

            

              
                Copy
              
            
          

بازسازی شده:

            
def get_rating(driver):
    return driver.number_of_late_deliveries > 5 ? 2 : 1

            

              
                Copy
              
            
          

4. جایگزینی متغیر موقت با پرس و جو

به جای استفاده از یک متغیر موقت برای نگهداری نتیجه یک عبارت، عبارت را به یک متد منتقل کنید. این کار از تکرار کد جلوگیری می‌کند و خوانایی بهتری را ترویج می‌کند.

مثال:

            
def get_price(order):
    base_price = order.quantity * order.item_price
    discount_factor = 0.98 if base_price > 1000 else 0.95
    return base_price * discount_factor

            

              
                Copy
              
            
          

بازسازی شده:

            
def get_price(order):
    return base_price(order) * discount_factor(order)


def base_price(order):
    return order.quantity * order.item_price


def discount_factor(order):
    return 0.98 if base_price(order) > 1000 else 0.95

            

              
                Copy
              
            
          

5. معرفی شی پارامتر

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

مثال:

            
def calculate_total(width, height, depth, weight, shipping_method):
    # Calculation logic
    pass

            

              
                Copy
              
            
          

بازسازی شده:

            
class ShippingDetails:
    def __init__(self, width, height, depth, weight, shipping_method):
        self.width = width
        self.height = height
        self.depth = depth
        self.weight = weight
        self.shipping_method = shipping_method


def calculate_total(shipping_details):
    # Calculation logic using shipping_details attributes
    pass

            

              
                Copy