Share
Embed
Transcript
72 slides
-
自己紹介 X ( 旧Twitter): @muno_92 所属: スパイダープラス株式会社 Web エンジニア PHPerKaigi
2025 コアスタッフ PHP カンファレンス小田原2025 コアスタッフ 来月4/12( 土) 開催。来てね! 2 -
そんな場合にREPL はどうでしょう? REPL (Read Eval Print Loop の略) 入力の読み取り (Read)
入力されたコードの評価 (Eval) 評価結果の出力 (Print) を繰り返し (Loop) ながらインタラ クティブにコードを実行できる環境 0:00/ 0:20 4 -
REPL の例 php -a (Interactive shell) ※Print 機能は備えていない PsySH (PHP)
IRB (Ruby) IPython (Python) Node.js REPL (JavaScript) 7 -
Web フレームワークの機能を使えるREPL も Laravel Tinker (laravel/tinker) REPL plugin for CakePHP
(cakephp/repl) Rails Console 8 -
PsySH とは PHP 製の開発者向けコンソール デバッガ機能やREPL 機能を備えている 「A runtime developer console,
interactive debugger and REPL for PHP. 」 https://github.com/bobthecow/psysh PsySH をベースとしてlaravel/tinker やcakephp/repl などが作られて いる 13 -
REPL で行う主な操作 シェルの起動 文字の入力 左右にカーソルを移動 入力した文字を編集 tab キーで補完 上下キーでhistory を表示
Enter で実行 0:00/ 0:20 20 -
( 再掲) REPL で行う主な操作 シェルの起動 文字の入力 左右にカーソルを移動 入力した文字を編集 tab キーで補完
上下キーでhistory を表示 Enter で実行 22 -
シェルの起動 (psysh コマンドの実態) 1. Phar アーカイブ リリースページなどからダウンロードした場合 https://www.php.net/manual/ja/intro.phar.php 2. Phar
アーカイブにしていないPHP スクリプト composer (global) require でインストールした場合 Phar アーカイブを使用すれば、PHP のアプリケーションをひ とつのファイルとして配布できるようになります。 “ “ 24 -
シェルの起動 (psysh コマンドの内部実装) call_user_func(function () { // オートロード // psyshコマンドを実行したディレクトリにpsyshがインストールされていたらローカルのpsyshを使う
}); // オートロードできなかったらPsySH自身が保持している依存ライブラリを使う if (!class_exists('Psy\Shell')) { Phar::mapPhar('psysh.phar'); require 'phar://psysh.phar/.box/bin/check-requirements.php'; require 'phar://psysh.phar/vendor/autoload.php'; } call_user_func(Psy\bin()); 25 -
Psy\bin() を深掘り (1/2) $input = new ArgvInput(); $input->bind(new InputDefinition(\array_merge(Configuration::getInputOptions(), [
new InputOption('help', 'h', InputOption::VALUE_NONE), new InputOption('version', 'V', InputOption::VALUE_NONE), new InputOption('self-update', 'u', InputOption::VALUE_NONE), new InputArgument('include', InputArgument::IS_ARRAY), ]))); symfony/console を使ってコマンドラインオプションをパース 26 -
Psy\bin() を深掘り (2/2) $config = Configuration::fromInput($input); $shell = new Shell($config);
$shell->run(); コマンドラインオプションから読み取った設定をセットした状態で シェルを起動 27 -
Shell クラス PsySH のコア laravel/tinker やcakephp/repl も内部ではShell クラスを実行している https://github.com/laravel/tinker/blob/102bfc19b79817022e9f b1d3dd235d43d42f1954/src/Console/TinkerCommand.php#L8
5 https://github.com/cakephp/repl/blob/6790873a9d1e93dcd4a5 860bc5afe404b77c652c/src/Command/ConsoleCommand.php# L49 28 -
symfony/console https://github.com/symfony/console コマンドラインアプリケーションの作成を簡単にしてくれる Symfony 製コンポーネント PsySH での使用 コマンドライン引数のパース Symfony\Component\Console\Input\ArgvInput コマンドの定義
(Shell クラスの基底クラス) Symfony\Component\Console\Application\Application 29 -
Shell クラスの実装 class Shell extends Application { private function doInteractiveRun():
int { $this->initializeTabCompletion(); $this->readline->readHistory(); // 省略 $loop = new ExecutionLoopClosure($this); $loop->execute(); } } 30 -
ExecutionLoopClosure ? while (true) { // Loop $__psysh__->getInput(); // Read
$_ = eval($__psysh__->flushCode()); // Eval $__psysh__->writeReturnValue($_); // Print } シェルが起動した後、while ループでユーザーの入力を待ち受ける closure を宣言しているクラス 文字通りRead Eval Print Loop してる! 31 -
GNU Readline / libedit ラインエディタ 対話型のツールを作るための様々な機能を提供している ユーザーの入力の読み取り tab 補完 history
GNU Readline はGPL ライセンスのためMac では代替のlibedit を使用 PHP からはあまり違いを意識せずに使える https://www.php.net/manual/ja/ref.readline.php 34 -
PHP でのreadline 利用サンプル while (true) { $line = readline(); echo
"line: {$line}\n"; } 1 行ごとに入力を受け取るだけならこれだけでOK とはいえ、複数行入力したい場合もある 35 -
どうやって複数行の入力を受け付けている? PHP のコードとしてパースが成功するまでreadline Parse Error のrawMessage を見て入力途中かを判別している 複数行をまとめて読み取っているのではなく1 行読み取りを繰り返 している
do { $input = $this->readline(); $this->addCode($input); // この中でコードがパースされる } while (!$this->hasValidCode()); 36 -
つまり for ($i = 0; $i < 10; $i++) {
echo $i . PHP_EOL; まで入力してから「$i < 100 に変更したいな」 ↓ 出来ない 37 -
PsySH 全体から見るとこうなっている // Read-Eval-Printのループ while (true) { // コードが有効になるまで行を読み続けるループ do
{ } while () // Eval // Print } 39 -
history ( 入力履歴) の管理・表示 大体readline がやってくれる readline_read_history() readline_add_history() readline_clear_history() etc
デフォルトでは$HOME/.config/psysh/psysh_history に保存 41 -
Eval ( 入力されたコードを評価) eval() 引数で渡した文字列をPHP のコードとして評価する return を付けるとeval の戻り値で評価結果が返ってくる php
> var_dump(eval('$a = 1;')); NULL php > var_dump(eval('return $a = 1;')); int(1) この値を出力時に使用 43 -
自動でreturn を付けるには 単純に文字列結合すると return if () { } のようになりかねない return
を付けて良い時だけreturn を付けたい = 式の場合 45 -
文と式 文 (statement) if 文、switch 文など 式 (expression) https://www.php.net/manual/ja/language.expressions.php コードを評価(
実行) した結果として値が返ってくるもの 今はこれだけ分かっていればOK 最も簡単で最も正確な式の定義は、" 値があるもの全て" “ “ 46 -
AST はノードがツリー状に構成されている $a = 1 PhpParser\Node\Stmt\Expression PhpParser\Node\Expr\Assign PhpParser\Node\Expr\Variable name: "a"
PhpParser\Node\Scalar\Int_ value: 1 49 -
元々のノードをReturn ノードで包む // Psy\CodeCleaner\ImplicitReturnPass } elseif ($last instanceof Expression &&
!($last->expr instanceof Exit_)) { $nodes[\count($nodes) - 1] = new Return_($last->expr, [ 'startLine' => $last->getStartLine(), 'endLine' => $last->getEndLine(), ]); } return $nodes; → ユーザーが入力したコードにreturn が付く! 51 -
cakephp/repl class ConsoleCommand extends Command { public function execute(Arguments $args,
ConsoleIo $io) { $psy = new Shell(); $psy->run(); } } ログの設定などは行っているが、ほとんどこれだけ シンプル。必要十分 61 -
laravel/tinker class TinkerCommand extends Command { public function handle() {
$config->getPresenter()->addCasters( $this->getCasters() ); $loader = ClassAliasAutoloader::register(引数は省略); $shell->execute($code); } } 62 -
ClassAliasAutoloader > User::find(1) [!] Aliasing 'User' to 'App\Models\User' for this
Tinker session. これ spl_autoload_register() にalias を解決するcallable を登録している spl_autoload_register([$loader, 'aliasClass']); . . . class_alias($fullName, $class); 66 -
まとめ PsySH は文字通りRead Eval Print Loop を体現する実装になっていた 対話型ツールの実装はreadline / libedit
が支えている PHP には文と式がある REPL に出力される実行結果は式を評価した値 PHP のソースコードを解析・操作したい場合はPHP Parser が便利 67 -
感想 普段使っている便利なツールも色々なOSS ・技術を組み合わせて作 られている 深堀りしてみると面白い PHP Parser は色んな所に出てくるので知ってるとお得 読む前はPHP Parser
が使われているとは想像してなかった Symfony のコンポーネントも色んな所で使われている 68 -
付録: 「ここ読んでて面白かった」ポイント ( 再掲) Psy\ExectionLoopClosure Psy\CodeCleaner getDefaultPasses() 今回紹介したImplicitReturnPass も含め、ユーザーが入力した コードに対して様々なバリデーション・加工を行っている
parse() どのパースエラーの場合は入力途中とみなすか Psy\Shell::getDefaultMatchers() 補完用のクラスが色々ある 71 -
付録: PHP 標準関数だけでRead を再実装 $input = []; $editing = true;
do { $input[] = readline(); try { eval(implode("\n", $input)); $editing = false; } catch (ParseError) { } } while ($editing); printf("input: %s\n", implode("\n", $input)); ポイント eval をパーサー代わ りに使っている 不正な構文の場合 にParse Error を投 げるのを利用 72