Jelaskan titik masuk Python?

Saya sudah membaca dokumentasi tentang titik masuk telur di Pylons dan di halaman Peak, dan saya masih tidak begitu mengerti. Bisakah seseorang menjelaskannya kepada saya?

"Titik masuk" biasanya merupakan fungsi (atau objek seperti fungsi lainnya yang dapat dipanggil) yang mungkin ingin digunakan oleh pengembang atau pengguna paket Python, meskipun objek yang tidak dapat dipanggil dapat diberikan sebagai titik masuk juga (juga dengan benar ditunjukkan dalam komentar!).

Jenis entri yang paling populer adalah titik entri console_scripts , yang menunjuk ke fungsi yang Anda inginkan tersedia sebagai alat baris perintah untuk siapa pun yang menginstal paket Anda. Ini masuk ke setup.py Anda seperti:

entry_points={
    'console_scripts': [
        'cursive = cursive.tools.cmd:cursive_command',
    ],
},

Saya memiliki paket yang baru saja saya gunakan yang disebut "cursive.tools", dan saya ingin membuatnya menyediakan perintah "cursive" yang dapat dijalankan seseorang dari baris perintah, seperti:

$ cursive --help
usage: cursive ...

Cara untuk melakukan ini adalah mendefinisikan suatu fungsi, seperti mungkin fungsi "cursive_command" di cursive / tools / cmd.py yang terlihat seperti:

def cursive_command():
    args = sys.argv[1:]
    if len(args) < 1:
        print "usage: ..."

Dan seterusnya; itu harus mengasumsikan bahwa itu dipanggil dari baris perintah, parsing argumen yang telah diberikan pengguna, dan ... yah, lakukan apa pun perintah yang dirancang untuk dilakukan.

Instal paket docutils untuk contoh penggunaan titik masuk yang bagus: ia akan menginstal sesuatu seperti setengah lusin perintah yang berguna untuk mengubah dokumentasi Python ke format lain.

EntryPoints menyediakan registrasi nama objek berbasis sistem file yang persisten dan mekanisme impor objek langsung berbasis nama (diimplementasikan oleh paket setuptools ).

Mereka mengaitkan nama objek Python dengan pengenal bentuk bebas. Jadi kode lain yang menggunakan instalasi Python yang sama dan mengetahui pengenal dapat mengakses objek dengan nama yang terkait, di mana pun objek didefinisikan. Nama terkait dapat berupa nama apa saja yang ada dalam modul Python ; misalnya nama kelas, fungsi atau variabel. Mekanisme titik masuk tidak peduli dengan apa namanya, asalkan dapat diimpor.

Sebagai contoh, mari kita gunakan (nama) sebuah fungsi, dan modul python imajiner dengan nama yang sepenuhnya memenuhi syarat 'myns.mypkg.mymodule':

def the_function():
   "function whose name is 'the_function', in 'mymodule' module"
   print "hello from the_function"

Titik masuk didaftarkan melalui deklarasi titik masuk di setup.py. Untuk mendaftarkan fungsi di bawah titik masuk yang disebut 'my_ep_func':

    entry_points = {
        'my_ep_group_id': [
            'my_ep_func = myns.mypkg.mymodule:the_function'
        ]
    },

Seperti yang ditunjukkan contoh, titik masuk dikelompokkan; ada API terkait untuk mencari semua titik masuk milik grup (contoh di bawah).

Setelah instalasi paket (mis. Menjalankan 'python setup.py install'), deklarasi di atas diuraikan oleh setuptools. Itu kemudian menulis informasi yang diuraikan dalam file khusus. Setelah itu, API pkg_resources (bagian dari setuptools) dapat digunakan untuk mencari titik masuk dan mengakses objek dengan nama terkait:

import pkg_resources

named_objects = {}
for ep in pkg_resources.iter_entry_points(group='my_ep_group_id'):
   named_objects.update({ep.name: ep.load()})

Di sini, setuptools membaca informasi titik masuk yang ditulis dalam file khusus. Ia menemukan titik masuk, mengimpor modul (myns.mypkg.mymodule), dan mengambil fungsi yang didefinisikan di sana, saat dipanggil ke pkg_resources.load ().

Dengan anggapan tidak ada pendaftaran titik masuk lain untuk id grup yang sama, memanggil fungsi_kan maka akan menjadi sederhana:

>>> named_objects['my_ep_func']()
hello from the_function

Jadi, walaupun mungkin agak sulit untuk dipahami pada awalnya, mekanisme entry point sebenarnya cukup mudah digunakan. Ini menyediakan alat yang berguna untuk pengembangan perangkat lunak Python pluggable.

Dari sudut pandang abstrak, titik masuk digunakan untuk membuat sistem registri Pyable callable yang mengimplementasikan berbagai antarmuka tertentu. Ada API di pkg_resources untuk melihat titik entri mana yang diiklankan oleh paket yang diberikan serta API untuk menentukan paket mana yang mengiklankan titik masuk tertentu.

Titik masuk berguna untuk memungkinkan satu paket menggunakan plugin yang ada dalam paket lain. Misalnya, proyek Tempel Ian Bicking menggunakan titik masuk secara luas. Dalam hal ini, Anda dapat menulis paket yang mengiklankan pabrik aplikasi WSGI menggunakan titik masuk paste.app_factory.

Penggunaan lain untuk titik masuk adalah enumerasi semua paket pada sistem yang menyediakan beberapa fungsionalitas plugin. Kerangka kerja TurboGears menggunakan python.templating.enginestitik masuk untuk mencari templating library yang diinstal dan tersedia.