|
| 1 | +"""UpperDict uppercases all string keys. |
| 2 | +
|
| 3 | +Test for initializer. `str` keys are uppercased:: |
| 4 | +
|
| 5 | + >>> d = UpperDict([('a', 'letter A'), ('B', 'letter B'), (2, 'digit two')]) |
| 6 | + >>> list(d.keys()) |
| 7 | + ['A', 'B', 2] |
| 8 | +
|
| 9 | +Tests for item retrieval using `d[key]` notation:: |
| 10 | +
|
| 11 | + >>> d['A'] |
| 12 | + 'letter A' |
| 13 | + >>> d['b'] |
| 14 | + 'letter B' |
| 15 | + >>> d[2] |
| 16 | + 'digit two' |
| 17 | +
|
| 18 | +
|
| 19 | +Tests for missing key:: |
| 20 | +
|
| 21 | + >>> d['z'] |
| 22 | + Traceback (most recent call last): |
| 23 | + ... |
| 24 | + KeyError: 'Z' |
| 25 | + >>> d[99] |
| 26 | + Traceback (most recent call last): |
| 27 | + ... |
| 28 | + KeyError: 99 |
| 29 | +
|
| 30 | +
|
| 31 | +Tests for item retrieval using `d.get(key)` notation:: |
| 32 | +
|
| 33 | + >>> d.get('a') |
| 34 | + 'letter A' |
| 35 | + >>> d.get('B') |
| 36 | + 'letter B' |
| 37 | + >>> d.get(2) |
| 38 | + 'digit two' |
| 39 | + >>> d.get('z', '(not found)') |
| 40 | + '(not found)' |
| 41 | +
|
| 42 | +Tests for the `in` operator:: |
| 43 | +
|
| 44 | + >>> ('a' in d, 'B' in d, 'z' in d) |
| 45 | + (True, True, False) |
| 46 | +
|
| 47 | +Test for item assignment using lowercase key:: |
| 48 | +
|
| 49 | + >>> d['c'] = 'letter C' |
| 50 | + >>> d['C'] |
| 51 | + 'letter C' |
| 52 | +
|
| 53 | +Tests for update using a `dict` or a sequence of pairs:: |
| 54 | +
|
| 55 | + >>> d.update({'D': 'letter D', 'e': 'letter E'}) |
| 56 | + >>> list(d.keys()) |
| 57 | + ['A', 'B', 2, 'C', 'D', 'E'] |
| 58 | + >>> d.update([('f', 'letter F'), ('G', 'letter G')]) |
| 59 | + >>> list(d.keys()) |
| 60 | + ['A', 'B', 2, 'C', 'D', 'E', 'F', 'G'] |
| 61 | + >>> d # doctest:+NORMALIZE_WHITESPACE |
| 62 | + {'A': 'letter A', 'B': 'letter B', 2: 'digit two', |
| 63 | + 'C': 'letter C', 'D': 'letter D', 'E': 'letter E', |
| 64 | + 'F': 'letter F', 'G': 'letter G'} |
| 65 | +
|
| 66 | +UpperCounter uppercases all `str` keys. |
| 67 | +
|
| 68 | +Test for initializer: keys are uppercased. |
| 69 | +
|
| 70 | + >>> d = UpperCounter('AbracAdaBrA') |
| 71 | + >>> sorted(d.keys()) |
| 72 | + ['A', 'B', 'C', 'D', 'R'] |
| 73 | +
|
| 74 | +Tests for count retrieval using `d[key]` notation:: |
| 75 | +
|
| 76 | + >>> d['a'] |
| 77 | + 5 |
| 78 | + >>> d['z'] |
| 79 | + 0 |
| 80 | +
|
| 81 | +""" |
| 82 | +# tag::UPPERCASE_MIXIN[] |
| 83 | +import collections |
| 84 | + |
| 85 | + |
| 86 | +def _upper(key): # <1> |
| 87 | + try: |
| 88 | + return key.upper() |
| 89 | + except AttributeError: |
| 90 | + return key |
| 91 | + |
| 92 | + |
| 93 | +class UpperCaseMixin: # <2> |
| 94 | + def __setitem__(self, key, item): |
| 95 | + super().__setitem__(_upper(key), item) |
| 96 | + |
| 97 | + def __getitem__(self, key): |
| 98 | + return super().__getitem__(_upper(key)) |
| 99 | + |
| 100 | + def get(self, key, default=None): |
| 101 | + return super().get(_upper(key), default) |
| 102 | + |
| 103 | + def __contains__(self, key): |
| 104 | + return super().__contains__(_upper(key)) |
| 105 | +# end::UPPERCASE_MIXIN[] |
| 106 | + |
| 107 | +# tag::UPPERDICT[] |
| 108 | +class UpperDict(UpperCaseMixin, collections.UserDict): # <1> |
| 109 | + pass |
| 110 | + |
| 111 | + |
| 112 | +class UpperCounter(UpperCaseMixin, collections.Counter): # <2> |
| 113 | + """Specialized 'Counter' that uppercases string keys""" # <3> |
| 114 | + |
| 115 | +# end::UPPERDICT[] |
0 commit comments