How to get a function name as a string

Question

In Python  how do I get a function name as a string  without calling the function   def my function        pass  print get function name as string my function    my function is not in quotes   should output  my function    Is such function available in Python  If not  any ideas on how to implement get function name as string  in Python

User · Answer

To get the current function s or method s name from inside it  consider   import inspect  this function name   inspect currentframe   f code co name   sys  getframe also works instead of inspect currentframe although the latter avoids accessing a private function   To get the calling function s name instead  consider f back as in inspect currentframe   f back f code co name     If also using mypy  it can complain that      error  Item  None  of  Optional FrameType   has no attribute  f code    To suppress the above error  consider   import inspect import types from typing import cast  this function name   cast types FrameType  inspect currentframe    f code co name

User · Answer

import inspect  def foo       print inspect stack   0  3    where  stack   0  is the caller  stack   3  is the string name of the method

User · Answer

I ve seen a few answers that utilized decorators  though I felt a few were a bit verbose  Here s something I use for logging function names as well as their respective input and output values  I ve adapted it here to just print the info rather than creating a log file and adapted it to apply to the OP specific example   def debug func None       def wrapper  args    kwargs           try              function name   func   func     qualname           except              function name   func   qualname           return func  args    kwargs  function name function name      return wrapper   debug def my function   kwargs       print kwargs   my function     Output     function name    my function

User · Answer

As an extension of  Demyn s answer  I created some utility functions which print the current function s name and current function s arguments   import inspect import logging import traceback  def get function name        return traceback extract stack None  2  0  2   def get function parameters and values        frame   inspect currentframe   f back     args        values   inspect getargvalues frame      return    i  values i   for i in args    def my func a  b  c None       logging info  Running     get function name           str get function parameters and values              pass  logger   logging getLogger   handler   logging StreamHandler   formatter   logging Formatter         asctime s    levelname s  - gt    message s   handler setFormatter formatter  logger addHandler handler  logger setLevel logging INFO   my func 1  3    2016-03-25 17 16 06 927  INFO  - gt  Running my func    a   1     b   3     c   None

User · Answer

my function   name     Using   name   is the preferred method as it applies uniformly  Unlike func name  it works on built-in functions as well    gt  gt  gt  import time  gt  gt  gt  time time func name Traceback  most recent call last     File   lt stdin gt    line 1  in   AttributeError   builtin function or method  object has no attribute  func name   gt  gt  gt  time time   name     time    Also the double underscores indicate to the reader this is a special attribute  As a bonus  classes and modules have a   name   attribute too  so you only have remember one special name

User · Answer

my function func name   There are also other fun properties of functions  Type dir func name  to list them  func name func code co code is the compiled function  stored as a string   import dis dis dis my function    will display the code in almost human readable format

User · Answer

my function   name     Using   name   is the preferred method as it applies uniformly  Unlike func name  it works on built-in functions as well    gt  gt  gt  import time  gt  gt  gt  time time func name Traceback  most recent call last     File   lt stdin gt    line 1  in   AttributeError   builtin function or method  object has no attribute  func name   gt  gt  gt  time time   name     time    Also the double underscores indicate to the reader this is a special attribute  As a bonus  classes and modules have a   name   attribute too  so you only have remember one special name

User · Answer

Try import sys fn name   sys  getframe   f code co name  further reference https   www oreilly com library view python-cookbook 0596001673 ch14s08 html

User · Answer

To get the current function s or method s name from inside it  consider   import inspect  this function name   inspect currentframe   f code co name   sys  getframe also works instead of inspect currentframe although the latter avoids accessing a private function   To get the calling function s name instead  consider f back as in inspect currentframe   f back f code co name     If also using mypy  it can complain that      error  Item  None  of  Optional FrameType   has no attribute  f code    To suppress the above error  consider   import inspect import types from typing import cast  this function name   cast types FrameType  inspect currentframe    f code co name

User · Answer

my function   name     Using   name   is the preferred method as it applies uniformly  Unlike func name  it works on built-in functions as well    gt  gt  gt  import time  gt  gt  gt  time time func name Traceback  most recent call last     File   lt stdin gt    line 1  in   AttributeError   builtin function or method  object has no attribute  func name   gt  gt  gt  time time   name     time    Also the double underscores indicate to the reader this is a special attribute  As a bonus  classes and modules have a   name   attribute too  so you only have remember one special name

User · Answer

sys  getframe   is not guaranteed to be available in all implementations of Python  see ref   you can use the traceback module to do the same thing  eg   import traceback def who am i       stack   traceback extract stack      filename  codeline  funcName  text   stack -2      return funcName   A call to stack -1  will return the current process details

User · Answer

This function will return the caller s function name   def func name        import traceback     return traceback extract stack None  2  0  2    It is like Albert Vonpupp s answer with a friendly wrapper

User · Answer

import inspect  def my first function        func name   inspect stack   0  3      print func name     my first function  or  import sys  def my second function        func name   sys  getframe   f code co name     print func name     my second function

User · Answer

If you re interested in class methods too  Python 3 3  has   qualname   in addition to   name     def my function        pass  class MyClass object       def method self           pass  print my function   name              gives  my function  print MyClass method   name           gives  method   print my function   qualname          gives  my function  print MyClass method   qualname       gives  MyClass method

User · Answer

