#15 Pythonで学ぶデバッグの基本

プログラムが思った通りに動かないとき、原因を探して修正する作業を「デバッグ」と呼びます。この記事では、Pythonにおけるデバッグの基本的な方法と、専用ツールの使い方を解説します。

print()でその場の状態を確認する

最も手軽なデバッグ方法は、print()を使って変数の中身を確認することです。

print(f"ageの中身: {age}")

怪しいと思う箇所の前後にprint()を挟んでいくことで、どこで想定と違う値になっているかを絞り込めます。変数名も一緒に表示しておくと、後で見返したときにどの出力か分かりやすくなります。

エラーメッセージを読む

Pythonのエラーメッセージ(トレースバック)には、どのファイルの何行目で、どんな種類のエラーが起きたかが書かれています。エラーが出たら、まず一番下に書かれているエラーの種類とメッセージを読むことから始めましょう。

Traceback (most recent call last):
  File "main.py", line 5, in <module>
    result = 10 / 0
ZeroDivisionError: division by zero

この例では、最後の行から「0で割ろうとした」ことが原因だと分かります。エラーの種類(ZeroDivisionErrorなど)で検索すると、原因や対処法が見つかりやすくなります。

デバッガーという専用のツール

VSCodeなどのエディタには、プログラムを1行ずつ実行しながら変数の中身を確認できる「デバッガー」という機能が用意されています。print()をたくさん挟むより効率的に原因を探せます。コード上の特定の行に「ブレークポイント」という目印を置いておくと、実行がその行で自動的に一時停止し、その時点でのすべての変数の値を確認できます。

assertで前提条件を確認する

「この時点でこの変数はこうなっているはず」という前提を明示的にチェックしたい場合は、assertという機能が使えます。

age = -5
assert age >= 0, "ageは0以上である必要があります"

前提が崩れていた場合、その場でエラーとして知らせてくれるため、バグの原因からかけ離れた場所でエラーが起きて混乱する事態を防げます。

Pythonならではの注意点

print()によるデバッグは手軽ですが、確認が終わったコードにデバッグ用のprint()を消し忘れると、実行結果に余計な表示が混ざってしまいます。デバッグが終わったら、使ったprint()を整理する習慣をつけましょう。標準のloggingモジュールを使えば、デバッグ用のメッセージだけをまとめてオン・オフできるため、頻繁にデバッグ出力を使う場合は検討する価値があります。

まとめ

Pythonのデバッグはprint()とエラーメッセージの読解が基本です。慣れてきたらデバッガーやassertも活用し、効率よく原因を探せるようになりましょう。

本ページはプロモーションを含みます。

参考書籍(PR)

Pythonをもっと学びたい方には「スッキリわかるPython入門 第2版」がおすすめです。

PR

コードを書かずに自動化したい方へ

「学んだけど自分の作業に組み込む時間がない」という方向けに、ダブルクリックで動く Windows専用の自動化ツールをオーダーメイドで作成しています。気になる方は こちらをご覧ください。

コメント

コメントを投稿

このブログの人気の投稿

#25 Rustで学ぶAI API(ChatGPT等)の呼び出し方の基本

