コマンドラインのショートオプションの大文字小文字の使い分け

投稿者: Anonymous

背景

PythonでCLIツールを作成しています。
コマンドライン引数のパースは、argparseモジュールで行っています。

考えていること

ロングオプションからショートオプション名を考えています。

質問

ショートオプションで大文字/小文字は、どう使い分ければよいですか?

Command-Line Options – The Art of Unix Programmingに載っているショートオプションには、-d-Dもありました。

上記サイトには、ショートオプションに関して、次のように述べています。

  • 大文字よりは小文字がよい
  • 大文字は、小文字オプションの特別な変形として使うのがよい

In this style, lowercase options are preferred to uppercase. When you use uppercase options, it’s good form for them to be special variants of the lowercase option.

「特別な変形」とは具体的に、どのようなことを指しているのでしょうか?

参考にしたサイト

解決

「特別な変形」とは具体的に、どのようなことを指しているのでしょうか?

Gitのbranchコマンドを例にすると、

  • -dは「ブランチの削除」で、予めマージをしていないと削除ができません。
  • -Dは「ブランチの強制削除」で、マージをしていなくても削除が出来ます (-d --force相当)。

通常の小文字オプションなら警告などが表示されるけど、大文字の入力で手間をかけさせる分その警告を無視させるようなイメージです。

回答者: Anonymous

Leave a Reply

Your email address will not be published. Required fields are marked *