什么是getattr(),我该如何使用它?

时间:2010-11-02 05:45:12

标签: python getattr

我是reading about the getattr() function。问题是我仍然无法掌握它的用法。我对getattr()唯一理解的是getattr(li, "pop")与调用li.pop相同。

我不明白这本书是什么时候提到你如何使用它来获取函数的引用而不知道它的名字直到运行时。也许这就是我在编程方面的一般菜鸟。任何人都可以对这个问题有所了解吗?我何时以及如何使用它?

16 个答案:

答案 0 :(得分:260)

Python中的对象可以具有属性 - 数据属性和函数以使用这些属性和函数(方法)。实际上,每个对象都有内置属性。

例如,您有一个对象person,它有多个属性:namegender等。

您可以通过以下方式访问这些属性(无论是方法还是数据对象):person.nameperson.genderperson.the_method()等。

但是如果你在编写程序时不知道属性的名称怎么办?例如,您将属性的名称存储在名为attr_name的变量中。

如果

attr_name = 'gender'

然后,而不是写

gender = person.gender

你可以写

gender = getattr(person, attr_name)

一些练习:

Python 3.4.0 (default, Apr 11 2014, 13:05:11)

>>> class Person():
...     name = 'Victor'
...     def say(self, what):
...         print(self.name, what)
... 
>>> getattr(Person, 'name')
'Victor'
>>> attr_name = 'name'
>>> person = Person()
>>> getattr(person, attr_name)
'Victor'
>>> getattr(person, 'say')('Hello')
Victor Hello
如果对象中不存在具有给定名称的属性,

getattr将引发AttributeError

>>> getattr(person, 'age')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'Person' object has no attribute 'age'

但是你可以传递一个默认值作为第三个参数,如果这个属性不存在,将返回该参数:

>>> getattr(person, 'age', 0)
0

您可以使用getattrdir来迭代所有属性名称并获取其值:

>>> dir(1000)
['__abs__', '__add__', ..., '__trunc__', '__xor__', 'bit_length', 'conjugate', 'denominator', 'from_bytes', 'imag', 'numerator', 'real', 'to_bytes']

>>> obj = 1000
>>> for attr_name in dir(obj):
...     attr_value = getattr(obj, attr_name)
...     print(attr_name, attr_value, callable(attr_value))
... 
__abs__ <method-wrapper '__abs__' of int object at 0x7f4e927c2f90> True
...
bit_length <built-in method bit_length of int object at 0x7f4e927c2f90> True
...

>>> getattr(1000, 'bit_length')()
10

实际用途是查找名称以testcall them开头的所有方法。

getattr类似,setattr允许您设置具有名称的对象的属性:

>>> setattr(person, 'name', 'Andrew')
>>> person.name  # accessing instance attribute
'Andrew'
>>> Person.name  # accessing class attribute
'Victor'
>>>

答案 1 :(得分:87)

对我来说,getattr最容易用这种方式解释:

它允许您根据字符串的内容调用方法,而不是键入方法名称。

例如,你不能这样做:

obj = MyObject()
for x in ['foo', 'bar']:
    obj.x()

因为x不是“builtin”类型,而是“str”。但是,你可以这样做:

obj = MyObject()
for x in ['foo', 'bar']:
    getattr(obj, x)()

它允许您根据输入动态连接对象。我发现它在处理自定义对象和模块时很有用。

答案 2 :(得分:60)

您可以在此处查看完整示例:

Introspection可以用于不同的目的,“Dive Into Python”中提供的内容只是一种在应用程序中动态添加功能(插件)的方法。

通过动态我的意思是不在核心应用程序中进行修改以添加新功能。

将'Dive Into Python'示例 - 一个简单的应用程序从不同文件的文件中提取属性 - 您可以添加新文件格式的处理,而无需修改原始应用程序。< / p>

我建议你完成这本书。在您阅读时,一切都将变得越来越清晰。

答案 3 :(得分:43)

getattr的一个非常常见的用例是将数据映射到函数。

例如,在像Django或Pylons这样的Web框架中,getattr可以直接将Web请求的URL映射到将要处理它的函数。例如,如果你看看Pylons的路由引擎,你会看到(默认情况下,至少)它会删除一个请求的URL,如:

http://www.example.com/customers/list

进入“客户”和“列表”。然后它搜索名为CustomerController的控制器类。假设它找到了类,它会创建一个类的实例,然后使用getattr来获取它的list方法。然后它调用该方法,将请求作为参数传递给它。

一旦掌握了这个想法,扩展Web应用程序的功能变得非常容易:只需向控制器类添加新方法,然后在页面中创建使用这些方法的相应URL的链接。所有这一切都可以通过getattr来实现。

答案 4 :(得分:12)

