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

时间:2011-11-15 05:34:30

标签: python instance-variables default-arguments

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

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"

这里有什么问题,为什么这不起作用?我怎么能让这个工作?

6 个答案:

答案 0 :(得分:54)

您无法将此定义为默认值,因为在定义方法之前会评估默认值,该方法存在于任何实例之前。通常的模式是做这样的事情:

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

    def process(self, formatting=None):
        if formatting is None:
            formatting = self.format
        print(formatting)
仅当self.formatformatting时才会使用

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仅被调用一次,并且在调用该函数之前发生过!

答案 1 :(得分:8)

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

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

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

  

我怎样才能做到这一点?

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

答案 2 :(得分: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')

答案 3 :(得分:1)

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

答案 4 :(得分:0)

您无法在方法定义中访问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 :(得分:0)

您可以使用“默认值”字典并通过使用eval()创建类的新实例,而不是创建跨越默认争论的if-thens列表:

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方法,但请放心。