Chương trình học Bài 240 trên tổng số 250 · Dự án cuối khóa: Ship It (Đóng gói dự án của bạn)
Dự án cuối khóa: Ship It (Đóng gói dự án của bạn)

Bố cục Repo

Bạn đã xây dựng được những sản phẩm thực tế trong các dự án cuối khóa trước: một trợ lý hỗ trợ, một công cụ trích xuất tài liệu, một cổng đánh giá. Hiện tại chúng có thể đang nằm dưới dạng một đống ô hoặc một đoạn script dài. Một quản lý tuyển dụng khi mở nó sẽ phải đoán vị trí của các thành phần, và một người tuyển dụng khi clone nó mà không thấy cách chạy rõ ràng sẽ đóng tab ngay lập tức. Việc quan trọng nhất bạn có thể làm cho một dự án portfolio là cho nó một bố cục nhàm chán, truyền thống để bất kỳ ai cũng có thể tìm hiểu trong 30 giây.

Lưu ý trung thực ngay từ đầu:mô-đun này nói về repo, không phải triển khai đám mây trực tiếp. Chúng ta không thể khởi chạy server hoặc đẩy lên host từ trong trình duyệt của bạn, và chúng ta sẽ không giả vờ làm điều đó. Những gì bạn can học và chứng minh ở đây là cấu trúc, các bài kiểm tra, và lệnh chạy một lần giúp việc triển khai sau này trở nên dễ dàng. Các ghi chú triển khai ở cuối chính xác là những ghi chú đó -> ghi chú, được đánh dấu là không tính điểm.

Bố cục mà hầu hết mọi dự án Python đều hướng tới:

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

Có hai điều cần lưu ý. Đầu tiên, gói nằm dưới src/ trong một thư mục được đặt tên theo dự án -> đó là "cấu trúc src", và nó ngăn các bài kiểm tra của bạn vô tình nhập thư mục cục bộ thay vì gói đã cài đặt. Thứ hai, tên thư mục gói theo sát tên dự án: một dự án tên là triage sẽ có src/triage/, một dự án tên là copilot sẽ có src/copilot/. Không có một câu trả lời cố định nào -> cây thư mục là một hàm của cái tên.

Nhiệm vụ của bạn là viết hàm đó. build_manifest(name) nhận vào một tên dự án và trả về danh sách các tệp mà repo nên chứa, dưới dạng một danh sách sorted các chuỗi đường dẫn. Nó phải bao gồm README.md, pyproject.toml, một thư mục package dưới src/<name>/ chứa __init__.py và một tệp module, và một tệp tests/test_*.py. Chuẩn hóa tên thành một thư mục package hợp lệ (chữ thường, và chuyển khoảng trắng và dấu gạch ngang thành dấu gạch dưới, vì doc-extractor không phải là tên module có thể import nhưng doc_extractor thì có).

Đây là manifest mà một script scaffolding sẽ tạo trên đĩa. Chúng ta không viết file trong grader -> chúng ta đang kiểm tra xem bạn có thể mô tả đúng cây thư mục cho bất kỳ tên dự án nào không. Nhấn Run để in bố cục cho một dự án tên là triage.

Đến lượt bạn

Viết build_manifest(name) trả về cấu trúc thư mục của một dự án dưới dạng danh sách các chuỗi đường dẫn được sắp xếp sorted. Nó phải bao gồm README.md, pyproject.toml, thư mục package dưới src/<pkg>/ với một __init__.py, một __main__.py (tệp đó là thứ làm cho python -m <pkg>, lệnh chạy trong bài học 3, hoạt động) và ít nhất một tệp module .py khác, và một tệp kiểm thử tên là tests/test_<pkg>.py. Chuẩn hóa name vào thư mục package (chữ thường, khoảng trắng và dấu gạch ngang trở thành dấu gạch dưới) để tên dự án khác nhau tạo ra cấu trúc khác nhau.

Bạn thấy vấn đề gì trong bài học này? Hãy báo cáo nó · Hỏi về bài học này

Bài tập này sẽ sớm mở.

Hoàn thành bài học trước đó để mở khóa bài này. Toàn bộ khóa học là miễn phí, không cần tài khoản, và bạn có thể đọc bài học này ngay bây giờ.