Python 関数を複数使用するスクリプトの構造に関して

Question

質問したいこと

現在、業務でスクリプトを作成しています。
関数を複数使用するスクリプトを作成する場合のベストプラクティスを知りたいと思っています。
例えば、スクリプトの内容は以下になります。

作成内容

1. Aという値を作成する
2. Bという値をAから作成する（作成するにはAのIDが必要）
3. Cという値をBから作成する（作成するにはBのIDが必要）

###スクリプトの例１

def method01():
  value01 = 'create_value'
  return value01

def method02():
  value01 = method01()
  value02 = value01 + '例1'
  return value02

def method03():
  value02 = method02()
  value03 = value02 + '例2'
  return value03

if __name__ == '__main__':
  method03()

このスクリプトは実際、私が作成しているものと似た作りになっています。（見苦しいコードですみません。。）

こういった場合は、以下の例２のように作成するのが正解でしょうか？

###スクリプトの例2

def method01():
  value01 = 'create_value'
  return value01

def method02(val01):
  value02 = val01 + '例1'
  return value02

def method03(val02):
  value03 = val02 + '例2'
  return value03

if __name__ == '__main__':
  first = method01()
  second = method02(first)
  third = method03(second)

また、一つ目の関数がエラーなく実行された場合のみ、二つ目の関数が実行される。二つ目の関数がエラーなく実行された場合のみ三つ目の...という処理を実装する場合は最後のif __name__ == '__main__':以下にif文を作成するというやり方がシンプルで良いのでしょうか？

###スクリプトの例3

def method01():
# エラーでなければvalue01にvalue01が入ると仮定
  value01 = request.post('https://test.co.jp', headers='test_headers', data='test_data')
  if value01.status_code == 404:
    value01 = 'False'
  return value01

def method02(val01):
# エラーでなければvalue02にvalue02が入ると仮定
  value02 = request.post('https://test.co.jp', headers='test_headers', data=val01)
  if value02.status_code == 404:
    value02 = 'False'
  return value02

def method03(val02):
  value03 = val02 + '例2'
  return value03

if __name__ == '__main__':
  first = method01()
  if first == 'value01'
    second = method02(first)
  if second == 'value02'
    third = method03(second)

3つ目の例くらいしか思い浮かばなかったです・・・。
ただ、本来はレスポンスの値が固定値ではないため、こんな書き方はできないと思います。
皆さんならこうする、もしくはこうした方が良いという書き方を教えていただけませんか？
よろしくお願いいたします。

Answer 1

まず、関数同士は関係性を低くすると流用しやすいしデバッグもしやすいです。
そういう意味では例１より例２ですね。

次に、流れの制御ですが…
関数からの戻りを結果とデータのタプルにして、受け側では結果をみて判定する
というかたちにすると、他の人がみたときに分かりやすいかもしれません。

あと、どこまで実行されたか(どこでエラーが起きたか)などをおさえておく
必要があるなら少し工夫が必要になりますかね。

Comments

[stwebyy]

回答ありがとうございます！
仰る通り、独立性がある方が良いというのは認識していました。
そうすると例２の方が良さそうですね。

また、確かに返り値を2つというのは他の人から見たらわかりやすそうです。
業務のスクリプトもそれで作成してみようと思います。
参考にさせていただきます。

Answer 2

自分がやるとしたらでの回答になりますが自分なら例2のやり方を採用します。

また、一つ目の関数がエラーなく実行された場合のみ、二つ目の関数が実行される。

エラー処理に関しては2つやり方が考えられて

1. 例外を投げられるものなら例外を投げて処理する方法
2. 関数からの戻り地をチェックしてif-elseで分岐してスクリプトを終了する方法

補足として例3のスクリプトのコードでTrue/Falseを文字列で扱ってしまっているのでそこは修正したほうが良いです。あとは他の言語のnullと似た値としてNoneがあるのでこの値をエラー処理のために返すといった方法もあります。

  if value01.status_code == 404:
    value01 = False

Comments

[stwebyy]

ありがとうございます！
やはり例２のやり方ですよね。
また、True、Falseの件ご指摘ありがとうございます。
うっかり文字列にしてしまいました。
無意識でも文字列にしないように気をつけていきたいと思います。