如何使用实例的属性作为方法的默认参数？

问题描述：

我想使用实例属性的值将默认参数传递给实例方法：

class C:
    def __init__(self, format):
        self.format = format

    def process(self, formatting=self.format):
        print(formatting)

当我尝试这样做时，我收到以下错误消息：

NameError: name 'self' is not defined

我希望该方法的行为如下：

C("abc").process()       # prints "abc"
C("abc").process("xyz")  # prints "xyz"

这里有什么问题？为什么它不起作用？我该如何让它工作？

解决方案 1：

您实际上不能将其定义为默认值，因为默认值是在定义方法时（即在任何实例存在之前）评估的。通常的模式是这样做：

class C:
    def __init__(self, format):
        self.format = format

    def process(self, formatting=None):
        if formatting is None:
            formatting = self.format
        print(formatting)

self.format`formatting仅当是 时才会使用None`。

为了演示默认值如何工作，请参见以下示例：

def mk_default():
    print("mk_default has been called!")

def myfun(foo=mk_default()):
    print("myfun has been called.")

print("about to test functions")
myfun("testing")
myfun("testing again")

输出如下：

mk_default has been called!
about to test functions
myfun has been called.
myfun has been called.

请注意，如何mk_default只被调用一次，并且发生在函数被调用之前！

解决方案 2：

在 Python 中，名称self并不特殊。它只是参数名称的约定，这就是为什么self中有一个参数__init__。（实际上，__init__也不是很特殊，特别是它实际上并没有创建对象……这是一个很长的故事）

C("abc").process()创建一个实例，在类中C查找方法，并以实例作为第一个参数来调用该方法。因此，如果您提供了它，它将最终出现在参数中。process`CCself`

但是，即使您有该参数，您也不能编写类似 的内容def process(self, formatting = self.formatting)，因为self在您设置默认值时，它尚未进入范围。在 Python 中，参数的默认值是在编译函数时计算的，并“粘”到函数上。（这也是为什么如果您使用像 这样的默认值[]，该列表将记住对函数的调用之间的更改的原因。）

我怎样才能让它工作？

传统方法是使用None为默认值，然后检查该值并在函数内部替换它。您可能会发现为此目的创建一个特殊值（object您只需要一个实例，只要您隐藏它以便调用代码不使用相同的实例）而不是 更安全一些。无论哪种方式，您都应该使用 而不是 来None检查此值。is`==`

解决方案 3：

由于您想将其用作self.format默认参数，这意味着该方法需要特定于实例（即无法在类级别定义它）。相反，您可以在类期间定义特定方法__init__。这是您可以访问特定于实例的属性的地方。

一种方法是使用functools.partial以获得该方法的更新（特定）版本：

from functools import partial


class C:
    def __init__(self, format):
        self.format = format
        self.process = partial(self.process, formatting=self.format)

    def process(self, formatting):
        print(formatting)


c = C('default')
c.process()
# c.process('custom')  # Doesn't work!
c.process(formatting='custom')

请注意，使用此方法您只能通过关键字传递相应的参数，因为如果您通过位置提供它，这将产生冲突partial。

另一种方法是定义并设置方法__init__：

from types import MethodType


class C:
    def __init__(self, format):
        self.format = format

        def process(self, formatting=self.format):
            print(formatting)

        self.process = MethodType(process, self)


c = C('test')
c.process()
c.process('custom')
c.process(formatting='custom')

这也允许通过位置传递参数，但是方法解析顺序变得不那么明显（例如，这可能会影响 IDE 检查，但我认为 IDE 有特定的解决方法）。

另一种方法是创建一个自定义类型，用于这些类型的“实例属性默认值”，并创建一个执行相应getattr参数填充的特殊装饰器：

import inspect


class Attribute:
    def __init__(self, name):
        self.name = name


def decorator(method):
    signature = inspect.signature(method)

    def wrapper(self, *args, **kwargs):
        bound = signature.bind(*((self,) + args), **kwargs)
        bound.apply_defaults()
        bound.arguments.update({k: getattr(self, v.name) for k, v in bound.arguments.items()
                                if isinstance(v, Attribute)})
        return method(*bound.args, **bound.kwargs)

    return wrapper


class C:
    def __init__(self, format):
        self.format = format

    @decorator
    def process(self, formatting=Attribute('format')):
        print(formatting)


c = C('test')
c.process()
c.process('custom')
c.process(formatting='custom')

解决方案 4：

您无法在方法定义中访问 self。我的解决方法是 -

class Test:
  def __init__(self):
    self.default_v = 20

  def test(self, v=None):
    v = v or self.default_v
    print(v)

Test().test()
> 20

Test().test(10)
> 10

解决方案 5：

如果您希望它们表现为非静态方法，则需要将“self”作为第一个参数传递给任何类函数。

它指的是对象本身。您不能将“self”作为默认参数传递，因为它的位置是固定的，作为第一个参数。

在您的情况下，不要使用“formatting=self.format”，而要使用“formatting=None”，然后从代码中分配值，如下所示：

[编辑]

class c:
        def __init__(self, cformat):
            self.cformat = cformat

        def process(self, formatting=None):
            print "Formating---",formatting
            if formatting == None:
                formatting = self.cformat
                print formatting
                return formatting
            else:
                print formatting
                return formatting

c("abc").process()          # prints "abc"
c("abc").process("xyz")     # prints "xyz"

注意：不要使用“format”作为变量名，因为它是 python 中的内置函数

解决方案 6：

您无需创建涵盖默认参数的 if-then 列表，而是可以利用“默认”字典并使用 eval() 创建类的新实例：

class foo():
    def __init__(self,arg):
        self.arg = arg

class bar():
    def __init__(self,*args,**kwargs):
        #default values are given in a dictionary
        defaults = {'foo1':'foo()','foo2':'foo()'}
        for key in defaults.keys():

            #if key is passed through kwargs, use that value of that key
            if key in kwargs: setattr(self,key,kwargs[key]) 

            #if no key is not passed through kwargs
            #create a new instance of the default value
            else: setattr(self,key, eval(defaults[key]))

我将其放在每个实例化另一个类的类的开头作为默认参数。这样可以避免 Python 在编译时评估默认值... 我希望有一种更干净的 Python 式方法，但是瞧。