Pythonのエントリポイントについて説明しますか？

Question

パイロンとピークページの卵の入り口に関する文書を読んだことがありますが、それでも私はまだ分かりません。誰かが私にそれらを説明することができますか？

Answer 1

"エントリポイント"は、通常、呼び出し可能ではないオブジェクトを次のようなエントリポイントとして提供することができますが、Pythonパッケージの開発者またはユーザーが使用したい関数（または他の呼び出し可能な関数のようなオブジェクト）です。よく（コメントで正しく指摘されたように！）

最も一般的なエントリポイントは「console_script」エントリポイントです。このポイントは、パッケージをインストールするユーザーにコマンドラインツールとして提供される機能を指します。これは、のようなあなたのsetup.pyに入る：

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

私はちょうど「cursive.tools」と呼ばれる展開きたパッケージを持っている、と私はそれが誰かから実行できることを「筆記体」コマンド利用できるようにしたかったです以下のようなコマンドライン、：

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

ので：

$ cursive --help 
usage: cursive ... 

はこれを行う方法は次のようになり筆記体/ツール/ cmd.pyで多分「cursive_command」機能のように、関数を定義しています前進;コマンドラインから呼び出され、ユーザーが提供している引数を解析していると仮定し、コマンドが何をするように設計されていてもそれを実行します。

入り口の使用の例としては、docutilsパッケージをインストールしてください。Pythonのドキュメントを他の形式に変換するための有用なコマンドをインストールします。

Answer 2

抽象的な観点から、エントリポイントは、特定のインターフェイスを実装するPython呼び出し可能プログラムのシステム全体のレジストリを作成するために使用されます。 pkg_resourcesには、特定のエントリーポイントをアドバタイズするパッケージを決定するために、特定のパッケージによってアドバタイズされるエントリーポイントとAPIが含まれています。

エントリーポイントは、あるパッケージが別のパッケージに含まれているプラ​​グインを使用できるようにするのに便利です。たとえば、Ian BickingのPasteプロジェクトでは、エントリポイントが広く使用されています。この場合、エントリポイントpaste.app_factoryを使用してWSGIアプリケーションファクトリを宣言するパッケージを作成できます。

エントリポイントのもう1つの用途は、プラグインの機能を提供するシステム上のすべてのパッケージを列挙することです。 TurboGears Webフレームワークでは、python.templating.enginesエントリポイントを使用して、インストールされ使用可能なテンプレートライブラリをルックアップします。

Answer 3

EntryPointsは、永続的なファイルシステムベースのオブジェクト名登録と名前ベースの直接オブジェクトインポートメカニズム（setuptoolsパッケージによって実装されています）を提供します。

これらは、Pythonオブジェクトの名前を自由形式の識別子に関連付けます。したがって、同じPythonインストールを使用し、識別子を知っている他のコードは、オブジェクトがどこに定義されていても、関連付けられた名前のオブジェクトにアクセスできます。 の名前には、Pythonモジュールに存在する任意の名前を使用できます。クラス、関数、または変数の名前などです。エントリポイントのメカニズムは、インポート可能である限り、名前が何を参照しているかには関係ありません。

例として、関数の名前（の名前）と完全修飾名 'myns.mypkgを持つ虚偽のpythonモジュールを使用しましょう。mymodule '：

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

エントリポイントは、setup.pyのエントリポイント宣言によって登録されます。 「my_ep_func」と呼ばれるエントリポイントの下the_function登録する：例が示すように

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

、エントリポイントは、グループ化されています。グループに属するすべてのエントリポイントを検索するための対応するAPIがあります（下の例を参照）。

「python setup.py install」を実行すると、上記の宣言はsetuptoolsによって解析されます。次に、解析された情報を特殊ファイルに書き込みます。その後、pkg_resources API（setuptoolsの一部）は、エントリポイントを検索し、関連付けられた名前（複数可）とオブジェクト（複数可）にアクセスするために使用することができる：ここ

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

、setuptoolsのは、エントリポイント情報を読み出します特別なファイルに書かれています。エントリポイントを見つけ、モジュール（myns.mypkg.mymodule）をインポートし、pkg_resources.load（）の呼び出し時にそこに定義されている関数を取得しました。

the_functionを呼び出すと、次に簡単になり、同一のグループIDには、他のエントリポイントの登録がなかったと仮定すると：最初に把握することが恐らく少し難しいつつ、エントリポイント機構が実際に

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

非常に使いやすい。プラグイン可能なPythonソフトウェア開発のための便利なツールを提供します。