フラグ変数の使用を避ける方法が知りたいです

Question

プログラミング初心者です。
フラグ変数は可読性を下げるため良くないと聞きましたが、どのように使用を避ければいいのかわかりません。
フラグ変数を使わない場合、以下のコードはどのように書けるのでしょうか？

def argCheck():
	args = sys.argv
	flag = False

	if len(args) != 2:
		flag = True
	if args[1].split('.')[1] != 'txt':
		flag = True

	if flag:
		print('Invalid arguments')
		sys.exit(1)

Answer 1

目的は、読みやすさ（可読性）なので、フラグを使って可読性が下がると思えば止めれば良いし、可読性が上がると思えば使えば良いです。

その前にバグの無いコードを書くことが大事ですが。

・len(args)が1の時でもargs[1]を参照している
・args[1]に.が含まれない場合を考慮していない

エラーかどうかの条件判断を一つのif文で行えばフラグは要らないです。

def argCheck():
    if len(sys.argv) == 2 and "." in sys.argv[1] and sys.argv[1].split(".")[1] == "txt":
        pass # check OK
    else:
        print('Invalid arguments')
        sys.exit(1)

少し改善すると、

def argCheck():
    if len(sys.argv) == 2 and sys.argv[1][-4:] == ".txt":
        pass # check OK
    else:
        print('Invalid arguments')
        sys.exit(1)

Comments

[pepperleaf]

if の条件を反転させると、 else が不要になる?
もっとも可読性に関して不明。
(細かな話)

[otn]

今回は、正常ケースを記述する方が読みやすいですね。
if not ( ～～ ):
でもいいのですが。

[movswr]

回答ありがとうございます。バグ見落としていました。可読性は一概に下がるわけではないんですね。参考になります。

Answer 2

一般的には、他に方法がない場合はフラグを使いたい部分を別関数にすることで避けることができます。

def argCheckSub(args):
    if len(args) != 2:
        return 'error', 'this command accept one option only'
    elif args[1].split('.')[1] != 'txt':
        return 'error', 'please specify ".txt" file'
    else:
        return 'OK', 'OK'

def argCheck():
    result, message = argCheckSub(sys.argv)
    if result == 'error':
        print(message)
        sys.exit(1)
    else:
        pass

このようにしておくことで、argCheckSubだけのテストも簡単にできるようになります。

>>> argCheckSub(['', 'a.txt'])
('OK', 'OK')
>>> argCheckSub(['', 'atxt'])
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 4, in argCheckSub
IndexError: list index out of range

このエラーが出るのは、atxt のように"."のない名前の場合です。エラーが簡単に検出できることは、保守性向上にもつながりますので、別関数化は役に立ちます。

Comments

[movswr]

回答ありがとうございます。エラーを細かく分けれるので良さそうですね。とても参考になりました。

Answer 3

    if (len(args) != 2) or (args[1].split('.')[1] != 'txt'):
        どーたらこーたら

まあ、一概にフラグは悪、というわけではないです。
フラグを使うことでわかりやすくなるとか、見通しが良くなるのであれば、どしどし使うべきです

Comments

[movswr]

回答ありがとうございます。一概に下がるわけではないんですね。参考になりました。