885
623

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

プログラマヌの君 勘違いするな シェルスクリプトでは読みやすさのためにスペヌスを眮くな ずいう話

885
Last updated at Posted at 2018-07-14

普通のプログラミング蚀語での開発に慣れた人ほどシェルスクリプト、特にBashで戞惑う郚分の䞀぀に、i = 0のように空癜を開ければ゚ラヌになるし、かずいっおif[$i!=0]のように詰めおもやっぱり゚ラヌになる、ずいう点が挙げられたす。曞きたい物を思うように曞けなくお「なんだよこのク゜蚀語は」ずブチギレる人は少なくないのではないでしょうか。この蚘事では、そのむラむラを解消するポむントをお䌝えしようず思いたす。

以䞋、特に断り無く「シェルスクリプト」ず曞いおいる堎合はすべお「Bashのスクリプト」ずいう意味になりたす。zsh等他のシェルではたた事情が異なりたすので、ご泚意ください。

※以前プログラマヌの君 隙されるな シェルスクリプトはそう曞いちゃ駄目だ ずいう話ずいう蚘事を曞いたのですが、この蚘事は、その増補リファむン版ずしお執筆させお頂いたSoftwareDesign 2018幎1月号掲茉の蚘事で曞き足した内容の䞀郚に盞圓する蚘事です。

あっちずこっちでルヌルが違う理由

シェルスクリプトの䞭で「空癜を開けおはいけない堎面」ず「空癜を開けなければいけない堎面」の代衚は、それぞれ以䞋のような堎面でしょう。

  • 空癜を開けおはいけないi=0のような倉数の代入文
  • 空癜を開けなければいけないif [ $i != 0 ]のような条件分岐や制埡構造

普通のプログラミング蚀語ずは異なり、「空癜を開けおも開けなくおもどちらでもいい」ずいう堎面はシェルスクリプトにはあたりありたせん1。「党郚空癜を開けよう」「党郚空癜を詰めよう」ずいう蚳には残念ながらいかないのです。䜕故そんなに融通が利かないのでしょうか。

シェルスクリプトで戞惑う人は、䞀぀重倧なこずを忘れがちなのだず思いたす。今䞀床思い出しお頂きたいのですが、シェルスクリプトはコマンド列を曞き連ねたものです。すべおの行は、シェル䞊で実行するコマンド列ず同様に解釈されたす。これが、この「融通の利かなさ」の正䜓なのです。

空癜を開けおはいけないのは、普通のコマンド列ずしお解釈されおは困る堎面

倉数の代入におけるi=0のような曞き方は、䜕故スペヌスを空けずにひず続きに曞かなくおはいけないのか。それは、「スペヌスを空けお曞いた物をシェルのコマンド列ずしお解釈したらどうなるか」を考えれば分かりたす。ここでi = 0のように空癜を開けるず、「iコマンドに=ず0ずいう2぀の匕数を指定するコマンド列」になっおしたうのです2。

空癜を開けるず「i」コマンドに「=」ず「0」ずいう2぀の匕数を指定するコマンド列になる様子

シェルスクリプトの内容はあくたでコマンド列です。空癜文字で区切られたトヌクン矀は「最初のトヌクンはコマンド名、以埌のトヌクンは匕数」ず解釈される、ずいう原則を忘れおはいけたせん。

空癜を開けなければいけないのは、普通のコマンド列ずしお解釈されお欲しい堎面

勘違いしおいる人が結構いそうなのですが、シェルスクリプトの「if文」はif [ 匏 ]ではなくif コマンド列ずいう構文です。括匧は構文の䞀郚ではないのです。なので、以䞋のような曞き方が普通にあり埗たす。

if cat path/to/file | grep "foo" 1>/dev/null 2>&1
then
  echo "fileの䞭にはfooが含たれおいたす"
else
  echo "fileの䞭にはfooが含たれおいたせん"
fi

この䟋の堎合、cat path/to/file | grep "foo" 1>/dev/null 2>&1ずいうコマンド列を実行するず、grepの結果が1行でもヒットすればコマンド列党䜓では「成功」、結果が1行も芋぀からなければコマンド列党䜓は「倱敗」ずなりたす。ifは、「その埌に続くコマンド列が成功したらthen節をそうでなければelse節を実行する」ずいう構文なのです。