这是一个快速而又脏的示例,说明类如何根据使用getattr()执行的操作系统来触发不同版本的save方法。

import os

class Log(object):
    def __init__(self):
        self.os = os.name
    def __getattr__(self, name):
        """ look for a 'save' attribute, or just 
          return whatever attribute was specified """
        if name == 'save':
            try:
                # try to dynamically return a save 
                # method appropriate for the user's system
                return getattr(self, self.os)
            except:
                # bail and try to return 
                # a default save method
                return getattr(self, '_save')
        else:
            return getattr(self, name)

    # each of these methods could have save logic specific to 
    # the system on which the script is executed
    def posix(self): print 'saving on a posix machine'
    def nt(self): print 'saving on an nt machine'
    def os2(self): print 'saving on an os2 machine'
    def ce(self): print 'saving on a ce machine'
    def java(self): print 'saving on a java machine'
    def riscos(self): print 'saving on a riscos machine'
    def _save(self): print 'saving on an unknown operating system'

    def which_os(self): print os.name

现在让我们在一个例子中使用这个类:

logger = Log()

# Now you can do one of two things:
save_func = logger.save
# and execute it, or pass it along 
# somewhere else as 1st class:
save_func()

# or you can just call it directly:
logger.save()

# other attributes will hit the else 
# statement and still work as expected
logger.which_os()

答案 5 :(得分:6)

除了这里所有令人惊讶的答案之外,还有一种方法可以使用getattr来保存丰富的代码并使其保持紧密。这个想法是在代码的可怕表示之后发生的,有时可能是必要的。

<强>方案

假设您的目录结构如下:

- superheroes.py
- properties.py

并且,您可以在Thor中获取有关Iron ManDoctor Strangesuperheroes.py的信息。您非常巧妙地在properties.py中的dict中写下所有这些属性,然后访问它们。

<强> properties.py

thor = {
    'about': 'Asgardian god of thunder',
    'weapon': 'Mjolnir',
    'powers': ['invulnerability', 'keen senses', 'vortex breath'], # and many more
}
iron_man = {
    'about': 'A wealthy American business magnate, playboy, and ingenious scientist',
    'weapon': 'Armor',
    'powers': ['intellect', 'armor suit', 'interface with wireless connections', 'money'],
}
doctor_strange = {
    'about': ' primary protector of Earth against magical and mystical threats',
    'weapon': 'Magic',
    'powers': ['magic', 'intellect', 'martial arts'],
}

现在,让我们假设您希望在superheroes.py中根据需要返回每个功能。所以,有像

这样的功能
from .properties import thor, iron_man, doctor_strange


def get_thor_weapon():
    return thor['weapon']


def get_iron_man_bio():
    return iron_man['about']


def get_thor_powers():
    return thor['powers']

...以及更多基于键和超级英雄返回不同值的函数。

getattr的帮助下,您可以执行以下操作:

from . import properties


def get_superhero_weapon(hero):
    superhero = getattr(properties, hero)
    return superhero['weapon']


def get_superhero_powers(hero):
    superhero = getattr(properties, hero)
    return superhero['powers']

你大大减少了代码行数,功能和重复次数!

哦,当然,如果您对变量有properties_of_thor这样的错误名称,只需执行

即可制作和访问它们。
def get_superhero_weapon(hero):
    superhero = 'properties_of_{}'.format(hero)
    all_properties = getattr(properties, superhero)
    return all_properties['weapon']

注意:对于这个特殊问题,可以采用更智能的方法来处理这种情况,但我们的想法是提供一些有关在正确位置使用getattr来编写更清晰代码的见解。

答案 6 :(得分:3)

我有时会使用getattr(..)在代码中使用之前懒洋洋地初始化次要重要性属性。

比较以下内容:

class Graph(object):
    def __init__(self):
        self.n_calls_to_plot = 0

    #...
    #A lot of code here
    #...

    def plot(self):
        self.n_calls_to_plot += 1

对此:

class Graph(object):
    def plot(self):
        self.n_calls_to_plot = 1 + getattr(self, "n_calls_to_plot", 0)

第二种方式的优点是n_calls_to_plot仅出现在代码中使用它的地方。这对于可读性是有好处的,因为(1)你可以在阅读它的使用方式时立即看到它的起始值,(2)它不会引起__init__(..)方法的干扰,理想情况应该是关于类的概念状态,而不是由于技术原因(例如优化)仅由函数的某个方法使用的某个实用程序计数器,并且与对象的含义无关。

答案 7 :(得分:3)

当我从存储在类中的数据创建XML文件时,如果属性不存在或属于None类型,我会经常收到错误。在这种情况下,我的问题是不知道属性名称是什么,如问题中所述,而是数据存储在该属性中。

class Pet:
    def __init__(self):
        self.hair = None
        self.color = None

