Oggetto del tipo personalizzato come chiave del dizionario

Question

Cosa devo fare per utilizzare i miei oggetti di un tipo personalizzato come chiavi in ​​un dizionario Python (dove non voglio che "ID oggetto" agisca come chiave), ad es.

class MyThing: 
    def __init__(self,name,location,length): 
      self.name = name 
      self.location = location 
      self.length = length 

Vorrei utilizzare MyThing come chiavi considerate uguali se nome e posizione sono uguali. Da C#/Java Sono abituato a dover eseguire l'override e fornire un metodo equals and hashcode, e prometto di non mutare nulla da cui dipende l'hashcode.

Cosa devo fare in Python per realizzare questo? Dovrei anche?

(In un caso semplice, come qui, forse sarebbe meglio mettere solo un (nome, posizione) tupla come chiave - ma prendere in considerazione vorrei la chiave per essere un oggetto)

Answer 1

è necessario aggiungere 2 methods, nota __hash__ e __eq__:

class MyThing: 
    def __init__(self,name,location,length): 
     self.name = name 
     self.location = location 
     self.length = length 

    def __hash__(self): 
     return hash((self.name, self.location)) 

    def __eq__(self, other): 
     return (self.name, self.location) == (other.name, other.location) 

    def __ne__(self, other): 
     # Not strictly necessary, but to avoid having both x==y and x!=y 
     # True at the same time 
     return not(self == other) 

Il Python dict documentation definisce questi requisiti oggetti chiave, vale a dire devono essere hashable.

Answer 2

È sostituisci __hash__ se vuoi hash-semantics speciali e __cmp__ o __eq__ per rendere la tua classe utilizzabile come chiave. Gli oggetti che confrontano lo stesso devono avere lo stesso valore di hash.

Python si aspetta __hash__ di restituire un numero intero, tornando Banana() non è raccomandato :)

classi

utente definito hanno __hash__ di default che chiama id(self), come avrete notato.

C'è qualche consiglio in più dalla documentation:.

classi che ereditano un metodo __hash__() da una classe padre, ma cambiano il significato di __cmp__() o __eq__() tale che il valore di hash restituito è no più appropriato (ad esempio per passando a un concetto basato sul valore di uguaglianza anziché all'uguaglianza basata sull'identità predefinita ) è possibile che sia contrassegnato esplicitamente come inammissibile impostando __hash__ = None nella definizione della classe. In questo modo significa che non solo le istanze di classe alzare un adeguato TypeError quando un programma tenta di recuperare il loro valore di hash, ma saranno anche correttamente identificate come calcolo dell'hash al momento del check isinstance(obj, collections.Hashable) (a differenza di classi che definiscono il proprio __hash__() per sollevare esplicitamente l'errore TypeError).

Answer 3

Un'alternativa in Python 2.6 o superiore è di usare collections.namedtuple() - consente di risparmiare iscritto eventuali metodi speciali:

from collections import namedtuple 
MyThingBase = namedtuple("MyThingBase", ["name", "location"]) 
class MyThing(MyThingBase): 
    def __new__(cls, name, location, length): 
     obj = MyThingBase.__new__(cls, name, location) 
     obj.length = length 
     return obj 

a = MyThing("a", "here", 10) 
b = MyThing("a", "here", 20) 
c = MyThing("c", "there", 10) 
a == b 
# True 
hash(a) == hash(b) 
# True 
a == c 
# False