Pythonの __copy__関数について現役エンジニアが解説【初心者向け】

初心者向けにPythonの __copy__関数について現役エンジニアが解説しています。__copy__関数とは、Pythonのクラスで定義できる特殊なメソッドの一つで、オブジェクトのコピーにかかわる動作を変更したい場合に定義します。copy.copy関数が実行された場合に__copy__メソッドが実行されます。

TechAcademyマガジンは受講者数No.1のオンラインプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。

Pythonの __copy__関数について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して、初心者向けに解説します。

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

 

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

 

田島悠介

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

大石ゆかり

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

田島悠介

Pythonの __copy__関数について詳しく説明していくね!

大石ゆかり

お願いします!

 

__copy__関数とは

__copy__関数は、Pythonのクラスで定義できる、特殊なメソッドの一つです。オブジェクトのコピーにかかわる動作を変更したい場合に定義します。オブジェクトに対し、copy.copy関数が実行された場合、内部的に__copy__関数が実行されます。

「浅いコピー(shallow copy)」の挙動を変更したい場合に、このメソッドを定義します。オブジェクトをコピーする場合に、元オブジェクト中のオブジェクトの参照(データ実体でない)を複製することを、「浅いコピー」と言います。

対義語は「深いコピー(deep copy)」で、copy.deepcopy関数が対応します。

__copy__関数の使い方

以下のようにクラスのメソッドとして定義します。メソッドの引数はありません。

class MyClass:
  def __copy__(self):
    # オブジェクトの複製を作成しreturnする処理

 

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

実際に書いてみよう

ソースコード __copy__関数を定義しない場合

class MyClassA:
  def __init__(self, ns):
    self._ns = ns
  def __str__(self):
    return str(self._ns)

ns = [1,2,3]
a0 = MyClassA(ns)
a1 = copy.copy(a0)
print(str(a0), str(a1))

ns.append(4)
print(str(a0), str(a1))

 

実行結果

[1, 2, 3] [1, 2, 3]
[1, 2, 3, 4] [1, 2, 3, 4]

 

解説

MyClassAはリストを引数にとるクラスです。整数のリストnsを作成し、a0インスタンスを作成しました。a0をコピーし、a1インスタンスを作成しました。

この時点でa0, a1を表示すると、どちらも[1,2,3]となっていました。nsに整数4を追加しました。再度a0, a1を表示すると、参照元のリストが書き変わったため、どちらも[1,2,3,4]となっていました。

ソースコード __copy__関数を定義する場合

class MyClassB:
  def __init__(self, ns):
    self._ns = ns
  def __copy__(self):
    print('object copied')
    return MyClassB(self._ns)
  def __str__(self):
    return str(self._ns)

ns = [1,2,3]
b0 = MyClassB(ns)
b1 = copy.copy(b0)
print(str(b0), str(b1))

ns.append(4)
print(str(b0), str(b1))

 

実行結果

object copied
[1, 2, 3] [1, 2, 3]
[1, 2, 3, 4] [1, 2, 3, 4]

 

解説

処理内容そのものは先のソースコードと同様です。

__copy__関数で、オブジェクトをコピーする時にメッセージを出力するようにしました。copy.copy関数に連動して、__copy__関数の呼び出されることを確認できました。

まとめ

この記事ではオブジェクトの浅いコピーと、その挙動を変更するための__copy__関数を紹介しました。

監修してくれたメンター

橋本紘希(はしもとひろき)

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

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

 

大石ゆかり

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

田島悠介

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

大石ゆかり

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

 

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

また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。