Python基礎講座 #20 モジュールとパッケージ 第1回 (Module and Package – vol.1)

プログラミング言語 Python
読了 8分

今回の講座ではモジュールとパッケージについて勉強していきましょう。

モジュールとパッケージが難しい概念だと考えている方が多いのですが、モジュールとパッケージは決して難しくありません。もし難しいと考えているのであれば、概念から使い方までこの講座でしっかり理解させて差し上げます。

まずモジュールの辞書的な意味は何でしょうか？ ネイバー英語辞典でモジュールの意味はこのように定義されています。

  1. モジュール、教科目単位(特にイギリスの大学で一つの教育課程の一部となる単位)
  2. コンピュータモジュール(特定の機能をするコンピュータシステムやプログラムの単位)
  3. モジュール、組み立て部品(機械・家具・建物などを構成する規格化された部品)

これらの定義を見ると、対象はそれぞれ違いますが、いずれも大きなシステムの小さなパートや、その中の小さな部品を指しています。プログラミングにおけるモジュールも同じ意味を持っており、一つの機能を意味したり、特定の機能のために作られたコードの集合を意味したりもします。Pythonにおけるモジュールは、Pythonファイルのことを指します。

それではなぜモジュールを使うのでしょうか？コンピュータを買う時、グラフィックカード、CPU、メモリがマザーボードに付いている一体型モデルが良いでしょうか？それとも、マザーボードと分離されているモジュール型モデルが良いでしょうか？一体型はCPUやメモリが故障すると、マザーボードを丸ごと交換しなければならないか、いっそ新しいコンピュータを一台買う方がいい場合もありますが、モジュール型コンピュータは故障した部品だけ交換すれば良いので、モジュール型コンピュータの方が当然良いですよね。プログラムを作る時も同じです。

プログラムでモジュールを使わなければならない理由です。

  1. 機能ごとにファイルを分けておくと、同じ機能が必要な別のプロジェクトで再利用することができます。
  2. プロジェクトが大きくなればなるほど管理が大変になりますが、プロジェクトがうまくモジュール化されていれば管理が楽になります。
  3. コーディングがしやすくなります。一つのファイルにコードが何万行も入っていると考えてみてください。上下にスクロールするだけで時間が過ぎてしまうでしょう。

Pythonをインストールすると、Pythonと一緒にインストールされるスタンダードライブラリがあるのですが、これらはすべてモジュールでできており、これらのモジュールはc言語で作られた組み込みモジュールとPythonで作られた一般のモジュールに分かれます。Pythonで使えるすべてのモジュールを確認したい場合は、Pythonの公式ドキュメントで確認できます。

Pythonモジュールインデックス

皆さんがいつも使っているprint関数やopen関数は組み込みモジュールに入っており、Pythonインタプリタが自動でインポートするため、別途インポートしなくても使うことができます。組み込み関数である dir 関数を使うと、現在のメイン名前空間に保存されているオブジェクトを確認することができます。

Pythonコード 
print(dir())
コンソール出力 
['__annotations__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__']

__builtins__ というオブジェクトが見えると思いますが、これがPythonインタプリタが自動でインポートした組み込みモジュールです。print関数で確認してみましょう。

Pythonコード 
print(__builtins__)
コンソール出力 
<module 'builtins' (built-in)>

組み込みモジュールと出力されましたが、このモジュールの中にどんなものが入っているか見てみましょう。

