PyScript Magic Command

概要

Jypyter(notebook/lab)・VSCodeまたはGoogle ColabでコードセルのPythonコードをPyScriptを使ってiframe(ブラウザ)上で実行するマジックコマンドです。

使い方

マジックコマンドの追加

コードセルに以下のコードを貼り付けて実行しマジックコマンドを登録してください。カーネルやランタイムを再起動する度に再実行する必要があります。

%pip install -q -U pysmagic
from pysmagic import register_pysmagic

register_pysmagic()

マジックコマンドの使い方

コードセルの冒頭に以下のようにマジックコマンドを記述してください。実行するとアウトプットにiframeが表示されてその中でコードセルのコードがPyScriptで実行されます。

%%runpys

from pyscript import display
display("Hello, world!")

以下はブラウザ用JavaScriptライブラリのp5.jsを使って円を描画し、キーボードの矢印キーで移動させるサンプルです。

%%runpys 500 500 white mpy '{"x":100, "y":100}' '{}' '["https://cdn.jsdelivr.net/npm/p5@1/lib/p5.js"]'

import pyscript
import js


js.console.log(js.window)

def sketch(p5):
    x = js.pys.x
    y = js.pys.y

    def setup():
        p5.createCanvas(300, 300)

    def draw():
        nonlocal x, y
        p5.background(128)
        p5.fill(255, 0, 0)
        p5.ellipse(x, y, 50, 50)

        if p5.keyIsDown(p5.LEFT_ARROW):
            x -= 1
        if p5.keyIsDown(p5.RIGHT_ARROW):
            x += 1
        if p5.keyIsDown(p5.UP_ARROW):
            y -= 1
        if p5.keyIsDown(p5.DOWN_ARROW):
            y += 1

    p5.setup = setup
    p5.draw = draw

js.p5.new(sketch)

グローバル変数

PyScriptから以下の変数にアクセスできます。

別のセルで設定したグローバル変数(_で始まる変数名やJSONに変換できないものは除く)
マジックコマンドの引数py_valで設定した変数
width: iframeの幅(マジックコマンドの引数で指定した幅)
height: iframeの高さ(マジックコマンドの引数で指定した高さ)

この変数はjs.pysオブジェクトを介してアクセスできます。変数名が衝突した場合は上記リストの順に上書きされて適用されます。

マジックコマンド

%%runpys

コードセルのコードをPyScriptを使ってiframe内で実行します。別のセルに定義したpys_args変数を使って引数を設定することもできます。

%%runpys [width] [height] [background] [py_type] [py_val] [py_conf] [js_src] [py_ver] [viewport]

width: iframeの幅を指定します。デフォルトは500です。
height: iframeの高さを指定します。デフォルトは500です。
background: iframeの背景色を指定します。デフォルトはwhiteです。
py_type: 実行するPythonの種類。pyまたはmpyまたはpy-gameを指定します。pyとpy-gameはCPython互換のPyodide、mpyはMicroPytonで実行します。py-gameではゲームライブラリとしてPygame-ceを使えるようになります。デフォルトはmpyです。
py_val: PyScriptに渡すデータを''で囲んだJSON文字列形式で設定します。デフォルトは'{}'です
py_conf: PyScriptの設定を''で囲んだJSON文字列形式で指定します。デフォルトは'{}'です。
js_src: 外部JavaScriptのURLを''で囲んだ文字列のJSON配列形式で指定します。デフォルトは'[]'です。
py_ver: PyScriptのバージョンを指定します、Noneを指定するとモジュール内部で設定したデフォルトのバージョンを使用します。デフォルトはNoneです。
viewport: iframeのviewportを指定します。デフォルトは'width=device-width, initial-scale=1.0'です。

%%genpys

セル内のPythonコードをPyScriptを用いてiframe内で実行するために生成したHTMLを表示するマジックコマンド

引数は%%runpysと同じです。

Release files for pysmagic 2.8.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pysmagic 2.8.8
File	Size	Uploaded
pysmagic-2.8.8.tar.gz	9.8 kB	Apr 19, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for pysmagic 2.8.8
File	Interpreter	ABI	Platform	Reset
pysmagic-2.8.8-py3-none-any.whl 9.8 kB Apr 19, 2025	Python 3	none	any	Details

Total release size: 19.6 kB

Release files / pysmagic-2.8.8.tar.gz

Download URL	pysmagic-2.8.8.tar.gz
Size	9.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`3e1852fb3cbe8e80785db9001aea9dfe220ee94b42a6de076e673e69f430a7fa`
BLAKE2b-256 checksum How to use checksums	`e3415a73ef00ce4fbaef1cfebf906d8b54a5a14ce72b7c6e15d546df467dba84`
Upload date	Apr 19, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.3`

Release files / pysmagic-2.8.8-py3-none-any.whl

Download URL	pysmagic-2.8.8-py3-none-any.whl
Size	9.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`a822e3f33799b788b307504a886c1c3d55c8bffc95d74518519a77af8473520b`
BLAKE2b-256 checksum How to use checksums	`032862972d92d85889b7b94949fc9db1a981ea1ddcf9e9d9ecd9bd69462eb64b`
Upload date	Apr 19, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.3`