Модификация docstring python с помощью декоратора: это хорошая идея?

Question

Докшнайт python должен быть задан как буквальная строка; но иногда полезно иметь аналогичные docstrings для нескольких функций (например, разные конструкторы), или несколько методов доступа могут принимать один и тот же список аргументов (а затем полагаться на один и тот же скрытый метод), поэтому было бы неплохо использовать описание везде. Для таких случаев я могу построить docstring, назначив __doc__, что я делаю с помощью простого декоратора. Система работает очень хорошо (в python 2), и я доволен тем, насколько прост, ясен и хорошо инкапсулирован.

Вопрос: Это хорошая идея? В частности, существуют ли инструменты, которые будут смущены этой настройкой (например, все, что извлекает docstrings из источника, а не из байт-кода). Является ли решение по-прежнему работать на python 3? Существуют ли другие причины или обстоятельства, которые сделают это нецелесообразным?

Answer 1

Он не должен нарушать каких-либо инструментов, и он должен работать на Python 3.

Это нормально Если это не повредит исходный код читаемость например, вы все еще можете выяснить, что делает эта функция и как использовать Это.

Проблема может заключаться в том, что она маскирует плохой дизайн. Если несколько методов используют один и тот же список аргументов, код должен быть реорганизован (создать объект, который работает со списком), а не исправлен путем создания повторяющихся docstrings.