Pythonでインスタンス生成時に代入先の変数名を取得する方法

Question

インスタンス生成時に代入先の変数名の取得方法

私はPythonの使われている、オープンソースのプログラミング言語の勉強をしています。

Pythonにおいて、生成されるインスタンスの代入先の変数名を文字列で取得したいです。
もし、これを実現する方法や代案が存在すれば教えてほしいです。

コードの例

具体的に実現したいコードを示します

# 現在のコードはこのようになっています
class ManualVariableNamed:
    def __init__(self, name):
        self.variable_name = name # ここに変数名の文字列を格納したいです

def main():
    x = ManualVariableNamed(name='x') # このように文字列を与えることが冗長だと感じます
    print(x.variable_name) # => 'x'


# 次に、実現したいコードの例を示します
# インスタンス生成時の変数名を自動で取得できるクラスを考えます
class GetSelfVariableNameClass:
    def __init__(self):
        self.variable_name = get_variable_name(self) # 例えばこのような具合です

def main():
    y = GetSelfVariableNameClass()
    print(y.variable_name) # => 'y'

試したこと

現在のスコープの変数名一覧はglobals()やlocals()で取得できます。
これを用いてid(self)と一致する変数を探すことを考えました。
しかし、①代入評価前の変数を、②違うスコープから見つける方法がありません。
イニシャライザの引数で現在のスコープを明示的に与えることはしたくありません。

こちらの記事では Qiita:変数の変数名を文字列で取得する 方法が紹介されています。
しかし、私の実現したい事は、これでは解決できませんでした。

仕様レベルでの話でもいいので、何か少しでもヒントがあれば教えてください。
この実現が不可能であれば、その根拠を教えてもらえると助かります。よろしくおねがいします。

Comments

[maisumakun]

「Pythonの使われている、オープンソースのプログラミング言語の勉強をしています。」とありますが、プログラミング言語はPythonそのものではないのですか？

[tas0g]

説明不足でした。TVMというプロジェクトに含まれる、プログラミング言語(Relay IR)とそのコンパイラについて勉強しています。このコンパイラは一部にPythonが含まれています。

Answer 1

• 直感的には無理では？　と思います。言語仕様上、まったく想定されていない動作なのです。
• 無理やりできる方法があったとして（呼び出し元の構文情報を渡すとか）、やるべきではないと感じます。
• 次善の策としてlocals()（ドキュメント）を渡して書き換えるという発想が出てくるかもしれませんが、これは書き換え不可能ですからできません。
• 名前空間の代わりに使う辞書を自分で作れば、↑相当の処理は可能でしょう。こんな感じです。できるけど何か利点はあるかなぁ・・・静的解析ツールなどの支援もこれだと受けられないでしょう。

class GetSelfVariableNameClass:
    # variable_name = None # クラス変数にしているのはたぶん意図と違うから消しておきますよ
    def __init__(self, name, names):
        self.variable_name = name
        names[name] = self

def main():
    names = dict()
    GetSelfVariableNameClass("y", names)
    # 以後ローカル変数yを書く代わりにnames["y"]と書くことにする

    print(names["y"].variable_name) # => 'y'

Comments

[tas0g]

(クラス変数に対するコードのミスは修正しました)

やはり、言語使用上は想定されていない使い方ですよね。
変数をディクショナリに格納する方法は、直接の解決でないですが、ヒントになりそうです。
ありがとうございます。

Answer 2

Pythonにおいて、生成されるインスタンスの代入先の変数名を文字列で取得したいです。

そもそも論として、このような動作が必要な理由がわかりません。

仮にできたとしても、「ローカル変数の名前を変えるだけで動作が変わってしまうオブジェクト」は、筋が悪すぎます（呼び出した環境と密結合になってしまいます）。そして、ローカル変数はまさにローカルなもので外部とのI/Fに使われることもありませんので、呼ばれたコードから知ったところで使い道もないはずです。

Comments

[tas0g]

回答ありがとうございます。
説明に語弊がありました。補足させてもらいます。

最初にローカル変数にインスタンスを代入したときの変数名を、変数名が変わっても保持し続けることを想定しています。例えば以下のような動作を想定しています。

```Python
y = GetSelfVariableNameClass()
print(y.variable_name) # => 'y'
z = y
print(z.variable_name) # => 'y'
```

また、おっしゃる通り、本質的にローカル変数名を保持している意味はありません。しかし、デバッグの都合から、オブジェクトに識別名を付与したいケースあります。

例えば、Tensorflowというディープラーニングのフレームワークには tf.constant という、定数オブジェクトを生成するメソッドがあります。
https://www.tensorflow.org/api_docs/python/tf/constant
デフォルトで`name='Const'`とされていますが、慣例的にローカル変数名をつけることがあります。
これは、動作には全く作用がありませんが、デバッグを容易にします。

私はこのような状況を想定して、質問していました。

Answer 3

インスタンス化した時点ではローカル変数はまだありません。
例えば
i = j = obj()
とした場合は、なにを格納しますか？
return obj()
とか。

というわけで無理です。

Answer 4

vars() で変数辞書一覧が取れるけど、そういう話ではない？
vars関数の引数には変数辞書を取りたいオブジェクトを指定できます。
引数を指定しないと locals() でローカル変数辞書が見えます。
他に、globals() でグローバル変数辞書が見えます。・

class SampleClass:
    def __init__(self):
        self.x = 123

def main():
    y = SampleClass()
    print(vars(y))
    print(vars())

if __name__ == '__main__':
    main()

実行結果:

{'x': 123}
{'y': <__main__.SampleClass object at 0x6ffffd106a0>}

Comments

[shiracamus]

インスタンス生成中に、その後に代入されるであろう変数名を取得したいということですか・・・
未来予想は無理ですねぇ・・・
変数に代入せずに使い捨てることもあるだろうし・・・
生成した関数から復帰すると変数名/変数辞書もなくなってしまうし・・・
関数オブジェクトを渡して、逆アセンブルして STORE命令を捜しますか・・・