APIドキュメント

ironpycompiler.detect

IronPython実行可能ファイルの存在する場所を調べるためのモジュールです。

ironpycompiler.detect.auto_detect()

システムにあるIronPythonのうちで、最適のバージョンを決定します。

この関数は、IronPyCompilerが実行されているCPythonのバージョンに対して、システムにある最も適切なIronPythonのバージョンを決定し、そのバージョン番号と場所（IronPythonディレクトリへのパス）を示すタプルを返します。

例：CPython 2.7上で、まずこの関数はIronPython 2.7を検索します。もしこれが見つからなければ、システムにある最新のIronPython 2.xを選択します。

戻り値の型:タプル 例外 ironpycompiler.exceptions.IronPythonDetectionError:  もしこの関数が最適なバージョンを決定できなかった場合

バージョン 0.9.0 で追加.

ironpycompiler.detect.detect_ipy(regkeys=['SOFTWARE\\IronPython', 'SOFTWARE\\Wow6432Node\\IronPython'], executable='ipy.exe')

この関数はIronPythonディレクトリへのパスからなるリストを返します。

この関数はWindowsのレジストリと環境変数PATHを読み取り、IronPythonを検索します。

パラメタ:

• regkeys (list) – （任意）検索対象とするIronPythonのレジストリキーです。
• executable (str) – （任意）IronPython実行可能ファイルの名前です。

戻り値の型:

リスト

例外 ironpycompiler.exceptions.IronPythonDetectionError:  

IronPythonが見つからない場合

バージョン 0.9.0 で変更: この関数は search_ipy() を使用するようになりました。

警告

この関数は非推奨であり、次のメジャーバージョンで削除される予定です。 search_ipy() を使用してください。

ironpycompiler.detect.search_ipy(regkeys=None, executable='ipy.exe')

IronPythonディレクトリを検索します。

この関数は search_ipy_env() と search_ipy_reg() の両方を使ってIronPythonディレクトリを検索し、IronPythonのバージョンと場所（IronPythonディレクトリへのパス）を示す辞書を返します。

パラメタ:

• executable (str) – （任意）IronPython実行可能ファイルの名前です。
• regkeys (list) – （任意）検索対象とするIronPythonのレジストリキーです。

戻り値の型:

辞書

バージョン 0.9.0 で追加.

バージョン 0.10.1 で変更: 引数 regkeys に対する既定値が可変であるという問題を解消しました。

ironpycompiler.detect.search_ipy_env(executable='ipy.exe')

環境変数PATHに含まれるIronPythonディレクトリを検索します。

この関数は、環境変数PATHを読み取り、システムにあるIronPython実行可能ファイルを検索します。そして、各実行ファイルを実行して、バージョン番号を取得します。

この関数はIronPythonのバージョンと場所（IronPythonディレクトリへのパス）を示す辞書を返します。

パラメタ:executable (str) – （任意）IronPython実行可能ファイルの名前です。 戻り値の型:辞書 例外 ironpycompiler.exceptions.IronPythonDetectionError:  IronPythonが見つからない場合

バージョン 0.9.0 で追加.

ironpycompiler.detect.search_ipy_reg(regkeys=None)

IronPythonのレジストリキーを検索します。

この関数はWindowsレジストリ内のIronPythonキーを検索し、IronPythonのバージョンと場所（IronPythonディレクトリへのパス）を示す辞書を返します。

パラメタ:regkeys (list) – （任意）検索対象とするIronPythonのレジストリキーです。 戻り値の型:辞書 例外 ironpycompiler.exceptions.IronPythonDetectionError:  IronPythonキーが見つからない場合

バージョン 0.9.0 で追加.

バージョン 0.10.1 で変更: 引数 regkeys に対する既定値が可変であるという問題を解消しました。

ironpycompiler.compiler

IronPythonスクリプトを解析・コンパイルするためのモジュールです。

