Sửa đổi một chuỗi mã vạch python bằng trình trang trí: Có phải là một ý tưởng hay không?

Question

Một chuỗi tài liệu python phải được đưa ra dưới dạng chuỗi chữ; nhưng đôi khi rất hữu ích khi có các quy tắc tương tự cho một số hàm (ví dụ, các hàm tạo khác nhau) hoặc một số phương thức truy cập có thể chấp nhận cùng một danh sách các đối số (và sau đó dựa vào cùng một phương thức ẩn), vì vậy sẽ rất tốt khi sử dụng mô tả ở mọi nơi. Đối với những trường hợp như vậy, tôi có thể xây dựng một docstring bằng cách gán cho __doc__, mà tôi làm bằng phương tiện của một trang trí đơn giản. Hệ thống hoạt động rất độc đáo (trong python 2), và tôi hài lòng với cách đơn giản, rõ ràng và được đóng gói tốt.

Câu hỏi: Đây có phải là một ý tưởng hay không? Cụ thể, có các công cụ sẽ bị nhầm lẫn bởi thiết lập này (ví dụ: bất kỳ thứ gì trích xuất docstrings từ nguồn thay vì từ bytecode). Là giải pháp vẫn sẽ làm việc trong python 3? Có những lý do hoặc hoàn cảnh nào khác có thể làm cho điều này trở nên vô ý?

Answer 1

Nó không nên phá vỡ bất kỳ công cụ và nó sẽ làm việc trên Python 3.

Nó là ok Nếu nó không làm tổn thương một ví dụ mã nguồn dễ đọc, bạn vẫn có thể tìm ra những chức năng thực hiện và cách sử dụng nó.

Vấn đề có thể là nó che dấu thiết kế kém. Nếu một số phương thức sử dụng cùng một danh sách các đối số thì mã sẽ được tái cấu trúc (tạo một đối tượng làm việc với danh sách) thay vì được vá bằng cách tạo ra các tài liệu lặp đi lặp lại.