Что такое getattr () и как мне его использовать? - PullRequest
Новая
       50

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

242 голосов
/ 02 ноября 2010

Я читал о функции getattr() . Проблема в том, что я до сих пор не могу понять идею его использования. Единственное, что я понимаю о getattr(), это то, что getattr(li, "pop") - это то же самое, что и li.pop.

Я не понял, когда в книге упоминалось, как вы используете ее, чтобы получить ссылку на функцию, не зная ее имени до времени выполнения. Может быть, это я нуб в программировании, в целом. Может ли кто-нибудь пролить свет на эту тему? Когда и как именно это использовать?

Ответы [ 12 ]

264 голосов
/ 02 ноября 2010

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

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

Вы получаете доступ к этиматрибуты (будь то методы или объекты данных) обычно записывают: person.name, person.gender, person.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

Вы можете использовать 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 существует setattr, который позволяет вам установить атрибут объекта с его именем: 

>>> setattr(person, 'name', 'Andrew')
>>> person.name  # accessing instance attribute
'Andrew'
>>> Person.name  # accessing class attribute
'Victor'
>>>
88 голосов
/ 30 августа 2013

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

Он позволяет вам вызывать методы, основанные на содержимом строки, вместо того, чтобы вводить имя метода.1006 * Например, вы не можете сделать это: 

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

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

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

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

60 голосов
/ 02 ноября 2010

Вы можете просмотреть полный пример здесь:

Самоанализ может использоваться для различных целей, тот, который представлен в «Dive Into Python»просто способ динамически добавлять функциональность (плагин) в ваше приложение.

По динамически Я имею в виду без внесения изменений в основное приложение для добавления новой функции.

Принимая пример 'Dive Into Python' - простое приложение для извлечения атрибута из файла другого файла - вы можете добавить обработку нового формата файла без внесения изменений в исходное приложение.

Я рекомендую вам закончить книгу.Как вы читаете, все станет все яснее.

43 голосов
/ 02 ноября 2010

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

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

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

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

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

12 голосов
/ 02 ноября 2010

Вот быстрый и грязный пример того, как класс может запускать разные версии метода сохранения в зависимости от того, в какой операционной системе он выполняется с использованием 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()
6 голосов
/ 09 мая 2018

Кроме всех удивительных ответов здесь, есть способ использовать 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 в нужных местах для написания более чистого кода.

4 голосов
/ 10 апреля 2019

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

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

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

Довольно часто, когда я создаю файл 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.

3 голосов
/ 11 июня 2015

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

2 голосов
/ 29 января 2018

Еще одно использование 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]))
Страница:
...