How do I get list of methods in a Python class

Question

I want to iterate through the methods in a class  or handle class or instance objects differently based on the methods present  How do I get a list of class methods   Also see    How can I list the methods in a Python 2 5 module   Looping over a Python   IronPython Object Methods  Finding the methods an object has  How do I look inside a Python object   How Do I Perform Introspection on an Object in Python 2 x   How to get a complete list of object   s methods and attributes   Finding out which functions are available from a class instance in python

User · Answer

class CPerson      def   init   self  age           self  age   age      def run self           pass       property     def age self   return self  age       staticmethod     def my static method    print  Life is short  you need Python         classmethod     def say cls  msg   return msg   test class   CPerson   print dir test class      list all the fields and methods of your object print   name  t  for name  t in test class   dict   items   if type t    name       function  and not name startswith         print   name  t  for name  t in test class   dict   items   if type t    name       function  and not name startswith            output     run    lt function CPerson run at 0x0000000002AD3268 gt       age    lt property object at 0x0000000002368688 gt      my static method    lt staticmethod object at 0x0000000002ACBD68 gt      say    lt classmethod object at 0x0000000002ACF0B8 gt

User · Answer

You can list all methods in a python class by using the following code  dir className    This will return a list of all the names of the methods in the class

User · Answer

There s this approach   getattr obj  m  for m in dir obj  if not m startswith         When dealing with a class instance  perhaps it d be better to return a list with the method references instead of just names    If that s your goal  as well as  Using no import Excluding private methods  e g    init    from the list  It may be of use  You might also want to assure it s callable getattr obj  m    since dir returns all attributes within obj  not just methods  In a nutshell  for a class like class Ghost      def boo self  who           return f Who you gonna call   who    We could check instance retrieval with  gt  gt  gt  g   Ghost    gt  gt  gt  methods    getattr g  m  for m in dir g  if not m startswith         gt  gt  gt  print methods    lt bound method Ghost boo of  lt   main   Ghost object at     gt  gt    So you can call it right away   gt  gt  gt  for method in methods          print method  GHOSTBUSTERS        Who you gonna call  GHOSTBUSTERS     An use case  I used this for unit testing  Had a class where all methods performed variations of the same process - which led to lengthy tests  each only a tweak away from the others  DRY was a far away dream  Thought I should have a single test for all methods  so I made the above iteration  Although I realized I should instead refactor the code itself to be DRY-compliant anyway    this may still serve a random nitpicky soul in the future

User · Answer

An example  listing the methods of the optparse OptionParser class     gt  gt  gt  from optparse import OptionParser  gt  gt  gt  import inspect  python2  gt  gt  gt  inspect getmembers OptionParser  predicate inspect ismethod         init      lt unbound method OptionParser   init   gt           add option    lt unbound method OptionParser add option gt       add option group    lt unbound method OptionParser add option group gt       add options    lt unbound method OptionParser add options gt       check values    lt unbound method OptionParser check values gt       destroy    lt unbound method OptionParser destroy gt       disable interspersed args      lt unbound method OptionParser disable interspersed args gt       enable interspersed args      lt unbound method OptionParser enable interspersed args gt       error    lt unbound method OptionParser error gt       exit    lt unbound method OptionParser exit gt       expand prog name    lt unbound method OptionParser expand prog name gt              python3  gt  gt  gt  inspect getmembers OptionParser  predicate inspect isfunction        Notice that getmembers returns a list of 2-tuples  The first item is the name of the member  the second item is the value   You can also pass an instance to getmembers    gt  gt  gt  parser   OptionParser    gt  gt  gt  inspect getmembers parser  predicate inspect ismethod

User · Answer

This also works  In mymodule py  def foo x      return  foo  def bar       return  bar   In another file  import inspect import mymodule method list     func 0  for func in inspect getmembers mymodule  predicate inspect isroutine  if callable getattr mymodule  func 0       Output     foo    bar    From the Python docs  inspect isroutine object    Return true if the object is a user-defined or built-in function or method

User · Answer

Say you want to know all methods associated with list class Just Type The following    print  dir list     Above will give you all methods of list class

User · Answer

Try the property   dict

User · Answer

Python 3 x answer without external libraries  method list    func for func in dir Foo  if callable getattr Foo  func      dunder-excluded result   method list    func for func in dir Foo  if callable getattr Foo  func   and not func startswith

User · Answer

you can also import the FunctionType from types and test it with the class   dict     from types import FunctionType  class Foo      def bar self   pass     def baz self   pass  def methods cls       return  x for x  y in cls   dict   items   if type y     FunctionType   methods Foo       bar    baz

User · Answer

Try print help ClassName   It prints out methods of the class

User · Answer

