Mendapatkan nama variabel sebagai string

Utas ini membahas cara mendapatkan nama fungsi sebagai string dengan Python: Bagaimana cara mendapatkan nama fungsi sebagai string?

Bagaimana saya bisa melakukan hal yang sama untuk suatu variabel? Berbeda dengan fungsi, variabel Python tidak memiliki __name__atribut.

Dengan kata lain, jika saya memiliki variabel seperti:

foo = dict()
foo['bar'] = 2

Saya mencari fungsi / atribut, misalnya retrieve_name()untuk membuat DataFrame di Panda dari daftar ini , di mana nama kolom diberikan oleh nama-nama kamus aktual:

# List of dictionaries for my DataFrame
list_of_dicts = [n_jobs, users, queues, priorities]
columns = [retrieve_name(d) for d in list_of_dicts] 

Menggunakan python-varnamepaket, Anda dapat dengan mudah mengambil nama variabel

https://github.com/pwwang/python-varname

Dalam kasus Anda, Anda dapat melakukan:

from varname import Wrapper

foo = Wrapper(dict())

# foo.name == 'foo'
# foo.value == {}
foo.value['bar'] = 2

Atau Anda juga dapat mencoba mengambil nama variabel secara langsung:

from varname import nameof

foo = dict()

fooname = nameof(foo)
# fooname == 'foo'

Saya penulis paket ini. Harap beri tahu saya jika Anda memiliki pertanyaan atau Anda dapat mengirimkan masalah di github.

Satu-satunya objek dalam Python yang memiliki nama kanonik adalah modul, fungsi, dan kelas, dan tentu saja tidak ada jaminan bahwa nama kanonik ini memiliki arti dalam ruang nama apa pun setelah fungsi atau kelas didefinisikan atau modul diimpor. Nama-nama ini juga dapat dimodifikasi setelah objek dibuat sehingga mereka tidak selalu dapat dipercaya.

Apa yang ingin Anda lakukan tidak mungkin tanpa secara rekursif berjalan di pohon objek bernama ; nama adalah referensi satu arah ke suatu objek. Objek Python umum atau variasi taman tidak berisi referensi untuk namanya. Bayangkan jika setiap bilangan bulat, setiap dict, setiap daftar, setiap Boolean perlu mempertahankan daftar string yang mewakili nama yang merujuknya! Ini akan menjadi mimpi buruk implementasi, dengan sedikit manfaat bagi programmer.

Bahkan jika nilai variabel tidak menunjuk kembali ke nama, Anda memiliki akses ke daftar setiap variabel yang ditugaskan dan nilainya, jadi saya kagum bahwa hanya satu orang yang menyarankan perulangan di sana untuk mencari nama var Anda.

Seseorang yang disebutkan pada jawaban itu bahwa Anda mungkin harus berjalan tumpukan dan memeriksa semua orang lokal dan global untuk menemukan foo, tetapi jika fooditugaskan dalam lingkup di mana Anda memanggil retrieve_namefungsi ini , Anda dapat menggunakan inspectitu current frameuntuk membuat Anda semua variabel-variabel lokal .

Penjelasan saya mungkin agak terlalu bertele-tele (mungkin saya seharusnya menggunakan kata "foo" lebih sedikit), tapi di sini caranya akan terlihat dalam kode ( Perhatikan bahwa jika ada lebih dari satu variabel yang ditugaskan ke nilai yang sama, Anda akan dapatkan kedua nama variabel tersebut ):

import inspect

x,y,z = 1,2,3

def retrieve_name(var):
    callers_local_vars = inspect.currentframe().f_back.f_locals.items()
    return [var_name for var_name, var_val in callers_local_vars if var_val is var]

print retrieve_name(y)

Jika Anda memanggil fungsi ini dari fungsi lain, sesuatu seperti:

def foo(bar):
    return retrieve_name(bar)

foo(baz)

Dan Anda menginginkan, bazalih - alih bar, Anda hanya perlu kembali lingkup lebih jauh. Ini dapat dilakukan dengan menambahkan ekstra .f_backdalam caller_local_varsinisialisasi.

Lihat contoh di sini: ideone

Dengan Python 3.8 orang cukup menggunakan fitur debugging f-string:

>>> foo = dict()
>>> f'{foo=}'.split('=')[0]
'foo' 

