UML-диаграммы Python

Question

Я создаю диаграмму UML для класса Python.

Стандартно ли включать открытые / закрытые / защищенные теги при выполнении UML для программ на Python?Например:

-n: int
+name_of_shop: str

В моей текущей программе все переменные и функции являются общедоступными, поскольку я не хотел, чтобы мои переменные начинались с одинарных (_) или двойных (__) подчеркиваний.Если переменные не доступны вне функции, является ли стандартным для каждой переменной начинаться с двойного подчеркивания?

Answer 1

Если у вас есть вопрос, стоит ли использовать подчеркивание, у PEP8 есть Описательный: Стили именования
В основном говорит

• _ единственный префикс подчеркивания для слабого индикатора "внутреннего использования"
• суффикс подчеркивания single_ подчеркивания для избежания конфликтов с ключевым словом
• ___ префикс двойного подчеркивания для mangles
• __ double__ подчеркивание на обоих концах магии, которую не следует изобретать.

Answer 2

Не существует Python стандарта по отношению к UML.В обеих парадигмах есть соглашения.То, как вы решите их, зависит от вас и ваших потребителей, то есть от того, кто оценивает вашу работу.

Python сам устанавливает очень мало стандартов, помимо необходимости языкового синтаксиса.Помните наш общий принцип: «Глупая последовательность - это хобгоблин маленьких умов».Вы можете ознакомиться с рекомендациями по кодированию (часто называемыми «Стандартом кодирования PEP-8»).

Тем не менее, у меня есть два основных замечания:

1. Да, внутренние переменные, как правило, начинаются с подчеркивания.
2. Вам необходимо обсудить удобство чтения с вашим инструктором и / или учеником.