Каков предпочтительный способ добавления предложения о цитировании в пакеты Python?

Question

Как разработчики должны указать, как пользователи должны ссылаться на пакет, кроме как в документации?

Пакеты

R возвращают предпочтительную цитату, используя citation("pkg").

Я могу думать о pkg.CITATION, pkg.citation и pkg.__citation__. Есть ли другие? Если нет предпочтительного способа (что, как мне кажется, имеет место, поскольку я ничего не нашел на python.org), каковы плюсы и минусы каждого из них?

Answer 1

Наконец-то я выбрал вариант с дундером.Только опция dunder (__citation__) проясняет, что это не нормальная переменная, необходимая для времени выполнения.

Да, строки dunder не должны использоваться инфляционно, потому что python может использовать их позже.Но если Python собирается использовать __citation__, то это будет сделано для аналогичной цели.Кроме того, я считаю, что относительная стоимость выше с другими вариантами.