Python: sử dụng doctests cho các lớp học

Question

Có thể sử dụng khái niệm doctest của Python cho các lớp học, không chỉ các chức năng?

Nếu có, tôi sẽ đặt tài liệu ở đâu - tại docstring của lớp học hoặc tại docstring của nhà xây dựng?

Để làm rõ, tôi đang tìm một cái gì đó như:

class Test: 
    """ 
    >>> a=Test(5) 
    >>> a.multiply_by_2() 
    10 
    """ 
    def __init__(self, number): 
     self._number=number 

    def multiply_by_2(self): 
     return self._number*2 

Cảm ơn trước,

Adam

Answer 1

Bạn đang thiếu mã để thực sự chạy các tài liệu ở cuối tệp:

class Test: 
    <snip> 

if __name__ == "__main__": 
    import doctest 
    doctest.testmod() 

Để biết vị trí cần kiểm tra:

• Nếu thử nghiệm toàn bộ lớp học, tôi sẽ đặt chúng trong chuỗi tài liệu của lớp học.
• Nếu nó đang thử nghiệm hàm tạo, tôi sẽ đặt chúng trong chuỗi tài liệu của hàm tạo.
• Nếu nó thử nghiệm một phương pháp (như nó có vẻ là trong trường hợp này), tôi thực sự sẽ đặt nó trong docstring của phương pháp đó.

Answer 2

Module doctest tìm kiếm bất kỳ docstrings trong một tập tin và thực hiện bất kỳ mã nhúng trong đó, vì vậy có thể sử dụng doctest cho các lớp học.

Để biết liệu tốt hơn là đặt các tài liệu trong chuỗi tài liệu của lớp hoặc hàm tạo, tôi nghĩ điều đó phụ thuộc vào chính xác những gì bạn đang làm tài liệu.

Nếu chuỗi cung cấp tổng quan chung về lớp học và cách sử dụng nó thì tôi nghĩ tốt hơn nên đặt nó trong lớp.

Nếu chuỗi tài liệu cụ thể về cách tạo các phiên bản của lớp thì nó sẽ theo phương thức __init__.

Hãy nhớ ý định của doctests chủ yếu là có mã mẫu tự xác thực trong tài liệu, vì vậy IMHO khía cạnh tài liệu nên được ưu tiên hơn khía cạnh thử nghiệm.

Edit:

Trong ví dụ của bạn ở trên không có mã để thực hiện doctest - chạy python test.py -v sẽ thực thi mã python chính mà chỉ định nghĩa lớp.

Bạn cần phải thêm video này vào cuối file:

if __name__ == "__main__": 
    import doctest 
    doctest.testmod() 

Ngoài Nếu bạn đang sử dụng Python 2.6 hoặc mới hơn chạy nó với:

python -m doctest -v test.py 

Answer 3

Thay vì instantiating các đối tượng trong mọi phương pháp, bạn có thể làm một cái gì đó như thế này:

class Test: 
    def multiply_by_2(self): 
     """ 
     >>> t.multiply_by_2() 
     10 
     """ 
     return self._number*2 

if __name__ == "__main__": 
    import doctest 
    doctest.testmod(extraglobs={'t': Test()})