How to list all functions in a Python module

Question

I have a Python module installed on my system and I d like to be able to see what functions classes methods are available in it  I want to call the help function on each one  In Ruby I can do something like ClassName methods to get a list of all the methods available on that class  Is there something similar in Python  eg  something like  from somemodule import foo print foo methods     or whatever is the correct method to call

User · Answer

dir module  is the standard way when using a script or the standard interpreter  as mentioned in most answers   However with an interactive python shell like IPython you can use tab-completion to get an overview of all objects defined in the module   This is much more convenient  than using a script and print to see what is defined in the module    module  lt tab gt  will show you all objects defined in the module  functions  classes and so on  module ClassX  lt tab gt  will show you the methods and attributes of a class module function xy  or module ClassX method xy  will show you the docstring of that function   method module function x   or module SomeClass method xy   will show you the source code of the function   method

User · Answer

This will append all the functions that are defined in your module in a list   result    for i in dir your module       if type getattr your module  i     name       function           result append getattr your module  i

User · Answer

If you want to get the list of all the functions defined in the current file  you can do it that way    Get this script s name  import os script name   os path basename   file    rstrip  quot  py quot      Import it from its path so that you can use it as a Python object  import importlib util spec   importlib util spec from file location script name    file    x   importlib util module from spec spec  spec loader exec module x     List the functions defined in it  from inspect import getmembers  isfunction list of functions   getmembers x  isfunction   As an application example  I use that for calling all the functions defined in my unit testing scripts  This is a combination of codes adapted from the answers of Thomas Wouters and adrian here  and from Sebastian Rittau on a different question

User · Answer

Use inspect getmembers to get all the variables classes functions etc  in a module  and pass in inspect isfunction as the predicate to get just the functions  from inspect import getmembers  isfunction from my project import my module  functions list    o for o in getmembers my module  if isfunction o 1     getmembers returns a list of  object name  object  tuples sorted alphabetically by name  You can replace isfunction with any of the other isXXX functions in the inspect module

User · Answer

Once you ve imported the module  you can just do  help modulename       To get the docs on all the functions at once  interactively   Or you can use  dir modulename       To simply list the names of all the functions and variables defined in the module

User · Answer

For completeness  sake  I d like to point out that sometimes you may want to parse code instead of importing it  An import will execute top-level expressions  and that could be a problem   For example  I m letting users select entry point functions for packages being made with zipapp  Using import and inspect risks running astray code  leading to crashes  help messages being printed out  GUI dialogs popping up and so on   Instead I use the ast module to list all the top-level functions   import ast import sys  def top level functions body       return  f for f in body if isinstance f  ast FunctionDef    def parse ast filename       with open filename   rt   as file          return ast parse file read    filename filename   if   name         main         for filename in sys argv 1            print filename          tree   parse ast filename          for func in top level functions tree body               print     s    func name    Putting this code in list py and using itself as input  I get     python list py list py list py   top level functions   parse ast   Of course  navigating an AST can be tricky sometimes  even for a relatively simple language like Python  because the AST is quite low-level  But if you have a simple and clear use case  it s both doable and safe   Though  a downside is that you can t detect functions that are generated at runtime  like foo   lambda x y  x y

User · Answer

import sys from inspect import getmembers  isfunction fcn list    o 0  for o in getmembers sys modules   name     isfunction

User · Answer

This will do the trick   dir module     However  if you find it annoying to read the returned list  just use the following loop to get one name per line   for i in dir module   print i

User · Answer

Use the inspect module  from inspect import getmembers  isfunction  from somemodule import foo print getmembers foo  isfunction    Also see the pydoc module  the help   function in the interactive interpreter and the pydoc command-line tool which generates the documentation you are after  You can just give them the class you wish to see the documentation of  They can also generate  for instance  HTML output and write it to disk

User · Answer

None of these answers will work if you are unable to import said Python file without import errors  This was the case for me when I was inspecting a file which comes from a large code base with a lot of dependencies  The following will process the file as text and search for all method names that start with  def  and print them and their line numbers   import re pattern   re compile  def          for i  line in enumerate open  Example py       for match in re finditer pattern  line       print   s   s     i 1  match groups   0

User · Answer

Use vars module  then filter out anything that isn t a function using inspect isfunction  import inspect import my module  my module functions    f for    f in vars my module  values   if inspect isfunction f    The advantage of vars over dir or inspect getmembers is that it returns the functions in the order they were defined instead of sorted alphabetically  Also  this will include functions that are imported by my module  if you want to filter those out to get only functions that are defined in my module  see my question Get all defined functions in Python module

User · Answer

