39

在 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 所写，文献参考会很棒。

4

3 回答 3

25

在模块级别第二个：

ReferenceToClass = MyClass

作为函数参数，第一个：

reference_to_class = MyClass

于 2012-12-07T15:29:16.583 回答
9

tl；博士：对于全局/公共名称，使用AllCapsXORcist说：

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 风格指南也没有）。

由于变量名可能只是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. 似乎不是每个人都得到后者，但无论如何我还没有测试他们是否会得到前者更好。

于 2014-08-28T11:54:27.733 回答
1

我将其视为实例变量，PEP8 将其定义为使用 lowercase_underscore_style。（小写，必要时用下划线分隔单词以提高可读性。）

http://www.python.org/dev/peps/pep-0008/#id34

于 2012-12-07T15:31:13.563 回答