Pada python3, fungsi ini akan mendapatkan nama paling luar di stack:

import inspect


def retrieve_name(var):
        """
        Gets the name of var. Does it from the out most frame inner-wards.
        :param var: variable to get name from.
        :return: string
        """
        for fi in reversed(inspect.stack()):
            names = [var_name for var_name, var_val in fi.frame.f_locals.items() if var_val is var]
            if len(names) > 0:
                return names[0]

Ini berguna di mana saja pada kode. Melintasi tumpukan yang terbalik mencari pertandingan pertama.

Saya tidak percaya ini mungkin. Perhatikan contoh berikut:

>>> a = []
>>> b = a
>>> id(a)
140031712435664
>>> id(b)
140031712435664

Titik adan bke objek yang sama, tetapi objek tidak dapat mengetahui variabel apa yang mengarah ke sana.

def name(**variables):
    return [x for x in variables]

Ini digunakan seperti ini:

name(variable=variable)

Inilah satu pendekatan. Saya tidak akan merekomendasikan ini untuk hal yang penting, karena itu akan sangat rapuh. Tapi itu bisa dilakukan.

Buat fungsi yang menggunakan inspectmodul untuk menemukan kode sumber yang memanggilnya. Kemudian Anda dapat mengurai kode sumber untuk mengidentifikasi nama variabel yang ingin Anda ambil. Misalnya, inilah fungsi yang dipanggil autodictyang mengambil daftar variabel dan mengembalikan kamus nama variabel pemetaan ke nilai-nilai mereka. Misalnya:

x = 'foo'
y = 'bar'
d = autodict(x, y)
print d

Akan memberi:

{'x': 'foo', 'y': 'bar'}

Memeriksa kode sumber itu sendiri lebih baik daripada mencari melalui locals()atau globals()karena pendekatan yang terakhir tidak memberi tahu Anda mana dari variabel yang Anda inginkan.

Bagaimanapun, inilah kodenya:

def autodict(*args):
    get_rid_of = ['autodict(', ',', ')', '\n']
    calling_code = inspect.getouterframes(inspect.currentframe())[1][4][0]
    calling_code = calling_code[calling_code.index('autodict'):]
    for garbage in get_rid_of:
        calling_code = calling_code.replace(garbage, '')
    var_names, var_values = calling_code.split(), args
    dyn_dict = {var_name: var_value for var_name, var_value in
                zip(var_names, var_values)}
    return dyn_dict

Tindakan terjadi di baris dengan inspect.getouterframes, yang mengembalikan string dalam kode yang dipanggil autodict.

Kelemahan yang jelas untuk jenis sihir ini adalah bahwa ia membuat asumsi tentang bagaimana kode sumber terstruktur. Dan tentu saja, itu tidak akan berfungsi sama sekali jika dijalankan di dalam interpreter.

Saya menulis paket sihir untuk melakukan sihir semacam ini dengan kuat. Kamu bisa menulis:

from sorcery import dict_of

columns = dict_of(n_jobs, users, queues, priorities)

dan meneruskannya ke konstruktor dataframe. Ini setara dengan:

columns = dict(n_jobs=n_jobs, users=users, queues=queues, priorities=priorities)

>>> locals()['foo']
{}
>>> globals()['foo']
{}

Jika Anda ingin menulis fungsi Anda sendiri, bisa dilakukan sedemikian rupa sehingga Anda bisa memeriksa variabel yang ditentukan dalam lokal kemudian memeriksa global. Jika tidak ada yang ditemukan, Anda dapat membandingkan pada id () untuk melihat apakah variabel menunjuk ke lokasi yang sama dalam memori.

Jika variabel Anda ada di kelas, Anda bisa menggunakan className. dict .keys () atau vars (self) untuk melihat apakah variabel Anda telah didefinisikan.

Dalam Python, defdan classkata kunci akan mengikat nama tertentu ke objek yang mereka tetapkan (fungsi atau kelas). Demikian pula, modul diberi nama berdasarkan disebut sesuatu yang spesifik dalam sistem file. Dalam ketiga kasus, ada cara yang jelas untuk menetapkan nama "kanonik" ke objek yang dimaksud.

