【初級】 pythonでモジュールを使う

記載日2023/02/05
モジュールのファイル構成が独特で、少し理解しずらかったので、備忘録として記述します。

なお、クラスとモジュールの使い分けについても考えたので、もし興味がある方はこちらも見てみてください。

流れ

まず、モジュールのファイル構成やコード記述の概要を記載します。
次に、具体的に機能をコードに書いてみます。

ファイル構成や書き方

参考サイトによると、ディレクトリ名にモジュールの名前を書き、そのディレクトリ内の__init.py__に機能を記載するのが一般的みたい。
__init__.pyにはメソッド（def）を記述する（classは記述しない）。

プロジェクト
　|
　|ーモジュール名
　|　　|
　|　　|－__init__.py
　|
　|ーMain.py

# __init__.py
import XX

def method():
    return YY

具体例

モジュールを使って以下機能を記述したコード例を記載する。
・引数2つの和と差をコンソールへ出力する。

ファイル構成は以下の通り。

　プロジェクト
　　|
　　|－Calc
　　|　　|
　　|　　|－__init__.py
　　|
　　|－Main.py

Calcモジュールでは足し算と引き算のメソッドを持つ。ディレクトリCalcの下に__init__.pyを配置して、Calcモジュールを構成する。
Main.pyでは、モジュールのメソッドを呼び出してコンソールに和と差を出力する。

Calc/__init__.pyのコード

def Sum(a, b):
    return a+b

def Sub(a, b):
    return a-b

Main.pyのコード

import sys
import Calc as CalcM

def Main():
    print(CalcM.Sum(int(sys.argv[1]),int(sys.argv[2])))
    print(CalcM.Sub(int(sys.argv[1]),int(sys.argv[2])))

    # > 実行すると和の5と差の1が出力される。
    # > python Main.py 3 2
    # > 5
    # > 1

if __name__=="__main__":
    Main()

参考にさせて頂いたサイト

・ファイル構成について
https://rinatz.github.io/python-book/ch04-07-project-structures/