Стоит ли глобальные переменные писать заглавными буквами в обычных скриптах?

Question

[seosova]

Есть для примера самый простой скрипт из Лутца. Если его прогнать через pylint - он ругается, что переменные глобальные и давай-ка пиши их большими. Но такой вид скрипта, почему-то очень режет взгляд

#!/usr/bin/env python3
""" Small test program for while cycle """

while True:
    REPLY = input('Enter text:')
    if REPLY == 'stop':
        break
    try:
        NUM = int(REPLY)
    except:
        print('Bad!' * 8)
    else:
        if NUM < 20:
            print('low')
        else:
            print(int(REPLY) ** 2)
print('Bye!')

Может быть стоит просто "забить" на придирчивость pylint ( тем более pep8, flake8 нормально воспринимают это). Или по большому счету, так и должны оформляться даже просты скрипты, и просто переменные, но существующие на уровне всего скрипта, стоит писать большими как "по настоящему" глобальные?

Answer 1

[angru]

А что если этот блок кода обернуть в:

def main():
    while True:
        # do something

if __name__ == '__main__':
    main()

Все еще придирается? Я, например, таким никогда не занимался, подразумевается(мной), что если переменная обьявлена на самом верхнем уровне, то да - она глобальная, должна содержать только заглавные буквы и не может нигде в коде быть изменена(опять же, все это на основе соглашения). У вас они обьявлены в блоке while, да еще и изменяются, меня бы это ввело в заблуждение, т.к. по внешнему виду - это константа.

P.S. В текущем виде ваш код противоречит PEP-8.

Comments

[seosova]

Возможно немного запутался. А как же всякие переменные для циклов? i в for i in range(0,10): ( ну и т.д). Это ведь переменная? Она существует только в теле цикла, но она изменяется. Так же и reply в этом примере? Она используется только в теле блока while и потом уже не нужна. Но стоит сделать ее маленькими получаешь - C: 5, 4: Invalid constant name "reply" (invalid-name) . Можно конечно в pylint насильно прописать, что они могут быть "маленькими", но тогда он будет пропускать реально важные места с глобальными переменными.

[angru]

seosova: у вас блок while находится на самом верхнем уровне, соответственно все что выполняется внутри него засоряет глобальное пространство имен, я немножко поменял ответ, оберните ваш цикл в функцию, тогда pylint не будет ругаться. Так лучше, т.к. не желательно выполнять какой либо код на самом верхнем уровне скрипта, представьте, что кто-то импортирует ваш скрипт из своего.

[seosova]

У меня почему-то если я запускаю `python3 -m pep8 testsyntax.py` не ругается на данный файл.

[seosova]

angru: Да спасибо большое, такая обертка его устраивает. Тогда ответ по сути, pylint ругается не зря, не пишите скрипты командами по порядку, а оборачивайте их, для возможности корректного импорта другими программами. Я прав?

[angru]

seosova: вы меньше полагайтесь на инструменты, они не всесильны, а больше думайте своей головой

[angru]

seosova: Вряд ли pylint руководствуется такими соображениями, скорее всего у него просто проверка на то, что если переменная глобальная, то имя должно содержать только заглавные буквы. Но то, что стоит стараться выполнять поменьше кода(а в идеале вообще не выполнять) на стадии импорта - правильно.

[seosova]

angru: ну когда пока своя голова мало знает, я думаю лучше вникать почему чекер ругается. Не просто заткнул его, а спросил, что до как. Вот теперь понял в чем проблема, знаю куда смотреть, мне кажется это большой плюс в таком контексте. Без чекера я бы даже не задумался о таком, писал бы с маленькой , ничего не оборачивал бы.

Answer 2

[nirvimel]

Константы в верхнем регистре.
Переменные - в нижнем.

Comments

[seosova]

Почему тогда pylint их так ревностно хочет сделать большими?

Answer 3

[Roman K]

REPLY = input('Enter text:')
Эта переменная по определению не подходит под константу, следовательно, это обычная переменная и писать ещё стоит как_обычную_переменную.

Comments

[seosova]

Почему тогда pylint так ругается? C: 5, 4: Invalid constant name "reply" (invalid-name) Или забить на него? Он слишком придирчив? Не понимает контекста?

[Roman K]

seosova: Не знаю, не пробовал. Мне хватает встроенного в PyCharm pep8-чекера и здравого смысла.

[seosova]

Roman Kitaev: Ну в PyCharm не только ведь pep8-чекер, а для vim хочется чего-то более основательного, pep8 и на глаз видно обычно что где

[Roman K]

seosova: А зачем что-то другое? И главное - что это "чего-то более основательное"?

[seosova]

Roman Kitaev: pylint делает статический анализ кода, flake8 тоже, там pep8 + pyflakes. pep8 просто смотрит за соблюдением соглашений об оформлении кода. По сути это те самые warnings в Pycharm, только в консоли. К сожалению, я не настолько гуру, чтобы все учесть сразу, да и всегда можно забыть что-то, где то не так продумать. Короче если ты не в Pycharm, лучше чем то проверить свой код понавороченее pep8 :)

[Roman K]

seosova: Куда-то уже унесло вас. Мы тут разговариваем о code style и именовании переменных, а не статическом анализе.

[seosova]

Roman Kitaev: Да вы правы. Просто pylint это все в одном, поэтому и пользуюсь, плюс у него понятный вывод в консоли. Поэтому и написал все это.

Answer 4

[s0ci0pat]

Если ты сейчас не привыкнешь к code style, потом будет поздно.

Comments

[seosova]

Так является ли именование обычных переменных в скриптах большими буквами ( как глобальные ) - по настоящему code style? Я понимаю когда в программе идут функции, классы, области видимости, но часто скрипты 3-4 строчки, я не видел чтобы в таком случае писали большими, или всем просто лень?

[s0ci0pat]

Обычно все помещают в функцию main. Пример тебе привели