بتل کد Battle Codeدارد باز می‌شود…

پایتون ۱

این هشت اصطلاح را در هر آموزش پایتونِ کمی جدی‌تر و در هر code review می‌شنوی. بیشترشان راه‌های کوتاه‌تر و خواناتر نوشتن چیزهایی است که همین حالا بلدی.

دستور و پیشنهاد در code review

در نظرهای code review بیشتر فعل امری می‌بینی: Use an f-string، Add a type hint. برای مؤدب‌تر شدن اولش Please می‌آید، یا با You can شروع می‌کنند: You can replace this loop. این‌ها دستور تند نیستند، پیشنهاد دوستانه‌اند.

هشت کلمه‌ی این درس

list comprehension (لیست کامپری‌هِنشِن): ساختن یک لیست در یک خط، با for داخل کروشه

comprehension در انگلیسی یعنی «فهم» و در ریاضی یعنی «تعریف کردن یک مجموعه با یک قاعده». list comprehension در پایتون روش کوتاهی است برای ساختن لیست تازه از روی یک لیست دیگر: به‌جای چند خط for و append، همه را در یک خط داخل کروشه می‌نویسی. می‌توانی یک if هم آخرش بگذاری تا فقط بعضی عضوها را نگه دارد.

Use a list comprehension instead of a loop with append.

به‌جای حلقه‌ای که append می‌کند، از list comprehension استفاده کن.

slicing (اِسلایسینگ): برش زدن؛ برداشتن تکه‌ای از لیست یا رشته

slice یعنی «برش»، مثل یک برش نان یا پیتزا. slicing در پایتون یعنی برداشتن یک تکه از لیست یا رشته با [start:stop]. خانه‌ی stop خودش جزو برش نیست، و اگر عددی را ننویسی یعنی «از اول» یا «تا آخر». عدد سوم گام است: ‎[::-1]‎ کل چیز را برعکس می‌کند.

You can reverse a string with slicing: text[::-1].

می‌توانی یک رشته را با برش زدن برعکس کنی: text[::-1].

f-string (اِف‌اِسترینگ): رشته‌ای در پایتون که مقدار متغیرها را داخل خودش می‌نشاند

f کوتاه‌شده‌ی formatted است، یعنی «قالب‌بندی‌شده». f-string رشته‌ای در پایتون است که قبل از کوتیشنش حرف f می‌آید و هر چه داخل آکولاد بنویسی، مقدارش جای خودش در متن می‌نشیند. از چسباندن رشته‌ها با + خواناتر است و عدد را هم خودش به متن تبدیل می‌کند.

Use an f-string to put the variable inside the message.

از f-string استفاده کن تا متغیر را داخل پیام بگذاری.

unpacking (آن‌پَکینگ): باز کردن چند مقدار و ریختنشان در چند متغیر

pack یعنی «چمدان بستن» و unpack یعنی «باز کردن چمدان و درآوردن وسایل». unpacking در پایتون یعنی مقدارهای یک تاپل یا لیست را یک‌جا در چند متغیر بریزی: a, b = 1, 2. با ستاره (*) هم می‌شود «بقیه» را در یک لیست جمع کرد، یا یک لیست را موقع صدا زدن تابع باز کرد.

Tuple unpacking lets you swap two variables in one line.

باز کردن تاپل به تو اجازه می‌دهد جای دو متغیر را در یک خط عوض کنی.

keyword argument (کی‌وِرد آرگیومِنت): آرگومانی که با اسمش به تابع داده می‌شود

keyword یعنی «کلمه‌ی کلیدی» و این‌جا منظور اسم پارامتر است. keyword argument آرگومانی است که موقع صدا زدن تابع اسمش را هم می‌نویسی: greet(name="Ali"). این‌طوری ترتیب مهم نیست و هر کس کد را بخواند می‌فهمد هر مقدار برای چیست. در پایتون کوتاهش kwarg است و ‎**kwargs همه‌شان را در یک دیکشنری جمع می‌کند.

Pass sep as a keyword argument: print(1, 2, sep="-").

sep را به‌شکل آرگومان اسم‌دار بده: print(1, 2, sep="-").

positional argument (پوزیشِنال آرگیومِنت): آرگومانی که از روی جایش به پارامتر می‌رسد

position یعنی «جا» یا «موقعیت». positional argument آرگومانی است که بدون اسم به تابع می‌دهی و پایتون از روی ترتیبش می‌فهمد مال کدام پارامتر است: اولی به پارامتر اول، دومی به دومی. کوتاه است، ولی اگر ترتیب را اشتباه بنویسی مقدارها جابه‌جا می‌رسند و خطایی هم نمی‌بینی.

The function takes two positional arguments: width and height.

این تابع دو آرگومان ترتیبی می‌گیرد: عرض و ارتفاع.

type hint (تایپ هینت): یادداشتی کنار متغیر یا تابع که نوعش را می‌گوید

hint یعنی «اشاره» یا «سرنخ». type hint در پایتون یادداشتی است که می‌گوید یک پارامتر، متغیر یا خروجی تابع قرار است از چه نوعی باشد: age: int یا ‎-> str. خود پایتون موقع اجرا آن را چک نمی‌کند؛ ولی ادیتور و ابزارهایی مثل mypy با آن اشتباه‌ها را قبل از اجرا پیدا می‌کنند و کد هم خواناتر می‌شود.

Add a type hint so the editor knows this function returns a string.

یک type hint اضافه کن تا ادیتور بداند این تابع رشته برمی‌گرداند.

dunder method (داندِر مِتِد): متد ویژه با دو زیرخط در دو طرف اسمش، مثل __init__

dunder کوتاه‌شده‌ی double underscore است، یعنی «دو زیرخط». dunder method در پایتون متدی است که اسمش بین دو جفت زیرخط است، مثل __init__، __str__ یا __len__. خودت معمولاً صدایشان نمی‌زنی؛ پایتون در لحظه‌ی خاصی خودش سراغشان می‌رود: len(x) در واقع x.__len__() را صدا می‌زند و علامت + هم __add__ را.

Define the __str__ dunder method to control what print shows.

متد ویژه‌ی __str__ را تعریف کن تا تعیین کنی print چه چیزی نشان دهد.

نظرهای بازبین روی یک pull request

Review comments on pull request #12

Line 4: You can replace this loop with a list comprehension. It is shorter and easier to read.
Line 9: Use an f-string here instead of joining strings with +.
Line 15: Please call resize() with keyword arguments: resize(width=100, height=50). With two positional arguments, it is easy to mix them up.
Line 20: Nice use of unpacking to swap the two values!
Line 22: Add a type hint for the return value. Everything else looks good to me.

نظرهای بازبینی روی pull request شماره‌ی ۱۲

خط ۴: می‌توانی این حلقه را با یک list comprehension عوض کنی. کوتاه‌تر است و راحت‌تر خوانده می‌شود.
خط ۹: این‌جا به‌جای چسباندن رشته‌ها با +، از f-string استفاده کن.
خط ۱۵: لطفاً resize را با آرگومان‌های اسم‌دار صدا بزن: resize(width=100, height=50). با دو آرگومان بی‌اسم، راحت ممکن است جایشان را قاطی کنی.
خط ۲۰: چه استفاده‌ی خوبی از unpacking برای جابه‌جا کردن دو مقدار!
خط ۲۲: برای مقدار برگشتی یک type hint اضافه کن. بقیه‌اش به نظرم خوب است.