blob: 91af83c08136495346daa97975e1bb2e650b1bb6 [file] [log] [blame]
Guido van Rossum4acc25b2000-02-02 15:10:15 +00001"""A more or less complete user-defined wrapper around dictionary objects."""
Guido van Rossumae3b3a31993-11-30 13:43:54 +00002
3class UserDict:
Guido van Rossum1697b9c1999-03-26 15:31:12 +00004 def __init__(self, dict=None):
5 self.data = {}
6 if dict is not None: self.update(dict)
Guido van Rossumb94cd961997-06-03 14:10:01 +00007 def __repr__(self): return repr(self.data)
8 def __cmp__(self, dict):
Guido van Rossum1697b9c1999-03-26 15:31:12 +00009 if isinstance(dict, UserDict):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +000010 return cmp(self.data, dict.data)
Guido van Rossum1697b9c1999-03-26 15:31:12 +000011 else:
12 return cmp(self.data, dict)
Guido van Rossumb94cd961997-06-03 14:10:01 +000013 def __len__(self): return len(self.data)
14 def __getitem__(self, key): return self.data[key]
15 def __setitem__(self, key, item): self.data[key] = item
16 def __delitem__(self, key): del self.data[key]
Guido van Rossum1697b9c1999-03-26 15:31:12 +000017 def clear(self): self.data.clear()
Guido van Rossumb94cd961997-06-03 14:10:01 +000018 def copy(self):
Guido van Rossum1697b9c1999-03-26 15:31:12 +000019 if self.__class__ is UserDict:
20 return UserDict(self.data)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +000021 import copy
Fred Drake3ce5af72001-11-05 17:40:48 +000022 data = self.data
23 try:
24 self.data = {}
25 c = copy.copy(self)
26 finally:
27 self.data = data
28 c.update(self)
29 return c
Guido van Rossumb94cd961997-06-03 14:10:01 +000030 def keys(self): return self.data.keys()
31 def items(self): return self.data.items()
Fred Drakebedebbd2001-05-03 04:54:41 +000032 def iteritems(self): return self.data.iteritems()
33 def iterkeys(self): return self.data.iterkeys()
34 def itervalues(self): return self.data.itervalues()
Guido van Rossumb94cd961997-06-03 14:10:01 +000035 def values(self): return self.data.values()
36 def has_key(self, key): return self.data.has_key(key)
Guido van Rossum1697b9c1999-03-26 15:31:12 +000037 def update(self, dict):
38 if isinstance(dict, UserDict):
39 self.data.update(dict.data)
40 elif isinstance(dict, type(self.data)):
41 self.data.update(dict)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +000042 else:
Guido van Rossum1697b9c1999-03-26 15:31:12 +000043 for k, v in dict.items():
Martin v. Löwisf3b30742001-06-18 01:09:41 +000044 self[k] = v
Barry Warsawfc3e61c1997-10-06 17:50:04 +000045 def get(self, key, failobj=None):
Martin v. Löwisf3b30742001-06-18 01:09:41 +000046 if not self.has_key(key):
47 return failobj
48 return self[key]
Guido van Rossum164452c2000-08-08 16:12:54 +000049 def setdefault(self, key, failobj=None):
Martin v. Löwisf3b30742001-06-18 01:09:41 +000050 if not self.has_key(key):
51 self[key] = failobj
52 return self[key]
Guido van Rossumf4956252002-04-13 14:03:38 +000053 def pop(self, key):
54 return self.data.pop(key)
Guido van Rossum1072c382000-12-12 22:06:00 +000055 def popitem(self):
56 return self.data.popitem()
Tim Petersa3f98d62001-04-21 09:13:15 +000057 def __contains__(self, key):
58 return key in self.data
Guido van Rossum2050b652001-08-07 17:40:42 +000059
60class IterableUserDict(UserDict):
Tim Petersa3f98d62001-04-21 09:13:15 +000061 def __iter__(self):
62 return iter(self.data)