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


70

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

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中的内置函数。
Yajushi 2011年

编辑selfinprocess method
Yugal Jindle中

Answers:


88

您不能真正将其定义为默认值,因为默认值是在定义方法(在任何实例存在之前)时评估的。通常的模式是改为执行以下操作:

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()
gary

2
请注意,formatting = formatting or self.format它将设置formattingself.formatifformatting是一个假值,例如0。这只是在咬我。一种更安全的方法是键入formatting = formatting if formatting is not None else self.format或等效形式。
Godsmith

1
@Godsmith,好点!我已经更新了我的答案,以解决这个问题。谢谢!
亚当·瓦格纳

9

在Python中,名字self不是特别的。这只是参数名称的约定,这就是为什么中存在self参数的原因__init__。(实际上,__init__它也不是很特别,特别是它实际上并没有创建对象……这是一个更长的故事)

C("abc").process()创建一个C实例,processC类中查找方法,并以该C实例作为第一个参数调用该方法。所以它最终会在self如果您提供了它参数中。

但是,即使您具有该参数,也不允许编写类似的内容def process(self, formatting = self.formatting),因为self在设置默认值时还不在范围之内。在Python中,参数的默认值是在编译函数时计算出来的,并“粘贴”到函数中。(这就是为什么如果使用默认值like的原因[],该列表将记住函数调用之间的更改。)

我该如何进行这项工作?

传统方法是使用None默认值,然后检查该值并将其替换在函数中。您可能会发现,为此目的设置一个特殊值(只需要一个object实例,只要将其隐藏起来,以便调用代码不使用同一实例)就更安全了None。无论哪种方式,你应该检查该值is,不是==


使用“无”时,您的解决方法不符合预期的输出。
Yugal Jindle

如果None是的有效值formatting,那么您将不得不选择其他内容,如我所解释的。
Karl Knechtel

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')

1

如果希望它们充当非静态方法,则必须将“ 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"

注意:请勿将“格式”用作变量名,因为它是python中的内置函数


好吧,我纠正了这个self问题。但是您的答案不符合期望的输出。
Yugal Jindle

1

您不能在方法定义中访问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

0

无需创建跨越默认争论的if-thens列表,而是可以使用“ defaults”字典并通过使用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在编译时评估默认值。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.