関数名を文字列として取得する方法は?


741

Pythonでは、関数を呼び出さずに関数名を文字列として取得するにはどうすればよいですか?

def my_function():
    pass

print get_function_name_as_string(my_function) # my_function is not in quotes

出力する必要があります"my_function"

そのような関数はPythonで利用できますか?そうでない場合get_function_name_as_string、Pythonでの実装方法に関するアイデアはありますか?


回答:


945
my_function.__name__

使用は__name__、それが均一に適用される好ましい方法です。とは異なりfunc_name、組み込み関数でも機能します。

>>> 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.__name__ 
'time'

また、二重下線は、これが特別な属性であることを読者に示します。おまけとして、クラスとモジュールにも__name__属性があるので、覚えている特別な名前は1つだけです。


420
場合によっては、関数の引数として関数オブジェクトを取得し、その関数の名前を表示/保存/操作する必要があるためです。おそらく、ドキュメント、ヘルプテキスト、アクションの履歴などを生成しているでしょう。そうではありません。関数名を常にハードコーディングしているわけではありません。
mbargiel 2013

2
@mgargiel:私が言ったことは、100のメソッドを定義するクラスがあるとします。すべてのメソッドはラッパーのみであり、プライベートメソッドを呼び出し、ラッパー自体の名前を渡します。このような何か:def wrapper(kwargs): super(ExtendedClass,self).call('wrapper', kwargs)。次の選択肢がありますdef wrapper(kwargs): super(ExtendedClass,self).call(sys._getframe().f_code.co_name, kwargs)。だから、アルバート・フォンパップからの答えは私にはよく見えます。
Richard Gomes 2013

19
@RichardGomes 1つの答えは関数自体の中で名前を取得するのに適切であり、もう1つは関数参照から名前を取得するのに適切です。書かれたOPの質問は後者を示しています。
Russell Borogove 2013

22
@RichardGomes実際、私はこの問題の解決策を探してこの質問に行きました。私が対処しようとしている問題は、すべての呼び出しをログに記録するために使用できるデコレーターを作成することです。
ali-hussain 2013

23
@RichardGomes関数はファーストクラスのオブジェクトであり、名前にバインドされているだけではありません。必ずしもそうではありませんf.__name__ == 'f'
2014年

298

内部から現在の関数またはメソッドの名前を取得するには、次のことを考慮してください。

import inspect

this_function_name = inspect.currentframe().f_code.co_name

sys._getframeinspect.currentframe後者はプライベート関数へのアクセスを回避しますが、代わりに機能します。

代わりに呼び出す関数の名前を取得するには、考えるf_backのようにinspect.currentframe().f_back.f_code.co_name


も使用している場合mypy、次のような不満が生じる可能性があります。

エラー:「Optional [FrameType]」のアイテム「None」に属性「f_code」がありません

上記のエラーを抑制するには、次のことを考慮してください。

import inspect
import types
from typing import cast

this_function_name = cast(types.FrameType, inspect.currentframe()).f_code.co_name

45
+1:これが私が知りたい答えです。他の回答は、呼び出し元が関数名をすでに知っていると仮定しています。これは、この質問のコンテキストではナンセンスです。
Richard Gomes 2013

110
リチャード:そうではありません。あなたは、関数でnameまたはfunc_nameを、それが定義されたのと同じスコープ内で直接呼び出すと想定していますが、これはほとんどの場合当てはまりません。関数はオブジェクトであることに留意してください-後で検索や実行などのためにそれらをリストに格納されている他の関数に引数として周りに渡すことができます/ dicts
mbargiel

11
@paulus_almighty、スタックフレームを掘り下げても、抽象的ではありません!実際、それは抽象の正反対のようなものです。ドキュメントの実装の詳細をご覧ください。Pythonのすべての実装が含まれるわけではありませんsys._getframe-CPythonの内部に直接接続されています。
sendle

6
これは関数の内部でのみ機能しますが、質問では関数を呼び出さないように指定しています。
user2357112は

5
関数をもっと使いやすく覚えやすいものにラップしたいsys._getframe(1).f_code.co_name場合は、のようなフレーム1を取得する必要があるため、のような関数を定義して、get_func_name()呼び出した関数の希望の名前を取得することができます。
m3nda 2017年

