質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

90.48%

  • Python

    8545questions

    Pythonは、コードの読みやすさが特徴的なプログラミング言語の1つです。 強い型付け、動的型付けに対応しており、後方互換性がないバージョン2系とバージョン3系が使用されています。 商用製品の開発にも無料で使用でき、OSだけでなく仮想環境にも対応。Unicodeによる文字列操作をサポートしているため、日本語処理も標準で可能です。

pythonの関数の見やすい並べ方

解決済

回答 4

投稿

  • 評価
  • クリップ 1
  • VIEW 2,655

minato_hy

score 34

pythonのファイル内にいくつか関数を作っているのですが,その並び方が見にくいというか汚いような気がしています.
例えば以下のように,最初にメインの関数calc_all()があり,それ以降には関数calc_all()内で使われる関数を列挙する,というような感じになっています.
ここにcalc()内で使われる関数やらcalc()とview()を使う別の関数やらが追加されると,後から見直したときに,見にくかったり目的の関数を探しにくかったりすると思うのですが,何か見やすい構成などのアイデアはありますでしょうか?
関数を切り分けすぎなのか,別々のファイルに機能ごとにまとめたりした方がいいのか,常套手段的なものがあれば助言をいただけますとありがたいです.
def calc_all():
    calc()を何度も実行
    view()を実行
    write_result()

def calc():
    ある計算をする

def view():
    計算結果を表示

def write_result()
    結果をファイルに書き出す

if __name__ == '__main__':
    calc_all()
  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 4

checkベストアンサー

+1

関数は適切な名前がつけられていれば適度に分割されていたほうが読んだときに理解しやすく、また修正や確認、テストもしやすくなります。
例の場合ですと、計算(calc)と表示(view)とファイルへの書き出し(write_result)と機能別に分かれているので、細かく分け過ぎということはないと思います。

個人的には、例のようなコードですとクラスを使ってまとめるのがいいと思います。

例えば以下のようにできるかと思います。

class Calc(object):
    def __init__(self, filename=None):
        # 例えば、結果を書き出すファイルを最初に指定する
        self.filename = filename
        # 結果を保存しておくリストを持たせるとか
        self.results = []

    def run(self):
        self.calc()
        self.view()
        self.write_result()

    def calc(self):
        # ある計算をする
        ...
        # 結果をリストに追加しておくとか
        self.results.append(result)

    def view(self):
        # 計算結果を表示
        print(self.results)

    def write_result(self)
        # 結果をファイルに書き出す
        if self.filename is not None:
            with open(self.filename, 'w') as f:
                f.write(self.results)


if __name__ == '__main__':
    calc = Calc('a.log')
    calc.run()

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+1

個人的主観なのですが,「calc_all」という関数名が違和感があります.

関数名自体は利用されうるものだとは思うのですが,内部処理で「計算」,「表示」,「出力」を全てしており,関数名からプログラムの内容を推測できません.個人的にはcalc_all関数をは"calc()を何度も実行"部分だけにして,main関数にてcalc_all,view,write_resultを呼び出したほうが見やすいと思います.

def calc_all():
    calc()を何度も実行

def calc():
    ある計算をする

def view():
    計算結果を表示

def write_result()
    結果をファイルに書き出す

if __name__ == '__main__':
    calc_all()
    view()
    write_result()

もう一つ言うのであれば,calcだけでは何の計算をしているのかわからないので,もう少し明確な命名をすると良いのかもしれませんね.

個人的に,命名を良くすることはプログラムの構成につながります.それに適した名前を付けることで処理内容を明確にし,関数内では複数の処理を実行しようとせず単体の処理を記述すると,見やすいコードになると思います.プログラムにもよるのでしょうが,オブジェクト指向を意識すれば構造も綺麗になっていくと思いますよ.極端な例ですが,参考スライドを貼っておきます.なかなか面白いので軽く参考にしてみてください.
オブジェクト指向できていますか?

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2015/07/01 09:42

    書き忘れましたが,何処にどのような関数があるか負えなくなってしまう場合は,統合開発環境等の関数定義位置に飛んでくれるエディタを利用することを推奨します.

    キャンセル

  • 2015/07/13 15:23

    上記の関数は例示のために適当に作ったものです、解りにくくて申し訳ないです
    「オブジェクト指向できていますか?」やリーダブルコードなど以前に読んで実践したいと考えているところですが、とても面白いですよね
    ご紹介ありがとうございます

    キャンセル

+1

プログラムを学び始めだと、なかなかオブジェクト指向の実践も大変だと思います。

まずは構造化の意味で関数の汎用化を行い、定数定義はいちばん上に、メインルーチンをいちばん下に書き、順次呼び出される関数をメインルーチンの上に上に書いていき、一連の処理にまつわる関数はなるべく近くにまとめておくなど、自分なりにルールを作った方が良いかと思います。

まとめ方が分かってきたら、なるべく早いうちに部品化をしきちんとオブジェクト指向を実践するのが幸せかと思います。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2015/07/13 15:18

    なるほど……
    やはり何度もプログラムを書いて自分の解りやすい整理の仕方を見つけるしかないのですね

    キャンセル

0

別々のファイルに機能ごとにまとめたりした方がいいのか

関係無いものを1ファイルに置けばそりゃ整理されていないように感じるでしょう。
ただ、規模によりけりです。

見づらいなと感じたら分割しましょう。
読むときにも脳内メモリが圧迫されずに済みます

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

関連した質問

同じタグがついた質問を見る

  • Python

    8545questions

    Pythonは、コードの読みやすさが特徴的なプログラミング言語の1つです。 強い型付け、動的型付けに対応しており、後方互換性がないバージョン2系とバージョン3系が使用されています。 商用製品の開発にも無料で使用でき、OSだけでなく仮想環境にも対応。Unicodeによる文字列操作をサポートしているため、日本語処理も標準で可能です。