مقدمه‌ای بر عملگر Walrus در Python

عملگر Walrus با سینتکس NAME := expr یک Assignment Expression یا عبارتی برای مقداردهی است که در Python 3.8 معرفی شده و توانسته توجه بسیاری از توسعه‌دهندگان را به خود جلب کند. طبق PEP 572، کدنویسی کم‌تر و پیشگیری از تکرار کدها که درنهایت باعث سریع‌تر شدن برنامه Python می‌شوند، منطق اصلی پشت Assignment Expression است بنابراین در ادامه‌ی مقاله با ما همراه باشید تا موارد استفاده و کاربردهای این عملگر جدید را با جزئیات بیشتری بررسی کنیم.

موارد استفاده از عملگر Walrus

جلوگیری از تکرار کدها

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

my_long_list = list(range(1000))

# You get the length twice!
if len(my_long_list) > 10:
    print(f"List is too long to consume (length={len(my_long_list)}, max=10)")

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

my_long_list = list(range(1000))

# Much better :)
if (count := len(my_long_list)) > 10:
    print(f"List is too long to consume (length={count}, max=10)")

خواناتر شدن کدها

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

result = parse_field_from(my_data)
if result:
    print("Success")

در چنین مواردی می‌توان این نوع بلوک‌های کد را با استفاده از عملگر Walrus به کدهای تمیزتری تبدیل کرد:

if result := parse_field_from(my_data):
    print("Success")

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

sample_data = [
    {"student_id": 200, "name": "Sally West", "graduation_date": "2019-05-01"},
    {"student_id": 404, "name": "Zahara Durham", "graduation_date": None},
    {"student_id": 555, "name": "Connie Coles", "graduation_date": "2020-01-15"},
    {"student_id": None, "name": "Jared Hampton", "graduation_date": None},
]

for student in sample_data:
    graduation_date = student["graduation_date"]
    if graduation_date:
        print(f'{student["name"]} graduated on {graduation_date}')
    else:
        # This nesting can be confusing!
        student_id = student["student_id"]
        if student_id:
            print(
                f'{student["name"]} is currently enrolled with ID {student_id}')
        else:
            print(f'{student["name"]} has no data')

حال statementهای تودرتو فوق را می‌توان به‌کمک عملگر Walrus به یک زنجیره از if، elif و else تبدیل کرد:

sample_data = [
    {"student_id": 200, "name": "Sally West", "graduation_date": "2019-05-01"},
    {"student_id": 404, "name": "Zahara Durham", "graduation_date": None},
    {"student_id": 555, "name": "Connie Coles", "graduation_date": "2020-01-15"},
    {"student_id": None, "name": "Jared Hampton", "graduation_date": None},
]

for student in sample_data:
    # Much cleaner
    if graduation_date := student["graduation_date"]:
        print(f'{student["name"]} graduated on {graduation_date}')
    elif student_id := student["student_id"]:
        print(f'{student["name"]} is currently enrolled with ID {student_id}')
    else:
        print(f'{student["name"]} has no data')

استفاده مجدد از متغیرها

استفاده از Regex در Python یکی از متداول‌ترین مواردی است که هر توسعه‌دهنده با آن سروکار دارد. برای مثال فرض کنید باید کد منطقه‌ی یک لیست از شماره‌های تلفن را با استفاده از Regex تشخیص داده و آن‌ها را چاپ کنید:

import re

phone_numbers = [
    "(317) 555-5555",
    "431-2973",
    "(111) 222-3344",
    "(710) 982-3811",
    "290-2918",
    "711-7712",
]

for number in phone_numbers:
    # The regular expression "\(([0-9]{3})\)" checks for a substring
    # with the pattern "(###)", where # is a 0-9 digit
    if match := re.match("\(([0-9]{3})\)", number):
        print(f"Area code: {match.group(1)}")
    else:
        print("No area code")

زمانی که می‌خواهید یک فایل را بخوانید

فرض کنید که می‌خواهید یک خط از فایلی را خوانده و در حلقه‌ی while، تغییراتی بر روی آن اعمال کنید:

f = open("walrus.txt", "r")
line = f.readline()
while line:
    do_something(line)
    line = f.readline()

همان‌طور که در کدهای بالا مشاهده می‌کنید، f.readline() دو بار تکرار شده اما به‌کمک عملگر Walrus می‌توان کدهای فوق را به‌صورت زیر خلاصه کرد:

f = open("walrus.txt", "r")
while line := f.readline():
    do_something(line)

مواردی که استفاده از عملگر Walrus توصیه نمی‌شود

استفاده از Assignment expression در برخی موارد خاص توصیه نمی‌شود زیرا ممکن است باعث ایجاد ابهام شوند:

y := f(x)  # INVALID
(y := f(x))  # Valid, though not recommended

y0 = y1 := f(x)  # INVALID
y0 = (y1 := f(x))  # Valid, though discouraged


foo(x = y := f(x))  # INVALID
foo(x=(y := f(x)))  # Valid, though probably confusing