【初心者向け】きれいなPythonプログラミングを書くコツとは?

Python

Pythonのプログラミングを始めたばかりの初心者だが、

  • 自分の書いたコードを読み返すとあとで意味が分からなくなってしまう…
  • なぜ思った通りに動作しないのか、バグを見つけるのに時間がかかってしまう…
  • 他の人から「コードが読みづらい」と指摘された

いざ初めてみたは良いが、そういったポイントで初心者の人はつまづきがちです。
※俺も大学時代、プログラミング始めたばかりの頃は同じような感じでしたので、安心してください(^^;)

今回は、そういったつまづきポイントを少しでも解消できるように、綺麗で読みやすいコードを書くためのコツをまとめました

まずPythonのインストール方法などから知りたいという方は
こちらの記事を読んでみてください↓

こんにちは。この記事を書いたHATOBA(はとば)です。

  • 開発経験5年以上のエンジニア
  • 大学時代に勉強~現場での業務経験もあり
  • プログラミング、論理思考が得意

きれいなPythonコードとは何か

きれいなPythonコードとは、誰が読んでも理解しやすく、修正や追加がしやすい書き方のことを指します。
読みやすいコードは、作業の引き継ぎやバグ修正をスムーズにする力を持っています。

その理由として、以下のような点が挙げられます。

  • 他人が読んでも意味がわかる
  • 将来の自分が見てもすぐ理解できる
  • バグの発見や修正がしやすくなる
  • チームでの作業が効率的になる

たとえば、同じ処理をする以下のコードを比べてみてください。

# 悪い例
x = 10
y = 20
z = x + y
print(z)

# よい例
num_apple = 10
num_orange = 20
total_fruit = num_apple + num_orange
print(total_fruit)

後者のほうが、何の計算をしているか、変数の用途などがすぐにわかりやすいと思います。

このように、意味のある名前を使い、読みやすく書くことで、きれいなPythonコードに近づけます。

Python初心者が意識すべき基本の書き方

Pythonを使う際、基本の書き方を守るだけで、ぐっと見やすいコードになります。
とくに初心者の方は、ルールを意識するだけでコードの質が向上します。

意識したいポイントは以下のとおりです。

  • インデント(字下げ)を4つの空白で統一する
  • 不要な空行は使わない
  • コメントを適度に入れて、説明を書く

以下は、基本を意識したサンプルです。

# 商品の合計金額を出す関数
def calculate_total(price, tax):
    total = price + tax
    return total

このように整った書き方を心がけることで、他の人にも伝わるコードが書けます。
書き方の基本をしっかり守ることが、きれいなコードへの第一歩です。

Pythonの命名規則を守ろう

変数や関数の名前をわかりやすく付けることで、コードの意味がすぐに伝わります。
命名規則を守ることは、プログラム全体の理解度を高めるために欠かせません。

Pythonでは、次のような命名ルールが一般的です。

  • 小文字で、単語の間を「_(下線)」でつなぐ
  • 英語の略語や1文字名は避ける
  • 意味のある名前を付ける

たとえば、以下のような例です。

# 悪い例
def c(a, b):
    return a * b

# よい例
def calculate_area(width, height):
    return width * height

※「よい例」の方では、変数名や関数名に対して意味が読み取りやすい命名を行っています。

このように、命名規則を守ることで、何の処理をしている関数かすぐにわかります。
名前を工夫するだけで、きれいで親切なPythonコードになります。

Pythonで役立つコードの整理術

コードが長くなると、どこに何が書いてあるのか分かりにくくなります。
整理されたコードは、読む人にやさしく、修正しやすい利点があります。

とくに意識したい整理のコツは以下の通りです。

  • 1つの関数には1つの役割だけを持たせる
  • よく使う処理は関数としてまとめる
  • 同じ処理を何度も書かない

以下は関数にまとめた例です。

# 割引価格を計算する関数
def calculate_discount(price, rate):
    return price * (1 - rate)

# 使用例
discounted_price = calculate_discount(1000, 0.1)

このように関数で分けることで、コードの見通しが良くなりますし、
整理整頓されたコードは、読み手に安心感を与えます。

Pythonの標準スタイルを知ろう

Pythonには、書き方の手本となる「PEP8」という決まりがあります。
この決まりに従えば、誰が見ても統一感のあるコードになります。

PEP8の代表的なルールは次のとおりです。

  • インデントは4つの空白で統一
  • 1行は79文字以内におさえる
  • 演算子の前後には空白を入れる(例:a + b)

※正式なドキュメント(日本語訳)のリンクはこちらです↓

https://pep8-ja.readthedocs.io/ja/latest

ボリュームが多いですが、ある程度Pythonに慣れたらざっと目を通してみてください。

たとえばPEP8を意識してみると、このような書き方のコードになります。

# 数値を二倍にする関数
def double_number(number):
    return number * 2

このように、スタイルの決まりを知っておくと、いつでもきれいなPythonコードが書けるようになります。

Python初心者におすすめの練習方法

きれいなPythonコードを書く力は、練習によって育てられます。
特別な知識よりも、くり返し書いて見ることが上達の近道です。

初心者におすすめの練習法はこちらです。

  • 短いプログラムを毎日1つ書いてみる
  • コメントをしっかり書く習慣をつける
  • ほかの人のコードを読んで良いところを真似する

実際に手を動かしながら、読みやすい書き方を意識すると、自然ときれいなコードが書けるようになります。
とにかく書いて、直して、学ぶことが大切です。

まとめ

今回は、初心者がつまづきがちなポイント

  • 自分の書いたコードを読み返すとあとで意味が分からなくなってしまう
  • なぜ思った通りに動作しないのか、バグを見つけるのに時間がかかってしまう
  • 他の人から「コードが読みづらい」と言われた

をすこしでも解消できるように、綺麗で読みやすいコードを書くコツについて記載しました。

まずは簡単なコードから、徐々にステップアップを目指してみて下さい。

ここまで読んでくれてありがとうございました。

コメント

タイトルとURLをコピーしました