Что такое getattr () и как его использовать?

getattr(object, 'x') полностью эквивалентно object.x.

Есть только два случая, когда getattr может быть полезным.

• вы не можете написать object.x, потому что заранее не знаете, какой атрибут вам нужен (он исходит из строки). Очень полезно для метапрограммирования.
• вы хотите указать значение по умолчанию. object.y поднимет AttributeError, если нет y. Но getattr(object, 'y', 5) вернет 5.

Объекты в Python могут иметь атрибуты - атрибуты данных и функции для работы с ними (методы). Собственно, у каждого объекта есть встроенные атрибуты.

Например, у вас есть объект person, у которого есть несколько атрибутов: name, gender и т. Д.

Вы получаете доступ к этим атрибутам (будь то методы или объекты данных), обычно записывая: person.name, person.gender, person.the_method() и т. Д.

Но что, если вы не знаете имя атрибута во время написания программы? Например, имя атрибута хранится в переменной attr_name.

if

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

Вы можете использовать getattr вместе с dir для перебора всех имен атрибутов и получения их значения:

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

На практике это можно использовать для поиска всех методов, имена которых начинаются с test и позвоните им.

Подобно getattr, есть _ 21_, который позволяет вам установить атрибут объекта, имеющего его имя:

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

Для меня getattr проще всего объяснить так:

Он позволяет вызывать методы на основе содержимого строки вместо ввода имени метода.

Например, нельзя этого сделать:

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

потому что x относится не к типу builtin, а к str. Однако вы МОЖЕТЕ сделать это:

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

Это позволяет вам динамически подключаться к объектам на основе ваших входных данных. Я нашел это полезным при работе с пользовательскими объектами и модулями.

Довольно распространенный вариант использования getattr - сопоставление данных с функциями.

Например, в веб-фреймворке, таком как Django или Pylons, getattr упрощает сопоставление URL-адреса веб-запроса с функцией, которая будет его обрабатывать. Если вы посмотрите, например, под капот маршрутизации Pylons, вы увидите, что (по крайней мере, по умолчанию) он разбивает URL-адрес запроса, например:

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

в «клиенты» и «список». Затем он ищет класс контроллера с именем CustomerController. Предполагая, что он находит класс, он создает экземпляр класса, а затем использует getattr для получения своего list метода. Затем он вызывает этот метод, передавая ему запрос в качестве аргумента.

Как только вы усвоите эту идею, становится действительно легко расширить функциональность веб-приложения: просто добавьте новые методы в классы контроллеров, а затем создайте ссылки на своих страницах, которые используют соответствующие URL-адреса для этих методов. Все это стало возможным благодаря getattr.

Вот быстрый и грязный пример того, как класс может запускать разные версии метода сохранения в зависимости от того, в какой операционной системе он выполняется, используя getattr().

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

Помимо всех замечательных ответов здесь, есть способ использовать getattr, чтобы сохранить обильные строки кода и сохранить его аккуратным. Эта мысль пришла после ужасного представления кода, которое иногда могло быть необходимостью.

Сценарий

Предположим, ваша структура каталогов выглядит следующим образом:

- superheroes.py
- properties.py

И у вас есть функции для получения информации о Thor, Iron Man, Doctor Strange в superheroes.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 в нужных местах для написания более чистого кода.

Иногда я использую 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__(..), который в идеале должен быть связан с концептуальным состоянием класс, а не какой-то счетчик утилит, который используется только одним из методов функции по техническим причинам, например для оптимизации, и не имеет никакого отношения к значению объекта.

Довольно часто, когда я создаю XML-файл из данных, хранящихся в классе, я часто получаю ошибки, если атрибут не существует или имеет тип None. В этом случае моя проблема заключалась не в знании имени атрибута, как указано в вашем вопросе, а в том, что данные, когда-либо хранящиеся в этом атрибуте.

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

Если бы я использовал для этого hasattr, он вернул бы True, даже если бы значение атрибута было типа None, и это привело бы к сбою моей команды ElementTree set.

hasattr(temp, 'hair')
>>True

Если бы значение атрибута было типа None, getattr также вернет его, что приведет к сбою моей команды 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.

Еще одно использование getattr () для реализации оператора switch в Python. Он использует оба отражения для получения типа дела.

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

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)

Я думаю, что этот пример не требует пояснений. Он запускает метод первого параметра, имя которого указано во втором параметре.

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

Это также уточняется из 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: объект 'Person' не имеет атрибута 'sex'

Я пробовал в 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

Я получаю что-то для getattr(5,'__doc__'), но 5.__doc__ выдает ошибку, поэтому я не уверен, что они полностью эквивалентны ...