Magic command to run Juypter's code cell on the server.
Project description
RunServer Magic Command
概要
Jypyter(notebook/lab)・VSCodeまたはGoogle ColabでコードセルのPythonコードをサーバーとして起動するマジックコマンドです。
使い方
マジックコマンドの追加
コードセルに以下のコードを貼り付けて実行しマジックコマンドを登録してください。カーネルやランタイムを再起動する度に再実行する必要があります。
%pip install -q runservermagic
from runserver import register_run_server
register_run_server()
マジックコマンドの使い方
コードセルの冒頭に%%run_server
マジックコマンドを記述してください。実行するとコードセルのコードがサーバーとして実行されます。
以下はFlaskでHello Worldを表示するサーバーの例です。
%%run_server 8000 flask_app.py
from flask import Flask
app = Flask(__name__)
@app.route("/")
def hello():
return "Hello World!"
app.run(port={{server_port}})
{{server_port}}
はマジックコマンドの引数で指定したポート番号に置き換えられます。
起動したサーバーを停止するには%stop_server
マジックコマンドを別のコードセルから実行してください。
同じポート番号でサーバーを起動した場合は、自動的に古いサーバーを停止してから新しいサーバーを起動します。
ノートブック内でサーバーにアクセスしてwebページを表示する場合は、IPython.display.IFrame
を使用します。
server_url
には直前に%%run server
で起動したサーバーのURLが格納されています。
import IPython
IPython.display.IFrame(src=f"{server_url}/", width="100%", height=500) # type: ignore
マジックコマンド
%%run_server
セル内のPythonコードをサーバーとして起動します。
%%run_server [port] [file] [remove]
port
: サーバーのポート番号を指定します。デフォルトは8000
です。file
: サーバーとして起動するために書き出すPythonファイル名を指定します。デフォルトはserver.py
です。remove
: サーバーを起動した後に書き出したファイルを削除するかどうかを指定します。デフォルトはTrue
です。
%stop_server
起動したサーバーを停止します。
%stop_server [port]
port
: 停止するサーバーのポート番号を指定します。デフォルトは8000
です。
グローバル変数
run_serverマジックコマンドがあるセルを実行した後には以下のグローバル変数が登録されています
server_url
: 直前に起動したサーバーのURLが格納されています。server_url_{port番号}
: 指定のポート番号で起動したサーバーのURLが格納されています。
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for runservermagic-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7f59a3acb9747cf366f2211dc92f8ce0aa874924eee073ef751bb285fef95b3a |
|
MD5 | d1da29f81c6aee732bfc55691d8bc8de |
|
BLAKE2b-256 | 4df0e7a0ee1862776dffa40050eb2b2b1ca3d8be30fdbe5ee5801bd8bd89d6f1 |