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

جلسه‌ی 17: تنظیمات بیرون کد Settings Outside the Code

اسکریپتی که قرار است ماه‌ها کار کند، تنظیماتش را از یک فایل می‌خواند نه از وسط کد: کدام پوشه، چند نسخه، کجا. فرمت ساده‌ی KEY=VALUE، خط‌های توضیح با #، مقدار پیش‌فرض برای کلیدهای غایب. و قانون طلایی: رمز و کلید هیچ‌وقت داخل کد نمی‌رود.

در این جلسه یاد می‌گیری

درس

🛡️ قانون این دوره: اسکریپت فقط نشان می‌دهد یا می‌سازد. اسکریپت‌های ما فایل می‌خوانند، لیست می‌کنند، می‌سازند و کپی می‌کنند؛ هیچ‌وقت چیزی را بی‌خبر پاک نمی‌کنند. همه‌چیز در یک پوشه‌ی تمرینی خالی اجرا می‌شود که هر بار از نو ساخته می‌شود، پس هر چه می‌خواهی امتحان کن: چیزی خراب نمی‌شود. روی کامپیوتر خودت هم همیشه اول یک پوشه‌ی practice بساز و فقط داخل آن کار کن.

یادت هست؟ جلسه‌ی ۱ گفتیم چیزهایی که عوض می‌شوند را بالای اسکریپت در متغیر بگذار. برای اسکریپتی که هر شب روی کامپیوتر واقعی اجرا می‌شود، یک قدم جلوتر می‌رویم: تنظیمات را در یک فایل جدا می‌گذاریم. آن وقت برای عوض کردن پوشه‌ی بکاپ، لازم نیست کسی کد را باز کند یا حتی پایتون بلد باشد.

# settings (session 1 style)
source = "projects"
keep = 5
print(f"Backing up {source}, keeping {keep} copies")

ساده‌ترین فرمت تنظیمات: هر خط یک KEY=VALUE. خط‌هایی که با # شروع می‌شوند توضیح‌اند و خط‌های خالی هیچ. فایل‌های .env که برنامه‌نویس‌ها همه‌جا استفاده می‌کنند دقیقاً همین‌اند. مثال config.txt اسکریپت بکاپ:

with open("config.txt", "w") as f:
    f.write("# backup settings\n")
    f.write("SOURCE=projects\n")
    f.write("TARGET=backup\n")
    f.write("\n")
    f.write("KEEP=5\n")
with open("config.txt") as f:
    print(f.read())

خواندنش همان بخوان، تکه کن، در دیکشنری بگذار است: برای هر خط strip کن؛ اگر خالی بود یا با # شروع می‌شد رد کن؛ key, value = line.split("=", 1) (عدد 1 یعنی فقط از اولین = جدا کن، چون مقدار خودش می‌تواند = داشته باشد، مثل یک آدرس). کلید و مقدار را هم strip کن.

with open("config.txt", "w") as f:
    f.write("# backup settings\nSOURCE=projects\nTARGET=backup\n\nKEEP=5\n")

config = {}
with open("config.txt") as f:
    for line in f.read().splitlines():
        line = line.strip()
        if line == "" or line.startswith("#"):
            continue
        key, value = line.split("=", 1)
        config[key.strip()] = value.strip()
print(config)

فایل تنظیمات ممکن است یک کلید را نداشته باشد. به‌جای خطا، پیش‌فرض بده: config.get("KEEP", "3"). و یادت باشد همه‌چیز در فایل متن است؛ عدد را با int() تبدیل کن. اسکریپت خوب در شروع تنظیماتش را چاپ می‌کند تا اگر اشتباهی بود در لاگ دیده شود.

config = {"SOURCE": "projects", "TARGET": "backup"}
source = config.get("SOURCE", "data")
target = config.get("TARGET", "backup")
keep = int(config.get("KEEP", "3"))
print(f"source={source} target={target} keep={keep}")

قانون طلایی: رمز، کلید API و توکن هیچ‌وقت داخل کد نمی‌روند. کدی که روی گیت‌هاب می‌رود در چند دقیقه توسط ربات‌ها اسکن می‌شود و کلیدت استفاده می‌شود. رازها در فایل .env می‌مانند که در .gitignore نوشته شده تا هرگز commit نشود، و اسکریپت آن‌ها را از همان فایل یا از متغیر محیطی (os.environ) می‌خواند. در ترمینال واقعی، چیزهای غیرمحرمانه را می‌شود به‌جای فایل، به شکل آرگومان داد: python backup.py projects 5، که در پایتون در لیست sys.argv می‌نشیند (sys.argv[1] اولین آرگومان). در ادیتور سایت، همان را با input() می‌گیریم.

اشتباه‌های رایج: line.split("=") بدون 1 مقدار URL=https://x.ir/a=b را سه تکه می‌کند و خطای unpack می‌دهد. فراموش کردن strip باعث می‌شود KEEP (با فاصله) کلید دیگری باشد. و خواندن KEEP بدون int یعنی "5" > 3 خطا می‌دهد.

مثال‌های این جلسه

چالش‌ها

  1. Where Does the Secret Go? (آسان)
  2. Read the Config (آسان)
  3. Defaults (متوسط)
  4. Write the Config (متوسط)
  5. (Harder) Validate the Config (سخت)
  6. (Harder) Hide the Secrets (سخت)

بیشتر بخوان

← جلسه‌ی 16: پروژه: مینی‌شل جلسه‌ی 18: بکاپ →