类方法和属性的命名约定 [关闭]

Question

命名类属性及其方法（函数）的最佳做法是什么。

class Base():   
    def __init__(self):
        self.name = 'My Name'
    def print_this(self):
        print "Hello"

创建一个类的实例：

a = Base()

了解此类中可用的方法和属性：

print dir(a)

得到这个输出：

['__doc__', '__init__', '__module__', 'name', 'print_this']

通过读取 dir() 输出中的名称，不可能看到变量在哪里（类属性）和方法在哪里（类函数）。

使用哪些命名约定来区分变量与函数（或属性与方法）？

Answer 1

方法中通常应该有一个动词，例如print_this、calculate_that、save，因为它们执行一些操作。

属性和属性只是一个裸名词，例如name、status、count，因为它们只包含一个值，或者在属性的情况下，底层函数应该计算并返回一个值，没有其他副作用。

你的问题很模糊：

• 这与 Python 中的命名约定有关吗？为此，您应该参考famous PEP8 document

• 是关于如何通过查看名称来区分方法和属性的吗？为此，请参阅我上面的经验法则

• 是关于如何以编程方式区分方法和属性吗？在这种情况下，您可以使用inspect 模块来提供明确的答案，例如：

  import inspect
  
  for attr in dir(a):
      if inspect.ismethod(getattr(a, attr)):
          print '%s is a method' % attr
      else:
          print '%s is an attribute or property' % attr