Como obter variáveis ​​de instância em Python?

120

Existe um método embutido no Python para obter um array de todas as variáveis ​​de instância de uma classe? Por exemplo, se eu tiver este código:

class hi:
  def __init__(self):
    self.ii = "foo"
    self.kk = "bar"

Existe uma maneira de fazer isso:

>>> mystery_method(hi)
["ii", "kk"]

Edit: Eu originalmente pedi variáveis ​​de classe erroneamente.

Chris Bunch
fonte
Seu exemplo mostra "variáveis ​​de instância". Variáveis ​​de classe são outra coisa.
S.Lott de

Respostas:

143

Cada objeto possui uma __dict__variável contendo todas as variáveis ​​e seus valores.

Tente isto

>>> hi_obj = hi()
>>> hi_obj.__dict__.keys()
cnu
fonte
7
FWIW, o módulo inspect oferece um método mais confiável do que confiar no dict , que nem todas as instâncias têm.
Thomas Wouters de
1
Que tipo de instância não tem dict ? Nunca encontrei um.
Carl Meyer de
3
Certos tipos integrados, como int. Tente dizer "x = 5" e "x .__ dict__" e você receberá um AttributeError
Eli Courtwright
6
Além disso, qualquer coisa que use slots .
Thomas Wouters,
2
Por que você deseja tentar obter as variáveis ​​de instância de classe de um int? Não é nem mesmo uma aula (embora eu possa estar errado nisso).
Martin Sherburn de
103

Use vars ()

class Foo(object):
    def __init__(self):
        self.a = 1
        self.b = 2

vars(Foo()) #==> {'a': 1, 'b': 2}
vars(Foo()).keys() #==> ['a', 'b']
Jeremy Cantrell
fonte
6
+1 Eu pessoalmente acho que esta sintaxe é mais limpa do que usar dict , uma vez que atributos com sublinhados duplos devem ser "privados" na sintaxe Python.
Martin W de
3
@Martin: __methodé privado, __method__é um método especial, não necessariamente privado; Eu gostaria de dizer que os métodos especiais definem as capacidades de um objeto em vez de métodos.
u0b34a0f6ae
2
__method__é muito feio, e acho que eles foram nomeados dessa forma para tentar impedir as pessoas de usá-los, a menos que seja absolutamente necessário. Neste caso, temos a alternativa vars ().
Martin Sherburn de
no meu caso, tentei chamar vars (ObjName) e ele retorna um dict_proxy com um dicionário cujas chaves são os métodos da classe / objeto fornecido, mas nenhum sinal de elementos init . Qualquer adivinha por quê?
user228137
Variáveis ​​de sublinhado duplo __str__, __method__normalmente são para o próprio idioma. O que acontece quando você str(something)?
Zizouz212
15

Você normalmente não pode obter atributos de instância dados apenas uma classe, pelo menos não sem instanciar a classe. Você pode obter atributos de instância dada uma instância, entretanto, ou atributos de classe dada uma classe. Veja o módulo 'inspecionar'. Você não pode obter uma lista de atributos de instância porque as instâncias realmente podem ter qualquer coisa como atributo e - como em seu exemplo - a maneira normal de criá-los é apenas atribuí-los no método __init__.

Uma exceção é se sua classe usa slots, que é uma lista fixa de atributos que a classe permite que as instâncias tenham. Os slots são explicados em http://www.python.org/2.2.3/descrintro.html , mas existem várias armadilhas com os slots; eles afetam o layout da memória, portanto, a herança múltipla pode ser problemática e, em geral, a herança também deve levar os slots em consideração.

Thomas Wouters
fonte
Votar negativamente porque "você não pode obter uma lista de atributos de instância" é simplesmente errado: tanto vars () quanto dict fornecem exatamente isso.
Carl Meyer de
2
Presumo que ele quis dizer "você não pode obter uma lista de todos os atributos de instância possíveis". Por exemplo, costumo usar a geração preguiçosa e o decorador @property para adicionar uma variável de instância na primeira vez que é solicitada. O uso de dict lhe informa sobre essa variável, uma vez que ela existe, mas não antes.
Eli Courtwright,
5
Eu não fiz downvote e observe o que eu realmente disse: você não pode obter uma lista de atributos de instância dada apenas uma classe , que é o que o código que acompanha a pergunta tenta fazer.
Thomas Wouters,
2
@Carl: Por favor, eduque-se antes de escrever comentários falsos e votar negativamente com base em sua falta de conhecimento.
nikow
14