class ironpycompiler.compiler.ModuleCompiler(paths_to_scripts, ipy_dir=None, pyc_path=None)

このクラスはスクリプトが必要とするモジュールを検索し、.NETアセンブリを作成します。

既定では、このクラスはIronPython標準ライブラリおよびCPythonの site-packagesディレクトリに含まれる純Pythonモジュールを検索します。

パラメタ:

• paths_to_scripts (list) – スクリプトへのパスを指定してください。EXEファイルを作成する際には、このリストの最初の要素は、最初に実行されるべきスクリプトへのパスでなければなりません。
• ipy_dir (str) – IronPythonのディレクトリを指定してください。さもなければ、 ironpycompiler.detect.auto_detect() を利用して自動的に検索します。
• pyc_path (str) – （任意）pyc.pyへのパスを指定してください。

バージョン 0.10.0 で変更: 引数``pyc_path``が追加されました。

builtin_modules = None

組み込みモジュールの名前の集合です。

call_pyc(args, delete_resp=True, executable='ipy.exe', cwd=None)

スクリプトをコンパイルするために、pyc.pyを実行します。

通常は、このメソッドを直接使用すべきではありません。 create_asm() を代わりに使用することをお勧めします。

パラメタ:

• args (list) – pyc.pyに送る引数を指定します。
• delete_resp (bool) – （任意）コンパイル後にレスポンスファイルを削除するかどうかを指定してください。
• executable (str) – （任意）IronPython実行ファイルの名前を指定してください。
• cwd (str) – （任意）作業ディレクトリを指定してください。

check_compilability(dirs_of_modules=None)

指定したスクリプトが必要とするモジュールをコンパイルできるか確認します。

パラメタ:dirs_of_modules (list) – スクリプトが必要とするモジュールが存在するディレクトリのパスを指定してください。さもなければ、このメソッドは、IronPython標準ライブラリおよびCPythonのsite-packagesディレクトリ内のモジュールを検索します。

compilable_modules = None

スクリプトが必要としており、コンパイルが可能なモジュールへのパスの集合です。

create_asm(out=None, target_asm='dll', target_platform=None, embed=True, standalone=True, mta=False, delete_resp=True, executable='ipy.exe', copy_ipydll=False)

pyc.pyを用いて、スクリプトを.NETアセンブリにコンパイルします。

パラメタ:

• out (str) – （任意）作成するEXEファイルの名前を指定してください。さもなければ、メインのスクリプトの名前が使われ、出力先のディレクトリは現在の作業ディレクトリとなります。
• target_asm (str) – （任意）出力するアセンブリの形式を、”dll”, “exe”, “winexe”のいずれかで指定してください。既定ではDLLファイルが作成されます。
• target_platform (str) – （任意）必要であれば、対象のプラットフォームを”x86” か “x64”で指定してください。
• embed (bool) – （任意）作成されるDLLを実行可能ファイルに埋め込むかどうかを指定してください。出力アセンブリの形式が”exe”または”winexe”であるときに有効です。
• standalone (bool) – （任意）IronPythonアセンブリを実行可能ファイルに埋め込むかどうかを指定してください。出力アセンブリの形式が”exe”または”winexe”であるときに有効です。
• mta (bool) – （任意）MTAThreadAttributeを設定するかどうかを指定してください。出力アセンブリの形式が”winexe”であるときに有効です。
• delete_resp (bool) – （任意）コンパイル後にレスポンスファイルを削除するかどうかを指定してください。
• executable (str) – （任意）IronPython実行ファイルの名前を指定してください。
• copy_ipydll (bool) – （任意）IronPythonのDLLファイルを出力先にコピーするかどうかを指定してください。

create_dll(out=None, delete_resp=True, executable='ipy.exe')

pyc.pyを使って、スクリプトをDLLファイル（.NETライブラリアセンブリ）にコンパイルします。

パラメタ:

