util.py 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
  1. """Various utility functions."""
  2. from collections import namedtuple, OrderedDict
  3. __unittest = True
  4. _MAX_LENGTH = 80
  5. def safe_repr(obj, short=False):
  6. try:
  7. result = repr(obj)
  8. except Exception:
  9. result = object.__repr__(obj)
  10. if not short or len(result) < _MAX_LENGTH:
  11. return result
  12. return result[:_MAX_LENGTH] + ' [truncated]...'
  13. def strclass(cls):
  14. return "%s.%s" % (cls.__module__, cls.__name__)
  15. def sorted_list_difference(expected, actual):
  16. """Finds elements in only one or the other of two, sorted input lists.
  17. Returns a two-element tuple of lists. The first list contains those
  18. elements in the "expected" list but not in the "actual" list, and the
  19. second contains those elements in the "actual" list but not in the
  20. "expected" list. Duplicate elements in either input list are ignored.
  21. """
  22. i = j = 0
  23. missing = []
  24. unexpected = []
  25. while True:
  26. try:
  27. e = expected[i]
  28. a = actual[j]
  29. if e < a:
  30. missing.append(e)
  31. i += 1
  32. while expected[i] == e:
  33. i += 1
  34. elif e > a:
  35. unexpected.append(a)
  36. j += 1
  37. while actual[j] == a:
  38. j += 1
  39. else:
  40. i += 1
  41. try:
  42. while expected[i] == e:
  43. i += 1
  44. finally:
  45. j += 1
  46. while actual[j] == a:
  47. j += 1
  48. except IndexError:
  49. missing.extend(expected[i:])
  50. unexpected.extend(actual[j:])
  51. break
  52. return missing, unexpected
  53. def unorderable_list_difference(expected, actual, ignore_duplicate=False):
  54. """Same behavior as sorted_list_difference but
  55. for lists of unorderable items (like dicts).
  56. As it does a linear search per item (remove) it
  57. has O(n*n) performance.
  58. """
  59. missing = []
  60. unexpected = []
  61. while expected:
  62. item = expected.pop()
  63. try:
  64. actual.remove(item)
  65. except ValueError:
  66. missing.append(item)
  67. if ignore_duplicate:
  68. for lst in expected, actual:
  69. try:
  70. while True:
  71. lst.remove(item)
  72. except ValueError:
  73. pass
  74. if ignore_duplicate:
  75. while actual:
  76. item = actual.pop()
  77. unexpected.append(item)
  78. try:
  79. while True:
  80. actual.remove(item)
  81. except ValueError:
  82. pass
  83. return missing, unexpected
  84. # anything left in actual is unexpected
  85. return missing, actual
  86. _Mismatch = namedtuple('Mismatch', 'actual expected value')
  87. def _count_diff_all_purpose(actual, expected):
  88. 'Returns list of (cnt_act, cnt_exp, elem) triples where the counts differ'
  89. # elements need not be hashable
  90. s, t = list(actual), list(expected)
  91. m, n = len(s), len(t)
  92. NULL = object()
  93. result = []
  94. for i, elem in enumerate(s):
  95. if elem is NULL:
  96. continue
  97. cnt_s = cnt_t = 0
  98. for j in range(i, m):
  99. if s[j] == elem:
  100. cnt_s += 1
  101. s[j] = NULL
  102. for j, other_elem in enumerate(t):
  103. if other_elem == elem:
  104. cnt_t += 1
  105. t[j] = NULL
  106. if cnt_s != cnt_t:
  107. diff = _Mismatch(cnt_s, cnt_t, elem)
  108. result.append(diff)
  109. for i, elem in enumerate(t):
  110. if elem is NULL:
  111. continue
  112. cnt_t = 0
  113. for j in range(i, n):
  114. if t[j] == elem:
  115. cnt_t += 1
  116. t[j] = NULL
  117. diff = _Mismatch(0, cnt_t, elem)
  118. result.append(diff)
  119. return result
  120. def _ordered_count(iterable):
  121. 'Return dict of element counts, in the order they were first seen'
  122. c = OrderedDict()
  123. for elem in iterable:
  124. c[elem] = c.get(elem, 0) + 1
  125. return c
  126. def _count_diff_hashable(actual, expected):
  127. 'Returns list of (cnt_act, cnt_exp, elem) triples where the counts differ'
  128. # elements must be hashable
  129. s, t = _ordered_count(actual), _ordered_count(expected)
  130. result = []
  131. for elem, cnt_s in s.items():
  132. cnt_t = t.get(elem, 0)
  133. if cnt_s != cnt_t:
  134. diff = _Mismatch(cnt_s, cnt_t, elem)
  135. result.append(diff)
  136. for elem, cnt_t in t.items():
  137. if elem not in s:
  138. diff = _Mismatch(0, cnt_t, elem)
  139. result.append(diff)
  140. return result