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

问题描述 投票:44回答:5

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

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"

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

python instance-variables default-arguments
5个回答
63
投票

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

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只被调用一次,这发生在函数被调用之前!


8
投票

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

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

即使你有这个参数,你也不会被允许写像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')

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


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

0
投票

可以使用“默认”字典并使用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方法,但是'。

© www.soinside.com 2019 - 2024. All rights reserved.