Pythonコード 
print(dir(__builtins__))
コンソール出力 
['ArithmeticError', 'AssertionError', 'AttributeError', 'BaseException', 'BlockingIOError', 'BrokenPipeError', 'BufferError', 'BytesWarning', 'ChildProcessError', 'ConnectionAbortedError', 'ConnectionError', 'ConnectionRefusedError', 'ConnectionResetError', 'DeprecationWarning', 'EOFError', 'Ellipsis', 'EncodingWarning', 'EnvironmentError', 'Exception', 'False', 'FileExistsError', 'FileNotFoundError', 'FloatingPointError', 'FutureWarning', 'GeneratorExit', 'IOError', 'ImportError', 'ImportWarning', 'IndentationError', 'IndexError', 'InterruptedError', 'IsADirectoryError', 'KeyError', 'KeyboardInterrupt', 'LookupError', 'MemoryError', 'ModuleNotFoundError', 'NameError', 'None', 'NotADirectoryError', 'NotImplemented', 'NotImplementedError', 'OSError', 'OverflowError', 'PendingDeprecationWarning', 'PermissionError', 'ProcessLookupError', 'RecursionError', 'ReferenceError', 'ResourceWarning', 'RuntimeError', 'RuntimeWarning', 'StopAsyncIteration', 'StopIteration', 'SyntaxError', 'SyntaxWarning', 'SystemError', 'SystemExit', 'TabError', 'TimeoutError', 'True', 'TypeError', 'UnboundLocalError', 'UnicodeDecodeError', 'UnicodeEncodeError', 'UnicodeError', 'UnicodeTranslateError', 'UnicodeWarning', 'UserWarning', 'ValueError', 'Warning', 'ZeroDivisionError', '__build_class__', '__debug__', '__doc__', '__import__', '__loader__', '__name__', '__package__', '__spec__', 'abs', 'aiter', 'all', 'anext', 'any', 'ascii', 'bin', 'bool', 'breakpoint', 'bytearray', 'bytes', 'callable', 'chr', 'classmethod', 'compile', 'complex', 'copyright', 'credits', 'delattr', 'dict', 'dir', 'divmod', 'enumerate', 'eval', 'exec', 'exit', 'filter', 'float', 'format', 'frozenset', 'getattr', 'globals', 'hasattr', 'hash', 'help', 'hex', 'id', 'input', 'int', 'isinstance', 'issubclass', 'iter', 'len', 'license', 'list', 'locals', 'map', 'max', 'memoryview', 'min', 'next', 'object', 'oct', 'open', 'ord', 'pow', 'print', 'property', 'quit', 'range', 'repr', 'reversed', 'round', 'set', 'setattr', 'slice', 'sorted', 'staticmethod', 'str', 'sum', 'super', 'tuple', 'type', 'vars', 'zip']

組み込みモジュールには、私たちがよく使う print 関数や、今使った dir 関数も含まれていますが、組み込みオブジェクトを通じて print 関数を実行してみましょうか？

Pythonコード 
__builtins__.print('test')
コンソール出力 
test

dir 関数も実行してみましょう。

Pythonコード 
__builtins__.print(__builtins__.dir())
コンソール出力 
['__annotations__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__']

組み込みモジュールはC言語で作られてコンパイルされているため、ソースコードを直接見ることはできません。本当に気になる方は、githubでC言語で作られたソースコードを見ることができます。

組み込みモジュール

それでは今度は、Pythonで作られたモジュールたちを見ていきましょう。Pythonで作られたモジュールたちは、Pythonがインストールされているフォルダ内のLibというフォルダの中にあるので、見てみたい方は直接ファイルを開いてみてください。これらのモジュールはimportキーワードを使ってインポートした後に使うことができます。

Libフォルダにある pathlib モジュールをインポートして出力してみましょう。

Pythonコード 
import pathlib

print(pathlib)
コンソール出力 
<module 'pathlib' from 'C:\\Users\\CURTIS\\anaconda3\\envs\\aws\\Lib\\pathlib.py'>

組み込みモジュールとは違って、ファイルパスが出力されるのが分かります。

inspect モジュールは getfile という関数を含んでいますが、この関数を使ってもファイルの位置を知ることができます。

Pythonコード 
import pathlib
import inspect

print(inspect.getfile(pathlib))
C:\Users\CURTIS\anaconda3\envs\aws\Lib\pathlib.py

そして getsource という関数を使うと、実際のコードを見ることもできます。

Pythonコード 
import pathlib
import inspect

print(inspect.getsource(pathlib))
コンソール出力 
import fnmatch
import functools
import io
import ntpath
import os
import posixpath
import re
...

Pythonインタプリタは、import キーワードでモジュールをインポートすると、sys.path に保存されているパスを一つずつ探して、モジュールを探します。これらのパスは、実行ファイルがある現在のフォルダ 👉 PYTHONPATH 環境変数に保存されているパス 👉 Pythonインストールパスの順序になっています。sys.path に保存されているパスを出力してみましょう。

