def文で機能定義しながらプログラムを書く時のデバッグ法

Question

プログラムの構造として、以下の例のように、def文で機能を定義し、メイン実行部でどの機能を使うかを指定する記載方法をよく見かけます。この方法だと各機能が明確になるし、変数が混乱しないのでわかりやすいのですが、いざ採用してみると、各関数のデバッグが面倒という問題にぶつかっています。

例えば関数Aをデバッグする時には、x=30とかx=10など、値をいろいろと代入した方がわかりやすいのですが、変数の数が多くなると、いちいち手で値を代入するのが面倒です。そこで、この構造を使いつつ、デバッグしやすい方法を教えていただけないでしょうか？

ちなみに、PyCharmを使っているので、使いこなしてはいないものの、デバッガはあります。

def A(x):
    return x**2

def B(x):
    return x+300

def C(x):
    return 2*x

# メイン実行部
print(C(B(A(100)))) # 20600

##以下追記
質問が曖昧との指摘をいただいたので、もう少し具体的に例を挙げてみました。

前者はdefを使わない例です。

この場合、各処理（3倍したり2乗したり正規化したりするなど）の機能修正は上から順にスクリプトを処理していけば実施できる一方、プログラムが長くなってくると、各機能がわかりにくくなってくるデメリットがあります。

一方、後者のdefを使った場合、各関数で何をやっているのかがわかりやすくなり（この例だと短いのであまり意味がないですが）、各機能で機能修正もしやすいなどのメリットがあります。

ただ、**後者で機能修正/追加する場合、以下の操作をしないといけないため、面倒と感じてしまいます。そこで、もっとよりやり方はないでしょうか？というのが質問の意図です。**その対応の1つとして、test機能を使ったら？という回答をいただきました。

1. def文を使わない形に直す
2. xを100とか10など入力して機能修正/追加（変数の数が多いと特に面倒）
3. またdef文にしてreturnを定義する

defを使わない場合

import pandas as pd

df = pd.DataFrame([[1,50,100],[5,12,200],[6,23,335]],columns=['A','B','C'])

df['A'] = df['A'] * 3  # 3倍する
df['B'] = df['B'] **2  # 2乗する
autoscale_df = (df-df.mean())/df.std() # 正規化する

defを使う場合

# 機能定義部
def multiply_3(x):
    return x * 3

def square(x):
    return x**2

def autoscale(df):
    return (df-df.mean())/df.std()

# メイン関数
df = pd.DataFrame([[1,50,100],[5,12,200],[6,23,335]],columns=['A','B','C'])
df['A'] = multiply_3(df['A'])
df['B'] = square(df['B'])
autoscale_df = autoscale(df)

Comments

[退会済みユーザー]

PyCharmは使っていないので、よく分かりません。
デバッグというのは通常プログラムを手で逐次的に実行(ステップ実行)することを指し、その名のとおりバグ取りを目的とした作業です。
それに対して、関数などを対象として、入力などの異なるテストケースを作り、想定通りに出力されるかどうかを確認する、テストという作業もあります。

質問者さんは恐らくこのテストを想定しているのかと思います。テストは通常、対象となる関数などを個別にテストする小さい別のプログラムになります。PyCharmにもそういうテストコードを効率的に書く機能があるようなので、詳しくはそちらを御覧ください。どんなものか分かると思います。

なお、恐らく楽にはなりません。

[MagMag]

dameo様。ありがとうございます。おっしゃるとおり、テストという意味の方が正しいと思います。いずれにしろ、テストするに当たって、変数をいちいち入力する手間を減らしたいというのが趣旨です。

def文を使わずに、データ読み込み→データ処理という流れでプログラムを書くと、読み込んだ変数を使ってデータ処理のテストできるので、テストにあたって、変数を再入力しなくていい、という意味です。

[退会済みユーザー]

えーっと…とりあえずPyCharmのマニュアルのテストのページが↓です。
https://pleiades.io/help/pycharm/testing-your-first-python-application.html

書いたとおり読めば分かると思いますが、これは入力変数をいちいちコーディングするということです。
そして、その変数を入力とした結果のassertionを行い、テスト結果としています。
最近の(ユニット)テストはこのようなコーディングと、その実行をもって行うことが一般的だと思います。

[quickquip]

> 変数の数が多くなると、いちいち手で値を代入するのが面倒です
ここが具体的でなく、いま、「どこに」「どうやって」入力していると言ってるのか、「なにが」面倒だと思っているかが伝わっていません。
こうやってるんだろうなあ、というのを勝手な想像するのも時間の無駄です。回答者は他の読んで分かる質問に移った方がいいと判断してしまいます。
特に、勝手な想像を元にこうやったらどうです? みたいな回答をして、それがあなたがすでにやっていることだったら本当に完全な無駄な時間になってしまいますから。

[退会済みユーザー]

ちょっとややこしくなりそうなので、私のコメントの趣旨をハッキリ言ってしまいますね。

質問者さんが「手間」と言っていることは普通の人は何とも思ってない程度の作業量で、一般にテストというのは市販ツールですら、ここまでのことをする前提の作業なのですよ、ということです。

では私はこの辺で失礼します。

[MagMag]

ありがとうございます。テスト機能を使っていなかったので、それを使うことを考えます。

Answer 1

デバッグではなく、テストを書くのはいかがでしょう？
ソースコードに使い方をdoctest形式で書いておいてテストするのが便利です。

"""
>>> print(C(B(A(100))))
20600
"""

def A(x):
    """
    >>> A(-3)
    9
    >>> A(100)
    10000
    """
    return x**2

def B(x):
    """
    >>> B(-400)
    -100
    >>> B(100)
    400
    """
    return x+300

def C(x):
    """
    >>> C(-3)
    -6
    >>> C(100)
    200
    """
    return 2*x

# メイン実行部
if __name__ == '__main__':
    print(C(B(A(100)))) # 20600

テスト実施

$ python3 -m doctest -v example.py
Trying:
    print(C(B(A(100))))
Expecting:
    20600
ok
Trying:
    A(-3)
Expecting:
    9
ok
Trying:
    A(100)
Expecting:
    10000
ok
Trying:
    B(-400)
Expecting:
    -100
ok
Trying:
    B(100)
Expecting:
    400
ok
Trying:
    C(-3)
Expecting:
    -6
ok
Trying:
    C(100)
Expecting:
    200
ok
4 items passed all tests:
   1 tests in example
   2 tests in example.A
   2 tests in example.B
   2 tests in example.C
7 tests in 4 items.
7 passed and 0 failed.
Test passed.