ディクショナリの1つの要素を操作すると他の要素まで同時に操作されてしまう。

Question

質問投稿の直前に自己解決したが、後から同じ問題に直面した人のために投稿し、解決方法を記す。

実現したいこと

• あるカードゲームのデッキをtxtファイルから読み込みたい。
• カードデータをディクショナリの形に変換し、ゲーム内で個別に参照・操作できるようにしたい。

前提

Pythonでカードゲームのプログラムを作っており、ゲームに用いるデッキをtxtファイルから読み込む機能を実装しようとしています。

ファイルパスの指定およびメッセージの表示にtkinterのfiledialogモジュールを使用しています。

カード情報には色とカード名があり、txtファイルではそれらのカード情報、およびカード枚数を指定しています。

発生した問題

該当コードの114行目の操作で問題が起こりました。

デッキMAIN_deckに格納される情報は以下のようになっています。

MAIN_deck = [{"name":"カード名", "color":色, "tap":カードの状態(T/F), "select":選択中か否か(T/F), "position":カードの座標},
             {"name":"カード名", "color":色, "tap":カードの状態(T/F), "select":選択中か否か(T/F), "position":カードの座標},
             ...]

例えば、MAIN_deckの0番目から3番目が同じ名前のカードのとき、0番目のカードに対して

MAIN_deck[0]['position'] = [100,0]

のように操作をした場合、MAIN_deck[0]からMAIN_deck[3]までのすべてについて、キー'position'の値が[100,0]に変更されてしまいます。

MAIN_deck[0]以外のカードの情報を変えることなくMAIN_deck[0]の情報を操作できるのが理想です。

該当のソースコード

from tkinter import filedialog
from tkinter import messagebox

# 色の設定
# 原色
red = (255, 0, 0)
green = (0, 255, 0)
blue = (0, 0, 255)
yellow = (255, 255, 0)
purple = (255, 0, 255)
black = (0, 0, 0)
white = (255, 255, 255)
# 各文明
light = (255, 255, 120)
water = (120, 120, 255)
darkness = (120, 120, 120)
fire = (255, 120, 120)
nature = (120, 255, 120)
zero = white

# txtファイル内の文字と色を対応させる関数
def color_read(color):
    if color in ["白", "光"]:
        return light
    elif color in ["青", "水"]:
        return water
    elif color in ["黒", "闇"]:
        return darkness
    elif color in ["赤", "火"]:
        return fire
    elif color in ["緑", "自然"]:
        return nature
    elif color in ["無", "零", "ゼロ"]:
        return white
    else:
        return purple

# txtファイルからデッキを読み取る関数
def deck_read():
    # ファイルパスを格納する変数
    # tkinter の filedialog によってブラウズウィンドウを表示、ファイル名を参照
    file = filedialog.askopenfilename()
    

    # ファイルが指定されなかったら空のデッキを返す
    if file == "":
        return []
    # txt ファイルでなければエラーメッセージを表示して空のデッキを返す
    elif file[-3:] != "txt":
        messagebox.showerror("Duel Masters", "txtファイルを選択してください")
        return []

    # txt ファイルなら開く
    else:
        f = open(file,"r",encoding="utf-8")

        # カードを入れるリスト
        MAIN_deck = []
        

        # 1行ずつ処理
        for line in f:
            # 全角空白を半角空白に置換
            line = line.replace("\n","")

            # その行が空でなければ処理
            if line != "":
                # 最初の文字がカードの文明なら処理
                if line[:1] in ("白", "青", "黒", "赤", "緑", "無", "光", "水", "闇", "火", "自", "零", "ゼ") and line[:2] != "零龍":
                    # その行を半角空白で分割、カード情報のリストにする
                    card_info_list = line.replace("\u3000"," ").split(" ")
                    # カード名を入れる変数
                    card_name = ""
                    # カードの枚数を入れる変数
                    card_value = 0
                    # カードの枚数が入力されていなかったら処理
                    if card_info_list[-1].isdigit() == False:
                        # カード情報が文明のみになるまで名前を結合
                        # カード名に空白が含まれている場合の処理
                        while len(card_info_list)>=2:
                            card_name += card_info_list[1]
                            card_info_list.pop(1)
                        # カード枚数を1枚に指定
                        card_value = 1
                        # カードデータの完成
                        card_info = {"name":card_name, "color":color_read(card_info_list[0]), "tap":False, "select":False, "position":[], "reverse":False}
                    else:
                        # カード情報が文明のみになるまで名前を結合
                        # カード名に空白が含まれている場合の処理
                        while len(card_info_list)>=3:
                            card_name += card_info_list[1]
                            card_info_list.pop(1)
                        # カード枚数を入力通りに指定
                        card_value = int(card_info_list[-1])
                        # カードデータの完成
                        card_info = {"name":card_name, "color":color_read(card_info_list[0]), "tap":False, "select":False, "position":[], "reverse":False}

                    for i in range(card_value):
                        MAIN_deck.append(card_info)

        # ファイルを閉じる
        f.close()

        #登録完了のメッセージ
        messagebox.showinfo("Notice","デッキを登録しました")
        # 読み取ったデッキを返す
        return MAIN_deck

