نمونه‌ای کامل از بازفرمت کردن (Reformat) کد در پایتون
در این بخش، نمونه‌ای از یک اسکریپت پایتون را می‌بینید که در ابتدا فرمت مناسبی ندارد: تو رفتگی‌ها رعایت نشده، ترتیب importها نامناسب است، خطوط خیلی طولانی هستند، و بین توابع فاصله‌گذاری درست وجود ندارد. سپس نسخه‌ای از همین کد را که با ابزار black بازفرمت شده، مشاهده می‌کنید.
کد اولیه (نامنظم):
import os,sys
import requests
def connect():print("connecting...")
def download_file(url,filename):r=requests.get(url);f=open(filename,'wb');f.write(r.content);f.close()
def main():connect();download_file("https://example.com/sample_data/very/long/path/with/file.txt","output.txt")
main()
دستور اجرای black:
black script.py
کد بعد از Reformat با black:
import os
import sys
import requests
def connect():
print("connecting...")
def download_file(url, filename):
r = requests.get(url)
f = open(filename, "wb")
f.write(r.content)
f.close()
def main():
connect()
download_file(
"https://example.com/sample_data/very/long/path/with/file.txt",
"output.txt",
)
main()
نکات قابل توجه:
- هر
importدر یک خط قرار گرفته و مرتب شده است. - بین توابع فاصله خالی رعایت شده است.
- خط طولانی آدرس URL شکسته و به چند خط قابل‌خواندن تبدیل شده است.
- از تو رفتگی‌ها برای افزایش خوانایی استفاده شده است.
با استفاده منظم از ابزارهایی مانند black، کد شما نه‌تنها زیباتر و تمیزتر خواهد بود، بلکه در کار تیمی نیز تفاوت سبک‌ها را به حداقل می‌رسانید.