Có thể vô hiệu hóa lỗi thiếu chuỗi ký tự thiếu pylint cho các hàm và phương thức ngắn không?

Question

Pylint báo cáo lỗi cho mọi chức năng và phương pháp (trừ __init__) không có chuỗi tài liệu.

Điều này thường được mong muốn, vì vậy tôi không muốn vô hiệu hóa nó trên toàn cầu (trong pylintrc hoặc ở cấp tệp).

Tuy nhiên, theo ý kiến ​​của tôi, có những trường hợp không cần đến dây rút và thậm chí có hại. Ví dụ:

def get_foo(self, foo_id): 
    """Gets foo by its id."""" 
    return foos[foo_id] 

Phương thức này là trình rút gọn đơn giản được mô tả đầy đủ bằng chữ ký của nó. Phải viết một docstring là có hại ở chỗ nó tạo ra trùng lặp bảo trì nếu phương pháp được thay đổi.

Tôi muốn có thể đặt (ví dụ: pylintrc) một cái gì đó như docstring_threshold=3, để chặn các lỗi chuỗi tài liệu bị thiếu nếu hàm hoặc phương thức ngắn hơn 3 dòng mã. Có cách nào để làm điều đó?

Answer 1

Sử dụng giá treo 1.3.1 thêm một dòng cho bạn pylintrc docstring-min-length=10 ví dụ.

Nó được mô tả trong tạo pylintrc pylint --generate-rcfile tập tin như

chiều dài dòng tối thiểu cho các chức năng/classes đòi hỏi docstrings, những ngắn hơn được miễn.

Documentation reference.