web-dev-qa-db-fra.com

Comment obtenir un nom de fonction sous forme de chaîne en Python?

En Python, comment puis-je obtenir un nom de fonction sous forme de chaîne sans appeler la fonction?

def my_function():
    pass

print get_function_name_as_string(my_function) # my_function is not in quotes

devrait sortir "my_function".

Une telle fonction est-elle disponible en Python? Si non, des idées sur la façon de mettre en œuvre get_function_name_as_string, en Python?

pythonstringfunction
639
e70
my_function.__name__

Utiliser __name__ est la méthode préférée car elle s’applique de manière uniforme. Contrairement à func_name, il fonctionne également sur les fonctions intégrées:

>>> import time
>>> time.time.func_name
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
AttributeError: 'builtin_function_or_method' object has no attribute 'func_name'
>>> time.time.__
'time'

Les doubles soulignés indiquent également au lecteur qu'il s'agit d'un attribut spécial. En prime, les classes et les modules ont également un attribut __name__, de sorte que vous ne devez vous rappeler que d'un nom spécial.

808
user28409

Pour obtenir le nom de la fonction ou de la méthode en cours, considérez:

import inspect

this_function_name = inspect.currentframe().f_code.co_name

sys._getframe fonctionne également à la place de inspect.currentframe bien que ce dernier évite d'accéder à une fonction privée.

Pour obtenir le nom de la fonction appelante à la place, considérons f_back comme dans inspect.currentframe().f_back.f_code.co_name.

Si vous utilisez également mypy, il peut se plaindre de ce qui suit:

error: L'item "None" de "Optional [FrameType]" n'a pas d'attribut "f_code"

Pour supprimer l'erreur ci-dessus, considérez:

import inspect
import types
from typing import cast

this_function_name = cast(types.FrameType, inspect.currentframe()).f_code.co_name
253
Albert Vonpupp
my_function.func_name

Il existe également d'autres propriétés amusantes des fonctions. Tapez dir(func_name) pour les lister. func_name.func_code.co_code est la fonction compilée, stockée sous forme de chaîne.

import dis
dis.dis(my_function)

affichera le code au format presque lisible par l'homme. :)

40
Markus Jarderot

Cette fonction renverra le nom de la fonction de l'appelant.

def func_name():
    import traceback
    return traceback.extract_stack(None, 2)[0][2]

C'est comme la réponse d'Albert Vonpupp avec un wrapper amical.

30
Demyn

Si vous êtes également intéressé par les méthodes de classe, Python 3.3+ contient __qualname__ en plus de __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"
23
lapis

J'aime utiliser un décorateur de fonction. J'ai ajouté une classe, qui chronomètre également le temps de la fonction. Supposons que gLog soit un enregistreur standard python:

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

alors maintenant tout ce que vous avez à faire avec votre fonction est décorer et le tour est joué

@func_timer_decorator
def my_func():
15
radato

il n'est pas garanti que sys._getframe () soit disponible dans toutes les implémentations de Python ( voir ref ), vous pouvez utiliser le module de suivi pour faire la même chose, par exemple.

import traceback
def who_am_i():
   stack = traceback.extract_stack()
   filename, codeline, funcName, text = stack[-2]

   return funcName

Un appel à stack [-1] renverra les détails du processus en cours.

12
sandyc

En tant qu'extension de @ Demyn's answer , j'ai créé des fonctions utilitaires qui affichent le nom de la fonction actuelle et ses 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] -> %(message)s')
handler.setFormatter(formatter)
logger.addHandler(handler)
logger.setLevel(logging.INFO)

my_func(1, 3) # 2016-03-25 17:16:06,927 [INFO] -> Running my_func([('a', 1), ('b', 3), ('c', None)])
10
Jim G.
import inspect

def foo():
   print(inspect.stack()[0][3])
7
Ma Guowei

Vous voulez juste obtenir le nom de la fonction, voici un code simple pour cela. disons que vous avez défini ces fonctions

def function1():
    print "function1"

def function2():
    print "function2"

def function3():
    print "function3"
print function1.__name__

la sortie sera fonction1

Maintenant, disons que vous avez ces fonctions dans une liste

a = [function1 , function2 , funciton3]

pour obtenir le nom des fonctions

for i in a:
    print i.__name__

la sortie sera

fonction1
fonction2
fonction

6
Muhammad Mohsin