Как документировать и использовать перечислимые типы данных в Python?

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

Пример

def MyFunc(region = None):
    if region in ['A','B','C', None]:
        # dosomething
    else:
        # complain about invalid parameter

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

  • иметь возможность использовать функцию автозаполнения в IDE для автозаполнения с возможными значениями для параметр.

  • документируйте список допустимых значений для параметра (в настоящее время код документируется с помощью doxygen)

5
задан Michael J. Barber 23 September 2011 в 10:14
поделиться