Как создать строку документации в python для нескольких языков

Невозможно перевести строку документации на несколько языков, но вы можете создать документацию с помощью инструмента Sphinx и перевести документы

Сам Sphinx поддерживает переводы на основе gettext для сгенерированных документов, см. Руководство по интернационализации Sphinx. .

У меня была такая же проблема; что-то вроде: модуль cmd использует строки документации для печати справки конечному пользователю, и мне действительно нужен был способ иметь строки документации на нескольких языках. Вот как я это сделал:

Взгляните на этот отличный туториал по использованию модуля gettext. Это позволяет вам переводить любое приложение Python. Я использую это так:

import gettext
try:
    lang = gettext.translation('myawesomeapp', localedir='locale')
    lang.install()
except FileNotFoundError:
    _ = lambda x: x

И теперь, когда вы хотите интернационализировать строку документации, следуйте этому шаблону:

class MyAwesomeClass:
    def incredible_method(with_fantastic_args):
        # Some marvellous code

    incredible_method.__doc__ = _('''\
Place here a fabulous docstrig for your incredible method.
This will be translated by the gettext module at runtime.''')

Сейчас самое время прочитать это руководство, о котором я упоминал ранее: вызывайте pygettext в своем коде, используйте poedit для создания переводов и получайте удовольствие.

Прощай, пайсанос.

Чтобы улучшить ответ Марио, вы можете поместить строки документации в декоратор, чтобы они были в начале функции.

def doc(docstring):
    def decorate(fn):
        fn.__doc__ = docstring
        return fn
    return decorate

class MyAwesomeClass:

    @doc(_(
    """My awesome documentation for an incredible method.
 
       It's really awesome, isn't it?
       """))
    def incredible_method(with_fantastic_args):
        ...

Все еще не идеально, но намного лучше, чем когда строка документации находится вне поля зрения/не в уме где-то внизу.

Единственное практическое решение, которое я могу придумать — и оно уродливое — это размещать один язык за другим в строке документации. Например:

def findChocolate(variety):
    '''Locate chocolate - Encuentra la choloate - nuqDaq yuch Dapol '''
    ...