Cas d'utilisation de la méthode 'setdefault' du dictionnaire

Question

L'ajout de collections.defaultdict en Python 2.5 a grandement réduit le besoin de la méthode setdefault de dict. Cette question est pour notre éducation collective :

1. Pour quoi setdefault est-il encore utile aujourd'hui en Python 2.6/2.7 ?
2. Quels cas d'utilisation populaires de setdefault ont été remplacés par collections.defaultdict ?

Answer 1

Vous pourriez dire que defaultdict est utile pour définir des valeurs par défaut avant de remplir le dictionnaire et que setdefault est utile pour définir des valeurs par défaut pendant ou après le remplissage du dictionnaire.

Probablement le cas d'utilisation le plus courant : regrouper des éléments (dans des données non triées, sinon utilisez itertools.groupby)

# vraiment verbeux
new = {}
for (key, value) in data:
    if key in new:
        new[key].append( value )
    else:
        new[key] = [value]

# facile avec setdefault
new = {}
for (key, value) in data:
    group = new.setdefault(key, []) # la clé pourrait déjà exister
    group.append( value )

# encore plus simple avec defaultdict 
from collections import defaultdict
new = defaultdict(list)
for (key, value) in data:
    new[key].append( value ) # toutes les clés ont déjà une valeur par défaut

Parfois, vous souhaitez vous assurer que des clés spécifiques existent après la création d'un dictionnaire. defaultdict ne fonctionne pas dans ce cas, car il crée des clés uniquement lors de l'accès explicite. Pensez à utiliser quelque chose de semblable à HTTP avec de nombreux en-têtes - certains sont facultatifs, mais vous voulez des valeurs par défaut pour eux :

headers = parse_headers( msg ) # analyser le message, obtenir un dictionnaire
# maintenant ajoutez tous les en-têtes facultatifs
for nom_en_tete, valeur_par_defaut in en_tetes_optionnels:
    headers.setdefault( nom_en_tete, valeur_par_defaut )

Answer 2

Je utilise communément setdefault pour les dictionnaires d'arguments de mots-clés, comme dans cette fonction :

def notify(self, level, *pargs, **kwargs):
    kwargs.setdefault("persist", level >= DANGER)
    self.__defcon.set(level, **kwargs)
    try:
        kwargs.setdefault("name", self.client.player_entity().name)
    except pytibia.PlayerEntityNotFound:
        pass
    return _notify(level, *pargs, **kwargs)

C'est idéal pour ajuster les arguments dans des wrappers autour des fonctions qui utilisent des arguments de mots-clés.

Answer 3

defaultdict est génial lorsque la valeur par défaut est statique, comme une nouvelle liste, mais pas tellement si elle est dynamique.

Par exemple, j'ai besoin d'un dictionnaire pour mapper les chaînes de caractères sur des entiers uniques. defaultdict(int) utilisera toujours 0 comme valeur par défaut. De même, defaultdict(intGen()) produit toujours 1.

À la place, j'ai utilisé un dictionnaire régulier :

nextID = intGen()
myDict = {}
pour beaucoup de choses compliquées :
    # choses qui génèrent des chaînes de caractères imprévisibles, peut-être déjà vues
    strID = myDict.setdefault(myStr, nextID())

Notez que dict.get(key, nextID()) est insuffisant car j'ai besoin de pouvoir référer à ces valeurs plus tard également.

intGen est une petite classe que j'ai créée qui incrémente automatiquement un entier et renvoie sa valeur :

class intGen:
    def __init__(self):
        self.i = 0

    def __call__(self):
        self.i += 1
    return self.i

Si quelqu'un a une manière de faire cela avec defaultdict, j'adorerais le voir.

Answer 4

J'utilise setdefault() lorsque je veux une valeur par défaut dans un OrderedDict. Il n'existe pas de collection Python standard qui le fait, mais il y a des moyens d'implémenter une telle collection.

Answer 5

Théoriquement parlant, setdefault serait toujours pratique si vous voulez parfois définir une valeur par défaut et parfois non. Dans la vraie vie, je n'ai pas encore rencontré un tel cas d'utilisation.

Cependant, un cas d'utilisation intéressant provient de la bibliothèque standard (Python 2.6, _threadinglocal.py) :

>>> mydata = local()
>>> mydata.__dict__
{'number': 42}
>>> mydata.__dict__.setdefault('widgets', [])
[]
>>> mydata.widgets
[]

Je dirais que l'utilisation de __dict__.setdefault est un cas assez utile.

Édition : Comme il se trouve, c'est le seul exemple dans la bibliothèque standard et il est dans un commentaire. Donc peut-être ce n'est pas suffisant pour justifier l'existence de setdefault. Néanmoins, voici une explication :

Les objets stockent leurs attributs dans l'attribut __dict__. Comme il se trouve, l'attribut __dict__ est modifiable à tout moment après la création de l'objet. C'est aussi un dictionnaire et non un defaultdict. Il n'est pas sensé pour les objets en général d'avoir __dict__ comme un defaultdict car cela ferait en sorte que chaque objet ait tous les identifiants légaux comme attributs. Donc je ne vois pas de changement possible dans les objets Python qui se débarrasseraient de __dict__.setdefault, à part le supprimer complètement s'il était jugé inutile.