Perl の wantarray 関数で返り値の扱いを確認する2020年12月22日 22時28分

こんにちは、nanto_vi です。この記事は Perl Advent Calendar の 22 日目です。


Perl の特徴のひとつに関数が多値を返せるというのがあります。Go 言語と同様に、処理の結果とエラーの値を同時に返すことができます。

sub do_something {
    ...

    return (undef, $error) if $something_wrong;

    return ($result, undef);
}

my ($result, $error) = do_something();

上述の do_something 関数はリストを返し、その第 1 要素に処理結果を、第 2 要素にエラーの値を含んでいます。ところが、ここでうっかり、

my $result = do_something();

とリストを使わずに返り値を受け取ってしまうと、変数 $result にエラーの値が代入されてしまいます。(リストをスカラコンテキストで評価した場合、そのリストの末尾要素が返ります。)

このような事態を防ぐために、wantarray 関数を使って呼び出し側がリストコンテキストで返り値を受け取っているか確かめられます。

use Carp qw(croak);

sub do_something {
    croak 'Must handle error' unless wantarray;

    ...

    return (undef, $error) if $something_wrong;

    return ($result, undef);
}

my $result = do_something();
# => 'Must handle error' 例外が投げられる。

ここでエラーの値だけを受け取りたいときは、次のようにリストの要素として undef を書けます。

my (undef, $error) = do_something();

空リストに代入することで、返り値をすべて無視することもできます。

() = do_something();

また、defined 関数と組み合わせて呼び出し側が返り値を受け取っているか確かめられます。

sub do_another_thing {
    croak 'Must handle error' unless defined wantarray;

    return $error if $something_wrong;

    return undef;
}

do_another_thing();
# => 'Must handle error' 例外が投げられる。

my $error = do_another_thing();
# => 例外が投げられず、エラーの値が返る。

この場合、返り値を無視するには scalar 関数が使えます。

scalar do_another_thing();

Perl の Test2::V0 でオブジェクトの基底クラスを確認する2020年12月18日 00時37分

こんにちは、nanto_vi です。この記事は Perl Advent Calendar の 18 日目です。


近年、Perl でテストの記述によく使われているモジュールが Test2::V0 です。Test2::V0 について詳しくは「第51回 Test2で変わるモダンなテスト―拡張性を持ったテスティングフレームワークとTest2::V0の使い方(1):Perl Hackers Hub|gihyo.jp … 技術評論社」を参照してください。

Test2::V0 を使い、あるオブジェクトがあるクラスのインスタンスであることを確かめたいときはどうすればよいでしょうか? 例えば、オブジェクトが URI クラスのインスタンスであることを確かめようとして、次のように書くと……

# Bad
use Test2::V0;
use URI;

my $uri = URI->new('https://www.example.com/');
is $uri, object {
    prop blessed => 'URI';
};

このテストは失敗します! prop blessed の値 (Scalar::Util::blessed($uri) の返り値) は URI::https であり、URI ではないからです。(URI::https クラスは URI クラスを継承しています。)

Test2::V0 0.000138 までは、次のように書く必要がありました。

# Good
is $uri, object {
    call [ isa => 'URI' ] => T;
};

$uri->isa('URI') の返り値が真ならよいというわけです。でもパッと見ただけでは何をやっているのかわかりづらいですよね。

Test2::V0 0.000139 (日本時間で 2020 年 12 月 16 日、つまりこれを書いている 2 日前のリリースです) では、次のように書けるようになりました!

# Good
is $uri, object {
    prop isa => 'URI';
};

prop isa を使うことで、オブジェクトの基底クラスの確認をわかりやすく書けます。また、check_isa 関数も追加されました。

これらの機能は Introduce object inehritance chekcs by nanto · Pull Request #230 · Test-More/Test2-Suite で導入されました。変更をレビューし取り込んでくださった Chad Granum 氏に感謝します。

Windowsでプロキシ自動設定ファイルを適用するPowerShellスクリプト2020年03月21日 22時23分

Windowsで一時的にプロキシ自動設定ファイル(プロキシ自動構成スクリプト、pacファイル)を利用したいとき、

  • プロキシ自動設定ファイルを配信するHTTPサーバーを立てなければいけない。(以前はローカルファイルが使えたが、Windows 10 Creators Updateから使えなくなった。)
  • Windowsの「プロキシ」設定画面で「スクリプトのアドレス」を指定しなければいけない。

という手間があります。

そこで、プロキシ自動設定ファイルを配信するHTTPサーバーを立ち上げ、そのURLをWindowsのプロキシ設定に指定するPowerShellスクリプトを書きました。

