Сегодня мы обсудим некоторые соглашения об именах в Python.

Различные типы соглашений об именах

Мы будем называть одну и ту же переменную в разных соглашениях. Предположим, мы пытаемся назвать список или массив, в котором хранятся оценки студентов.

Змеиный чехол

students_marks

Слова разделяются знаком подчеркивания. Каждое слово начинается со строчной буквы.

Паскаль Кейс

StudentMarks

Каждое слово начинается с верхнего регистра. Они не разделяются никаким разделителем.

Случай верблюда

studentMarks

Первое слово начинается с буквы нижнего регистра, а следующие слова начинаются с буквы верхнего регистра.

Кебаб Кейс

student-marks

Каждое слово начинается с нижнего регистра и разделяется дефисом.

Венгерская нотация

arrStudentMarks

В этом соглашении об именах переменных мы добавляем структуру данных в начало имени.

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

Пакеты

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

import streamlit
import pulp
import flask_sqlalchemy

Модули

Модули - это функции, которые вы импортируете из пакета. Еще они используют snake_case

from streamlit import subheader, text, markdown, title
from datetime import datetime
from flask import jsonify

Классы

Классы должны быть названы в формате «PascalCase».

class MyClass:
    def __init__():
        pass
class Dog:
    def __init__():
        pass

Ниже приведен еще один пример импорта классов из модуля.

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

Глобальные (на уровне модуля) переменные

Глобальные переменные должны следовать за snake_case

variable = 1
variable_one = 2
def func():
      global variable
      global variable_one

Методы

  • Открытый метод должен быть назван с помощью snake_case
  • По соглашению частные методы должны начинаться с символа подчеркивания (‘_’).
class MyClass:
    '''
    This is a public method
    '''
    def  public_method():
        pass
    '''
    This is a private method
    '''
    def _private_method():
        pass

Переменные экземпляра

Подобно методам, общедоступные экземпляры должны быть в snake_case, а частные экземпляры должны начинаться с подчеркивания (_)

class MyClass:
    pass
public_instance = MyClass()
_private_instance = MyClass()

Функции

Функции также должны следовать за snake_case

def func():
    pass
def func_one():
    pass

Константы

Постоянные имена должны быть в верхнем регистре.

PI = 3.14
CONSTANT = 10

Это просто соглашение об именах. Python не поддерживает константы.

Первоначально опубликовано на https://www.realpythonproject.com 10 апреля 2021 г.