Giới thiệu
pydoc mô-đun tự động tạo tài liệu từ các mô-đun Python. Tài liệu có thể được lưu dưới dạng các trang văn bản trên bảng điều khiển, hiển thị trên trình duyệt web hoặc thậm chí dưới dạng tệp HTML.
Trong bài viết này, bạn sẽ học các phương pháp để xem các tài liệu này trong nhiều trường hợp khác nhau và thậm chí tìm hiểu về docstrings giúp bạn tạo tài liệu riêng cho các tập lệnh python của mình.
Bây giờ bạn đã biết cách sử dụng pydoc, hãy để chúng tôi bắt đầu.
Bắt đầu
Mô-đun pydoc được đóng gói cùng với Python, có nghĩa là bạn không phải tải xuống và cài đặt riêng.
Để truy cập pydoc, trước tiên bạn phải nhập nó.
import pydoc
Truy cập trình bao tương tác bằng hàm help ()
Bạn có thể truy cập trình bao tương tác trong pydoc bằng chức năng trợ giúp của nó.
Để thực hiện việc này, hãy khởi chạy thiết bị đầu cuối của bạn và nhập trình bao tương tác python.
Bây giờ, nhập pydoc và sau đó sử dụng lệnh pydoc.help () để khởi chạy trình bao tương tác.
Ví dụ
>>>import pydoc >>>pydoc.help()
Bây giờ, bạn có thể nhập tên của mô-đun, kiểu dữ liệu, hàm, các lớp, v.v., để lấy tài liệu của nó ngay từ tập lệnh tương tác.
Xem tài liệu từ trình duyệt
Nếu bạn muốn xem tài liệu từ trình duyệt, bạn có thể dễ dàng thực hiện việc này bằng cách sử dụng pydoc.
Lần này, bạn không cần chạy lệnh thông qua python shell. Thay vào đó, bạn có thể cung cấp các đối số và khởi chạy nó trực tiếp.
Để làm như vậy, hãy khởi chạy thiết bị đầu cuối của bạn và nhập lệnh dưới đây.
python −m pydoc −b
Điều này sẽ tạo ra tài liệu cho tất cả các mô-đun, chức năng, đối tượng python có trên hệ thống cục bộ của bạn trên trình duyệt.
Bạn thậm chí có thể tìm kiếm và truy xuất các từ khóa cụ thể theo cách này.
C:\Users\vijay>python −m pydoc −b Server ready at https://localhost:50621/ Server commands: [b]rowser, [q]uit server> q Server stopped
Làm việc với docstrings
Ví dụ
def documentation(): '''Documentation using docstrings''' print(documentation.__doc__) help(documentation)
Đầu ra
Documentation using docstrings Help on function documentation in module __main__: documentation() Documentation using docstrings
Kết luận
Giờ đây, bạn biết cách xem và đọc tài liệu về các từ khóa, chức năng, mô-đun, phương pháp python khác nhau khi ngoại tuyến bằng cách sử dụng hàm pydoc.
Bạn cũng đã học cách tạo và tạo tài liệu của riêng mình bằng docstrings.
Điều cần thiết là duy trì tài liệu tốt trong khi làm việc trên các dự án quy mô lớn để biết bạn đang làm gì ở đâu và tránh nhầm lẫn sau này trong tương lai. Nó cũng giúp ngăn ngừa các lỗi không xác định hoặc lỗi thời gian chạy khác nhau.