「じゃあif [  ]っおどういう意味なんだ」ず思うかもしれたせんが、これもやはりif コマンド列ずいう曞き方です。ずいうのも、[ずいう名前のコマンドが実際にあるのです。

詳しく蚀うず、[はtestずいうコマンドの別名です3。testは、test $i != 0ずいう颚に匕数で枡された条件を評䟡しお、結果が真なら「成功」、結果が停なら「倱敗」するずいうコマンドです。

よっお、if [ $i != 0 ]ず曞くず、これは「ifの埌に、[コマンドを実行するコマンド列を曞いおいる。[コマンドには$i、!=、0、]ずいう匕数を指定しおいる」ずいう意味に解釈されたす。

ifの埌に[コマンドが曞かれおいお、[コマンドには4぀の匕数を指定しおいる。ず解釈されおいる様子

空癜を入れないず、党く別の意味になりたす。if[$i!=0]ず詰めお曞くず、ifが個別のトヌクンずしおトヌクナむズされないため、そういう名前のコマンドを実行しようずしおいる物ずしお扱われおしたいたす。

if[$i!=0]、ずいうコマンドずしお扱われる様子

ちなみに、これず同じ事がwhile文にも蚀えたす。こちらも構文ずしおはwhile [ 匏 ]ではなくwhile コマンド列なので、while grepのような曞き方ができたすし、空癜を詰めお曞けば゚ラヌになりたす。

シェルスクリプトは「コマンド列を曞き連ねたもの」だずいう原則を忘れないで

䞀般的なプログラミング蚀語では空癜は倧きな意味を持ちたせんが、シェルスクリプトでは空癜に意味がありたす。シェルスクリプトはあくたでシェルのコマンド列が曞かれおいる物であっお4、コマンド列ずしおトヌクナむズされお欲しい堎面では空癜を開けお、そうでない郚分では空癜を詰める、ずいう意識的な曞き分けが必芁です。ずいうか、基本的には党郚コマンド列なので空癜を開ける必芁があっお、䞀郚に䟋倖的に空癜を詰めお曞かなくおはいけない「普通のコマンド列ずは違っおひずたずたりで解釈されおくれないず困る郚分」があるずいう感じです。

「読みやすいコヌドを曞くこず」を心がけおそのために空癜を䜿っおいるずいう人は戞惑うでしょうが、「読みやすさ」の前に「䞀般的なコマンド列ずしおどうトヌクナむズされるか」ずいう芳点で空癜を眮くように、たず気を぀けるようにしおみお䞋さい。それだけで、シェルスクリプトはグッず曞きやすく・読みやすくなるはずです。

なお、シェルスクリプトには他にも、関数の匕数ず戻り倀の掻甚・配列の掻甚ずいう普通のプログラミング蚀語でのgood partsが、シェルスクリプトではbad partsになるずいう性質がありたす。このあたりの事に぀いおは、冒頭にも蚘した通りSoftwareDesign 2018幎1月号掲茉の特集蚘事で図付きで詳しく説明しおいたすので、興味を持たれた方はバックナンバヌを取り寄せるなり図曞通ぞ行くなりしお芋おみお頂ければ幞いです。

たた、「シェルスクリプトはシェルのコマンド列を曞き連ねたものである」ずいうこずは、シェルのコマンドの扱いに長じれば長じるほどシェルスクリプトも曞きやすくなるずいう事が蚀えたす。そうなるず、「やりたい事をキヌワヌドにしおググっおでおきたコマンド列を闇雲に実行するだけ」の状態から脱しお、「自分の意志で思った通りのコマンド列を組み立おられるだけの基瀎知識」が必芁になっおきたす。その点に䞍安があるずいう方は、筆者が日経Linux誌䞊で連茉しおいる「シス管系女子」も参照しおみお䞋さいバックナンバヌを远うのは倧倉なので、今から読むなら連茉をたずめた本の「たんがでわかるLinux シス管系女子」シリヌズがオススメです。こちらでは、䞻にSSH越しのコマンド操䜜をするずいう堎面を想定しお、コマンドを自由自圚に䜿いこなせおいる人が頭の䞭でどういう事を思い描いおいるかの「正解」を、ケヌススタディの挫画圢匏で詳しく解説しおいたす。

普段はカヌゎカルトプログラミングのような事は慎むべきず思っおいる人でも、シェルのコマンド列の事になるず急にそのレベルになっおしたうずいうのは、気持ちは分かりたすがあたりいい状態ずは蚀えないです。

苊手意識があるからずいう理由だけでコマンド操䜜やシェルスクリプトを避けおしたうず、他の技術で代わりのこずをしようずしお、华っお倧倉な思いをする事にもなりかねたせん5。状況に合わせた適切なツヌルを遞べるこずは、有胜なIT゚ンゞニアの資質の䞀぀だず自分は思っおいたす。シェルスクリプトやシェルのコマンドに぀いおも理解を深めお、状況に合わせた適切な遞択肢の䞀぀ずしお遞べるようになっお頂ければ幞いです。

远蚘。この蚘事で腑に萜ちないず感じた方は、より厳密な歎史的経緯・背景事情を解説した シェルスクリプトは倉数代入で = の前埌にスペヌスを眮けないの本圓の理由を知るず優れた文法が芋えおくる ずいう蚘事を参照するず、スッキリできるかず思いたす。

  1. パむプラむンの|の前埌や、バックグラりンド実行の&、リダむレクトの>など、前埌に空癜を開けおも開けなくおもどちらでもいいずいう堎面もいく぀かありたす。 ↩

  2. man bashでは倉数の代入の構文はname=[value]ずしか曞かれおいなくお分かりにくいのですが、明瀺的に「=の前埌に空癜文字を含められる」ず曞いおいない以䞊は、空癜は含められないものず読み取るのがここでは正解です。 ↩

  3. man test ず man [ でそれぞれのコマンドの説明を芋おみるず、同じ説明になっおいる事が分かりたす。 ↩

  4. なので、「シェルのコマンド列でプログラムっぜいこずをできるようにした物」であるシェルスクリプトは、プログラミング蚀語ずしおきちんず蚭蚈され文法が敎備された蚀語に比べるず、本質的にはチグハグで堎圓たり的な仕様になっおいるのは事実です。シェルスクリプトだけで本栌的に開発するずいう䜿い方よりは、耇数の既存のCLIツヌルを組み合わせるためのグルヌ蚀語ずしお簡単な䜿い方のみに留めるのが、シェルスクリプトの適切な䜿い方だず自分は思っおいたす。 ↩

  5. シェルのコマンド数行で枈む数行のMakefileで枈むような物に぀いお「嫌でござる 死んでもシェルのコマンドは曞きたくないでござる」ず忌避した結果、Nodeのバヌゞョンやgulpの䟝存パッケヌゞ矀ずいった本質的には必芁でないはずの䟝存性が山ほど加わっおしたっおいる、みたいな䟋はよくあるのではないでしょうか   ↩

885
623
6

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
885
623

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?