
.. image:: https://raw.githubusercontent.com/lmacken/pyrasite/develop/docs/logo.png
.. image:: https://github.com/lmacken/pyrasite/actions/workflows/ci.yml/badge.svg?branch=develop :target: https://github.com/lmacken/pyrasite/actions/workflows/ci.yml .. image:: https://img.shields.io/pypi/v/pyrasite?style=flat :target: https://pypi.org/project/pyrasite/
実行中の Python プロセスに任意のコードを注入するためのツール。
:homepage: https://github.com/lmacken/pyrasite :documentation: https://pyrasite.readthedocs.io/ :download: https://pypi.org/project/pyrasite/ :source: https://github.com/lmacken/pyrasite :issues: https://github.com/lmacken/pyrasite/issues
要件
* `gdb <https://www.gnu.org/s/gdb>`_ (バージョン 7.3 以上)
* ptrace ポリシーが対象プロセスへのアタッチを許可している Linux システム。
下記の `ptrace_scope` を参照してください。
インストール
::
pipx install pyrasite
または、オプションのメモリビューアを含める場合::
pip install "pyrasite[memory-viewer]"
互換性
Pyrasite は CPython 3.9 から 3.15 で動作します。バージョン間の注入も可能で、
ある Python で Pyrasite を実行し、別の Python で動作しているプロセスに注入
できます。pyrasite クライアントと対象プロセスの両方が CPython である必要が
あります。
ptrace_scope
最近の Linux ディストリビューションでは ptrace が制限されており、プロセスは
その祖先からのみアタッチできます。/proc/sys/kernel/yama/ptrace_scope が
ゼロ以外の場合、警告が表示されます。グローバルにアタッチを許可するには::
echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope
または、対象プロセス側で prctl(PR_SET_PTRACER, PR_SET_PTRACER_ANY) を
呼び出してオプトインさせる方法もあります。Fedora では SELinux の設定も
必要になる場合があります::
sudo setsebool -P deny_ptrace=off
マルチスレッドプログラムの場合、pyrasite は Py_AddPendingCall でペイロード
をキューに入れ、すでに GIL を保持しているスレッド上で実行されるようにします。
対象が C コードでブロックされ、Python バイトコードを一切実行しない場合は、
代わりに --inject-method direct を使用してください。
使い方
::
pyrasite <pid> hello.py
pyrasite <pid> - <<'EOF'
import sys
print(sys.version)
EOF
pyrasite <pid> <(echo 'print("hello")')
ペイロードは pyrasite プロセスによって読み取られ、gdb コマンドに埋め込まれる
ため、対象プロセスはペイロードファイルへの読み取りアクセスを必要としません。
これにより、パイプやプロセス置換も利用できます。標準のペイロードは名前で
選択できます(``pyrasite --list-payloads`` を参照)。
テスト
::
pip install -e ".[dev]"
pytest
ruff check .
ruff format --check .
uv <https://docs.astral.sh/uv/>_ を使って、サポートされているすべての
インタプリタでテストスイートを実行するには::
uv python install 3.9 3.10 3.11 3.12 3.13 3.14 3.15
tox
あるインタプリタから他のすべてのインタプリタへの注入をテストするには、
pytest を実行する前に PYRASITE_TEST_INTERPRETERS をコロン区切りの
インタプリタパスのリストに設定してください。
pyrasite-gui
グラフィカルインターフェースは https://github.com/lmacken/pyrasite-gui で
別途メンテナンスされています。
作者
~~~~
`Luke Macken <https://twitter.com/lmacken>`_ が
`David Malcolm <https://dmalcolm.livejournal.com>`_ やその他多くの
`コントリビューター <https://github.com/lmacken/pyrasite/contributors>`_ の
協力を得て作成しました。
ロゴは `Adam Saunders <https://fedorahosted.org/design-team/ticket/214>`_ によるものです。
ライセンス
~~~~~~~~~~
コード
^^^^^^
.. image:: https://www.gnu.org/graphics/gplv3-127x51.png
:target: https://www.gnu.org/licenses/gpl.txt
ロゴ
^^^^
.. image:: https://creativecommons.org/images/deed/nolaw.png
:target: https://creativecommons.org/publicdomain/zero/1.0/