# メイン部分
# デッキを読み込み
deck = deck_read()
# デッキ内のカードそれぞれに番号を割り当てる
for i in range(len(deck)):
    deck[i]["card_num"] = i # ここがうまくいかない
# 読み取ったデッキを表示
print(deck)

テキストファイルのサンプル

• 色　カード名　枚数　の順に記述
• 全角スペースと半角スペースは区別しない

青黒緑　カード1　4
緑　カード2　4
緑　カード3　3
青赤緑　カード4　4
白　カード5　4
白黒赤　カード6　2
白青赤　カード7　4
白黒赤　カード8　4
黒　カード9　4
赤緑　カード10　1
白青　カード11　1
青黒緑　カード12　1
黒　カード13　1
青　カード14　1
緑 カード15 2

想定していた実行結果

キー'card_num'の値は0から39、1枚ごとに異なる

[{'name': 'カード1', 'color': (255, 0, 255), 'tap': False, 'select': False, 'position': [], 'reverse': False, 'card_num': 0}, {'name': 'カード1', 'color': (255, 0, 255), 'tap': False, 'select': False, 'position': [], 'reverse': False, 'card_num': 1}, {'name': 'カード1', 'color': (255, 0, 255), 'tap': False, 'select': False, 'position': [], 'reverse': False, 'card_num': 2}, {'name': 'カード1', 'color': (255, 0, 255), 'tap': False, 'select': False, 'position': [], 'reverse': False, 'card_num': 3}, {'name': 'カード2', 'color': (120, 255, 120), 'tap': False, 'select': False, 'position': [], 'reverse': False, 'card_num': 4}, ...]

実際の実行結果

キー'card_num'の値が同名カードで同じ値になっている

[{'name': 'カード1', 'color': (255, 0, 255), 'tap': False, 'select': False, 'position': [], 'reverse': False, 'card_num': 3}, {'name': 'カード1', 'color': (255, 0, 255), 'tap': False, 'select': False, 'position': [], 'reverse': False, 'card_num': 3}, {'name': 'カード1', 'color': (255, 0, 255), 'tap': False, 'select': False, 'position': [], 'reverse': False, 'card_num': 3}, {'name': 'カード1', 'color': (255, 0, 255), 'tap': False, 'select': False, 'position': [], 'reverse': False, 'card_num': 3}, {'name': 'カード2', 'color': (120, 255, 120), 'tap': False, 'select': False, 'position': [], 'reverse': False, 'card_num': 7}, ...]

試したこと

• より単純な以下のコードdict_test.pyで実験。正しく処理され、想定通りの結果となった。

# dict_test.py
dic_list = []

for i in range(4):
    dic_list.append({"name":"a", "grade":1, "student":True})

for i in range(3):
    dic_list.append({"name":"b", "grade":1, "student":True})

for i in range(2):
    dic_list.append({"name":"c", "grade":3, "student":True})

for i in range(len(dic_list)):
    dic_list[i]["num"] = i

print(dic_list)

# 実行結果
[{'name': 'a', 'grade': 1, 'student': True, 'num': 0}, {'name': 'a', 'grade': 1, 'student': True, 'num': 1}, {'name': 'a', 'grade': 1, 'student': True, 'num': 2}, {'name': 'a', 'grade': 1, 'student': True, 'num': 3}, {'name': 'b', 'grade': 1, 'student': True, 'num': 4}, {'name': 'b', 'grade': 1, 'student': True, 'num': 5}, {'name': 'b', 'grade': 1, 'student': True, 'num': 6}, {'name': 'c', 'grade': 3, 'student': True, 'num': 7}, {'name': 'c', 'grade': 3, 'student': True, 'num': 8}]

