Python

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

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

テックアカデミーマガジンは受講者数No.1のプログラミングスクール「テックアカデミー」が運営。初心者向けにプロが解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。 ※ アンケートモニター提供元：GMOリサーチ株式会社　調査期間：2021年8月12日～8月16日　調査対象：2020年8月以降にプログラミングスクールを受講した18～80歳の男女1,000名　調査手法：インターネット調査

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

そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。

なお本記事は、TechAcademyのオンラインブートキャンプPython講座の内容をもとに紹介しています。

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

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

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

お願いします！

命名規則とは

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

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

PEPとは

PEPはPython Enhancement Proposalの略です。

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

[PR] 未経験からWebエンジニアを目指す方法とは

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

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

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

実際に書いてみよう

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

PEP8に準拠する例

websocket.py
web_socket.py

PEP8に準拠しない例

WebSocket.py
WEBSOCKET.py
web-socket.py

監修してくれたメンター

橋本紘希

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

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

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

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

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

TechAcademyでは、初心者でもPythonを使った人工知能（AI）や機械学習の基礎を習得できるオンラインブートキャンプPython講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。

Pythonでπ（円周率）を使う方法を現役エンジニアが解説【初心者向け】

Pythonでπ（円周率）を使う方法について解説します。そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読む...

Python

Pythonにおけるraw_inputについて現役エンジニアが解説【初心者向け】

Pythonにおけるraw_inputについて、TechAcademyのメンター（現役エンジニア）が実際のコードを使用して初心者向けに解説します。そもそ...

Python

PythonによるWebスクレイピングの方法を現役エンジニアが解説【初心者向け】

PythonによるWebスクレイピングの方法ついて解説します。そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事...

Python

Pythonで文字列の改行コードを削除する方法を現役エンジニアが解説【初心者向け】

Pythonで文字列の改行コードを削除する方法について、テックアカデミーのメンター（現役エンジニア）が実際のコードを使用して初心者向けに解説します。 P...

Python

PythonでIPアドレスを取得する方法【初心者向け】

PythonでIPアドレスを取得する方法について解説します。そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を...

Python

Pythonの正規表現の使い方を現役エンジニアが解説【初心者向け】

Pythonの正規表現の使い方について解説します。そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読むとさら...

Python

あわせてよく読まれている記事

Javaの命名規則について、TechAcademyのメンター（現役エンジニア）が実際のコードを使用して初心者向けに解説します。 Javaについてそもそもよく分からないという方は、Javaとは何なのか解説した記事を読むとさらに理解が深まります。なお本記事は、TechAcademyのオンラインブートキャンプ、Java講座の内容をもとに作成しています。田島悠介今回は、Javaに関する内容だね！大石ゆかりどういう内容でしょうか？田島悠介 Javaの命名規則について詳しく説明していくね！大石ゆかりお願いします！目次命名規則とは Javaの命名規則クラスの命名規則メソッドの命名規則変数の命名規則まとめ命名規則とは命名規則とは、プログラムの変数名や関数名などを決めるルールです。 Javaは、その言語仕様さえ守っていれば自由にソースコードを記述することができます。しかし、変数名や関数名を好きなように記述するとどうなるでしょう。変数名や関数名から意味を読み解くことができず、結果的にプログラム全体の処理も分かりづらくなってしまいます。このようにプログラムでは、変数名や関数名を分かりやすく命名するとこがとても重要です。特に複数人で開発する際には命名規則を守らず作ってしまうとソースコードの理解に時間がかかり、作業効率低下などを招く恐れがあります。 [PR] 未経験からWebエンジニアを目指す方法とはJavaの命名規則 Javaの命名規則は以下の通りですすべてのUnicode文字列を使用できる。ただ基本的には英数字や_(アンダーバー)を用いる先頭文字に数字は使えない文字数に制限はない予約語は使えないクラスの命名規則 Javaのクラスにおける命名規則は以下の通りです 1文字目は大文字それ以外は小文字だが単語区切りは大文字例) TestClass, MainInterface, Entity メソッドの命名規則 Javaのメソッドにおける命名規則は以下の通りです 1文字目は小文字それ以外も小文字だが単語区切りは大文字基本の命名規則は以上だがメソッドの処理内容次第で以下のような命名規則を用います真偽値を返すメソッドの場合・is + 形容詞・has + 過去分詞・can + 動詞フィールド変数の値を受け取るおよび設定するメソッドの場合・受け取るメソッドの先頭はget。get以降はメソッドの命名規則に従う・設定するメソッドの先頭はset。set以降はメソッドの命名規則に従う変数の命名規則 Javaの変数における命名規則は以下の通りです先頭文字は小文字で命名するそれ以外は小文字だが単語区切りは大文字例) test, testDate, count しかし、変数名であったとしても固定の値が入っている定数の命名の場合は以下の命名規則となります。すべて大文字で命名する単語区切りは_(アンダーバー)を用いる例) TEST_DATE, MAIN_DATA まとめ今回はJavaにおける命名規則について解説しました。命名規則を守ることで名前だけで何をしている処理なのかを理解することができます。よって開発効率を上げることにも繋がります。監修してくれたメンターメンターSさんシステムエンジニアとしてこれまで行政システムや医療用システムの保守、開発に携わりました。 JavaやPython、PHP、Kotlinなど様々な言語での開発経験があります。 TechAcademyではJavaコース、Pythonコース、AIコースなど7コースを担当しています。大石ゆかり内容分かりやすくて良かったです！田島悠介ゆかりちゃんも分からないことがあったら質問してね！大石ゆかり分かりました。ありがとうございます！ TechAcademyでは、初心者でも、JavaやServletの技術を使ってWebアプリケーション開発を習得できる、オンラインブートキャンプを開催しています。また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。

