Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 1 | """A more or less complete user-defined wrapper around dictionary objects.""" |
Guido van Rossum | ae3b3a3 | 1993-11-30 13:43:54 +0000 | [diff] [blame] | 2 | |
| 3 | class UserDict: |
Raymond Hettinger | 5440545 | 2002-11-22 00:07:40 +0000 | [diff] [blame] | 4 | def __init__(self, dict=None, **kwargs): |
Raymond Hettinger | e4827eb | 2002-11-27 08:29:11 +0000 | [diff] [blame] | 5 | self.data = {} |
Raymond Hettinger | 5440545 | 2002-11-22 00:07:40 +0000 | [diff] [blame] | 6 | if dict is not None: |
Raymond Hettinger | e4827eb | 2002-11-27 08:29:11 +0000 | [diff] [blame] | 7 | self.update(dict) |
| 8 | if len(kwargs): |
| 9 | self.update(kwargs) |
Guido van Rossum | b94cd96 | 1997-06-03 14:10:01 +0000 | [diff] [blame] | 10 | def __repr__(self): return repr(self.data) |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 11 | def __eq__(self, dict): |
Guido van Rossum | 1697b9c | 1999-03-26 15:31:12 +0000 | [diff] [blame] | 12 | if isinstance(dict, UserDict): |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 13 | return self.data == dict.data |
Guido van Rossum | 1697b9c | 1999-03-26 15:31:12 +0000 | [diff] [blame] | 14 | else: |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 15 | 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 Rossum | b94cd96 | 1997-06-03 14:10:01 +0000 | [diff] [blame] | 21 | def __len__(self): return len(self.data) |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 22 | 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 Rossum | b94cd96 | 1997-06-03 14:10:01 +0000 | [diff] [blame] | 28 | def __setitem__(self, key, item): self.data[key] = item |
| 29 | def __delitem__(self, key): del self.data[key] |
Guido van Rossum | 1697b9c | 1999-03-26 15:31:12 +0000 | [diff] [blame] | 30 | def clear(self): self.data.clear() |
Guido van Rossum | b94cd96 | 1997-06-03 14:10:01 +0000 | [diff] [blame] | 31 | def copy(self): |
Guido van Rossum | 1697b9c | 1999-03-26 15:31:12 +0000 | [diff] [blame] | 32 | if self.__class__ is UserDict: |
Raymond Hettinger | 9014560 | 2003-12-21 22:19:08 +0000 | [diff] [blame] | 33 | return UserDict(self.data.copy()) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 34 | import copy |
Fred Drake | 3ce5af7 | 2001-11-05 17:40:48 +0000 | [diff] [blame] | 35 | 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 Rossum | b94cd96 | 1997-06-03 14:10:01 +0000 | [diff] [blame] | 43 | def keys(self): return self.data.keys() |
| 44 | def items(self): return self.data.items() |
| 45 | def values(self): return self.data.values() |
Raymond Hettinger | 31017ae | 2004-03-04 08:25:44 +0000 | [diff] [blame] | 46 | def update(self, dict=None, **kwargs): |
| 47 | if dict is None: |
| 48 | pass |
| 49 | elif isinstance(dict, UserDict): |
Guido van Rossum | 1697b9c | 1999-03-26 15:31:12 +0000 | [diff] [blame] | 50 | self.data.update(dict.data) |
Raymond Hettinger | 31017ae | 2004-03-04 08:25:44 +0000 | [diff] [blame] | 51 | elif isinstance(dict, type({})) or not hasattr(dict, 'items'): |
Guido van Rossum | 1697b9c | 1999-03-26 15:31:12 +0000 | [diff] [blame] | 52 | self.data.update(dict) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 53 | else: |
Guido van Rossum | 1697b9c | 1999-03-26 15:31:12 +0000 | [diff] [blame] | 54 | for k, v in dict.items(): |
Martin v. Löwis | f3b3074 | 2001-06-18 01:09:41 +0000 | [diff] [blame] | 55 | self[k] = v |
Raymond Hettinger | 31017ae | 2004-03-04 08:25:44 +0000 | [diff] [blame] | 56 | if len(kwargs): |
| 57 | self.data.update(kwargs) |
Barry Warsaw | fc3e61c | 1997-10-06 17:50:04 +0000 | [diff] [blame] | 58 | def get(self, key, failobj=None): |
Guido van Rossum | e2b70bc | 2006-08-18 22:13:04 +0000 | [diff] [blame] | 59 | if key not in self: |
Martin v. Löwis | f3b3074 | 2001-06-18 01:09:41 +0000 | [diff] [blame] | 60 | return failobj |
| 61 | return self[key] |
Guido van Rossum | 164452c | 2000-08-08 16:12:54 +0000 | [diff] [blame] | 62 | def setdefault(self, key, failobj=None): |
Guido van Rossum | e2b70bc | 2006-08-18 22:13:04 +0000 | [diff] [blame] | 63 | if key not in self: |
Martin v. Löwis | f3b3074 | 2001-06-18 01:09:41 +0000 | [diff] [blame] | 64 | self[key] = failobj |
| 65 | return self[key] |
Raymond Hettinger | a3e1e4c | 2003-03-06 23:54:28 +0000 | [diff] [blame] | 66 | def pop(self, key, *args): |
| 67 | return self.data.pop(key, *args) |
Guido van Rossum | 1072c38 | 2000-12-12 22:06:00 +0000 | [diff] [blame] | 68 | def popitem(self): |
| 69 | return self.data.popitem() |
Tim Peters | a3f98d6 | 2001-04-21 09:13:15 +0000 | [diff] [blame] | 70 | def __contains__(self, key): |
| 71 | return key in self.data |
Guido van Rossum | 75b64e6 | 2005-01-16 00:16:11 +0000 | [diff] [blame] | 72 | @classmethod |
Raymond Hettinger | e4827eb | 2002-11-27 08:29:11 +0000 | [diff] [blame] | 73 | def fromkeys(cls, iterable, value=None): |
| 74 | d = cls() |
| 75 | for key in iterable: |
| 76 | d[key] = value |
| 77 | return d |
Guido van Rossum | 2050b65 | 2001-08-07 17:40:42 +0000 | [diff] [blame] | 78 | |
| 79 | class IterableUserDict(UserDict): |
Tim Peters | a3f98d6 | 2001-04-21 09:13:15 +0000 | [diff] [blame] | 80 | def __iter__(self): |
| 81 | return iter(self.data) |