• out (str) – （任意）作成するDLLファイルの名前を指定してください。
• delete_resp (bool) – （任意）コンパイル後にレスポンスファイルを削除するかどうかを指定してください。
• executable (str) – （任意）IronPython実行ファイルの名前を指定してください。

警告

この関数は非推奨であり、次のメジャーバージョンで削除される予定です。 create_asm() を代わりにお使いください。

create_executable(out=None, winexe=False, target_platform=None, embed=True, standalone=True, mta=False, delete_resp=True, executable='ipy.exe')

pyc.pyを用いて、スクリプトを実行可能ファイル（.NETプロセスアセンブリ）にコンパイルします。

パラメタ:

• out (str) – （任意）作成するEXEファイルの名前を指定してください。
• winexe (bool) – （任意）グラフィカルな実行可能ファイルとコンソール実行可能ファイルのいずれを作成するか指定してください。さもなければ、コンソール実行可能ファイルが作成されます。
• target_platform (str) – （任意）必要であれば、対象のプラットフォームを”x86” か “x64”で指定してください。
• embed (bool) – （任意）作成されるDLLを実行可能ファイルに埋め込むかどうかを指定してください。
• standalone (bool) – （任意）IronPythonアセンブリを実行可能ファイルに埋め込むかどうかを指定してください。出力アセンブリの形式が”exe”または”winexe”であるときに有効です。
• mta (bool) – （任意）MTAThreadAttributeを設定するかどうかを指定してください。出力アセンブリの形式が”winexe”であるときに有効です。
• delete_resp (bool) – （任意）コンパイル後にレスポンスファイルを削除するかどうかを指定してください。
• executable (str) – （任意）IronPython実行ファイルの名前を指定してください。

警告

この関数は非推奨であり、次のメジャーバージョンで削除される予定です。 create_asm() を代わりにお使いください。

output_asm = None

出力するアセンブリへのパスです。

pyc_stdout = None

pyc.pyの標準出力です。

uncompilable_modules = None

スクリプトが必要とするが、コンパイルが不可能なモジュールの名前の集合です。

ironpycompiler.compiler.gather_ipydll(dest_dir, ipy_dir=None)

IronPythonのDLLファイルを指定されたディレクトリにコピーします。

パラメタ:

• dest_dir (str) – 出力先のディレクトリのパスです。
• ipy_dir (str) – IronPythonディレクトリのパスを指定してください。さもなければ ironpycompiler.detect.auto_detect() を利用して自動的に検索します。

バージョン 0.9.0 で追加.

バージョン 0.10.0 で変更: この関数は ironpycompiler.detect.detect_ipy() の代わりに ironpycompiler.detect.auto_detect() を使います。

ironpycompiler.exceptions

このモジュールはIronPyCompilerの例外を含みます。

exception ironpycompiler.exceptions.IPCError

これはこのモジュールが定義する例外の基底クラスです。

exception ironpycompiler.exceptions.IronPythonDetectionError(executable=None, msg=None)

IronPythonがシステム内に見つからないときに、この例外が発生します。

パラメタ:

• executable (str) – （任意）検索するIronPython実行可能ファイルの名前です。この引数は後方互換性のために残されています。
• msg – （任意）エラーに関する詳細情報です。

バージョン 0.9.0 で変更: 引数 executable は任意となり、引数 msg が追加されました。

exception ironpycompiler.exceptions.ModuleCompilationError(msg=None)

この例外はコンパイル中にエラーが生じたことを意味します。

パラメタ:msg – （任意）エラーに関する詳細情報です。

バージョン 0.10.0 で追加.

ironpycompiler.constants

IronPyCompierのための定数です。

ironpycompiler.constants.EXECUTABLE = 'ipy.exe'

IronPython実行可能ファイルの既定の名前です。

ironpycompiler.constants.REGKEYS = ['SOFTWARE\\IronPython', 'SOFTWARE\\Wow6432Node\\IronPython']

既定のIronPythonレジストリキーです。