Java

Rubyにおける命名規則（命名規約）とは【初心者向け】

Rubyにおける命名規則（命名規約）について解説します。そもそもRubyについてよく分からないという方は、Rubyとは何なのか解説した記事を読むとさらに理解が深まります。なお本記事は、TechAcademyのオンラインブートキャンプRuby講座の内容をもとに紹介しています。田島悠介今回は、Rubyに関する内容だね！大石ゆかりどういう内容でしょうか？田島悠介命名規則（命名規約）について詳しく説明していくね！大石ゆかりお願いします！命名規則（命名規約）とは命名規則とは、プログラミングで、変数、型、関数などに名前を付ける際のルールや慣習のことです。命名規則が無い場合と比較し、命名規則を定めることは以下のような利点があります。 – 名前が役割や意味を表現するので、ソースコードを読解する労力を削減できる。 – ソースコードレビューの際に、文法や命名規則についての議論が不要になり、本質的な部分に集中できる。プログラミング言語そのものが命名規則を定義(推奨)している場合もあります。また、所属している会社や、参加しているプロジェクトで、命名規則を定めている場合もあります。命名規則（命名規約）の例インターネット上で、Rubyのコーディング規約が多数公開されています。有名なものを3つ取り上げます。 Rubyスタイルガイド Rubyアソシエーションのコーディング規約集 Ruby コーディング規準これらは、命名規則だけでなく、インデントの仕方やコメントの入れ方など、Rubyのコーディング全般に触れています。ここでは、上記の「Rubyスタイルガイド」より、命名規則を抜粋します。シンボル、メソッド、変数にはsnake_caseを用いる snake_caseとは英小文字の単語を_(アンダースコア)で区切り連結する方法です。 # 良い例 today_weather = 'sunny' # 悪い例 todayweather = 'sunny' TodayWeather = 'sunny' シンボル、メソッド、および変数名において、文字と数字を分離しない文字に続けて(アンダースコアを入れずに)数字を入れます。 # 良い例 var0 = 0 # 悪い例 var_0 = 0 クラスやモジュールにはCamelCaseを用いる CameCaseとは、単語の先頭を大文字にし、単語の区切りを示す方法です。 # 良い例 class MyClass end # 悪い例 class my_class end 定数はSCREAMING_SNAKE_CASEを用いる snake_caseで、かつ全て大文字にする表記です。 # 良い例 CIRCLE_RATIO = 3.14 # 悪い例 CircleRatio = 3.14 述語メソッド(boolean値が返るメソッド)は疑問符で終わる述語メソッドとはオブジェクトが特定の状態かどうか、true/falseを返すメソッドです。例えば、Arrayクラスのempty?メソッドは、配列が空の場合にtrueを返します。 # 良い例 class Person def tall? # 実装 end end # 悪い例 class Person def tall # 実装 end end 危険な可能性のあるメソッドは感嘆符で終わるここでの危険とは、破壊的な(不可逆な)変更を行うかどうかです。例えばArrayクラスのreverse!メソッドは、配列そのものを逆転させるため、感嘆符付きになっています。一方、reverseメソッドは、配列そのものを変更せず、逆転した配列を戻り値とするため、感嘆符なしです。 # 良い例 class MyClass

