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

初心者向けにPythonのスクリプト(ファイル名)に関する命名規則について現役エンジニアが解説しています。ファイル名の命名規則があったほうが複数人や大規模プログラムになると役に立ちます。アンダースコアや英字小文字などを使うように慣例になっています。

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

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

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

 

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

 

田島悠介

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

大石ゆかり

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

田島悠介

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

大石ゆかり

お願いします!

 

命名規則とは

命名規則とは、ものごとに名前を付ける際のルールです。

特にプログラミングでは、クラス、メソッド、変数に名前を付ける際のルールを指します。
特に複数名でコーディングを行う時に、命名規則を定めると、コードの見通しが良くなり、バグの防止や保守性の向上に役立ちます。

PEPとは

PEPはPython Enhancement Proposalの略です。

Pythonはオープンソースの言語で、開発の主体はコミュニティです。
コミュニティに提出された、Pythonの機能拡張や改善のための提案がPEPです。
PEP8がPythonのコーディングガイドを定めていて、命名規則もこの中に含まれています。

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

モジュール名(ファイル名)に関する命名規則

Pythonではファイル名がモジュール名になります。
PEP8がモジュール名のガイドラインを定めています。以下に抜粋します。

モジュール名は短く、英小文字とする。
可読性の増す場合、アンダースコア(_)を利用してもよい。

 

実際に書いてみよう

例えばウェブソケット機能を提供するモジュールの場合、モジュール名は以下のようになります。

 

PEP8に準拠する例

websocket.py
web_socket.py

 

PEP8に準拠しない例

WebSocket.py
WEBSOCKET.py
web-socket.py

監修してくれたメンター

橋本紘希

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

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

 

大石ゆかり

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

田島悠介

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

大石ゆかり

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

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

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

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

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