ChatGPTのようなAI(人工知能)の機能を自分のアプリに組み込みたいとき、多くの場合は「AI API」と呼ばれる仕組みを使います。APIとは「Application Programming Interface」の略です。簡単に言えば、「あるサービスの機能を、プログラムから呼び出せるようにした窓口」のことです。この記事では、Rustから外部のAI APIをHTTPリクエストで呼び出す基本的な流れを、初心者向けに解説します。 AI APIを呼び出すとはどういうことか ChatGPTを提供するOpenAI社などは、インターネット経由でAIに質問を送り、回答を受け取れる「AI API」を公開しています。これはWebブラウザで検索するときのように、決まった宛先(URL)にデータを送信し、返ってきた結果を受け取る仕組みです。この「データを送って結果を受け取る」通信方式を、HTTPリクエストと呼びます。Rustのプログラムからこの通信を行うことで、自分のアプリの中でAIに質問し、回答を取得できるようになります。 reqwestクレートを使う Rustには標準でHTTP通信の機能は含まれていません。そこで使うのが「クレート」と呼ばれる外部ライブラリです。クレートはPythonのライブラリやJavaScriptのパッケージに近いもので、 Cargo.toml というファイルに追記するだけで簡単に導入できます。HTTP通信でよく使われるのが reqwest というクレートです。 Cargo.toml に次のように追記します(バージョン番号は執筆時点の例なので、実際に使う際は最新版を確認してください)。 [dependencies] reqwest = { version = "0.11", features = ["json"] } tokio = { version = "1", features = ["full"] } serde_json = "1.0" ここで tokio という見慣れないクレートも一緒に入れています。これは「非同期処理」と呼ばれる、通信の待ち時間の間に他の処理を進められる仕組みを扱うためのものです。ネットワーク通信は結果が返ってくるまで時間...
続きを読む

#8 C++で学ぶ文字列操作の基本

C++の文字列操作は、`std::string`という型を使うのが現代的な基本の書き方です。この記事では、C++における文字列操作の基本と、注意しておきたい落とし穴を解説します。 文字列を連結する std::string greeting = "こんにちは、" + name + "さん"; `std::string`同士であれば、`+`を使った連結がそのまま使えます。既存の文字列に追加する場合は`+=`や`append`メソッドも使えます。 greeting += "。よろしくお願いします。"; よく使う文字列操作 name.length() 文字数を調べる(バイト数であることに注意、後述) name.substr(0, 3) 一部分を取り出す(開始位置と長さを指定) name.find("A") 特定の文字の位置を探す(見つからなければ`std::string::npos`) name.replace(0, 2, "XX") 一部分を置き換える 文字列を数値に変換する 文字列を数値に変換したい場合は`std::stoi`(整数)や`std::stod`(小数)、逆に数値を文字列にしたい場合は`std::to_string`を使います。 int num = std::stoi("123"); std::string s = std::to_string(456); 文字列を分割する C++の標準ライブラリには、他言語の`split`のような文字列分割の関数が長らく用意されていませんでした。`std::stringstream`を使うのが伝統的な方法です。 #include <sstream> std::stringstream ss("a,b,c"); std::string item; while (std::getline(ss, item, ',')) { std::cout << item << std::endl; } C++ならではの注意点 C++には、古くからある`char`の配列を...
続きを読む

#16 TypeScriptで学ぶ辞書型(マップ)の基本

TypeScriptの辞書に相当する仕組みは、JavaScriptと同じですが、キーと値の型をあらかじめ決めておけるのが特徴です。この記事では、TypeScriptにおける辞書の扱い方と、用途別の型の選び方を解説します。 型付きのオブジェクト interface Person { name: string; age: number; } const person: Person = { name: "太郎", age: 20 }; キーの型が決まっていない辞書 キーの名前が事前に決まっていない辞書のような使い方をしたい場合は、次のように書きます。 const scores: { [key: string]: number } = {}; scores["太郎"] = 90; 同じ意味を Record というユーティリティ型で簡潔に書くこともできます。 const scores: Record = {}; Mapを使う場合 const person = new Map (); person.set("name", "太郎"); console.log(person.get("name")); Map<string, string> のように、キーと値それぞれの型を指定できます。 Object と違い、キーの数を person.size で正確に取得できる、キーの型を文字列以外にもできるといった利点があります。 値が存在しないかもしれない場合 キーが実在するとは限らない辞書の場合、値の型に | undefined を含めておくと、より正確な型になります。 const scores: { [key: string]: number | undefined } = {}; const value = scores["三郎"]; // number | undefined 型 こうしておくと、存在しないキーへのアクセスがコンパイル時に見過ごされにくくなります。 存在しないキーへのアクセスを防ぐ tsconfig.json で noUncheckedIndexedAccess を有効にす...
続きを読む