سرفصل‌ها درس 240 از 250 · خروجی نهایی: ارسال پروژه (بسته‌بندی پروژه)
خروجی نهایی: ارسال پروژه (بسته‌بندی پروژه)

طرح‌بندی مخزن

شما در پروژه‌های پایانی قبلی چیزی واقعی ساختید: یک کاپیتان پشتیبانی، یک استخراجگر سند، یک گیت ارزیابی. در حال حاضر احتمالاً به صورت توده‌ای از سلول‌ها یا یک اسکریپت طولانی وجود دارد. مدیر استخدامی که آن را باز می‌کند باید حدس بزند چیزها کجا هستند، و استخدام‌کننده‌ای که آن را کلون می‌کند و راه واضحی برای اجرای آن نمی‌بیند، تب را می‌بندد. مهم‌ترین کاری که می‌توانید برای یک پروژهٔ پرتفولیو انجام دهید این است که آن را با یک چیدمان خسته‌کننده و متعارف ارائه کنید تا هر کسی بتواند ظرف ۳۰ ثانیه راهش را پیدا کند.

یک نکته صادقانه از همان ابتدا: این ماژول درباره مخزن (repo) است، نه استقرار زنده در ابر. ما نمی‌توانیم از داخل مرورگر شما یک سرور راه‌اندازی کنیم یا آن را به یک میزبان (host) ارسال (push) کنیم، و قرار نیست تظاهر به این کار کنیم. چیزی که می‌توانید در اینجا بیاموزید و اثبات کنید، ساختار، تست‌ها و اجرای یک‌دستوری است که استقرار (deploy) را در آینده بسیار ساده می‌کند. یادداشت‌های مربوط به استقرار در انتها دقیقاً همان هستند -> یادداشت‌هایی که به‌عنوان «امتیازدهی‌نشده» علامت‌گذاری شده‌اند.

قالبی که تقریباً همه پروژه‌های پایتون به آن می‌رسند:

my_project/
  README.md            # what it is + how to run it
  pyproject.toml       # name, version, dependencies
  .env.example         # the shape of the secrets (NEVER the real ones)
  src/
    my_project/        # the importable package
      __init__.py
      __main__.py      # runs on `python -m my_project`
      core.py          # your actual code
  tests/
    test_my_project.py # pytest finds these by the test_ prefix

دو نکته قابل توجه. اول، پکیج زیر قرار دارد src/ در پوشه‌ای با نام پروژه قرار دارد -> این «ساختار src» است و مانع از آن می‌شود که تست‌های شما به‌طور تصادفی پوشه محلی را به جای بسته نصب‌شده وارد کنند. دوم اینکه، نام دایرکتوری بسته با نام پروژه مطابقت دارد: پروژه‌ای به نام triage می‌شود src/triage/، یک پروژه به نام copilot gets src/copilot/. پاسخ واحد و ثابتی وجود ندارد -> درخت تابعی از نام است.

وظیفه شما نوشتن آن تابع است. build_manifest(name) یک نام پروژه را می‌گیرد و فهرستی مرتب‌شده از رشته‌های مسیر را که باید در مخزن باشد، بازمی‌گرداند. باید شامل README.md, pyproject.toml، یک دایرکتوری بسته زیر src/<name>/ حاوی __init__.py و یک فایل ماژول، و یک tests/test_*.py فایل. نام را به یک مسیر بسته معتبر نرمال‌سازی کنید (حروف کوچک، و تبدیل فضاها و خط تیره به زیرخط، زیرا doc-extractor یک نام ماژول قابل واردکردن نیست اما doc_extractor است).

این همان مینیفستی است که یک اسکریپت اسکلت‌بندی روی دیسک ایجاد می‌کند. ما فایل‌هایی را در grader نمی‌نویسیم -> ما در حال بررسی هستیم که شما می‌توانید درخت صحیح را برای هر نام پروژه‌ای توصیف کنید. دکمه Run را فشار دهید تا چیدمان یک پروژه با نام triage.

نوبت شما

نوشتن build_manifest(name) که درخت فایل‌های مخزن پروژه را به‌عنوان فهرستی مرتب‌شده از رشته‌های مسیر بازمی‌گرداند. باید شامل باشد README.md, pyproject.toml، دایرکتوری بسته زیر src/<pkg>/ با یک __init__.py، یک __main__.py (همان فایلی است که باعث می‌شود python -m <pkg>، دستور run در درس ۳، work) و حداقل یک ماژول دیگر .py فایل، و یک فایل آزمایشی به نام tests/test_<pkg>.py. نرمال‌سازی name آنها را در پوشه package قرار دهید (با حروف کوچک، فضاها و خط‌تیره تبدیل به زیرخط می‌شوند) تا نام پروژه متفاوت، ساختار درختی متفاوتی ایجاد کند.

مشکلی در این درس دیدید؟ گزارشش کنید · دربارهٔ این درس بپرسید

این تمرین به‌زودی باز می‌شود

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