Pythonコード 
import sys

print(sys.path)
コンソール出力 
['C:\\Users\\CURTIS\\Dev\\Python\\aws', 'C:\\Users\\CURTIS\\anaconda3\\envs\\aws\\python311.zip', 'C:\\Users\\CURTIS\\anaconda3\\envs\\aws\\DLLs', 'C:\\Users\\CURTIS\\anaconda3\\envs\\aws\\Lib', 'C:\\Users\\CURTIS\\anaconda3\\envs\\aws', 'C:\\Users\\CURTIS\\anaconda3\\envs\\aws\\Lib\\site-packages']

それでは今からカスタムモジュールを作ってみましょう。現在のフォルダにモジュールファイルを一つ作成します。一般的にモジュールファイルの名前は、モジュールの機能を説明する名前がよく使われます。ゲームで攻撃をする機能を入れたモジュールを作ってみましょう。attack.py というファイルを作って、簡単に print 関数を実行するコードを入力し、main.py ファイルから使ってみましょう。

attack.py 
print('attack モジュールをインポートしました。')
main.py 
import attack

単純にインポートだけしてコードを実行してみましょう。

コンソール出力 
$ python main.py 
attack モジュールをインポートしました。

インポートしただけなのに、モジュール内の print 関数が実行されたのが分かります。この理由は、モジュールがインポートされると現在の名前空間にロードされるため、モジュール内のすべてのコードが実行されるからです。

今度はモジュール内に関数を定義してみましょう。

attack.py 
print('attack モジュールをインポートしました。')

def arrow():
    print('シュシュシュッ！ 矢で敵にダメージを50与えました。')

def fireball():
    print('ドカン！ ファイアボールで敵にダメージを100与えました。')

モジュールをインポートする方法はいくつかありますが、モジュール内のすべてのコードをインポートしたい場合は、下のコードのようにインポートすれば大丈夫です。インポートしたら、名前空間にどんなものが保存されるか見てみましょう。

main.py 
import attack

print(dir())
コンソール出力 
['__annotations__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', 'attack']

ご覧の通り、このようにインポートすると、モジュール名だけ見えて関数名は見えません。モジュール内の関数を使いたい場合は、モジュール名を通じてアクセスすることができます。攻撃をしてみましょう。

main.py 
import attack

attack.arrow()
attack.fireball()
コンソール出力 
$ python main.py 
attack モジュールをインポートしました。
シュシュシュッ！ 矢で敵にダメージを50与えました。
ドカン！ ファイアボールで敵にダメージを100与えました。

攻撃がうまくできました。😁

時々名前がとても長いモジュールがありますが、毎回長いモジュール名を入力するのが面倒だという場合は、下のコードのように as キーワードでエイリアス(別名)を付けて使うこともできます。

main.py 
import attack as att

att.fireball()
コンソール出力 
$ python main.py 
ドカン！ ファイアボールで敵にダメージを100与えました。

エイリアスも面倒、そもそもモジュール名自体を使いたくないという方は、from キーワードとアスタリスクを使ってインポートすれば大丈夫です。from キーワードでインポートして、名前空間にどんなものが保存されているか見てみましょう。

main.py 
from attack import *

print(dir())
コンソール出力 
['__annotations__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', 'arrow', 'fireball']

今度はモジュール名は見えず、関数名だけが保存されているのが分かります。このようにインポートすると、すぐに関数名を使って関数を呼び出すことができます。

main.py 
from attack import *

arrow()
fireball()
コンソール出力 
シュシュシュッ！ 矢で敵にダメージを50与えました。
ドカン！ ファイアボールで敵にダメージを100与えました。

もしモジュールのサイズが大きく、いくつかの関数だけを使いたい時は、必要な関数だけインポートして使う方が効率的です。

main.py 
from attack import arrow, fireball

arrow()
fireball()

モジュールについての整理はここまでとし、次回はパッケージを取り上げます。

参考リンク：Pythonモジュールリスト

X