関数の引数に変更しないグローバル変数を含めるべきでしょうか？

Question

そのモジュールの中では変更しないであろう変数

dirname = '/home/username/'
today = '2016-10-20'

などあった時，それらを全て使用する関数を定義するとします．
この時，

def fn(dirname, today):
    return do_something(dirname, today)

が良いのか，それとも

def fn():
    do_something(dirname, today)

が良いのか，ということに悩んでいます．

Pythonは勝手にモジュール内のグローバルスコープを参照してくれるので，わざわざ引数に明記しない方が簡潔であるように思えます．

しかし，多少長くなっても関数内で使う変数を全て引数として明記した方が，依存関係がわかりやすい方ように思えます．一体どちらが良いのでしょうか？

Answer 1

モジュールを跨ぐ場合は当然渡すことになるのですが、そのモジュール内の関数呼び出しであれば無理に渡さなくても良いかなぁと思います。

変更しないであろう変数ならば、それは

TODAY
DIR_NAME

のように大文字にしてモジュールの上のほうにでも宣言する方が良いのではないでしょうか。
そうすると、以下のように書けます。その変数を見つけることも容易になるでしょう。

def fn():
    do_something(DIR_NAME, TODAY)

グローバル変数とは言ってもモジュールレベルの話ですし、私はそこまで敬遠するものでもないと考えます。
グローバル変数をモジュール内で書き換える場合は、明示的にglobal の文の宣言が必要ですし、他のモジュールから書き換えるにもimportしなければいけません。

Comments

[IwaoWatanabe]

変更しないであろう変数であるならば、私もこちらの回答（大文字変数にして引数で渡さないスタイル）に賛同します。そして実務でそのようにコーディングしています。

[MasatakaMiyoshi]

大文字で変数というのは忘れていました．そういえばこれまで全く使ってこなかったので検討してみようと思います．

Answer 2

LLmanさんに同意。

で、もしグローバル変数を使う必要があるなら
(自分だったら)専用のget/set関数を用意して
必ずそれを通してアクセスするようにします。
ソースのどこらへんで使ってるのか調べやすいですしね。
ただし、多人数で開発しててそれを徹底するのは
難しいかもしれません。(汗

Answer 3

関数の引数に変更しないグローバル変数を含めるべきでしょうか？

関数の引数にグローバル変数は書かなくていいです。
グローバルの意味がないので、普通は書かないと思います。

---

多少長くなっても関数内で使う変数を
全て引数として明記した方が，依存関係がわかりやすい

しかし、コードの分かりやすさを考慮するくらいなら、
そもそもグローバル変数は、使わないで済むなら、なるべく使わない方が良いです。

スコープの限定による複雑性の低減が、グローバル変数への対策の本質なので、
引数に書いたからといって、グローバル変数を使用するマイナスは打ち消せないです。
引数に書くより、グローバル変数を使わないことの方がずっと重要です。

Comments

[MasatakaMiyoshi]

そうですね．今回はengine, session, configのような名前・役割の変数であり削ることが難しいので，前者の，引数を書かない方法で対処したいと思います．ありがとうございます．