Pythonのスクリプト(ファイル名)に関する命名規則を現役エンジニアが解説【初心者向け】

初心者向けにPythonのスクリプト(ファイル名)に関する命名規則について解説しています。ファイル名やクラス名などは好きなように付けても問題ないのですが、小規模なプログラム以外は混乱の原因になりますので命名規則を利用しましょう。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が2,000以上あります。

Pythonのスクリプト(ファイル名)に関する命名規則について解説します。

Pythonについてそもそもよく分からないという方は、Pythonとは何なのか解説した記事をまずご覧ください。

 

なお本記事は、TechAcademyのPythonオンライン講座の内容をもとにしています。

 

田島悠介

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

大石ゆかり

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

田島悠介

スクリプト(ファイル名)に関する命名規則について詳しく説明していくね!

大石ゆかり

お願いします!

 

命名規則とは

命名規則とはものごとに名前を付ける際の規則や慣習のことです。
特にコーディング(プログラミング)では、ファイル、変数、クラスなどに名前を付ける時の規則や慣習を指します。

命名規則を設けるとコードの見通しが良くなり、可読性や保守性が向上するため、バグの減少やコーディング効率の向上につながります。

 

PEP8とは

PEPは、Python Enhancement Proposalsの略です。Pythonの機能向上、改善のために提案された文書群で、PEPの一部はPythonの機能として実装されています。

PEP8はPythonのコーディングスタイルを定めたガイドラインです。
PEP8の一部にPythonの命名規則があります。
 

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

スクリプト(ファイル名)に関する命名規則

PEP8によると、Pythonスクリプト名に関する規則は以下の通りです。

・モジュールの名前は全て英小文字の短い名前にする。
・読みやすさのためにアンダースコアで単語を区切ってもよい。

なお、Pythonの標準モジュールは全て英小文字のみになっています。
 

実際に書いてみよう

PEP8に従うと、モジュールをインポートする/される側の名前は以下のようになります。

 

インポートされる側のファイル(mymodule.py)

class MyClass:
  # クラスの定義

 

インポートする側のファイル(sample.py)

import mymodule

c = mymodule.MyClass()

 

監修してくれたメンター

橋本紘希

システムインテグレータ企業勤務のシステムエンジニア。

開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。

 

大石ゆかり

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

田島悠介

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

大石ゆかり

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

オンラインのプログラミングスクールTechAcademyではPythonを使って機械学習の基礎を学ぶPythonオンライン講座を開催しています。

初心者向けの書籍を使って人工知能(AI)や機械学習について学ぶことができます。

現役エンジニアがパーソナルメンターとして受講生に1人ずつつき、マンツーマンのメンタリングで学習をサポートし、最短4週間で習得することが可能です。

また、現役エンジニアから学べる無料のプログラミング体験会も実施しているので、ぜひ参加してみてください。