Namun, untuk jenis objek lainnya, nama kanonik semacam itu mungkin tidak ada . Misalnya, perhatikan elemen daftar. Elemen-elemen dalam daftar tidak disebutkan secara individual, dan sangat mungkin bahwa satu-satunya cara untuk merujuk mereka dalam suatu program adalah dengan menggunakan indeks daftar pada daftar yang berisi. Jika daftar objek seperti itu diteruskan ke fungsi Anda, Anda tidak mungkin dapat menetapkan pengidentifikasi yang berarti untuk nilai.

Python tidak menyimpan nama di sisi kiri penugasan ke objek yang ditugaskan karena:

1. Ini akan membutuhkan mencari tahu nama mana yang "kanonik" di antara banyak objek yang saling bertentangan,
2. Tidak masuk akal untuk objek yang tidak pernah ditugaskan ke nama variabel eksplisit,
3. Itu akan sangat tidak efisien,
4. Secara harfiah tidak ada bahasa lain yang melakukan itu.

Jadi, misalnya, fungsi yang didefinisikan menggunakan lambdaakan selalu memiliki "nama" <lambda>, bukan nama fungsi tertentu.

Pendekatan terbaik adalah dengan meminta pemanggil untuk memberikan daftar nama (opsional). Jika mengetik '...','...'terlalu rumit, Anda bisa menerima mis. String tunggal yang berisi daftar nama yang dipisahkan koma (seperti namedtuplehalnya).

>> my_var = 5
>> my_var_name = [ k for k,v in locals().items() if v == my_var][0]
>> my_var_name 
'my_var'

lokal () - Mengembalikan kamus yang berisi variabel lokal lingkup saat ini. dengan mengulangi kamus ini kita dapat memeriksa kunci yang memiliki nilai sama dengan variabel yang didefinisikan, hanya mengekstrak kunci akan memberi kita teks variabel dalam format string.

dari (setelah sedikit perubahan) https://www.tutorialspoint.com/How-to-get-a-variable-name-as-a-string-in-Python

Saya pikir sangat sulit untuk melakukan ini dengan Python karena fakta sederhana bahwa Anda tidak akan pernah tahu nama variabel yang Anda gunakan. Jadi, dalam contohnya, Anda dapat melakukan:

Dari pada:

list_of_dicts = [n_jobs, users, queues, priorities]

dict_of_dicts = {"n_jobs" : n_jobs, "users" : users, "queues" : queues, "priorities" : priorities}

hanyalah cara lain untuk melakukan ini berdasarkan konten dari variabel input:

(mengembalikan nama variabel pertama yang cocok dengan variabel input, jika tidak Tidak ada. Seseorang dapat memodifikasinya untuk mendapatkan semua nama variabel yang memiliki konten yang sama dengan variabel input)

def retrieve_name(x, Vars=vars()):
    for k in Vars:
        if type(x) == type(Vars[k]):
            if x is Vars[k]:
                return k
    return None

Fungsi ini akan mencetak nama variabel dengan nilainya:

import inspect

def print_this(var):
    callers_local_vars = inspect.currentframe().f_back.f_locals.items()
    print(str([k for k, v in callers_local_vars if v is var][0])+': '+str(var))

***Input & Function call:***
my_var = 10

print_this(my_var)

***Output**:*
my_var: 10

Saya punya metode, dan meskipun bukan yang paling efisien ... itu berhasil! (dan itu tidak melibatkan modul mewah).

Pada dasarnya ini membandingkan ID Variabel Anda dengan global () ID Variabel , lalu mengembalikan nama pertandingan.

def getVariableName(variable, globalVariables=globals().copy()):
    """ Get Variable Name as String by comparing its ID to globals() Variables' IDs

        args:
            variable(var): Variable to find name for (Obviously this variable has to exist)

        kwargs:
            globalVariables(dict): Copy of the globals() dict (Adding to Kwargs allows this function to work properly when imported from another .py)
    """
    for globalVariable in globalVariables:
        if id(variable) == id(globalVariables[globalVariable]): # If our Variable's ID matches this Global Variable's ID...
            return globalVariable # Return its name from the Globals() dict

Jika tujuannya adalah untuk membantu Anda melacak variabel Anda, Anda dapat menulis fungsi sederhana yang memberi label pada variabel dan mengembalikan nilai dan jenisnya. Sebagai contoh, misalkan i_f = 3.01 dan Anda membulatkannya ke integer yang disebut i_n untuk digunakan dalam kode, dan kemudian membutuhkan string i_s yang akan masuk ke laporan.