The Python documentation provides the perfect solution for this which uses the built-in function dir  You can just use dir module name  and then it will return a list of the functions within that module  For example  dir time  will return    STRUCT TM ITEMS      doc        loader        name        package        spec      altzone    asctime    ctime    daylight    get clock info    gmtime    localtime    mktime    monotonic    monotonic ns    perf counter    perf counter ns    process time    process time ns    sleep    strftime    strptime    struct time    time    time ns    timezone    tzname    tzset   which is the list of functions the  time  module contains

User · Answer

You can use the following method to get list all the functions in your module from shell   import module  module

User · Answer

For code that you do not wish to parse  I recommend the AST-based approach of  csl above   For everything else  the inspect module is correct   import inspect  import  lt module to inspect gt  as module  functions   inspect getmembers module  inspect isfunction    This gives a list of 2-tuples in the form    lt name str gt    lt value function gt           The simple answer above is hinted at in various responses and comments  but not called out explicitly

User · Answer

import types import yourmodule  print  getattr yourmodule  a  for a in dir yourmodule    if isinstance getattr yourmodule  a   types FunctionType

User · Answer

For global functions dir   is the command to use  as mentioned in most of these answers   however this lists both public functions and non-public functions together    For example running    gt  gt  gt  import re  gt  gt  gt  dir re    Returns functions classes like      all       MAXCACHE     alphanum bytes     alphanum str     pattern type     pickle     subx    Some of which are not generally meant for general programming use  but by the module itself  except in the case of DunderAliases like   doc      file   ect    For this reason it may not be useful to list them with the public ones  this is how Python knows what to get when using from module import        all   could be used to solve this problem  it returns a list of all the public functions and classes in a module  those that do not start with underscores -     See  Can someone explain   all   in Python  for  the use of   all     Here is an example    gt  gt  gt  import re  gt  gt  gt  re   all     match    fullmatch    search    sub    subn    split    findall    finditer    compile    purge    template    escape    error    A    I    L    M    S    X    U    ASCII    IGNORECASE    LOCALE    MULTILINE    DOTALL    VERBOSE    UNICODE    gt  gt  gt    All the functions and classes with underscores have been removed  leaving only those that are defined as public and can therefore be used via import     Note that   all   is not always defined  If it is not included then an AttributeError is raised    A case of this is with the ast module    gt  gt  gt  import ast  gt  gt  gt  ast   all   Traceback  most recent call last     File   lt stdin gt    line 1  in  lt module gt  AttributeError  module  ast  has no attribute    all     gt  gt  gt

User · Answer

r   globals   sep     n  100       n    To make it clean to read  for k in list r keys         try          if str type r k    count  function                print sep k        n    str r k    doc         except Exception as e          print e      Output                                                                                               GetNumberOfWordsInTextFile         Calcule et retourne le nombre de mots d un fichier texte      param path   le chemin du fichier    analyser      return  le nombre de mots du fichier                                                                                                  write in             Ecrit les donnees  2nd arg  dans un fichier txt  path en 1st arg  en mode a           param path   le path du fichier texte          param data   la liste des donn  es      crire ou un bloc texte directement          return  None                                                                                                   write in as w                 Ecrit les donnees  2nd arg  dans un fichier txt  path en 1st arg  en mode w               param path   le path du fichier texte              param data   la liste des donn  es      crire ou un bloc texte directement              return  None

User · Answer

Except dir module  or help module  mentioned in previous answers  you can also try   - Open ipython   - import module name   - type module name  press tab  It ll open a small window with listing all functions in the python module   It looks very neat    Here is snippet listing all functions of hashlib module   C  Program Files Anaconda2  C  Users lenovo gt ipython Python 2 7 12  Anaconda 4 2 0  64-bit    default  Jun 29 2016  11 07 13   MSC v 1500 64 bit  AMD64   Type  copyright    credits  or  license  for more information   IPython 5 1 0 -- An enhanced Interactive Python            - gt  Introduction and overview of IPython s features   quickref - gt  Quick reference  help      - gt  Python s own help system  object    - gt  Details about  object   use  object    for extra details   In  1   import hashlib  In  2   hashlib               hashlib algorithms            hashlib new                   hashlib sha256              hashlib algorithms available  hashlib pbkdf2 hmac           hashlib sha384              hashlib algorithms guaranteed hashlib sha1                  hashlib sha512              hashlib md5                   hashlib sha224

User · Answer

You can use dir module  to see all available methods attributes   Also check out PyDocs

[python] How to list all functions in a Python module?

Examples related to python

Examples related to reflection

Examples related to module

Examples related to inspect