Pythonの特殊変数__all__について現役エンジニアが解説【初心者向け】
初心者向けにPythonの特殊変数__all__について現役エンジニアが解説しています。パッケージからモジュールをインポートするときの設定で用いられるもので、インポートするモジュール名をリストにして定義することができます。特殊変数__all__の書き方や使い方について解説します。
テックアカデミーマガジンは受講者数No.1のプログラミングスクール「テックアカデミー」が運営。初心者向けにプロが解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。 ※ アンケートモニター提供元：GMOリサーチ株式会社 調査期間：2021年8月12日～8月16日 調査対象：2020年8月以降にプログラミングスクールを受講した18～80歳の男女1,000名 調査手法：インターネット調査
Pythonの特殊変数__all__について、TechAcademyのメンター（現役エンジニア）が実際のコードを使用して、初心者向けに解説します。
Pythonについてそもそもよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。
なお本記事は、TechAcademyのオンラインブートキャンプ、Python講座の内容をもとに紹介しています。
今回は、Pythonに関する内容だね！
どういう内容でしょうか？
Pythonの特殊変数__all__について詳しく説明していくね！
お願いします！
この記事では、Pythonにおいてインポートの制限のために利用する__all__という特殊変数の使い方について解説します。
目次
特殊変数__all__とは
特殊変数__all__というものは、パッケージからモジュールをインポートするときの設定で用いられるものです。Pythonにおいて、基本的には、
from パッケージ名 import *
とすると、パッケージ内に存在するすべてのモジュールをインポートする処理を意味します。
しかしながら、パッケージを作ったときに、すべてのモジュールをインポートしたくない場合や、すべてをインポートしようとすると長時間かかってしまう場合などがあります。
そのような問題を解決したい場合に用いられるのが「特殊変数」__all__です。__all__を使うことで、
from パッケージ名 import *
としたときに、インポートするモジュールを指定することができます。
__all__の使い方
__all__の使い方について説明します。
__all__は、パッケージを作成するときに必要な__init__.pyの中で用います。__init__.pyの中に
__all__ = ["モジュール名1", "モジュール名2", "モジュール名3", ....]
と__all__変数をインポートするモジュール名をリストにして定義しておきます。こうすることで、
from パッケージ名 import *
としたときに、リストで指定したモジュールのみをインポートするように制限できます。
実際に使ってみよう
それでは、実際にコードを書いて、特殊変数__all__を使ってインポートするモジュールを指定する方法を確認してみましょう。
まずは、次のようなディレクトリ構造を準備してください。これは、greetという名前のパッケージの構造となっています。
greet │--__init__.py │--hello.py │--goodbye.py
それぞれのファイルの中身は、
__init__.py
__all__ = ["hello"]
hello.py
def print_hello():
print("hello")
goodbye.py
def print_goodbye():
print("goodbye")
となっています。
__init__.pyでは、特殊変数__all__を使って、*でimportしたときにhelloモジュールのみをimportするということを指定しています。
hello.pyとgoodbye.pyではそれぞれ、”hello”と”goodbye”をprint関数で出力するものです。
上のディレクトリが存在するパスで、Pythonの対話モードで
>>> from greet import *
を実行し、hello_print()関数を使うと、
>>> hello.print_hello() hello
となり、helloモジュールがインポートされていることが確認できます。
一方、goodbyeモジュールについては
>>> goodbye Traceback (most recent call last): File "<stdin>", line 1, in <module> NameError: name 'goodbye' is not defined
と表示されて、*を使ってもインポートされていないことが確認できます。
また、直接指定して、
>>>>>> from greet import goodbye >>> goodbye.print_goodbye() goodbye
のようにすることで、goodbyeモジュールをインポートできます。
コスパとタイパ、両方結果的に良くなる良くなる学び方とは？
「スクールは高いし時間も縛られて効率が悪い」と考える方は多いと思います。
もちろん、時間も費用もかかることは間違いありません。
ただ
結果的に無駄な学びにお金も時間もかける方がリスクが高いという考えもあります。
コスパ・タイパ最適化の参考として、
テックアカデミー卒業生がスクールを選んだ理由
をご紹介します。
- ・困ったときに、質問や相談できる相手がいるため挫折しなかった
- ・プロとして必要なスキルのみを深く学べたので無駄がなかった
- ・副業案件の提供と納品までのサポートがあったので目的を達成できた
安価・短期間で広く浅く学んでも意味がありません。
本当に自分の目的が達成できるか、それが重要です。
自分にどのスキルや学び方が合っているか、どんな学習方法かなど、お気軽に
無料相談
に参加してみませんか？
カウンセラー・現役のプロへ、何でも気軽に無料相談可能。
30分か60分お好きな時間が選べて、かつ3回まで
すべて無料で
ご利用できます。
無理な勧誘は一切ない
ので、お気軽にご参加ください。
まとめ
この記事では、Pythonにおいてパッケージにおいてモジュールのインポートを制限する特殊変数__all__の使い方について解説しました。
自分でパッケージを作る際などに使ってみてください。
監修してくれたメンター
| メンターOS
AIプログラミングを使って開発を行う。 プログラミング歴は約3年でPythonは割と得意。好きな物理理論は一般相対性理論で動物も好き。 |
内容分かりやすくて良かったです！
ゆかりちゃんも分からないことがあったら質問してね！
分かりました。ありがとうございます！
TechAcademyでは、初心者でも、Pythonを使った人工知能（AI）や機械学習の基礎を習得できる、オンラインブートキャンプを開催しています。
また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。
プログラミングを独学で学習していて、このように感じた経験はないでしょうか？
- ・調べてもほしい情報が見つからない
- ・独学のスキルが実際の業務で通用するのか不安
- ・目標への学習プランがわからず、迷子になりそう
テックアカデミーでは、このような
学習に不安を抱えている方へ、マンツーマンで相談できる機会を無料で提供
しています。
30分間、オンラインでどんなことでも質問し放題です。
「受けてよかった」と感じていただけるよう
カウンセラーやエンジニア・デザイナー
があなたの相談に真摯に向き合います。
「自分に合っているか診断してほしい」
「漠然としているが話を聞いてみたい」
こんなささいな悩みでも大丈夫です。
無理な勧誘は一切ありません
ので、まずはお気軽にご参加ください。
※体験用のカリキュラムも無料で配布いたします。（1週間限定）