Ruby

JavaScriptの命名規則を現役エンジニアが解説【初心者向け】

JavaScriptの命名規則について解説します。実際のコードをもとに解説していきますので、理解を深めていきましょう。また、入門向けのJavaSriptを学習できるサイトも紹介しているので、合わせてご覧ください。そもそもJavaScriptについてよく分からないという方は、JavaScriptとは何なのかについて解説した記事を読むとさらに理解が深まります。なお本記事は、TechAcademyのオンラインブートキャンプJavaScript/jQuery講座の内容をもとにしています。田島悠介今回は、JavaScriptに関する内容だね！大石ゆかりどういう内容でしょうか？田島悠介 JavaScriptの命名規則について詳しく説明していくね！大石ゆかりお願いします！命名規則とは命名規則とは、プログラムの変数名や関数名などを決めるルールです。ほとんどのプログラミング言語は、その言語仕様さえ守っていればとても自由にソースコードを記述することができます。しかし、変数名や関数名を以下のように記述するとどうなるでしょう。 var _1 = 180; var _2 = 75; function a(_a, _b) { _a /= 100; return _b / (_a * _a); } var _3 = a(_1, _2); console.log(_3); 変数名や関数名から意味を読み解くことができず、結果的にプログラム全体の処理も分かりづらくなってしまいます。それでは同じプログラムを、変数名や関数名を変え、コメントを付与するとどうなるでしょうか。 // 身長(cm) var height = 180; // 体重(kg) var weight = 75; // BMIを計算する関数 // BMI = 体重kg / (身長mの2乗) function calcBmi(height_cm, weight_kg) { var height_m = height_cm /= 100; return weight_kg / (height_m * height_m); } //

JavaScript

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

Pythonのスクリプト（ファイル名）に関する命名規則について解説します。そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。なお本記事は、TechAcademyのオンラインブートキャンプPython講座の内容をもとに紹介しています。田島悠介今回は、Pythonに関する内容だね！大石ゆかりどういう内容でしょうか？田島悠介スクリプト（ファイル名）に関する命名規則について詳しく説明していくね！大石ゆかりお願いします！命名規則とは命名規則とはものごとに名前を付ける際の規則や慣習のことです。特にコーディング(プログラミング)では、ファイル、変数、クラスなどに名前を付ける時の規則や慣習を指します。命名規則を設けるとコードの見通しが良くなり、可読性や保守性が向上するため、バグの減少やコーディング効率の向上につながります。 PEP8とは PEPは、Python Enhancement Proposalsの略です。Pythonの機能向上、改善のために提案された文書群で、PEPの一部はPythonの機能として実装されています。 PEP8はPythonのコーディングスタイルを定めたガイドラインです。 PEP8の一部にPythonの命名規則があります。 [PR] 未経験からWebエンジニアを目指す方法とはスクリプト（ファイル名）に関する命名規則 PEP8によると、Pythonスクリプト名に関する規則は以下の通りです。・モジュールの名前は全て英小文字の短い名前にする。・読みやすさのためにアンダースコアで単語を区切ってもよい。なお、Pythonの標準モジュールは全て英小文字のみになっています。実際に書いてみよう PEP8に従うと、モジュールをインポートする/される側の名前は以下のようになります。インポートされる側のファイル(mymodule.py) class MyClass: # クラスの定義インポートする側のファイル(sample.py) import mymodule c = mymodule.MyClass() 監修してくれたメンター橋本紘希システムインテグレータ企業勤務のシステムエンジニア。開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。大石ゆかり内容分かりやすくて良かったです！田島悠介ゆかりちゃんも分からないことがあったら質問してね！大石ゆかり分かりました。ありがとうございます！ TechAcademyでは、初心者でもPythonを使った人工知能（AI）や機械学習の基礎を習得できるオンラインブートキャンプPython講座を開催しています。挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。