You can use a function which I have created  def method finder classname        non magic class           class methods   dir classname       for m in class methods           if m startswith                     continue          else               non magic class append m       return non magic class     method finder list   Output    append     clear     copy     count     extend     index     insert     pop     remove     reverse     sort

User · Answer

I just keep this there  because top rated answers are not clear   This is simple test with not usual class based on Enum     - - coding  utf-8 - - import sys  inspect from enum import Enum  class my enum Enum          Enum base class my enum        M ONE   -1     ZERO   0     ONE   1     TWO   2     THREE   3      def is natural self               return  self value  gt  0      def is negative self               return  self value  lt  0   def is clean name name       return not name startswith      and not name endswith      def clean names lst       return   n for n in lst if is clean name n    def get items cls lst       try              res     getattr cls n  for n in lst       except Exception as e              res    Exception  type e   e              pass     return res   print  sys version    dir res   clean names  dir my enum    inspect res   clean names    x 0  for x in inspect getmembers my enum      dict res   clean names  my enum   dict   keys      print      names       print  dir res   print  inspect res   print  dict res    print      items       print  get items my enum dir res    print  get items my enum inspect res    print  get items my enum dict res      And this is output results   3 7 7  default  Mar 10 2020  13 18 53    GCC 9 2 1 20200306     names      M ONE    ONE    THREE    TWO    ZERO     M ONE    ONE    THREE    TWO    ZERO    name    value     is natural    is negative    M ONE    ZERO    ONE    TWO    THREE      items      lt my enum M ONE  -1 gt    lt my enum ONE  1 gt    lt my enum THREE  3 gt    lt my enum TWO  2 gt    lt my enum ZERO  0 gt     lt class  Exception  gt    lt class  AttributeError  gt   AttributeError  name      lt function my enum is natural at 0xb78a1fa4 gt    lt function my enum is negative at 0xb78ae854 gt    lt my enum M ONE  -1 gt    lt my enum ZERO  0 gt    lt my enum ONE  1 gt    lt my enum TWO  2 gt    lt my enum THREE  3 gt     So what we have    dir provide not complete data inspect getmembers provide not complete data and provide internal keys that are not accessible with getattr     dict   keys   provide complete and reliable result   Why are votes so erroneous  And where i m wrong  And where wrong other people which answers have so low votes

User · Answer

methods     func  getattr o  func   for func in dir o  if callable getattr o  func      gives an identical list as  methods   inspect getmembers o  predicate inspect ismethod    does

User · Answer

If your method is a  quot regular quot  method and not a staticmethod  classmethod etc  There is a little hack I came up with - for k  v in your class   dict   items        if  quot function quot  in str v           print k   This can be extended to other type of methods by changing  quot function quot  in the if condition correspondingly  Tested in Python 2 7 and Python 3 5

User · Answer

This is just an observation   encode  seems to be a method for string objects  str 1    a  str 1 encode  utf-8    gt  gt  gt  b a    However  if str1 is inspected for methods  an empty list is returned  inspect getmember str 1  predicate inspect ismethod   gt  gt  gt       So  maybe I am wrong  but the issue seems to be not simple

User · Answer

def find defining class obj  meth name       for ty in type obj  mro            if meth name in ty   dict                return ty   So  print find defining class car   speedometer      Think Python page 210

User · Answer

If you want to list only methods of a python class  import numpy as np print np random   all

User · Answer

To produce a list of methods put the name of the method in a list without the usual parenthesis  Remove the name and attach the parenthesis and that calls the method      def methodA            print  quot   MethodA quot        def methodB            print  quot   methodB quot        a          a append methodA      a append methodB      for item in a          item

User · Answer

There is the dir theobject  method to list all the fields and methods of your object  as a tuple  and the inspect module  as codeape write  to list the fields and methods with their doc  in        Because everything  even fields  might be called in Python  I m not sure there is a built-in function to list only methods  You might want to try if the object you get through dir is callable or not

User · Answer

I know this is an old post  but just wrote this function and will leave it here is case someone stumbles looking for an answer   def classMethods the class class only False instance only False exclude internal True        def acceptMethod tup            internal function that analyzes the tuples returned by getmembers tup 1  is the           actual member object         is method   inspect ismethod tup 1           if is method              bound to   tup 1  im self             internal   tup 1  im func func name  2          and tup 1  im func func name -2                       if internal and exclude internal                  include   False             else                  include    bound to    the class and not instance only  or  bound to    None and not class only          else              include   False         return include      uses filter to return results according to internal function and arguments     return filter acceptMethod inspect getmembers the class

User · Answer

Note that you need to consider whether you want methods from base classes which are inherited  but not overridden  included in the result  The dir   and inspect getmembers   operations do include base class methods  but use of the   dict   attribute does not

[python] How do I get list of methods in a Python class?

Examples related to python