これから学ぶ人も、資格取得を目指す人も、最適なカリキュラムを選べます。
これから学ぶ人も、資格取得を目指す人も、最適なカリキュラムを選べます。
CTC 教育サービス
[IT研修]注目キーワード Python Power Platform 最新技術動向 生成AI Docker Kubernetes
こんにちは、吉政創成 菱沼です。
今回も「きれいなPythonプログラミング（マイナビ出版）」という書籍を利用して学習します。
4章「わかりやすいネーミング」にという章の学習中です。この章では、変数の適切な名前の付け方を学ぶことになります。
前回までは変数名にはこういった名前を付けるのが良いという内容を学んできましたが、今回は、こういう名前を付けるのはやめようという内容です。
変数名はとにかく誰が読んでもわかりやすいものにしよう、というのはよく理解しましたが、今回はやめた方が良い名前に関する話題です。まずはジョークやダジャレ、文化的な言及を避けましょうというものからです。
---------------------------------------------------------------
P.67
コードの意図を明確に伝えるためには、文化固有の知識が必要な表現は邪魔になることがあります。インターネットのおかげで、英語が堪能ではなくても、英語のジョークを理解できなくても、世界中の見知らぬ人たちとソースコードを共有することが簡単になりました。
本編の前半で述べたように、Pythonのドキュメントで使用されているspam、egg、baconという名前は、モンティ・パイソンのスケッチコメディーを元にしていますが、これらはメタ構文変数としてのみ使用するもので、実際のコードで使用することはお勧めできません。
一番よいのは、英語を母国語としない人でも理解しやすいコードを書く事です。つまり、丁寧で、直接的で、ユーモアのない方法です。
---------------------------------------------------------------
ちなみに、この前後の文章で、実際に筆者が遭遇したジョーク...というか、他の業界の用語を基にした変数名がつけられたもののエピソードが書かれています。当然、用途が分からず、説明を受けたそうですが、一度ではなぜその名前にしたのか理解できず詳しく聞いたこと、そして、命名者が退職したと同時に変数名を変更したというものです。ここら辺は皮肉がたっぷり含まれた形で書かれており、該当の変数名を付けた人に対して、「理解しがたいわぁ...迷惑だわぁ...」と思っている様子がありありと目に浮かぶようでした。
グッとくるのは「将来的にそのジョークは面白くなくなるかも」や「説明しなければならないようなジョークほど寒いものはありません」という一文ですね。ほんとグッときます。
さて、確かに外国のジョークや文化に詳しくない私からすると、一見して分からない変数名を見つけたら「？マーク」が頭に飛び散りそうです。他の業界の専門用語を元にされていても、やはりすぐには理解できません。さらに言えば、同じ単語が異なる業界ごとに違う意味になることもありますので、どの業界のものなのかと思うこともでてくるかもしれません。
調べる→意味を知る、選別する→意味から用途を推測するという流れは面倒でしかありませんし、作った側や引き継がれた側として、毎度誰かに説明するのも面倒です。誰もが知っていて当たり前の知識であるという思い込みは捨てて、シンプルにその変数が持つ役割の名前を付けてあげるのが一番ですね。
ちなみに、最悪な変数名（P.71）という項目があるのですが、ここでは変数には必ずデータが含まれているのだからdataという名前を使わないこと、varやtempも同じく、おすすめしないという事が書かれています。例えば、温度データの統計的分散を保持する変数を作りたいのなら、tempVarDataではなく、temperatureVarianceというような名前にせよと書かれていました。
よっぽど変数名に苦労されてきたのか、ここにも皮肉があふれていました。これまでの中で、著者の気持ちが一番あふれている章な気がします。お疲れ様です。
さて次に、例えばlistやsetなどの組み込み名を変数名に利用しないという内容です。利用しないようにする理由はこちら。
---------------------------------------------------------------
P.69
例えば変数にlistやsetという名前を付けると、Pythonのlist()やset()関数が上書きされてしまい、後でバグが発生する可能性があります。list()関数はリストオブジェクトを生成します。しかし、それを上書きすると、このようなエラーが発生します。
listという名前にリストの値を割り当てる①と、元のlist()関数がなくなってしまい、list()を呼ぼうとする②とTypeErrorが発生してしまいます。
---------------------------------------------------------------
なるほど。
かといって、Pythonですでに利用されている組み込み名をすべて覚えておくというのはなかなか難しいですよね。それを調べるには次の方法があるそうです。
これを実行してみて、使用されていない場合には、NameErrorやModule NotFoundErrorが発生するそうです。
識別子として使わないでほしいものとしては、all、any、date、email、file、format、hash、id、input、list、min、max、object、open、random、set、str、sum、test、typeなどがあるそうです。
インストール済みのサードパーティ製ライブラリと、同じ名前の.pyファイルがあると上書きされてしまい、ライブラリの関数が存在しないというエラーが発生してしまうそうです。
書籍のこの章には書かれていないようですが、この二つ以外に、「予約語」に使われているものは使えないという話を聞いたことがありました。予約語にはあらかじめ、特定の動作や操作、データ型を識別するためのものが定義されているため、変更ができないのだそう。
Python3.11には35個の予約語がありますが、ときどきバージョンアップによって追加されることもあるそうです。必要に応じて調べておくのがいいかもしれません。
調べ方など含め、参考URLを載せておきますので、興味がある方はご一読ください。
Pythonのキーワード（予約語）一覧を確認するkeyword
【Python】予約語とは
これでこの章が終了します。改めて、変数名の付け方についてまとめておきます。
PEP8の命名規則の原文はこちら。
https://peps.python.org/pep-0008/#naming-conventions
それでは今回はこちらで終了です。次回から5章「怪しいコード臭」に入ります。
今回もお付き合いいただきありがとうございました。
[IT研修]注目キーワード Python Power Platform 最新技術動向 生成AI Docker Kubernetes
