zsh でシェルスクリプトを書くときの留意点 - 拡張 POSIX シェルスクリプト Advent Calendar 2013 - ダメ出し Blog

2013-12-03(Tue) [sh][shell][zsh] [更新履歴]

拡張 POSIX シェルスクリプト Advent Calendar 2013、3日目の記事です。

初日に「bash を避けて ksh や zsh で書くとスクリプトが速くなるよ!」 と紹介しましたが、実は zsh でふつうの sh なシェルスクリプトを書くと、色々ハマれます。 何が問題でどうすればいいのでしょうか。 いきなりですが、最初にどうすればいいかを紹介します。 スクリプトの先頭を以下のように書くだけです。

#!/bin/zsh

## sh エミュレーションモード
emulate -R sh

## 以下、ふつうに sh なシェルスクリプトを実装…

zsh は sh, ksh, csh (誰が使うの?) のエミュレーション機能を持っていて、 それを切り替えるのが組込みコマンド emulate です。 -R オプションを指定すると、各種シェルオプション (zshoptions(1) を参照) を指定したシェルエミュレーションに合ったデフォルト値にリセットします。 こうすることで概ね POSIX sh 互換の動きとなり、概ね POSIX sh や bash に近い動きになります。

では、emulate -R sh で具体的にどんなオプションが変化するのか見てみましょう。 set -ozshoptions(1) 記載のオプションを設定する組込みコマンドですが、 オプション名指定なしで実行すると現在の設定を表示します。

$ zsh -c 'set -o'
noaliases             off
allexport             off
...省略...
nohashdirs            on
...省略...
nonomatch             off
nonotify              off
...省略...

zshoptions(1) 記載のオプション名は「大文字とアンダーバー」なのですが、 set -o の出力ではこの実行例のように「小文字」で表示されます。 また、オプションは set -o NO<オプション名>set +o <オプション名> のように指定すると無効にできるのですが、set -o による一覧表示では左辺のオプション名の先頭に no が付いたり、 代わりに右辺が off になったり、no であって off になったり(二重否定死ね)、 統一されていません。 しかも set に指定するオプション名は大文字・小文字を無視し、アンダーバーも無視します。 なんてわかりにくいんだ、zsh …。

そこで、まずはこの表示を正規化するフィルターを用意します。 (すべてシェルで実装してもいいのだけど素直に sed で :-)

$ zshoptions_normalize() {
  sed '/^nomatch/n; /^notify/n; s/^no\(.*\)on$/\1  off/; s/^no\(.*\)off$/\1  on/'
}

これを利用して、zsh の既定時と sh エミュレーション時のオプションを比較します。

$ diff --side-by-side \
  <(zsh -c 'set -o' |zshoptions_normalize) \
  <(zsh -c 'emulate -R sh; set -o' |zshoptions_normalize) \
  |awk '/\|/{printf "%-20s%-4s%s\n", $1, $2, $5}'
badpattern          on  off
banghist            on  off
bareglobqual        on  off
bgnice              on  off
bsdecho             off on
checkjobs           on  off
cprecedences        off on
equals              on  off
evallineno          on  off
functionargzero     on  off
globalexport        on  off
globsubst           off on
hashdirs            off on
hup                 on  off
ignorebraces        off on
interactivecomments off on
ksharrays           off on
kshautoload         off on
multibyte           on  off
multifuncdef        on  off
multios             on  off
nomatch             on  off
notify              on  off
octalzeroes         off on
pathscript          off on
posixaliases        off on
posixbuiltins       off on
posixcd             off on
posixidentifiers    off on
posixjobs           off on
posixstrings        off on
posixtraps          off on
promptpercent       on  off
promptsubst         off on
rmstarsilent        off on
shfileexpansion     off on
shglob              off on
shnullcmd           off on
shoptionletters     off on
shortloops          on  off
shwordsplit         off on
typesetsilent       off on

思ったより沢山あったわ…。 左がオプション名、真ん中が zsh デフォルト時の設定、 右が ksh エミュレーション時の設定になります。

すべてを解説するのは面倒なので、sh なシェルスクリプトを書く上で特徴的なものだけ解説します。 (詳細は zshoptions(1) を参照。括弧内のオプション名は zshoptions(1) 記載の名前)

globsubstshwordsplit がよくわからない人のためのデモ:

$ zsh -c 'v="/*"; echo $v; set -o GLOB_SUBST; echo $v'
/*
/bin /boot /dev /etc /home /lib /lib32 /lib64 /lost+found /media /mnt /opt /proc /root /run /sbin /srv /sys /tmp /usr /var
$ zsh -c 'v=" foo "" bar "; echo $v; set -o SH_WORD_SPLIT; echo $v'
 foo  bar 
foo bar

なお rmstarsilent (RM_STAR_SILENTrm * 実行時にユーザーに確認をとる) は対話シェルの場合だけ機能するので、 シェルスクリプトの場合は on でも off でも関係ありません。


emulate -R sh を利用せずに個別にオプションを設定して他 sh との互換性を高める例を示します。 zsh 特有の挙動を利用したスクリプトを書く場合、 一部の挙動だけ他 sh 互換にしたいときはこのようにします。

#!/bin/zsh

set -o BSD_ECHO
set -o KSH_ARRAYS
set -o GLOB_SUBST
set -o NO_NOMATCH
set -o SH_WORD_SPLIT
## ほかにもあれば、適宜 on / off する

## 以下、ふつうに sh なシェルスクリプトを実装…

zsh 専用のモジュールの中には zsh の既定のシェルオプション設定に依存しているものがあります。 外部モジュールを利用した zsh シェルスクリプトを書く場合は注意しましょう。 ログインシェルに zsh を利用しているなら、 ~/.zshrc の先頭のほうに emulate -R sh と書いてログインしてみると実感できるかと。


ちなみに、ksh の組込みコマンド echo は環境 (OS) に依って動作が異なるというクソ仕様だったりします。 わざわざ OS の echo(1) (/bin/echo) に合わせているらしい。 なんてこった。

Advent Calendar ネタが尽きたら echo コマンドの闇に迫りたいと思います。

書きました


ところで、12月25日はクリスマスな上に、 OSS 界隈で地味に活躍されているふみやすさんの誕生日ですね。
http://www.amazon.co.jp/registry/wishlist/27M7TV8CEEF6G?sort=priority

逆に、あなたの書いた OSS や Blog や Advent Calendar が気に入ったら何か送りたく なってしまうかもしれないので、プロフィールや Web サイトに あなたの Amazon 欲しいものリストの URL を貼っておいてくださいね!


私が勤める OSSTech っていう某弊社で社員募集しているようです。 人材紹介会社を介さなければ、入社後に 20万円のボーナス! 「ふみやすっていう人に紹介された」と言ってもらえると私にもボーナス!! → http://www.osstech.co.jp/company/recruit

バツイチでアラフォーでほとんど諦めていますが、新たなパートナーも募集中です。 ちゃんと愛情表現してくれて精神的に自立している女性がいいです。お友達から始めましょう。 → https://twitter.com/satoh_fumiyasu


よろしければ、過去の Advent Calendar もどうぞ。