python 変数に辞書の値を入れたいが辞書に値がない時エラーになる

Question

実現したいこと

辞書にあるアイテムを変数に入れたいのですが、何らかの理由で辞書の情報が欠けてしまっている場合があります。
ソースコードでは 'utao' のweightが欠けていますがageやheightが欠けている場合もあります。
辞書にアイテムが存在するということを前提に変数に入れているので欠けていた場合エラーが出てしまいます。

こういうイレギュラーを防ぐために辞書のチェックを行い、欠けていた場合は暫定の値を入れるみたいなことをしたいのですがどうすればよいでしょうか？

エラー

__sent_weight = list[name]['weight']
KeyError: 'weight'

該当のソースコード

list = {
    'jone': {'age': 20, 'height': 180, 'weight': 75},
    'kaori': {'age': 18, 'height': 160, 'weight': 43},
    'utao': {'age': 16, 'height': 175},
}


async def get_items(name, list):
    if list.get(name, None) is not None:        
        _sent_age = list[name]['age']
        _sent_height = list[name]['height']
        _sent_weight = list[name]['weight']

Comments

[int32_t]

公式のリファレンスを読んでみましたか?
https://docs.python.org/ja/3/library/stdtypes.html?highlight=dict#mapping-types-dict

[meg_]

エラーと直接は関係ありませんが、変数名に「list」を使うのは止めましょう。

Answer 1

get(key, default) を使いましょう。

  _sent_weight = list[name].get('weight', -1)

Answer 2

こんにちは。初学者の回答になりますので、話半分くらいで聞いていただけると幸いです。実際、asyncのところの表記は今ひとつ理解ができていませんので、「欠けていた場合は暫定の値を入れる」というところに絞って回答させていただきます。

さて本題ですが、コードと質問の方を読ませていただく限り、defaultdictで解決できると思われます。defaultdictはコンテナデータ型の一つで、生成時に関数を引数として与えることで、その関数が自動的に初期化を行ってくれるようになります。サンプルコードとしてはこんな感じ。

from collections import defaultdict

utao_profile = defaultdict(int)
utao_profile['age'] = 16
utao_profile['height'] = 175

print(utao_profile['age'])
print(utao_profile['height'])
print(utao_profile['weight'])

16
175
0

ここではintを関数として与えています。intは引数を取らない時に0を返しますので、存在しない'weight'というキーを読み込んだときにもエラーを吐かず、ゼロを出力してくれます。

もちろんこの関数は自作しても良いです。値が存在しないということで、Noneを格納して欲しければ、Noneを返す関数を自作して与えてあげればOK。

from collections import defaultdict

def NoneMaker():
    return None

utao_profile = defaultdict(NoneMaker)
utao_profile['age'] = 16
utao_profile['height'] = 175

print(utao_profile['age'])
print(utao_profile['height'])
print(utao_profile['weight'])

16
175
None

ただ、この程度の働きであれば、関数を定義するまでもなく無名関数を使ってあげればよいでしょう。lambda: 値とすることで、任意の値を返す名無しの関数が作れます。

ということで、書かれているものと(おおむね)同じ働きをするコードは以下のようになります。

from collections import defaultdict


jone_profile = defaultdict(lambda: None)
jone_profile['age'] = 20
jone_profile['height'] = 180
jone_profile['weight'] = 75

kaori_profile = defaultdict(lambda: None)
kaori_profile['age'] = 18
kaori_profile['height'] = 160
kaori_profile['weight'] = 43

utao_profile = defaultdict(lambda: None)
utao_profile['age'] = 16
utao_profile['height'] = 175

profiles = {
    'jone': jone_profile,
    'kaori': kaori_profile,
    'utao': utao_profile,
}

print(profiles['jone']['age'])
print(profiles['utao']['weight'])

20
None

ただ、このコードにも少し問題がありまして、それはどんなキーでアクセスしてもエラーを吐かずNoneが返ってくることです。上の例だと誕生日だとかでアクセスをかけてもNoneが返ってきてしまいます。

print(profiles['jone']['birthday'])

None

想定しない値へのアクセスは防ぎつつ、デフォルトの値を設定したいのであれば、NamedTupleとOptionalの併用も視野に入るでしょう。NamedTupleは.属性名でアクセスできるコンテナの一種で、Optionalと併用することで、「基本はNoneで、値が入力された場合はそちらを採用」といった形で利用することが可能です。この方法であれば存在していない属性へのアクセスが防げて、かつ決まったデータ型を格納することもできるようになります。

from typing import NamedTuple, Optional

class Profile(NamedTuple):
    name: str
    age: Optional[int] = None
    height: Optional[int] = None
    weight: Optional[int] = None

jone_profile = Profile(name='jone', age=20, height=180, weight=75)
utao_profile = Profile(name='utao', age=16, height =175)

print(jone_profile.weight)
print(utao_profile.weight)

75
None

必ず与えられる属性は、"属性名: データ型"。与えられないかもしれない属性は"属性: Optional[想定されるデータ型] = デフォルト値"という使い方です。こいつなら、

print(utao_profile.birthday)

というアクセスがあっても、

AttributeError: 'Profile' object has no attribute 'birthday'

「そんなもん設定されてないよ」と返してくれます。

以上、なにかの参考になれば幸いです。

(追記)
だーっと書いて見直してから気づいたのですが、「辞書側には干渉できない」という可能性が頭から抜けてました。その場合は力技にはなりますが、for文+valuesで中身の辞書を取り出してから、setdefaultメソッドで片っ端から値を代入するのが手っ取り早いかもしれません。setdefaultは辞書に備え付けられたメソッドの一つで、setdefault(key, value)とすることで、keyが存在しない場合のみ、valueが新たな値として追加されるという働きをします。

profiles = {
    'jone': {'age': 20, 'height': 180, 'weight': 75},
    'kaori': {'age': 18, 'height': 160, 'weight': 43},
    'utao': {'age': 16, 'height': 175},
}

for profile_dict in profiles.values():
    profile_dict.setdefault('age', None)
    profile_dict.setdefault('height', None)
    profile_dict.setdefault('weight', None)

print(profiles)

{'jone': {'age': 20, 'height': 180, 'weight': 75}, 'kaori': {'age': 18, 'height': 160, 'weight': 43}, 'utao': {'age': 16, 'height': 175, 'weight': None}}

Comments

[ngmg]

すごいです！とても丁寧に解説頂きありがとうございます！
自分の知らない方法を聞けて感激です。
こちらの方法でやってみたいと思います。
ありがとうございました！