如何将实例成员的默认参数值传递给方法？

Posted 2023-02-18

【中文标题】如何将实例成员的默认参数值传递给方法？

【英文标题】：How to pass a default argument value of an instance member to a method?

【发布时间】：2022-01-19 09:04:44

【问题描述】：

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

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"

这里有什么问题，为什么这不起作用？我怎样才能做到这一点？

【问题讨论】：

不要使用format作为变量名，因为它是python的内置函数。

编辑self在process method中的错误

【参考方案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 是如何只被调用一次的，而这发生在函数被调用之前！

【讨论】：

我相信 mk_default 在函数被调用之前被调用，因为 foo=mk_default() 调用它，由于括号。不应该是foo=mk_default吗？那么您的示例可能会更改为myfun("testing")，后跟myfun()。

请注意，如果 formatting 是一个虚假值，例如 0，formatting = formatting or self.format 会将 formatting 设置为 self.format。这只会咬我。更安全的方法是输入 formatting = formatting if formatting is not None else self.format 或等效项。

@Godsmith，好点子！我已经更新了我的答案来解决这个问题。谢谢！

【参考方案2】：

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

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

即使你有那个参数，你也不会被允许写像def process(self, formatting = self.formatting)这样的东西，因为self在你设置默认值的地方还没有在范围内。在 Python 中，参数的默认值是在编译函数时计算的，并“卡”在函数中。 （这也是为什么，如果你使用像 [] 这样的默认值，该列表将记住函数调用之间的变化。）

我怎样才能做到这一点？

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

【讨论】：

您的解决方法不符合使用 None 时所需的输出。

如果None 是formatting 的有效值，那么您将不得不选择其他值，就像我解释的那样。

【参考方案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=None”代替“formatting=self.format”，然后从代码中分配值，如下所示：

[编辑]

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的内置函数

【讨论】：

好吧，我纠正了self 的问题。但是您的答案不符合预期的输出。

【参考方案6】：

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

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 在编译时评估默认值......我希望有一个更干净的 pythonic 方法，但是lo'。