blob: cb8a826ff45e21a0175cd7101c7452a565d7a3a2 [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:
Raymond Hettinger54405452002-11-22 00:07:40 +00004 def __init__(self, dict=None, **kwargs):
Raymond Hettingere4827eb2002-11-27 08:29:11 +00005 self.data = {}
Raymond Hettinger54405452002-11-22 00:07:40 +00006 if dict is not None:
Raymond Hettingere4827eb2002-11-27 08:29:11 +00007 self.update(dict)
8 if len(kwargs):
9 self.update(kwargs)
Guido van Rossumb94cd961997-06-03 14:10:01 +000010 def __repr__(self): return repr(self.data)
Guido van Rossum47b9ff62006-08-24 00:41:19 +000011 def __eq__(self, dict):
Guido van Rossum1697b9c1999-03-26 15:31:12 +000012 if isinstance(dict, UserDict):
Guido van Rossum47b9ff62006-08-24 00:41:19 +000013 return self.data == dict.data
Guido van Rossum1697b9c1999-03-26 15:31:12 +000014 else:
Guido van Rossum47b9ff62006-08-24 00:41:19 +000015 return self.data == dict
16 def __ne__(self, dict):
17 if isinstance(dict, UserDict):
18 return self.data != dict.data
19 else:
20 return self.data != dict
Guido van Rossumb94cd961997-06-03 14:10:01 +000021 def __len__(self): return len(self.data)
Guido van Rossum1968ad32006-02-25 22:38:04 +000022 def __getitem__(self, key):
23 if key in self.data:
24 return self.data[key]
25 if hasattr(self.__class__, "__missing__"):
26 return self.__class__.__missing__(self, key)
27 raise KeyError(key)
Guido van Rossumb94cd961997-06-03 14:10:01 +000028 def __setitem__(self, key, item): self.data[key] = item
29 def __delitem__(self, key): del self.data[key]
Guido van Rossum1697b9c1999-03-26 15:31:12 +000030 def clear(self): self.data.clear()
Guido van Rossumb94cd961997-06-03 14:10:01 +000031 def copy(self):
Guido van Rossum1697b9c1999-03-26 15:31:12 +000032 if self.__class__ is UserDict:
Raymond Hettinger90145602003-12-21 22:19:08 +000033 return UserDict(self.data.copy())
Guido van Rossum45e2fbc1998-03-26 21:13:24 +000034 import copy
Fred Drake3ce5af72001-11-05 17:40:48 +000035 data = self.data
36 try:
37 self.data = {}
38 c = copy.copy(self)
39 finally:
40 self.data = data
41 c.update(self)
42 return c
Guido van Rossumb94cd961997-06-03 14:10:01 +000043 def keys(self): return self.data.keys()
44 def items(self): return self.data.items()
45 def values(self): return self.data.values()
Raymond Hettinger31017ae2004-03-04 08:25:44 +000046 def update(self, dict=None, **kwargs):
47 if dict is None:
48 pass
49 elif isinstance(dict, UserDict):
Guido van Rossum1697b9c1999-03-26 15:31:12 +000050 self.data.update(dict.data)
Raymond Hettinger31017ae2004-03-04 08:25:44 +000051 elif isinstance(dict, type({})) or not hasattr(dict, 'items'):
Guido van Rossum1697b9c1999-03-26 15:31:12 +000052 self.data.update(dict)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +000053 else:
Guido van Rossum1697b9c1999-03-26 15:31:12 +000054 for k, v in dict.items():
Martin v. Löwisf3b30742001-06-18 01:09:41 +000055 self[k] = v
Raymond Hettinger31017ae2004-03-04 08:25:44 +000056 if len(kwargs):
57 self.data.update(kwargs)
Barry Warsawfc3e61c1997-10-06 17:50:04 +000058 def get(self, key, failobj=None):
Guido van Rossume2b70bc2006-08-18 22:13:04 +000059 if key not in self:
Martin v. Löwisf3b30742001-06-18 01:09:41 +000060 return failobj
61 return self[key]
Guido van Rossum164452c2000-08-08 16:12:54 +000062 def setdefault(self, key, failobj=None):
Guido van Rossume2b70bc2006-08-18 22:13:04 +000063 if key not in self:
Martin v. Löwisf3b30742001-06-18 01:09:41 +000064 self[key] = failobj
65 return self[key]
Raymond Hettingera3e1e4c2003-03-06 23:54:28 +000066 def pop(self, key, *args):
67 return self.data.pop(key, *args)
Guido van Rossum1072c382000-12-12 22:06:00 +000068 def popitem(self):
69 return self.data.popitem()
Tim Petersa3f98d62001-04-21 09:13:15 +000070 def __contains__(self, key):
71 return key in self.data
Guido van Rossum75b64e62005-01-16 00:16:11 +000072 @classmethod
Raymond Hettingere4827eb2002-11-27 08:29:11 +000073 def fromkeys(cls, iterable, value=None):
74 d = cls()
75 for key in iterable:
76 d[key] = value
77 return d
Guido van Rossum2050b652001-08-07 17:40:42 +000078
79class IterableUserDict(UserDict):
Tim Petersa3f98d62001-04-21 09:13:15 +000080 def __iter__(self):
81 return iter(self.data)