Стиль Python: следует ли мне не комментировать свои операторы импорта?

Question

Я постараюсь сделать этот вопрос как можно более закрытым:

Я часто нахожу, что у меня есть группа импортов, которые объединяются, как куча математического импорта;но позже я могу удалить или переместить фрагмент кода, который использует эти импортированные элементы, в другой файл.Проблема в том, что я часто забываю, почему я использовал определенный импорт (например, я очень часто использую класс Counter или случайные вещи из itertools.) По этой причине мне могут потребоваться комментарии, которые указывают, для чего предназначен мой импорт;таким образом, если они мне больше не нужны, я могу просто удалить весь кусок.

Считается ли плохим стилем добавлять комментарии к моим операторам импорта?

Answer 1

Что ж, прекрасная вещь в python - это то, что он (или должен быть) явным.В этом случае, если вы не выполняете * импорт, (что считается плохой практикой), вы будете УЗНАТЬ, ссылаются ли на импорт, просто выполнив grep для пространства имен.И тогда вы узнаете, можете ли вы удалить его.

Позвольте мне также добавить контрапункт к другим ответам.«Слишком много» комментариев может действительно быть плохой практикой.Вы не должны добавлять избыточные комментарии к коду, который явно очевиден в отношении его функции.Кроме того, комментарии, как и код, должны быть сохранены.Если вы создаете чрезмерное количество комментариев, вы создаете массу дополнительной работы для себя.

Answer 2

Комментарии здесь, чтобы помочь объяснить / напомнить.Если они вам полезны, используйте их.Кроме того, инструменты, такие как pylint , могут помочь обнаружить ненужный импорт, а также многое другое.

Answer 3

Это совсем не плохая практика. Лучше иметь больше комментариев, чем меньше комментариев. Документируя причины, по которым вы используете определенные операции импорта, он объяснит читателю вашего кода причину, по которой он у вас есть, и, возможно, читатель поймет, почему вы что-то сделали, и сможет найти лучший способ сделать это.

На самом деле вы не должны уклоняться от правильного комментирования вашего кода.

Answer 4

Я бы не назвал это плохой практикой.Комментарии должны дать ясность, и это то, что вы пытаетесь сделать.Однако, если вы не понимаете, для чего используется импорт, я бы порекомендовал определить, не становятся ли ваши модули слишком большими.

Answer 5

Я почти уверен, что если вы добавляете значимые комментарии в любом месте в коде, это может быть только плюсом.

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