Pythonのスクリプト(ファイル名)に関する命名規則を現役エンジニアが解説【初心者向け】
初心者向けにPythonのスクリプト(ファイル名)に関する命名規則について解説しています。ファイル名やクラス名などは好きなように付けても問題ないのですが、小規模なプログラム以外は混乱の原因になりますので命名規則を利用しましょう。
テックアカデミーマガジンは受講者数No.1のプログラミングスクール「テックアカデミー」が運営。初心者向けにプロが解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。 ※ アンケートモニター提供元:GMOリサーチ株式会社 調査期間:2021年8月12日~8月16日 調査対象:2020年8月以降にプログラミングスクールを受講した18~80歳の男女1,000名 調査手法:インターネット調査
Pythonのスクリプト(ファイル名)に関する命名規則について解説します。
そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。
なお本記事は、TechAcademyのオンラインブートキャンプPython講座の内容をもとに紹介しています。
今回は、Pythonに関する内容だね!
どういう内容でしょうか?
スクリプト(ファイル名)に関する命名規則について詳しく説明していくね!
お願いします!
命名規則とは
命名規則とはものごとに名前を付ける際の規則や慣習のことです。
特にコーディング(プログラミング)では、ファイル、変数、クラスなどに名前を付ける時の規則や慣習を指します。
命名規則を設けるとコードの見通しが良くなり、可読性や保守性が向上するため、バグの減少やコーディング効率の向上につながります。
PEP8とは
PEPは、Python Enhancement Proposalsの略です。Pythonの機能向上、改善のために提案された文書群で、PEPの一部はPythonの機能として実装されています。
PEP8はPythonのコーディングスタイルを定めたガイドラインです。
PEP8の一部にPythonの命名規則があります。
スクリプト(ファイル名)に関する命名規則
PEP8によると、Pythonスクリプト名に関する規則は以下の通りです。
・モジュールの名前は全て英小文字の短い名前にする。
・読みやすさのためにアンダースコアで単語を区切ってもよい。
なお、Pythonの標準モジュールは全て英小文字のみになっています。
実際に書いてみよう
PEP8に従うと、モジュールをインポートする/される側の名前は以下のようになります。
インポートされる側のファイル(mymodule.py)
class MyClass: # クラスの定義
インポートする側のファイル(sample.py)
import mymodule c = mymodule.MyClass()
監修してくれたメンター
橋本紘希
システムインテグレータ企業勤務のシステムエンジニア。 開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。 |
内容分かりやすくて良かったです!
ゆかりちゃんも分からないことがあったら質問してね!
分かりました。ありがとうございます!
TechAcademyでは、初心者でもPythonを使った人工知能(AI)や機械学習の基礎を習得できるオンラインブートキャンプPython講座を開催しています。
挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。