上記リンク先のスクリプトをローカルに保存し、Explorerでスクリプトファイルのコンテキストメニューから「PowerShell で実行」を選択すると、コンソールウィンドウが開き、スクリプト中に記述されたプロキシ自動設定が適用された状態になります。コンソールウィンドウ内でCtrl + Cを押下すれば、プロキシ自動設定が解除されます。

なお、プロキシ自動設定でSOCKSプロキシを使う場合、そのためのSSH接続は別途立ち上げておく必要があります。

既知の不具合

EdgeやInternet Explorerではプロキシ自動設定が期待通り適用されないことがあるようです。

プロキシ設定の変更をブラウザに通知する

プロキシ設定はレジストリに保存されていますが、レジストリの値を書き換えるだけではうまく機能しませんでした。どうもプロキシ設定が変更されたことをWebブラウザなどの各アプリケーションに伝えるために、Windows APIを呼び出す必要があるようです(スクリプト中のRefresh-Proxy-Settings関数の処理)。

もっと言うと、プロキシ設定の変更自体もレジストリを直接いじるのではなく、WinInetライブラリのInternetSetOption関数経由でやったほうがよいようです。ただし、そのためには構造体を定義するなど、PowerShellスクリプト中にC#のコードを書く必要があり、面倒になってやっていません。

Windows PowerShellの感想

今回初めてWindows PowerShellを書いたのですが、.NET Frameworkをそのまま使え、C#のコードを書け、Windows APIまで呼び出せるなど、何でもできる感じで感心しました。Taskオブジェクトを直接扱うことでC#のasync/await相当の処理を実現できるのも面白かったです。

もっとも、気をつけないと「PowerShellを書いていたつもりが、いつの間にかC#を書いていた」ということになりかねませんが(笑)

xargsで入力が空のときに何も実行しない2019年12月31日 19時56分

xargsコマンドで入力が空のときは何も実行しないようにしたいのですが、BSD版(macOSなど)とGNU版(Linuxなど)などで挙動が異なります。BSD版は最初からそのような挙動なのに対し、GNU版では--no-run-if-emptyオプションをつけないとそのような挙動になりません。両者で挙動を合わせるために、シェルスクリプトで以下のように書けます。

NO_RUN_IF_EMPTY=$(: | xargs echo '--no-run-if-empty')
command1 | xargs $NO_RUN_IF_EMPTY command2

コロン(:)は何もしないコマンドであり、パイプでつながれたxargsの入力も空となります。なので、BSD版ではechoコマンドが実行されずNO_RUN_IF_EMPTY変数の値が空文字列となり、一方GNU版ではechoコマンドが実行されNO_RUN_IF_EMPTY変数の値に文字列'--no-run-if-empty'が入ります。

参考: GNU版, BSD版 xargsの挙動の違い - syohex’s diary

JavaScriptの正規表現の戻り読みはPerlのそれよりも表現力が高い2018年12月29日 22時37分

ECMAScript 2018で正規表現の戻り読み(lookbehind)が追加されました。

/(?<=foo)bar/.test('foobar'); // => true
'foobar'.replace(/(?<=foo)bar/, 'baz'); // => 'foobaz

正規表現の戻り読みと言えばPerlでは1998年7月リリースのバージョン5.005からサポートしており、そこから20年もたってと思いたくなるかもしれません。しかし、ECMAScript (JavaScript)のそれはPerlのものとは一味違います。なんと戻り読みの中で量指定子(*+?{n}など)を使えるのです。

// JavaScriptなら(?<=...)の中で+が使える。
/(?<=fo+)bar/.test('foobar'); // => true
# Perlでは(?<=...)の中で+を使おうとするとエラーになる。
"foobar" =~ m/(?<=fo+)bar/;
# => Variable length lookbehind not implemented in regex m/(?<=fo+)bar/ at - line 1.

Perlの場合、戻り読みとして指定されたパターンの文字数だけ戻ってから(文字列末尾方向に向けて)マッチしていきます。あらかじめ戻る文字数がわからないといけないので、戻り読みの中で量指定子を使えません。

一方、ECMAScriptでは戻り読みとして指定されたパターンそのものを逆方向に解釈し、1文字ずつ逆向きに(文字列先頭方向に向けて)マッチしていきます。ですから量指定子が含まれていても問題ないのです。

パターンが逆方向に解釈されるので、後方参照を使えるようになるのも戻る方向になります。

// 1番目の(...)よりも\1のほうが文字列先頭方向側にある。
                                 //     $&     $1
/(?<=f\1(o))bar/.exec('foobar'); // => ["bar", "o"]

ただし、後方参照の番号はパターン内での出現順のままです。

                                              //     $&          $1     $2
/([0-9]+)([0-9]+)兆円/.exec('5000兆円');      // => ["5000兆円", "500", "0"  ]
/(?<=([0-9]+)([0-9]+))兆円/.exec('5000兆円'); // => ["兆円",     "5",   "000"]