Должен ли я действительно использовать все прописные буквы для моих констант?

Я в основном программист на Python, который использует pylint для слияния исходного кода. Я могу удалить все предупреждения, кроме одного: Неверное имя для константы. Изменение названия на все заглавные буквы исправляет это, но действительно ли я должен это делать? Если я сделаю это, я обнаружу, что мой код выглядит безобразно, так как большинство переменных являются постоянными (в соответствии с Pylint).

Вы, вероятно, пишете такой код:

notes_director = argv[1]
chdir(notes_director)
files = glob('*.txt')
rand_file = choice(files)
with open(rand_file) as notes_file: 
    points = notes_file.readlines() 
    rand_point = choice(points)

Вы должны переместить этот код в функцию:

def main():
    notes_director = argv[1]
    chdir(notes_director)
    files = glob('*.txt')
    rand_file = choice(files)
    with open(rand_file) as notes_file: 
        points = notes_file.readlines() 
        rand_point = choice(points)

# actually call the main function    
main()

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

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

Да. Согласно правилу PEP8s о константах :

Константы обычно определяются на уровне модуля и пишутся заглавными буквами с подчеркиванием, разделяющим слова. Примеры включают MAX_OVERFLOWи TOTAL.

Длинная версия:

В сообществе Python (как и во многих других сообществах) существуют соглашения о том, как писать код. Это отличается от рабочего кода : даже если вы пишете свои константы в нижнем регистре, ваш код все еще работает.

Но существует консенсус сообщества (как задокументировано в PEP8), который "навязывается" такими инструментами, как Pylint . Если вы программируете для собственного счастья, вы можете игнорировать подсказки, которые дает вам Pylint. Если вы хотите открытого обмена с сообществом, то есть «кто-то кроме меня должен использовать мой код», вы должны подготовить свой код в соответствии с PEP8.

PEP8 и норма сообщества Python - это использование ALL_CAPS_CONSTANTS. Это общая визуальная подсказка, используемая десятилетиями в C, Java, Perl, PHP, Python, bash и других языках программирования и средах оболочки. Но на современном интернет-языке ВСЕ КОПИИ ЗНАЧИТ КРИТЬ . И кричать это грубо.

Python, однако, довольно противоречив ALL_CAPS_CONSTANTS. JavaScript может иметь Math.PI, но Python есть math.pi. Нет более узнаваемой или устойчивой константы, чем π. Или рассмотрите sys.version_infoверсию Python, на которой вы работаете. 100% постоянным в течение жизни вашей программы - гораздо больше , чем PORTили MAX_ITERATIONSили другие константы , которые бы определить. Или как насчет sys.maxsize? Максимальное собственное целочисленное значение вашей платформы постоянно не только в течение одного или двух запусков программы, но и в течение срока службы вашего оборудования.

Если эти константы, в том числе такие, как π и e, являются фундаментальными константами вселенной и не будут изменяться в течение всей вечности, - если они могут быть строчными, хорошо ... как и другие константы. Ты можешь выбрать.

Помните, PEP8 - это руководство по стилю. Руководство, а не закон. Руководство часто нарушается даже стандартной библиотекой Python. И ссылаясь на другое основное руководство по Python, PEP20 (он же «Дзен Питона»):

• Красиво лучше, чем некрасиво
• Читаемость имеет значение
• Практичность превосходит чистоту.

На практическом примечании, когда програмы YELLY_CONSTANTи SHOUTY_PARAMETERначинает тереть, это помогает помнить , что все-CAPS константы как правило, не очень прочный платоновские идеалы , но параметры работы программы. Там нет ничего действительно постоянной о PORT, SITENAMEили NUMRUNS, и они не должны управляться как отдельная программа глобалов. Например, их можно поместить в словарь как глобально доступный набор параметров программы:

config = {
    'port': 80,
    'sitename': "Bubba's Blog",
    'numruns': 100,
}

В Python также есть прекрасная возможность передачи параметров ключевых слов, что уменьшает необходимость использования APPARENTLY_ANGRY_GLOBAL_VARIABLES:

def process_data(sitename, port=80, numruns=100):
    ...

process_data("Bubba's Blog")

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

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

Вы можете обратиться к этой ссылке Google, чтобы поделиться общим стилем между разработчиками одной команды.

Рекомендуется использовать

Type                  |Public          |Internal
Global/Class Constants|CAPS_WITH_UNDER |_CAPS_WITH_UNDER