You just want to get the name of the function here is a simple code for that  let say you have these functions defined  def function1        print  function1   def function2        print  function2   def function3        print  function3  print function1   name     the output will be function1  Now let say you have these functions in a list  a    function1   function2   funciton3    to get the name of the functions  for i in a      print i   name     the output will be  function1 function2 function3

User · Answer

This function will return the caller s function name   def func name        import traceback     return traceback extract stack None  2  0  2    It is like Albert Vonpupp s answer with a friendly wrapper

User · Answer

my function func name   There are also other fun properties of functions  Type dir func name  to list them  func name func code co code is the compiled function  stored as a string   import dis dis dis my function    will display the code in almost human readable format

User · Answer

As an extension of  Demyn s answer  I created some utility functions which print the current function s name and current function s arguments   import inspect import logging import traceback  def get function name        return traceback extract stack None  2  0  2   def get function parameters and values        frame   inspect currentframe   f back     args        values   inspect getargvalues frame      return    i  values i   for i in args    def my func a  b  c None       logging info  Running     get function name           str get function parameters and values              pass  logger   logging getLogger   handler   logging StreamHandler   formatter   logging Formatter         asctime s    levelname s  - gt    message s   handler setFormatter formatter  logger addHandler handler  logger setLevel logging INFO   my func 1  3    2016-03-25 17 16 06 927  INFO  - gt  Running my func    a   1     b   3     c   None

User · Answer

I  like using a function decorator  I added a class  which also times the function time  Assume gLog is a standard python logger   class EnterExitLog        def   init   self  funcName           self funcName   funcName      def   enter   self           gLog debug  Started   s    self funcName          self init time   datetime datetime now           return self      def   exit   self  type  value  tb           gLog debug  Finished   s in   s seconds     self funcName  datetime datetime now   - self init time    def func timer decorator func       def func wrapper  args    kwargs           with EnterExitLog func   name                 return func  args    kwargs       return func wrapper   so now all you have to do with your function is decorate it and voila   func timer decorator def my func

User · Answer

If you re interested in class methods too  Python 3 3  has   qualname   in addition to   name     def my function        pass  class MyClass object       def method self           pass  print my function   name              gives  my function  print MyClass method   name           gives  method   print my function   qualname          gives  my function  print MyClass method   qualname       gives  MyClass method

User · Answer

my function func name   There are also other fun properties of functions  Type dir func name  to list them  func name func code co code is the compiled function  stored as a string   import dis dis dis my function    will display the code in almost human readable format

User · Answer

Try import sys fn name   sys  getframe   f code co name  further reference https   www oreilly com library view python-cookbook 0596001673 ch14s08 html

User · Answer

I  like using a function decorator  I added a class  which also times the function time  Assume gLog is a standard python logger   class EnterExitLog        def   init   self  funcName           self funcName   funcName      def   enter   self           gLog debug  Started   s    self funcName          self init time   datetime datetime now           return self      def   exit   self  type  value  tb           gLog debug  Finished   s in   s seconds     self funcName  datetime datetime now   - self init time    def func timer decorator func       def func wrapper  args    kwargs           with EnterExitLog func   name                 return func  args    kwargs       return func wrapper   so now all you have to do with your function is decorate it and voila   func timer decorator def my func

User · Answer

import inspect  def foo       print inspect stack   0  3    where  stack   0  is the caller  stack   3  is the string name of the method

User · Answer

import inspect  def my first function        func name   inspect stack   0  3      print func name     my first function  or  import sys  def my second function        func name   sys  getframe   f code co name     print func name     my second function

User · Answer

my function func name   There are also other fun properties of functions  Type dir func name  to list them  func name func code co code is the compiled function  stored as a string   import dis dis dis my function    will display the code in almost human readable format

User · Answer

I ve seen a few answers that utilized decorators  though I felt a few were a bit verbose  Here s something I use for logging function names as well as their respective input and output values  I ve adapted it here to just print the info rather than creating a log file and adapted it to apply to the OP specific example   def debug func None       def wrapper  args    kwargs           try              function name   func   func     qualname           except              function name   func   qualname           return func  args    kwargs  function name function name      return wrapper   debug def my function   kwargs       print kwargs   my function     Output     function name    my function

User · Answer

my function   name     Using   name   is the preferred method as it applies uniformly  Unlike func name  it works on built-in functions as well    gt  gt  gt  import time  gt  gt  gt  time time func name Traceback  most recent call last     File   lt stdin gt    line 1  in   AttributeError   builtin function or method  object has no attribute  func name   gt  gt  gt  time time   name     time    Also the double underscores indicate to the reader this is a special attribute  As a bonus  classes and modules have a   name   attribute too  so you only have remember one special name

User · Answer

You just want to get the name of the function here is a simple code for that  let say you have these functions defined  def function1        print  function1   def function2        print  function2   def function3        print  function3  print function1   name     the output will be function1  Now let say you have these functions in a list  a    function1   function2   funciton3    to get the name of the functions  for i in a      print i   name     the output will be  function1 function2 function3

User · Answer

sys  getframe   is not guaranteed to be available in all implementations of Python  see ref   you can use the traceback module to do the same thing  eg   import traceback def who am i       stack   traceback extract stack      filename  codeline  funcName  text   stack -2      return funcName   A call to stack -1  will return the current process details

[python] How to get a function name as a string?

Examples related to python

Examples related to string

Examples related to function