• dict_test.pyを少し書き換えたプログラムdict_test2.pyを実行した。今回質問するに至った問題が再現された。

# dict_test2.py
dic_list = []
a = {"name":"a", "grade":1, "student":True}
b = {"name":"b", "grade":1, "student":True}
c = {"name":"c", "grade":3, "student":True}

for i in range(4):
    dic_list.append(a)

for i in range(3):
    dic_list.append(b)

for i in range(2):
    dic_list.append(b)

for i in range(len(dic_list)):
    dic_list[i]["num"] = i

print(dic_list)

# 実行結果
[{'name': 'a', 'grade': 1, 'student': True, 'num': 3}, {'name': 'a', 'grade': 1, 'student': True, 'num': 3}, {'name': 'a', 'grade': 1, 'student': True, 'num': 3}, {'name': 'a', 'grade': 1, 'student': True, 'num': 3}, {'name': 'b', 'grade': 1, 'student': True, 'num': 8}, {'name': 'b', 'grade': 1, 'student': True, 'num': 8}, {'name': 'b', 'grade': 1, 'student': True, 'num': 8}, {'name': 'b', 'grade': 1, 'student': True, 'num': 8}, {'name': 'b', 'grade': 1, 'student': True, 'num': 8}]

補足情報（FW/ツールのバージョンなど）

• Python 3.10.4

Answer 1

自己解決となっていますが、コメントします。

この件はpython(他でもありますが)のプログラミングあるあるの筆頭でしょう。

pythonでは値はオブジェクトであり、何らかの方法で生成されます。

                        card_info = {"name":card_name, "color":color_read(card_info_list[0]), "tap":False, "select":False, "position":[], "reverse":False}

上のコードでは、辞書が一つ生成されてcard_info変数に代入されていまが、ここで大事なのは、変数card_infoに値を入れているわけではないことを理解することです。 辞書はどこかに作られていて、それを変数からアクセスできるようになっているのです。
card_ifno ---> {辞書データ}
こんな感じです。

変数に値が入っていることとの違いは、変数間で値を受け渡すときです。

xx = card_info

としたとき、xx に card_infoが持つ辞書を代入していますが、このとき、変数は入れ物ではないので、オブジェクトのコピーは起きません。 この処理の結果は、 card_info と xx が同じオブジェクトを指すようになるということです。
card_info ---> {辞書データ}
xx -----------↑
この状態で、card_ifno を変更すると xx の値も変更されます。 同じものを指しているので当然です。

今変数xx で説明したことは、 配列や辞書の値についても同様です。

                    for i in range(card_value):
                        MAIN_deck.append(card_info)

この処理で、 MAIN_deckリストにappendされているのは、 card_infoが指している辞書のコピーではなく、同じものへのリンクのようなものです。 同じ辞書を指しているので、1つ変更すればすべて変ってしまいます。

解決策の1つは、 appendするものを、その都度生成する方法です。 自己解決の方法はそれです。
説明に何度か書いたように、コピーではないのが問題なので、コピーするという 方法もあります。

                    for i in range(card_value):
                        MAIN_deck.append(card_info.copy())

だだし、今回のコピーは浅い(shallow)コピーなので、場合によっては深い(deep)コピーが必要になるかもしれません。

Comments

[union_15]

ありがとうございます。
変数に値が入っているのかリンクが入っているのかという考え方は私の頭にはなかったため、非常に参考になりました。
また、そういった内部の構造、処理についてもっと勉強しなければとやる気が湧きました。
お教えくださり感謝いたします。

Answer 2

「試したこと」の欄が的を得ていた。
コードの95~99行目を以下のように置換したところ、想定通りの結果が得られた。

                        # カードデータの完成
                        for i in range(card_value):
                            MAIN_deck.append({"name":card_name, "color":color_read(card_info_list[0]), "tap":False, "select":False, "position":[], "reverse":False})

元のコードでは格納するデータを一度変数に代入してからその変数をリストに格納しており、どうやらこれがよくなかったらしい。
変更後のコードでは格納するデータをそのままリストに格納している。