How to get the caller s method name in the called method

Question

Python  How to get the caller s method name in the called method   Assume I have 2 methods   def method1 self               a   A method2    def method2 self             If I don t want to do any change for method1  how to get the name of the caller  in this example  the name is method1  in method2

User · Answer

Shorter version   import inspect  def f1    f2    def f2        print  caller name    inspect stack   1  3   f1      with thanks to  Alex  and Stefaan Lippen

User · Answer

I ve come up with a slightly longer version that tries to build a full method name including module and class    https   gist github com 2151727  rev 9cccbf     Public Domain  i e  feel free to copy paste   Considered a hack in Python 2  import inspect  def caller name skip 2          Get a name of a caller in the format module class method          skip  specifies how many levels of stack to skip while getting caller        name  skip 1 means  who calls me   skip 2  who calls my caller  etc          An empty string is returned if skipped levels exceed stack height             stack   inspect stack       start   0   skip     if len stack   lt  start   1        return        parentframe   stack start  0           name          module   inspect getmodule parentframe         modname  can be None when frame is executed directly in console       TODO techtonik   consider using   main       if module          name append module   name          detect classname     if  self  in parentframe f locals            I don t know any way to detect call from the object method           XXX  there seems to be no way to detect static method call - it will                be just a function call         name append parentframe f locals  self     class     name        codename   parentframe f code co name     if codename      lt module gt       top level usually         name append  codename     function or a method         Avoid circular refs and frame leaks        https   docs python org 2 7 library inspect html the-interpreter-stack     del parentframe  stack      return     join name

User · Answer

This seems to work just fine   import sys print sys  getframe   f back f code co name

User · Answer

inspect getframeinfo and other related functions in inspect can help    gt  gt  gt  import inspect  gt  gt  gt  def f1    f2         gt  gt  gt  def f2          curframe   inspect currentframe         calframe   inspect getouterframes curframe  2        print  caller name    calframe 1  3         gt  gt  gt  f1   caller name  f1   this introspection is intended to help debugging and development  it s not advisable to rely on it for production-functionality purposes

User · Answer

I would use inspect currentframe   f back f code co name  Its use hasn t been covered in any of the prior answers which are mainly of one of three types   Some prior answers use inspect stack but it s known to be too slow  Some prior answers use sys  getframe which is an internal private function given its leading underscore  and so its use is implicitly discouraged  One prior answer uses inspect getouterframes inspect currentframe    2  1  3  but it s entirely unclear what  1  3  is accessing   import inspect from types import FrameType from typing import cast   def caller name   - gt  str       quot  quot  quot Return the calling function s name  quot  quot  quot        Ref  https   stackoverflow com a 57712700      return cast FrameType  cast FrameType  inspect currentframe    f back  f code co name   if   name         main         def  test caller name   - gt  None          assert caller name        test caller name       test caller name    Note that cast FrameType  frame  is used to satisfy mypy   Acknowlegement  comment by 1313e for an answer

User · Answer

Bit of an amalgamation of the stuff above  But here s my crack at it   def print caller name stack size 3       def wrapper fn           def inner  args    kwargs               import inspect             stack   inspect stack                modules     index  inspect getmodule stack index  0                           for index in reversed range 1  stack size                module name lengths    len module   name                                       for    module in modules               s     index  gt 5     module   i     name      max module name lengths    4              callers                               s format index  level   module  module   name  name                            -    50               for index  module in modules                  callers append s format index index                                          module module   name                                            name stack index  3                 callers append s format index 0                                      module fn   module                                        name fn   name                 callers append                 print   n  join callers                fn  args    kwargs          return inner     return wrapper   Use    print caller name 4  def foo        return  foobar   def bar        return foo    def baz        return bar    def fizz        return baz    fizz     output is   level               module               name --------------------------------------------------     3                None                fizz     2                None                baz     1                None                bar     0                main                foo

User · Answer

I found a way if you re going across classes and want the class the method belongs to AND the method  It takes a bit of extraction work but it makes its point  This works in Python 2 7 13   import inspect  os  class ClassOne      def method1 self           classtwoObj method2    class ClassTwo      def method2 self           curframe   inspect currentframe           calframe   inspect getouterframes curframe  4          print   nI was called from   calframe 1  3              in   calframe 1  4  0  6  -2     create objects to access class methods classoneObj   ClassOne   classtwoObj   ClassTwo      start the program os system  cls   classoneObj method1

User · Answer

usr bin env python import inspect  called lambda  inspect stack   1  3   def caller1        print  inside    called    def caller2        print  inside    called    if   name       main         caller1       caller2   shahid shahid-VirtualBox   Documents  python test func py  inside   caller1 inside   caller2 shahid shahid-VirtualBox   Documents

[python] How to get the caller's method name in the called method?

Examples related to python

Examples related to introspection