Bài học và trò chơi học tập

Debugging Python

Tìm và sửa lỗi thật trong script của một thiết bị đo dưới đáy biển chạy trên Raspberry Pi 4, với đúng các traceback và log mà engine này in ra.

Khóa học

Debugging Python is an intermediate Coding course in seven lessons, after Python from zero and Fix the bug. The scripts belong to Nereus, a deep sea probe, and every lesson starts with one of them broken: a real bug that crashes it or quietly gets a number wrong. You find it with the lesson's technique, fix it, and the check proves the fixed output. The circuits are gallery Pi builds: two lamps, a PIR standing in for the sonar, a button and a lamp, and the traffic light module.

  1. Đọc traceback: một script đo độ sâu bị sập, đọc từ dưới lên; một số đo sai trong dữ liệu, một tên bị gõ sai, một khóa dict bị thiếu, và dữ liệu serial xấu được bắt bằng except ValueError trong khi traceback.print_exc() vẫn giữ manh mối.
  2. Print và logging: một đèn báo tiếp xúc sonar không bao giờ sáng, được tìm bằng một print đặt đúng chỗ (một bộ đếm bị reset ngay trong vòng lặp của nó), rồi các print chuyển thành logging với các mức, tên logger và số dòng.
  3. Assert: một kho ballast xuống dưới mức rỗng mà không một lời, một assert chặn nó ngay tại giá trị sai đầu tiên, cách sửa, rồi các assert trở thành các bài kiểm tra nhỏ bắt được lỗi tràn số của một đồng đội.
  4. Chia đôi tìm lỗi: một sonar đặt đáy biển ở 21,579 m, được tìm bằng cách kiểm tra chính giữa chuỗi xử lý (lỗi thứ tự toán tử), rồi cũng cách chia đôi đó để tìm một ping sai trong 1,000 bằng mười lần thử và phiên bản firmware sai đầu tiên trong bốn lần, giống như git bisect làm.
  5. Lệch một: một chỉ mục vượt quá cuối, một vòng lặp bỏ qua số đọc đầu tiên, một biên vùng đại dương lệch bên (bật trên đèn giao thông) và bài toán cọc rào, tất cả tìm bằng một danh sách kiểm tra: đầu, cuối, bao nhiêu.
  6. Lỗi trạng thái: một nút chuyển đổi bị sập vì gán giá trị khiến tên thành cục bộ, một danh sách mặc định dùng chung cho mọi lần lặn, một bản sao lưu tự làm rỗng mình và một bản ghi rò rỉ từ lần lặn này sang lần lặn kia.
  7. Bài cuối: ba script hỏng: màn kết.

Hồi kết

Một giờ trước giờ lặn, ba script gặp sự cố. Một đèn hiệu mặt nước sáng mãi thay vì nhấp nháy (lỗi copy-paste, tìm bằng cách đọc vòng lặp như chính chiếc đèn), một bản tóm tắt nhật ký lặn sập ngay dòng đầu (dòng đầu CSV, tìm từ traceback) và nút chế độ chết ở lần bấm thứ ba (một bộ đếm không bao giờ vòng lại, tìm bằng danh sách kiểm tra lệch-một). Mỗi lần sửa được chứng minh trên mạch, và khóa học kết thúc bằng một báo cáo lỗi viết tay cho từng cái: triệu chứng, nguyên nhân, cách sửa và bằng chứng.

Pi engine khác gì ở điểm nào

Pi chạy MicroPython 1.29, và gỡ lỗi chính là lúc các thông báo của nó quan trọng. Các bài học trích nguyên văn những gì nó in ra:

  • Traceback liệt kê tệp, dòng và hàm của từng khung, nhưng không có dòng mã nguồn hay dấu mũ của CPython, nên bạn tự mở dòng đó ra.
  • Một số thông báo được diễn đạt khác đi: unsupported types for __sub__: 'str', 'int', name 'x' isn't defined, invalid syntax for integer with base 10, và một KeyError in khóa của nó không có dấu nháy.
  • Gán cho một biến toàn cục mà không có global sẽ gây ra NameError: local variable referenced before assignment, không phải UnboundLocalError của CPython, và không nêu tên biến.
  • logging là của CPython: cùng cấp độ, cùng định dạng (kể cả %(lineno)d) và cùng những bẫy, ví dụ basicConfig không làm gì sau thông điệp đầu tiên nếu bạn không truyền force=True.
  • Không cài được pytest, nên các bài kiểm tra là các hàm thuần dùng assert, mà đó cũng chính là tất cả những gì một unit test cần.