def whatis(string, x):
    print(string+' value=',repr(x),type(x))
    return string+' value='+repr(x)+repr(type(x))
i_f=3.01
i_n=int(i_f)
i_s=str(i_n)
i_l=[i_f, i_n, i_s]
i_u=(i_f, i_n, i_s)

## make report that identifies all types
report='\n'+20*'#'+'\nThis is the report:\n'
report+= whatis('i_f ',i_f)+'\n'
report+=whatis('i_n ',i_n)+'\n'
report+=whatis('i_s ',i_s)+'\n'
report+=whatis('i_l ',i_l)+'\n'
report+=whatis('i_u ',i_u)+'\n'
print(report)

Ini mencetak ke jendela di setiap panggilan untuk keperluan debugging dan juga menghasilkan string untuk laporan tertulis. Satu-satunya downside adalah bahwa Anda harus mengetik variabel dua kali setiap kali Anda memanggil fungsi.

Saya seorang pemula Python dan menemukan cara ini sangat berguna untuk mencatat upaya saya ketika saya memprogram dan mencoba untuk mengatasi semua objek dalam Python. Salah satu cacatnya adalah whatis () gagal jika ia memanggil fungsi yang dijelaskan di luar prosedur di mana ia digunakan. Misalnya, int (i_f) adalah panggilan fungsi yang valid hanya karena fungsi int diketahui oleh Python. Anda dapat memanggil whatis () menggunakan int (i_f ** 2), tetapi jika karena alasan yang aneh Anda memilih untuk mendefinisikan fungsi yang disebut int_squared, ia harus dideklarasikan di dalam prosedur di mana whatis () digunakan.

Mungkin ini bisa bermanfaat:

def Retriever(bar):
    return (list(globals().keys()))[list(map(lambda x: id(x), list(globals().values()))).index(id(bar))]

Fungsi melewati daftar ID nilai dari lingkup global (namespace dapat diedit), menemukan indeks var / fungsi yang diinginkan / diperlukan berdasarkan ID-nya, dan kemudian mengembalikan nama dari daftar nama global berdasarkan pada indeks yang diakuisisi.

Metode berikut tidak akan mengembalikan nama variabel tetapi menggunakan metode ini Anda dapat membuat bingkai data dengan mudah jika variabel tersedia dalam cakupan global.

class CustomDict(dict):
    def __add__(self, other):
        return CustomDict({**self, **other})

class GlobalBase(type):
    def __getattr__(cls, key):
        return CustomDict({key: globals()[key]})

    def __getitem__(cls, keys):
        return CustomDict({key: globals()[key] for key in keys})

class G(metaclass=GlobalBase):
    pass

x, y, z = 0, 1, 2

print('method 1:', G['x', 'y', 'z']) # Outcome: method 1: {'x': 0, 'y': 1, 'z': 2}
print('method 2:', G.x + G.y + G.z) # Outcome: method 2: {'x': 0, 'y': 1, 'z': 2}

A = [0, 1]
B = [1, 2]
pd.DataFrame(G.A + G.B) # It will return a data frame with A and B columns

Untuk konstanta, Anda dapat menggunakan enum, yang mendukung pengambilan namanya.

Saya mencoba untuk mendapatkan nama dari memeriksa penduduk setempat, tetapi tidak dapat memproses var seperti [1], b.val. Setelah itu, saya mendapat ide baru --- dapatkan nama var dari kode, dan saya coba succ! kode seperti di bawah ini:

#direct get from called function code
def retrieve_name_ex(var):
    stacks = inspect.stack()
    try:
        func = stacks[0].function
        code = stacks[1].code_context[0]
        s = code.index(func)
        s = code.index("(", s + len(func)) + 1
        e = code.index(")", s)
        return code[s:e].strip()
    except:
        return ""

Anda dapat mencoba yang berikut ini untuk mengambil nama fungsi yang Anda tetapkan (meskipun tidak berfungsi untuk fungsi bawaan):

import re
def retrieve_name(func):
    return re.match("<function\s+(\w+)\s+at.*", str(func)).group(1)

def foo(x):
    return x**2

print(retrieve_name(foo))
# foo