Как мне документировать константы Python, чтобы они отражались в Intellisense и Sphinx? ⇐ Python

[Anonymous]

У меня есть файл с именем constants.py, где я храняю все мои константы, такие как Paths path_datasets = "Data/DataSets/" или значения ширина = 416 .
Они используют много времени в коде, иногда в качестве значений по умолчанию для функций, как

Код: Выделить всё

def main_train(..., width: int = constants.WIDTH,...):
< /code>
В документации у меня есть: < /p>
Args:
width (int):
Width of the network from which the images will be processed. Must be a multiple of 32. The default is constants.WIDTH.
< /code>
Теперь, если я напишу функцию main_train, когда я наведу ее, чтобы увидеть помощь, я вижу константы. Всего, а не 416. Кроме того, при использовании Sphinx Docs показывают: < /p>
width (int) – Width of the network from which the images will be processed. Must be a multiple of 32. The default is constants.WIDTH.
< /code>
Но в Sphinx, если я посмотрю, как объявлена ​​функция, я вижу: < /p>
main.main_train(path_home: PurePath, path_dataset: PurePath, template: List[PurePath], width: int = 416,

Должен ли я оставить по умолчанию константы. width. Из комментариев моей функции, поскольку Sphinx уже отражает его? У меня не было бы режима, чтобы увидеть опцию по умолчанию, парящую в VSCODE с Intellisense. Или я должен заменить имя констант на его значение? Таким образом было бы больно обновлять мою документацию каждый раз, когда я хочу менять постоянную.>

Подробнее здесь: https://stackoverflow.com/questions/796 ... isense-and