Руководство по стилю Qiskit Metal

Стиль кода Metal соответствует соглашению PEP-8 для кода Python.

Шпаргалка PEP-8

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

• Никогда не используйте однобуквенные имена I, O или l, так как они могут быть ошибочно приняты за 1 и 0 в зависимости от шрифта.
• Используйте snake case для имён функций. Например: function, my_function.
• Используйте snake case для имён методов. Например: class_method, method.
• Используйте snake case для переменных. Например: x, var, my_variable.
• Используйте snake case для модулей. Например: module.py, my_modeul.py.
• Используйте camel case для классов. Например: Model, MyClass.
• Для констант используйте все заглавные буквы. Например: CONSTANT, MY_CONSTANT.

Максимальная длина строки

• Длина строки должна быть ограничена 79 символами.
• Python предполагает продолжение строки, если код содержится в скобках, скобках или фигурных скобках:

def function(arg_one, arg_two,
             arg_three, arg_four):
    return arg_one

• Чтобы разбить слишком длинные строки, используйте обратный слеш:

from mypackage import example1, example2 \
    example3

Отступ

• Для обозначения отступа используйте 4 пробела.
• Пробелы предпочтительнее табуляции.

Комментарии

• Используйте полные предложения, начинающиеся с заглавной буквы.
• Не забывайте обновлять комментарии при изменении кода.
• Отступ комментариев блоков до того же уровня, что и описываемый ими код.
• Начинайте каждую строку с #, за которым следует один пробел.
• Разделяйте абзацы строкой, содержащей только #.
• Встроенные комментарии используйте экономно.
• Не используйте встроенные комментарии для объяснения очевидного.

Когда избегать добавления пробелов

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

Где размещать закрывающие фигурные скобки

• Выровняйте закрывающую фигурную скобку с первым символом строки, начинающейся с конструкции:

list_of_numbers = [
    1, 2, 3,
    4, 5, 6
]

Пробелы вокруг бинарных операторов

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

Другие рекомендации

• Чтобы убедиться, что функция не может быть вызвана повторно, используйте метод del.

my_function()
del my_function

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

Руководство по стилю PEP-8

Для более полного понимания PEP-8 ознакомьтесь с полным руководством по стилю Python.