Стандарты кодирования - это набор руководящих принципов для создания поддерживаемого и масштабируемого кода. И от того, насколько хорошо вы будете следовать им, зависит продолжительность вашей карьеры в области разработки программного обеспечения. Поскольку я кодирую на Python, в этом посте я расскажу о соглашениях об именах Python.

Я взял эту информацию из документации Python PEP8 и попытался выразить ее простыми словами. Так что я мог облегчить читателям усвоение.

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

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

Соглашения об именах в Python

I. Что сохранять и чего избегать?

  • С чего начать?
    Не используйте имена, которые выглядят слишком общими или многословными.
    Поддерживайте четкую грань между ними.
  • Что плохого?
    user_list, moveInts, swapNums, dict_to_store_defns_of_a_word
  • Что хорошо?
    user_info, move_integers, swap_numbers, word_definitions.
  • На заметку-
    Не будьте наивны и назовите такие вещи, как «X», «Y» или «Z».
    Используйте CamelCase только тогда, когда это имеет смысл.

II. Как назвать пакет в Python?

  • При именовании пакета в Python используйте только нижний регистр.
  • Используйте подчеркивание в качестве разделителя, чтобы при необходимости объединить несколько слов и получить логическое имя.
  • Тем не менее, PEP 8 предпочитает использовать короткое имя (предпочтительно одно слово).

III. Каким должно быть имя моего модуля?

  • Python любит маленькие буквы алфавита и, следовательно, предлагает, чтобы имена модулей также следовали за набором.
  • Как и в случае с пакетами, объедините несколько слов с подчеркиванием для создания значимого имени модуля.
  • Не думайте дважды, если у вас уже есть идеальное однословное название для вашего модуля.

IV. Как выбрать имя класса в Python?

  • Классы в Python подчиняются другой схеме именования, называемой соглашением CapWords.
  • В некоторых случаях, если класс вызываемый (позволяет использовать круглые скобки) и имеет надлежащую документацию, вы можете назвать их как функции.
  • В отличие от вышеуказанного принципа, Python имеет встроенные классы с именами в нижнем регистре.
  • Классы исключений всегда должны иметь в конце слово Ошибка.

V. Стоит ли мне называть Globals по-другому?

  • Все глобальные переменные должны быть в нижнем регистре.
  • Знак подчеркивания следует использовать в качестве разделителя при формировании переменной с несколькими словами.

VI. Какое хорошее имя переменной экземпляра?

  • Имена переменных экземпляра должны соответствовать соглашению о нижнем регистре.
  • Используйте подчеркивание в качестве разделителя при именовании переменной экземпляра, состоящей из нескольких слов.
  • Начинайте закрытое имя переменной экземпляра с одного символа подчеркивания.
    Используйте два последовательных символа подчеркивания в начале переменной экземпляра. Имя будет искажено (вроде как закрытый член).

VII. Не связывайтесь с именем метода в Python.

  • Делайте имена методов только строчными буквами.
  • Подчеркивание должно разделять слова в имени метода.
  • Непубличные методы должны иметь подчеркивание в начале.
  • Изменение имени метода потребует добавления двух знаков подчеркивания в начале.

VIII. Никогда не игнорируйте аргументы метода.

  • Каждый метод экземпляра должен иметь в качестве первого аргумента ‘self’.
  • Все методы класса должны иметь в качестве первого аргумента ‘cls’.

IX. Имя функции должно передавать то, что она делает.

  • Имена функций должны соответствовать соглашению об именах в нижнем регистре.
  • Они также должны использовать подчеркивание для разделения слов в имени функции.

X. Невежество - это блаженство, но не в случае с константами в Python.

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