Python

Python 関数

関数とは、ある処理をひとまとめにして名称を付けたものです。
何回も使う処理(データ集計や計算など)を、関数としてまとめることで使いやすくなります。

Python 関数の種類

簡単に分けると次のような3種類になります。

組み込み関数

標準装備の関数のことです。
import せずに使うことができます。

次のような関数が組み込み関数です。

print()、type()、abs()、sum() などで、画面表示や計算などがあります。

import で使用できる関数

「他のモジュール」を読み込んで(import)、その中の関数やクラスを使えるようにする仕組みです。

>>> import math         # math をインポート
>>> math.sqrt(9)        # math の sqrt を実行
3.0                     # 結果 -> 3.0

補足ですが import できるのはモジュールだけでなく パッケージ、サブモジュール、フォルダ などもできます。

自分で作成した関数はどうする?

VSCode や テキストエディタで作成したファイルは、他のモジュールと同じように import することで使用できます。

>>> import test

作成した test.py を import する記述です。

他のモジュールやパッケージと同様に扱えます。

関数の形式

標準的な関数の書き方

関数は、下記のような形式で記述します。

def 関数名(引数1, 引数2):              # *A
    """                              # *B
    関数のタイトル(概要)

    関数の詳細説明を書く(複数行可)

    パラメータ
        引数1 (型): 引数1の説明
        引数2 (型): 引数2の説明

    戻り値
        戻り値の型: 戻り値の説明

    使用例
        >>> 関数名(1, 2)
        3
    """

    処理(関数のコーディングを記述)  # *C

    return 戻り値           # *D

*A def で関数名とパラメータを記載します。

def calc_add( a, b ):

*B 関数の説明文(ドキュメント)を記載します。

""" と """ で囲んだ部分がドキュメントです。
help で表示することができるのが「ドキュメント」です。
誰が見てもわかるように記述しておきましょう。

    """ 関数名  :calc_add
        パラメータ:a, b
        a と b を加算して返す
    """

*C 処理を記載します。

プログラムを記述する部分です。

    c = a + b

*D 戻り値を記載します。

    return c

関数のサンプル

def calc_add( a, b ):
    """ 関数名  :calc_add
        パラメータ:a, b
        a と b を加算して返す
    """
    c = a + b        # 処理
    return c         # 結果を返す

-Python