44
my_function.func_name

関数には他にも楽しいプロパティがあります。dir(func_name)リストに入力します。func_name.func_code.co_codeコンパイルされた関数で、文字列として保存されます。

import dis
dis.dis(my_function)

ほぼ人間が読める形式でコードを表示します。:)


4
f .__ name__とf.func_nameの違いは何ですか?
Federico A. Ramponi 08年

14
サム:名前はプライベートです、__名前は特別です。概念的な違いがあります。
マシュートレバー

11
誰かがマシューの前の答えに戸惑った場合、コメントシステムはいくつかの二重下線を太字のコードとして解釈しました。バックティックでエスケープされたメッセージは次のようになります。__names__プライベート、__names特別です。
gwideman 2014

12
実際、私は正しいと思います_names(private(前に1つのアンダースコア、単なる規則))、__names__特別な(前後に2つのアンダースコア)。以前に二重の下線が正式に、または慣習として意味があるかどうかは不明です。
MestreLion 2014

8
func_namepython3にはもう存在しないため、func.__name__互換性が必要な場合は使用する必要があります
Daenyth

34

この関数は、呼び出し元の関数名を返します。

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

それは、フレンドリーなラッパーを使用したAlbert Vonpuppの回答のようなものです。


1
インデックス[2]に「<モジュール>」がありましたが、次のように機能しました:traceback.extract_stack(None、2)[0] [-1]
emmagras

3
私にとってはこれは機能しませんが、これは機能します:traceback.extract_stack()[-1] [2]
mike01010 '22

これは、最初のインデックスを1に変更すると機能します。コメントする前にデバッグを学ぶ必要があります... traceback.extract_stack(None、2)[1] [2]
Jcc.Sanabria

29

クラスメソッドにも興味がある場合は、Python 3.3以降__qualname__に加えてがあり__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"

20

関数デコレータを使うのが好きです。クラスを追加しました。これは、関数の時間も計測します。gLogが標準の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

だから今あなたの関数でしなければならないすべてはそれを飾り、出来上がりです

@func_timer_decorator
def my_func():

15

sys._getframe()Pythonのすべての実装で利用できることは保証されていません(refを参照)。tracebackモジュールを使用して同じことを行うことができます。

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

   return funcName

を呼び出すとstack[-1]、現在のプロセスの詳細が返されます。


申し訳ありませんが、sys._getframe()が未定義の場合、traceback.extract_stackも動作しません。後者は前者の機能の大まかなスーパーセットを提供します。もう1つがなければ、一方が表示されるとは期待できません。そして実際、IronPython 2.7ではextract_stack()常にが返されます[]。-1
SingleNegationElimination 2013

15
import inspect

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

どこ

  • stack()[0]呼び出し元

  • stack()[3]メソッドの文字列名


1
簡潔でシンプル。stack()[0]常に呼び出し元、[3]メソッドの文字列名になります。
kontur

14

@Demynの回答の拡張として、現在の関数の名前と現在の関数の引数を出力するユーティリティ関数をいくつか作成しました。

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)])

8

ここで関数の名前を取得したいのは、そのための単純なコードです。これらの関数が定義されているとしましょう

def function1():
    print "function1"

def function2():
    print "function2"

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

出力はfunction1になります

これらの関数がリストにあるとしましょう

a = [function1 , function2 , funciton3]

関数の名前を取得する

for i in a:
    print i.__name__

出力は

function1
function2
function3


5

デコレータを利用したいくつかの回答を見てきましたが、いくつかは少し冗長であると感じました。これは、関数名とそれぞれの入力値および出力値のロギングに使用するものです。ここでは、ログファイルを作成するのではなく情報を出力するように調整し、OP固有の例に適用するように調整しました。

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()

出力:

{'function_name': 'my_function'}

1
他のすべてとは対照的に、これについて私が気に入っているのはdebug、関数名を出力したい、または関数名を出力したい関数にデコレータを追加するだけで機能を追加できたら、関数を追加することです。それは最も簡単で最も適応性があるようです。
spaTimeCoder
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.