Os métodos Vars () e dict funcionarão para o exemplo postado pelo OP, mas não para objetos definidos "vagamente" como:

class foo:
  a = 'foo'
  b = 'bar'

Para imprimir todos os atributos não chamáveis, você pode usar a seguinte função:

def printVars(object):
    for i in [v for v in dir(object) if not callable(getattr(object,v))]:
        print '\n%s:' % i
        exec('print object.%s\n\n') % i
dmark
fonte
5
exec('print object.%s\n\n') % ideve ser escrito comoprint getattr(object, i)
user102008
11

Você também pode testar se um objeto tem uma variável específica com:

>>> hi_obj = hi()
>>> hasattr(hi_obj, "some attribute")
Daniel
fonte
6

Seu exemplo mostra "variáveis ​​de instância", não realmente variáveis ​​de classe.

Procure hi_obj.__class__.__dict__.items()as variáveis ​​de classe, junto com outros membros da classe, como funções de membro e o módulo que o contém.

class Hi( object ):
    class_var = ( 23, 'skidoo' ) # class variable
    def __init__( self ):
        self.ii = "foo" # instance variable
        self.jj = "bar"

Variáveis ​​de classe são compartilhadas por todas as instâncias da classe.

S.Lott
fonte
6

Sugira

>>> print vars.__doc__
vars([object]) -> dictionary

Without arguments, equivalent to locals().
With an argument, equivalent to object.__dict__.

Em outras palavras, basicamente envolve __dict__

Daniel
fonte
5

Embora não seja uma resposta direta à pergunta do OP, há uma maneira muito agradável de descobrir quais variáveis ​​estão no escopo de uma função. dê uma olhada neste código:

>>> def f(x, y):
    z = x**2 + y**2
    sqrt_z = z**.5
    return sqrt_z

>>> f.func_code.co_varnames
('x', 'y', 'z', 'sqrt_z')
>>> 

O atributo func_code contém todos os tipos de coisas interessantes. Ele permite que você faça algumas coisas legais. Aqui está um exemplo de como tenho usado isso:

def exec_command(self, cmd, msg, sig):

    def message(msg):
        a = self.link.process(self.link.recieved_message(msg))
        self.exec_command(*a)

    def error(msg):
        self.printer.printInfo(msg)

    def set_usrlist(msg):
        self.client.connected_users = msg

    def chatmessage(msg):
        self.printer.printInfo(msg)

    if not locals().has_key(cmd): return
    cmd = locals()[cmd]

    try:
        if 'sig' in cmd.func_code.co_varnames and \
                       'msg' in cmd.func_code.co_varnames: 
            cmd(msg, sig)
        elif 'msg' in cmd.func_code.co_varnames: 
            cmd(msg)
        else:
            cmd()
    except Exception, e:
        print '\n-----------ERROR-----------'
        print 'error: ', e
        print 'Error proccessing: ', cmd.__name__
        print 'Message: ', msg
        print 'Sig: ', sig
        print '-----------ERROR-----------\n'
tim.tadh
fonte
2

construído com base na resposta da dmark para obter o seguinte, o que é útil se você deseja o equivalente a sprintf e espero que ajude alguém ...

def sprint(object):
    result = ''
    for i in [v for v in dir(object) if not callable(getattr(object, v)) and v[0] != '_']:
        result += '\n%s:' % i + str(getattr(object, i, ''))
    return result
Ethan Joffe
fonte
0

Às vezes, você deseja filtrar a lista com base em vars públicos / privados. Por exemplo

def pub_vars(self):
    """Gives the variable names of our instance we want to expose
    """
    return [k for k in vars(self) if not k.startswith('_')]
hi2meuk
fonte