Nhân sư có chạy mã của tôi khi thực thi 'make html' không?

Question

Tôi thừa kế một codebase khá lớn mà tôi muốn tạo tài liệu html cho. Vì nó được viết bằng Python, tôi quyết định sử dụng nhân sư vì người dùng mã đã quen với thiết kế và chức năng của tài liệu python được tạo bằng nhân sư. Tôi đã sử dụng lệnh sphinx-apidoc để tự động tạo tệp rst. Tôi đã nhập đường dẫn mô-đun vào sys.path để nhân sư có thể tìm thấy mã.

Cho đến nay rất tốt. Tuy nhiên, khi tôi cố gắng tạo html bằng cách sử dụng lệnh make html, có nhiều tracebacks bật lên và một số ví dụ trong codebase dường như được thực hiện. Điều gì có thể là lý do cho điều đó và làm thế nào tôi có thể ngăn chặn điều đó xảy ra?

Answer 1

Khi sử dụng autodoc, Nhân sư nhập các mô-đun được ghi lại, do đó, tất cả mã cấp mô-đun được thực thi. Điều này xảy ra mỗi khi bạn thực hiện "make html". Theo nghĩa đó, Nhân sư làm "chạy" mã của bạn.

Bạn có thể phải tổ chức mã của mình hơi khác một chút để làm cho các lỗi biến mất (chuyển mã cấp mô-đun thành các hàm). Xem this question để biết ví dụ về những gì có thể xảy ra.

Đây là phỏng đoán của tôi nhưng có thể không phải là toàn bộ câu chuyện. Thật khó để nói nhiều hơn nếu không có thêm thông tin.

Answer 2

def main(): 

    print('hello world') 

if __name__ == '__main__': 

    main() 

Bằng cách này mã của bạn sẽ không chạy.