如果我使用hasattr执行此操作,即使属性值类型为True,它也会返回None,这会导致我的ElementTree set命令失败

hasattr(temp, 'hair')
>>True

如果属性值的类型为Nonegetattr也会返回它,这会导致我的ElementTree set命令失败。

c = getattr(temp, 'hair')
type(c)
>> NoneType

我现在使用以下方法来处理这些情况:

def getRealAttr(class_obj, class_attr, default = ''):
    temp = getattr(class_obj, class_attr, default)
    if temp is None:
        temp = default
    elif type(temp) != str:
        temp = str(temp)
    return temp

这是我何时以及如何使用getattr

答案 8 :(得分:2)

# getattr

class hithere():

    def french(self):
        print 'bonjour'

    def english(self):
        print 'hello'

    def german(self):
        print 'hallo'

    def czech(self):
        print 'ahoj'

    def noidea(self):
        print 'unknown language'


def dispatch(language):
    try:
        getattr(hithere(),language)()
    except:
        getattr(hithere(),'noidea')()
        # note, do better error handling than this

dispatch('french')
dispatch('english')
dispatch('german')
dispatch('czech')
dispatch('spanish')

答案 9 :(得分:2)

getattr()在Python中实现switch语句的另一个用途。它使用两种反射来获得案例类型。

import sys

class SwitchStatement(object):
    """ a class to implement switch statement and a way to show how to use gettattr in Pythion"""

    def case_1(self):
        return "value for case_1"

    def case_2(self):
        return "value for case_2"

    def case_3(self):
        return "value for case_3"

    def case_4(self):
        return "value for case_4"

    def case_value(self, case_type=1):
        """This is the main dispatchmethod, that uses gettattr"""
        case_method = 'case_' + str(case_type)
        # fetch the relevant method name
        # Get the method from 'self'. Default to a lambda.
        method = getattr(self, case_method, lambda: "Invalid case type")
        # Call the method as we return it
        return method()

def main(_):
    switch = SwitchStatement()
    print swtich.case_value(_)

if __name__ == '__main__':
    main(int(sys.argv[1]))

答案 10 :(得分:2)

getattr(object, 'x') 等同于 object.x

两种情况下,其中getattr可能有用。

  • 您无法编写object.x,(因为您事先不知道要使用哪个属性,例如:它来自字符串)
  • 您要提供默认值。如果没有object.y,则AttributeError将引发y。但是getattr(object, 'y', 5)将返回5

答案 11 :(得分:2)

我认为这个例子是不言自明的。它运行第一个参数的方法,其名称在第二个参数中给出。

class MyClass:
   def __init__(self):
      pass
   def MyMethod(self):
      print("Method ran")

# Create an object
object = MyClass()
# Get all the methods of a class
method_list = [func for func in dir(MyClass) if callable(getattr(MyClass, func))]
# You can use any of the methods in method_list
# "MyMethod" is the one we want to use right now

# This is the same as running "object.MyMethod()"
getattr(object,'MyMethod')()

答案 12 :(得分:1)

setattr()

我们使用 setattr 将属性添加到我们的类实例中。我们传递类实例,属性名称和值。

getattr()

使用 getattr ,我们可以检索这些值

例如

Employee = type("Employee", (object,), dict())

employee = Employee()

# Set salary to 1000
setattr(employee,"salary", 1000 )

# Get the Salary
value = getattr(employee, "salary")

print(value)

答案 13 :(得分:0)

https://www.programiz.com/python-programming/methods/built-in/getattr

中的内容也有所说明
class Person:
    age = 23
    name = "Adam"

person = Person()
print('The age is:', getattr(person, "age"))
print('The age is:', person.age)

年龄是:23

年龄是:23

class Person:
    age = 23
    name = "Adam"

person = Person()

# when default value is provided
print('The sex is:', getattr(person, 'sex', 'Male'))

# when no default value is provided
print('The sex is:', getattr(person, 'sex'))

性别是:男性

AttributeError:“人物”对象没有属性“性别”

答案 14 :(得分:0)

我已经在Python2.7.17中尝试过

一些同胞已经回答了。但是我试图打电话 getattr(obj,'set_value')并且没有执行set_value方法,因此我将其更改为getattr(obj,'set_value')()->这有助于调用相同的内容。

示例代码:

示例1:

    class GETATT_VERIFY():
       name = "siva"
       def __init__(self):
           print "Ok"
       def set_value(self):
           self.value = "myself"
           print "oooh"
    obj = GETATT_VERIFY()
    print getattr(GETATT_VERIFY, 'name')
    getattr(obj, 'set_value')()
    print obj.value

答案 15 :(得分:0)

我为 getattr(5,'__doc__') 得到了一些东西,但是 5.__doc__ 给了我一个错误,所以我不确定它们是否完全相同......