Trovare quali metodi ha un oggetto Python


430

Dato un oggetto Python di qualsiasi tipo, c'è un modo semplice per ottenere l'elenco di tutti i metodi che ha questo oggetto?

O,

se ciò non è possibile, esiste almeno un modo semplice per verificare se ha un metodo particolare oltre a controllare semplicemente se si verifica un errore quando viene chiamato il metodo?


Risposte:


524

Per molti oggetti , puoi utilizzare questo codice, sostituendo "oggetto" con l'oggetto che ti interessa:

object_methods = [method_name for method_name in dir(object)
                  if callable(getattr(object, method_name))]

L'ho scoperto su diveintopython.net (ora archiviato). Speriamo che ciò fornisca ulteriori dettagli!

Se ne ricevi uno AttributeError, puoi invece usarlo :

getattr(è intollerante alle sottoclassi virtuali astratte di python3.6 stile panda. Questo codice fa lo stesso come sopra e ignora le eccezioni.

import pandas as pd 
df = pd.DataFrame([[10, 20, 30], [100, 200, 300]],  
                  columns=['foo', 'bar', 'baz']) 
def get_methods(object, spacing=20): 
  methodList = [] 
  for method_name in dir(object): 
    try: 
        if callable(getattr(object, method_name)): 
            methodList.append(str(method_name)) 
    except: 
        methodList.append(str(method_name)) 
  processFunc = (lambda s: ' '.join(s.split())) or (lambda s: s) 
  for method in methodList: 
    try: 
        print(str(method.ljust(spacing)) + ' ' + 
              processFunc(str(getattr(object, method).__doc__)[0:90])) 
    except: 
        print(method.ljust(spacing) + ' ' + ' getattr() failed') 


get_methods(df['foo']) 

3
È una comprensione dell'elenco, che restituisce un elenco di metodi in cui il metodo è un elemento nell'elenco restituito da dir (oggetto) e in cui ciascun metodo viene aggiunto all'elenco solo se getattr (oggetto, metodo) restituisce un callable.
Mnebuerquo,

1
Come lo usi esattamente? Per dire stampare un elenco dei metodi.
palude

12
@marsh Per stampare i metodi: print [method for method in dir(object) if callable(getattr(object, method))].
Orienteerix,

1
Ricevo un messaggio AttributeError: module 'pandas.core.common' has no attribute 'AbstractMethodError'quando provo a eseguirlo. Vedi i dettagli su stackoverflow.com/q/54713287/9677043 .
Karl Baker,

1
non funziona per l'oggetto panda dataframe in python 3.6.
Stefan Karlsson,

226

È possibile utilizzare la dir()funzione integrata per ottenere un elenco di tutti gli attributi di un modulo. Prova questo dalla riga di comando per vedere come funziona.

>>> import moduleName
>>> dir(moduleName)

Inoltre, puoi utilizzare la hasattr(module_name, "attr_name")funzione per scoprire se un modulo ha un attributo specifico.

Consulta la Guida all'introspezione di Python per ulteriori informazioni.


hasattrha aiutato il mio caso d'uso a scoprire se l'oggetto python ha una variabile o un metodo membro particolare.
Akshay,

Non sono sicuro del perché questa soluzione non sia sufficientemente votata. Questo è conciso e preciso.
Prasad Raghavendra,

93

Il metodo più semplice è usare dir(objectname). Visualizzerà tutti i metodi disponibili per quell'oggetto. Bel trucco.


3
Visualizza anche gli attributi dell'oggetto, quindi se si desidera trovare metodi specifici, non funzionerà.
Eric

Sì. Concordato. Ma non sono a conoscenza di altre tecniche per ottenere solo l'elenco dei metodi. Forse l'idea migliore è quella di ottenere l'elenco di entrambi gli attributi e i metodi e quindi utilizzare <hasattr (oggetto, "method_name"> per filtrarlo ulteriormente?
Pawan Kumar,

1
@neuronet, sto cercando di eseguire la risposta accettata ma ottengo un AttributeError: module 'pandas.core.common' has no attribute 'AbstractMethodError'. Qualche idea? Vedere deets a stackoverflow.com/q/54713287/9677043 . Da +1 a @Pawan Kumar b / c la risposta funziona e a @ljs per la promessa di un elenco filtrato dei soli metodi.
Karl Baker,

30

Per verificare se ha un metodo particolare:

hasattr(object,"method")

14
dal momento che l'OP è alla ricerca di un metodo e non solo e attributo, penso che tu voglia fare un ulteriore passo avanti con:if hasattr(obj,method) and callable(getattr(obj,method)):
Bruno Bronosky,

28

Credo che ciò che vuoi sia qualcosa del genere:

un elenco di attributi da un oggetto

A mio modesto parere, la funzione integrata dir()può fare questo lavoro per te. Tratto help(dir)dall'output su Python Shell:

dir (...)

dir([object]) -> list of strings

Se chiamato senza argomento, restituisce i nomi nell'ambito corrente.

Altrimenti, restituisce un elenco alfabetico di nomi comprendente (alcuni) degli attributi dell'oggetto dato e degli attributi raggiungibili da esso.

Se l'oggetto fornisce un metodo denominato __dir__, verrà utilizzato; in caso contrario viene utilizzata la logica dir () predefinita e restituisce:

  • per un oggetto modulo: gli attributi del modulo.
  • per un oggetto di classe: i suoi attributi e ricorsivamente gli attributi delle sue basi.
  • per qualsiasi altro oggetto: i suoi attributi, gli attributi della sua classe e ricorsivamente gli attributi delle classi base della sua classe.

Per esempio:

$ python
Python 2.7.6 (default, Jun 22 2015, 17:58:13) 
[GCC 4.8.2] on linux2
Type "help", "copyright", "credits" or "license" for more information.

>>> a = "I am a string"
>>>
>>> type(a)
<class 'str'>
>>>
>>> dir(a)
['__add__', '__class__', '__contains__', '__delattr__', '__doc__',
'__eq__', '__format__', '__ge__', '__getattribute__', '__getitem__',
'__getnewargs__', '__getslice__', '__gt__', '__hash__', '__init__',
'__le__', '__len__', '__lt__', '__mod__', '__mul__', '__ne__', '__new__',
'__reduce__', '__reduce_ex__', '__repr__', '__rmod__', '__rmul__',
'__setattr__', '__sizeof__', '__str__', '__subclasshook__',
'_formatter_field_name_split', '_formatter_parser', 'capitalize',
'center', 'count', 'decode', 'encode', 'endswith', 'expandtabs', 'find',
'format', 'index', 'isalnum', 'isalpha', 'isdigit', 'islower', 'isspace',
'istitle', 'isupper', 'join', 'ljust', 'lower', 'lstrip', 'partition',
'replace', 'rfind', 'rindex', 'rjust', 'rpartition', 'rsplit', 'rstrip',
'split', 'splitlines', 'startswith', 'strip', 'swapcase', 'title',
'translate', 'upper', 'zfill']

Mentre stavo controllando il tuo problema, ho deciso di dimostrare il mio flusso di pensieri, con una migliore formattazione dell'output di dir().

dir_attributes.py (Python 2.7.6)

#!/usr/bin/python
""" Demonstrates the usage of dir(), with better output. """

__author__ = "ivanleoncz"

obj = "I am a string."
count = 0

print "\nObject Data: %s" % obj
print "Object Type: %s\n" % type(obj)

for method in dir(obj):
    # the comma at the end of the print, makes it printing 
    # in the same line, 4 times (count)
    print "| {0: <20}".format(method),
    count += 1
    if count == 4:
        count = 0
        print

dir_attributes.py (Python 3.4.3)

#!/usr/bin/python3
""" Demonstrates the usage of dir(), with better output. """

__author__ = "ivanleoncz"

obj = "I am a string."
count = 0

print("\nObject Data: ", obj)
print("Object Type: ", type(obj),"\n")

for method in dir(obj):
    # the end=" " at the end of the print statement, 
    # makes it printing in the same line, 4 times (count)
    print("|    {:20}".format(method), end=" ")
    count += 1
    if count == 4:
        count = 0
        print("")

Spero di aver contribuito :).


