Pythonで自作モジュールを作る方法を現役エンジニアが解説【初心者向け】

初心者向けにPythonで自作モジュールを作る方法について現役エンジニアが解説しています。モジュールとは、関数やクラスの集まりのことです。Pythonの自作モジュールの作成方法や、読み込み方法などについて解説します。またPythonのモジュールをパッケージ化する方法についても解説します。

TechAcademyマガジンは受講者数No.1のオンラインプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。

Pythonで自作モジュールを作る方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。

そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプPython講座の内容をもとに紹介しています。

 

田島悠介

今回は、Pythonに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

Pythonで自作モジュールを作る方法について詳しく説明していくね!

大石ゆかり

お願いします!

この記事ではPythonにおいて自作モジュールを作る方法と、それをパッケージ化して使う方法について解説します。

目次

 

自作モジュールの実装方法

まずは、自作「モジュール」の実装の仕方について説明していきます。

「モジュール」というのは、「関数やクラスの集まり」といったイメージです。この「モジュール」を作るには、単純に関数やクラスを定義したPythonファイルを作成するだけで良いので、簡単かと思います。

例えば、

Hello

という文字列を表示するhello()関数をモジュールとして使いたい場合は、

「function.py」という名前で、

def hello():
    print('Hello')

を保存します。これでモジュールは完成です。このモジュールを使うには、モジュールの保存先と同じディレクトリで、

>>> import function
>>> function.hello()

とすれば良いです。以上をまとめると、モジュール名.py」という名前で関数やクラスを保存して、同じディレクトリで、

import モジュール名
モジュール名.関数名

もしくは、

モジュール名.クラス名

という手順を踏むことでモジュールの作成と使用ができます。

[PR] Pythonで挫折しない学習方法を動画で公開中

自作モジュールをパッケージ化する方法

次に、自分で作ったモジュールを「パッケージ化」する方法について説明します。

「パッケージ化」というのは「モジュールを集めてまとめたもの」というイメージです。パッケージとして扱うことによって、いろいろな機能ごとにプログラムを呼び出すことが容易になります。

自作モジュールをパッケージ化する方法ですが、

  • 「パッケージ名」を名前にしてフォルダを作る
  • フォルダ内に「__init__.py」という空ファイルを作成

の2つの手順を踏めば良いです。例えば、先程作ったfunctionモジュールを「tool」という名前でパッケージにする場合は、

tool
│─ function.py
└─__init__.py

という形でディレクトリ構造を作りましょう。

自作モジュールをインポートする方法

パッケージ化したモジュールを使うには、同じディレクトリで、

from パッケージ名 import モジュール名

とすれば、モジュールを使うのと同じように使うことができます。上で作ったtoolパッケージのfunctionモジュールを使う場合は、

>>> from tool import function

とすれば、

>>> function.hello()

のようにしてモジュールで定義された関数やクラスを使うことができます。

まとめ

この記事ではPythonにおいてモジュールを自分で作る方法、そしてそれらをパッケージ化する方法を解説しました。コード量が多くなってくると必ずと言っていいほど必要になってくるので参考にしてみてください。

監修してくれたメンター

メンターOS

AIプログラミングを使って開発を行う。

プログラミング歴は約3年でPythonは割と得意。好きな物理理論は一般相対性理論で動物も好き。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でもPythonを使った人工知能(AI)や機械学習の基礎を習得できるオンラインブートキャンプPython講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。