Python类引用的命名约定是什么

Question

在Python中引用类的变量的命名约定是什么？

class MyClass(object):
    pass

# which one is correct?
reference_to_class = MyClass

# or
ReferenceToClass = MyClass

这是另一个类似于我的情况的例子:

# cars.py
class Car(object):
    pass

class Sedan(Car):
    pass

class Coupe(Car):
    pass

class StatonWagon(Car):
    pass

class Van(Car):
    pass

def get_car_class(slug, config):
    return config.get(slug)

# config.py
CONFIG = {
    'ford-mustang': Coupe,
    'buick-riviera': Coupe,
    'chevrolet-caprice': Sedan,
    'chevy-wan' Van:
    'ford-econoline': Van
}

# main.py
from config.py import CONFIG
from cars import get_car_class

MyCarClass = get_car_class('buick-riviera')

my_car = MyCarClass()

我更喜欢ReferenceToClass,每个新来的代码都知道它是一个类,而不是一个实例.但正如@poplitea写的那样,文献参考会很棒.

Answer 1

在模块级别第二个:

ReferenceToClass = MyClass

作为函数参数,第一个:

reference_to_class = MyClass

Answer 2

tl; dr:对于AllCaps像XORcist这样的全球/公共名称使用说:

class Logger:
    pass

AliasLogger = Logger

对于函数参数和函数本地,请明确表示您正在使用如下描述性名称处理类对象:

def some_func(logger_class):
    pass

或类似的东西

def some_func(my_class_classobj):
    pass

当这个词"class"实际上在你的类名中时.对于classobj,请参阅class_和klass.

分析/动机(长版)

没有彻底的阅读,但一眼就看出PEP 8似乎并不明确(这也不是谷歌的蟒蛇风格指南).

由于变量名可能只是python中的另一个名称绑定,在我看来,无论是将该名称与定义块绑定还是稍后=将某个对象的等号绑定在一起并不重要.

为此,我同意XORcist,模块级"别名"引用应遵循您的类命名标准,可能是AllCaps:

class MyClass(object):
    pass

# good
ReferenceToClass = MyClass

但是,当涉及到参数和变量名称时,应该lowercase_underscores适用,对吧？我只对此感到不满,因为它会将你推向实例与类参考歧义.全小写名称可能是尝试提示对象是实例.就此而言,我建议使用"class"后缀对全小写,类引用变量名称进行后缀,如下所示:

class Logger(object):
    pass

def function_expecting_class_reference(logger_class):
    pass

我将您的示例类重命名为MyClass,Logger因为在实际场景中只有少数类名包含该字符串"class".然而,在后一种情况下,我建议再次使用描述性命名来避免含糊不清.例如,您可以使用classobj后缀:

class MyClass(object):
    pass

def function_expecting_class_reference(another_param, my_class_classobj):
    ReferenceToClass = MyClass

我倾向于采用的另一种方法是使用后缀klass,例如my_class_klass.不是每个人似乎都得到后者,但无论如何我还没有测试他们是否会更好地得到前者.