1
Ha contribuito? La tua risposta ha funzionato per me in Python 2.7.12, quindi diavolo sì!
gsamaras,

23

Oltre alle risposte più dirette, sarei negligente se non menzionassi iPython . Premi 'tab' per vedere i metodi disponibili, con completamento automatico.

E una volta trovato un metodo, prova:

help(object.method) 

per vedere i pydocs, la firma del metodo, ecc.

Ahh ... REPL .


12

Se si desidera specificamente metodi , è necessario utilizzare inspect.ismethod .

Per i nomi dei metodi:

import inspect
method_names = [attr for attr in dir(self) if inspect.ismethod(getattr(self, attr))]

Per i metodi stessi:

import inspect
methods = [member for member in [getattr(self, attr) for attr in dir(self)] if inspect.ismethod(member)]

A volte inspect.isroutinepuò anche essere utile (per built-in, estensioni C, Cython senza la direttiva del compilatore "vincolante").


Non dovresti usare inspect.getmembersinvece di usare dirnella comprensione di un elenco?
Boris,

Sì, sembra meglio!
paulmelnikow,

11

Apri bash shell (ctrl + alt + T su Ubuntu). Avvia la shell python3 al suo interno. Creare un oggetto per osservare i metodi di. Basta aggiungere un punto dopo di esso e premere due volte "tab" e vedrai qualcosa del genere:

 user@note:~$ python3
 Python 3.4.3 (default, Nov 17 2016, 01:08:31) 
 [GCC 4.8.4] on linux
 Type "help", "copyright", "credits" or "license" for more information.
 >>> import readline
 >>> readline.parse_and_bind("tab: complete")
 >>> s = "Any object. Now it's a string"
 >>> s. # here tab should be pressed twice
 s.__add__(           s.__rmod__(          s.istitle(
 s.__class__(         s.__rmul__(          s.isupper(
 s.__contains__(      s.__setattr__(       s.join(
 s.__delattr__(       s.__sizeof__(        s.ljust(
 s.__dir__(           s.__str__(           s.lower(
 s.__doc__            s.__subclasshook__(  s.lstrip(
 s.__eq__(            s.capitalize(        s.maketrans(
 s.__format__(        s.casefold(          s.partition(
 s.__ge__(            s.center(            s.replace(
 s.__getattribute__(  s.count(             s.rfind(
 s.__getitem__(       s.encode(            s.rindex(
 s.__getnewargs__(    s.endswith(          s.rjust(
 s.__gt__(            s.expandtabs(        s.rpartition(
 s.__hash__(          s.find(              s.rsplit(
 s.__init__(          s.format(            s.rstrip(
 s.__iter__(          s.format_map(        s.split(
 s.__le__(            s.index(             s.splitlines(
 s.__len__(           s.isalnum(           s.startswith(
 s.__lt__(            s.isalpha(           s.strip(
 s.__mod__(           s.isdecimal(         s.swapcase(
 s.__mul__(           s.isdigit(           s.title(
 s.__ne__(            s.isidentifier(      s.translate(
 s.__new__(           s.islower(           s.upper(
 s.__reduce__(        s.isnumeric(         s.zfill(
 s.__reduce_ex__(     s.isprintable(       
 s.__repr__(          s.isspace(           

1
Mentre parliamo di soluzioni alternative come questa, aggiungerò che puoi anche eseguire ipython, iniziare a digitare l'oggetto e premere tabe funzionerà anche. Nessuna impostazione readline necessaria
Max Coplan

1
@MaxCoplan Ho aggiunto la soluzione alternativa nel codice per i casi in cui il completamento della scheda non è abilitato per impostazione predefinita
Valery Ramusik

8

Il problema con tutti i metodi indicati qui è che NON PUOI essere sicuro che non esiste un metodo.

In Python puoi intercettare il punto chiamando attraverso __getattr__e __getattribute__, rendendo possibile la creazione del metodo "in fase di esecuzione"

Esempio:

class MoreMethod(object):
    def some_method(self, x):
        return x
    def __getattr__(self, *args):
        return lambda x: x*2

Se lo esegui, puoi chiamare il metodo inesistente nel dizionario degli oggetti ...

>>> o = MoreMethod()
>>> o.some_method(5)
5
>>> dir(o)
['__class__', '__delattr__', '__dict__', '__doc__', '__format__', '__getattr__', '__getattribute__', '__hash__', '__init__', '__module__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', 'some_method']
>>> o.i_dont_care_of_the_name(5)
10

Ed è per questo che usi il Più facile per chiedere perdono rispetto ai paradigmi di autorizzazione in Python.


6

Il modo più semplice per ottenere un elenco di metodi di qualsiasi oggetto è utilizzare il help()comando.

%help(object)

Elencherà tutti i metodi disponibili / importanti associati a quell'oggetto.

Per esempio:

help(str)

Cosa fa %il primo esempio? Non funziona nel mio Python 2.7.
Scorchio,

@Scorchio Ho usato "%" come prompt invece ">>>" per Python. È possibile rimuovere% prima di eseguire il comando.
Paritosh Vyas,

3
import moduleName
for x in dir(moduleName):
print(x)

Questo dovrebbe funzionare :)


1

È possibile creare una getAttrsfunzione che restituirà i nomi delle proprietà richiamabili di un oggetto

def getAttrs(object):
  return filter(lambda m: callable(getattr(object, m)), dir(object))

print getAttrs('Foo bar'.split(' '))

Sarebbe tornato

['__add__', '__class__', '__contains__', '__delattr__', '__delitem__',
 '__delslice__', '__eq__', '__format__', '__ge__', '__getattribute__', 
 '__getitem__', '__getslice__', '__gt__', '__iadd__', '__imul__', '__init__', 
 '__iter__', '__le__', '__len__', '__lt__', '__mul__', '__ne__', '__new__', 
 '__reduce__', '__reduce_ex__', '__repr__', '__reversed__', '__rmul__', 
 '__setattr__', '__setitem__', '__setslice__', '__sizeof__', '__str__', 
 '__subclasshook__', 'append', 'count', 'extend', 'index', 'insert', 'pop', 
 'remove', 'reverse', 'sort']

1

Non esiste un modo affidabile per elencare tutti i metodi dell'oggetto. dir(object)è di solito utile, ma in alcuni casi potrebbe non elencare tutti i metodi. Secondo la dir()documentazione : "Con un argomento, tenta di restituire un elenco di attributi validi per quell'oggetto".

La verifica callable(getattr(object, method))dell'esistenza del metodo può essere eseguita come già indicato in precedenza.


1

Prendi un elenco come oggetto

obj = []

list(filter(lambda x:callable(getattr(obj,x)),obj.__dir__()))

Ottieni:

['__add__',
 '__class__',
 '__contains__',
 '__delattr__',
 '__delitem__',
 '__dir__',
 '__eq__',
 '__format__',
 '__ge__',
 '__getattribute__',
 '__getitem__',
 '__gt__',
 '__iadd__',
 '__imul__',
 '__init__',
 '__init_subclass__',
 '__iter__',
 '__le__',
 '__len__',
 '__lt__',
 '__mul__',
 '__ne__',
 '__new__',
 '__reduce__',
 '__reduce_ex__',
 '__repr__',
 '__reversed__',
 '__rmul__',
 '__setattr__',
 '__setitem__',
 '__sizeof__',
 '__str__',
 '__subclasshook__',
 'append',
 'clear',
 'copy',
 'count',
 'extend',
 'index',
 'insert',
 'pop',
 'remove',
 'reverse',
 'sort']

0

... c'è almeno un modo semplice per verificare se ha un metodo particolare oltre a controllare semplicemente se si verifica un errore quando viene chiamato il metodo

Mentre " Più facile chiedere perdono che permesso " è certamente il modo Pythonic, quello che stai cercando forse:

d={'foo':'bar', 'spam':'eggs'}
if 'get' in dir(d):
    d.get('foo')
# OUT: 'bar'

0

Per cercare un metodo specifico in un intero modulo

for method in dir(module) :
  if "keyword_of_methode" in method :
   print(method, end="\n")

-1

Ad esempio, se stai usando shell plus, puoi usare questo:

>> MyObject??

in quel modo, con il '??' subito dopo il tuo oggetto, ti mostrerà tutti gli attributi / metodi della classe.

Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.