Pythonのgcモジュールでガベージコレクションを行う方法【初心者向け】

初心者向けにPythonのgcモジュールでガベージコレクションを行う方法について解説しています。ガベージコレクションとは不要になったメモリ領域を開放して再利用する機能です。gcモジュールを使ったガベージコレクションの方法について学習しましょう。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事が4,000以上あります。現役エンジニアの方はこちらをご覧ください。

Pythonのgcモジュールでガベージコレクションを行う方法について解説します。

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

 

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

 

田島悠介

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

大石ゆかり

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

田島悠介

gcモジュールでガベージコレクションを行う方法について詳しく説明していくね!

大石ゆかり

お願いします!

 

ガベージコレクションとは

プログラムは、実行中に必要なメモリ領域を動的に確保します。

ガベージコレクションとは、不要になったメモリ領域を自動的に解放する機能です。

ガベージコレクションの機能が無い場合、プログラマーはメモリの解放を明示的にコーディングしなければなりません。コーディングを忘れたり間違えたりすると、メモリリーク(漏れ)の原因になります。

Pythonもガベージコレクションの仕組みを備えています。

 

gcモジュールでガベージコレクションを行う方法

Pythonは必要に応じて自動的にガベージコレクションを行います。
通常の用途では明示的にガベージコレクションを行う必要はありません。

明示的にガベージコレクションを行うにはgcモジュールのcollect関数を呼び出します。詳細は公式の文書を参照してください。

import gc
gc.collect()

 

[PR] Pythonで挫折しない学習方法を動画で公開中

実際に書いてみよう

サンプルコード

import gc

# コールバック関数を定義する
def callback(phase, info):
    print(phase, info)
gc.callbacks.append(callback)

gc.disable()
gc.set_debug(gc.DEBUG_STATS)

# 循環参照を作成する
x = []
x.append(x)
del x

print(gc.get_stats()[2])
gc.collect()
print(gc.get_stats()[2])

 

実行結果

{'collections': 0, 'collected': 0, 'uncollectable': 0}
start {'generation': 2, 'collected': 0, 'uncollectable': 0}
gc: collecting generation 2...
gc: objects in each generation: 625 1034 11715
gc: objects in permanent generation: 0
gc: done, 1 unreachable, 0 uncollectable, 0.0160s elapsed
stop {'generation': 2, 'collected': 1, 'uncollectable': 0}
{'collections': 1, 'collected': 1, 'uncollectable': 0}

 

解説

1行目でgcモジュールをインポートしています。

3行目で関数を定義し、コールバックに登録しました。
ガベージコレクション実行のたびに、このコールバック関数が呼び出されます。

8行目で自動ガベージコレクションを停止しました。

9行目でガベージコレクションの統計表示を有効にしています。
ガベージコレクション実行時に、所要時間や処理オブジェクト数などを表示します。

11行目で循環参照を用いたゴミ(ガベージ)を作成します。

16行目でガベージコレクション実行前の状態を表示しました。

17行目でガベージコレクションを手動実行しました。
コールバック関数が呼び出され、’collected’:1とあることから、1オブジェクトが回収されたとわかりました。
また実行中の統計情報が表示されました。

18行目でガベージコレクション実行後の状態を表示しました。
同じく、’collected’:1とあることから、1オブジェクトが回収されたとわかりました。

 

監修してくれたメンター

橋本紘希

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

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

 

大石ゆかり

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

田島悠介

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

大石ゆかり

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

 

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

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