Python

Railsの命名規則を現役エンジニアが解説【初心者向け】

Railsの命名規則について解説します。そもそもRubyについてよく分からないという方は、Rubyとは何なのか解説した記事を読むとさらに理解が深まります。なお本記事は、TechAcademyのオンラインブートキャンプRuby講座の内容をもとに紹介しています。田島悠介今回は、Rubyに関する内容だね！大石ゆかりどういう内容でしょうか？田島悠介 Railsの命名規則について詳しく説明していくね！大石ゆかりお願いします！ Railsの命名規則（モデル名、テーブル名等） Rails の命名規則について解説していきます。モデルモデル名は単数形で記述します。試しに以下のコマンドを実行してみましょう。 $ rails generate model book 以下のように、先頭が大文字のBookクラスがapp/models/book.rbに記述されます。 class Book < ApplicationRecord end もし複数単語からなるMyBookクラスを作りたい場合は、以下のコマンドを実行しましょう。スネークケース(my_book)、キャメルケース(myBook)、パスカルケース(MyBook)、ケバブケース(my-book)など、どの書き方でも大丈夫です。 $ rails generate model my_book 以下のようにMyBookクラスがapp/models/my_book.rbに記述されます。ファイル名はスネークケースとなっていることに注意してください。 class MyBook < ApplicationRecord end テーブルテーブル名は、スネークケースの複数形で記述します。先ほどのrails generate modelコマンドを実行することで、一緒にdb/migrate配下にマイグレーションファイルが作成されます。 create_table :my_books となっています。 class CreateMyBooks < ActiveRecord::Migration[5.2] def change create_table :my_books do |t| t.timestamps end end end カラムカラム名はusers.name, users.ageなどのように、スネークケースの単数形で記述します。コントローラコントローラ名は、複数形で記述し、末尾にControllerを付けます。モデルと同じように、rails generate controllerコマンドで生成してみましょう。 $ rails generate controller my_books コマンドを実行するとapp/controllers/my_books_controller.rbにMyBooksControllerが定義されています。 class MyBooksController < ApplicationController end ビュービューファイルはapp/views/<resource>/<action>.html.haml

Ruby

Pythonの変数名の命名規則を現役エンジニアが解説【初心者向け】

Pythonの変数名の命名規則について解説します。そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。なお本記事は、TechAcademyのオンラインブートキャンプPython講座の内容をもとに紹介しています。田島悠介今回は、Pythonに関する内容だね！大石ゆかりどういう内容でしょうか？田島悠介 Pythonの変数名の命名規則について詳しく説明していくね！大石ゆかりお願いします！ Pythonの変数名の命名規則（変数名の付け方） PythonではPEP8でコーディング規約が定められています。PEPはPython Enhancement Proposalの略で、コミュニティに提示された、Pythonの機能改善のための提案総称です。 PEP8の日本語訳によれば、変数名の規約は以下の通りです。関数の名前は小文字のみにすべきです。また、読みやすくするために、必要に応じて単語をアンダースコアで区切るべきです。変数の名前についても、関数と同じ規約に従います。命名規則に沿わなくてもエラーにはなりません。ただし、特に複数名でプログラムを開発している場合には、ソースコードの可読性を悪化させ、バグの原因になります。特別な理由の無い限りは、命名規則に沿ってコーディングをするのが妥当です。実際に書いてみよう上記の規約に従い、規約に沿う例と沿わない例を示します。規約に沿う例 count = 0 word_count = 1 規約に沿わない例 Count = 0 WordCount = 1 [PR] 未経験からWebエンジニアを目指す方法とは監修してくれたメンター橋本紘希システムインテグレータ企業勤務のシステムエンジニア。開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。大石ゆかり内容分かりやすくて良かったです！田島悠介ゆかりちゃんも分からないことがあったら質問してね！大石ゆかり分かりました。ありがとうございます！ TechAcademyでは、初心者でもPythonを使った人工知能（AI）や機械学習の基礎を習得できるオンラインブートキャンプPython講座を開催しています。挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。

Python

記事を検索

ニュース

インタビュー

テクノロジー

キャリア

お問い合わせ

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

命名規則とは

PEPとは

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