1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
|
# coding: utf-8
import collections
import sys
import re
import pytest
from _pydevd_bundle.pydevd_safe_repr import SafeRepr
import json
from _pydevd_bundle.pydevd_constants import IS_PY36_OR_GREATER
try:
import numpy as np
except ImportError:
np = None
PY_VER = sys.version_info[0]
assert PY_VER <= 3 # Fix the code when Python 4 comes around.
PY3K = PY_VER == 3
class SafeReprTestBase(object):
saferepr = SafeRepr()
def assert_saferepr(self, value, expected):
safe = self.saferepr(value)
if len(safe) != len(expected):
raise AssertionError(
"Expected:\n%s\nFound:\n%s\n Expected len: %s Found len: %s"
% (
expected,
safe,
len(expected),
len(safe),
)
)
assert safe == expected
return safe
def assert_unchanged(self, value, expected):
actual = repr(value)
safe = self.assert_saferepr(value, expected)
assert safe == actual
def assert_shortened(self, value, expected):
actual = repr(value)
safe = self.assert_saferepr(value, expected)
assert safe != actual
def assert_saferepr_regex(self, s, r):
safe = self.saferepr(s)
assert re.search(r, safe) is not None
return safe
def assert_unchanged_regex(self, value, expected):
actual = repr(value)
safe = self.assert_saferepr_regex(value, expected)
assert safe == actual
def assert_shortened_regex(self, value, expected):
actual = repr(value)
safe = self.assert_saferepr_regex(value, expected)
assert safe != actual
class TestSafeRepr(SafeReprTestBase):
def test_collection_types(self):
colltypes = [t for t, _, _, _ in SafeRepr.collection_types]
assert colltypes == [
tuple,
list,
frozenset,
set,
collections.deque,
]
def test_largest_repr(self):
# Find the largest possible repr and make sure it works
coll = "-" * (SafeRepr.maxstring_outer * 2)
for limit in reversed(SafeRepr.maxcollection[1:]):
coll = [coll] * (limit * 2)
dcoll = {}
for i in range(SafeRepr.maxcollection[0]):
dcoll[str(i) * SafeRepr.maxstring_outer] = coll
text = self.saferepr(dcoll)
# try:
# text_repr = repr(dcoll)
# except MemoryError:
# print('Memory error raised while creating repr of test data')
# text_repr = ''
# print('len(SafeRepr()(dcoll)) = ' + str(len(text)) +
# ', len(repr(coll)) = ' + str(len(text_repr)))
assert len(text) <= 158538
class TestStrings(SafeReprTestBase):
def test_str_small(self):
value = "A" * 5
self.assert_unchanged(value, "'AAAAA'")
self.assert_unchanged([value], "['AAAAA']")
def test_str_large(self):
value = "A" * (SafeRepr.maxstring_outer + 10)
self.assert_shortened(value, "'" + "A" * 43690 + "..." + "A" * 21845 + "'")
self.assert_shortened(
[value],
"['AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA...AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA']",
)
def test_str_largest_unchanged(self):
value = "A" * (SafeRepr.maxstring_outer)
self.assert_unchanged(value, "'" + "A" * 65536 + "'")
def test_str_smallest_changed(self):
value = "A" * (SafeRepr.maxstring_outer + 1)
self.assert_shortened(value, "'" + "A" * 43690 + "..." + "A" * 21845 + "'")
def test_str_list_largest_unchanged(self):
value = "A" * (SafeRepr.maxstring_inner)
self.assert_unchanged(
[value],
"['AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA']",
)
def test_str_list_smallest_changed(self):
value = "A" * (SafeRepr.maxstring_inner + 1)
self.assert_shortened(
[value],
"['AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA...AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA']",
)
@pytest.mark.skipif(sys.version_info > (3, 0), reason="Py2 specific test")
def test_unicode_small(self):
value = "A" * 5
self.assert_unchanged(value, "u'AAAAA'")
self.assert_unchanged([value], "[u'AAAAA']")
@pytest.mark.skipif(sys.version_info > (3, 0), reason="Py2 specific test")
def test_unicode_large(self):
value = "A" * (SafeRepr.maxstring_outer + 10)
self.assert_shortened(value, "u'" + "A" * 43690 + "..." + "A" * 21845 + "'")
self.assert_shortened([value], "[u'AAAAAAAAAAAAAAAAAAAA...AAAAAAAAAA']")
@pytest.mark.skipif(sys.version_info < (3, 0), reason="Py3 specific test")
def test_bytes_small(self):
value = b"A" * 5
self.assert_unchanged(value, "b'AAAAA'")
self.assert_unchanged([value], "[b'AAAAA']")
@pytest.mark.skipif(sys.version_info < (3, 0), reason="Py3 specific test")
def test_bytes_large(self):
value = b"A" * (SafeRepr.maxstring_outer + 10)
self.assert_shortened(value, "b'" + "A" * 43690 + "..." + "A" * 21845 + "'")
self.assert_shortened(
[value],
"[b'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA...AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA']",
)
# @pytest.mark.skip(reason='not written') # TODO: finish!
# def test_bytearray_small(self):
# raise NotImplementedError
#
# @pytest.mark.skip(reason='not written') # TODO: finish!
# def test_bytearray_large(self):
# raise NotImplementedError
class RawValueTests(SafeReprTestBase):
def setUp(self):
super(RawValueTests, self).setUp()
self.saferepr.raw_value = True
def test_unicode_raw(self):
value = "A\u2000" * 10000
self.assert_saferepr(value, value)
def test_bytes_raw(self):
value = b"A" * 10000
self.assert_saferepr(value, value.decode("ascii"))
def test_bytearray_raw(self):
value = bytearray(b"A" * 5)
self.assert_saferepr(value, value.decode("ascii"))
# class TestNumbers(SafeReprTestBase):
#
# @pytest.mark.skip(reason='not written') # TODO: finish!
# def test_int(self):
# raise NotImplementedError
#
# @pytest.mark.skip(reason='not written') # TODO: finish!
# def test_float(self):
# raise NotImplementedError
#
# @pytest.mark.skip(reason='not written') # TODO: finish!
# def test_complex(self):
# raise NotImplementedError
class ContainerBase(object):
CLASS = None
LEFT = None
RIGHT = None
@property
def info(self):
try:
return self._info
except AttributeError:
for info in SafeRepr.collection_types:
ctype, _, _, _ = info
if self.CLASS is ctype:
type(self)._info = info
return info
else:
raise TypeError("unsupported")
def _combine(self, items, prefix, suffix, large):
contents = ", ".join(str(item) for item in items)
if large:
contents += ", ..."
return prefix + contents + suffix
def combine(self, items, large=False):
if self.LEFT is None:
pytest.skip("unsupported")
return self._combine(items, self.LEFT, self.RIGHT, large=large)
def combine_nested(self, depth, items, large=False):
_, _prefix, _suffix, comma = self.info
prefix = _prefix * (depth + 1)
if comma:
suffix = _suffix + ("," + _suffix) * depth
else:
suffix = _suffix * (depth + 1)
# print("ctype = " + ctype.__name__ + ", maxcollection[" +
# str(i) + "] == " + str(SafeRepr.maxcollection[i]))
return self._combine(items, prefix, suffix, large=large)
def test_large_flat(self):
c1 = self.CLASS(range(SafeRepr.maxcollection[0] * 2))
items = range(SafeRepr.maxcollection[0] - 1)
c1_expect = self.combine(items, large=True)
self.assert_shortened(c1, c1_expect)
def test_large_nested(self):
c1 = self.CLASS(range(SafeRepr.maxcollection[0] * 2))
c1_items = range(SafeRepr.maxcollection[1] - 1)
c1_expect = self.combine(c1_items, large=True)
c2 = self.CLASS(c1 for _ in range(SafeRepr.maxcollection[0] * 2))
items = (c1_expect for _ in range(SafeRepr.maxcollection[0] - 1))
c2_expect = self.combine(items, large=True)
self.assert_shortened(c2, c2_expect)
# @pytest.mark.skip(reason='not written') # TODO: finish!
# def test_empty(self):
# raise NotImplementedError
#
# @pytest.mark.skip(reason='not written') # TODO: finish!
# def test_subclass(self):
# raise NotImplementedError
def test_boundary(self):
items1 = range(SafeRepr.maxcollection[0] - 1)
items2 = range(SafeRepr.maxcollection[0])
items3 = range(SafeRepr.maxcollection[0] + 1)
c1 = self.CLASS(items1)
c2 = self.CLASS(items2)
c3 = self.CLASS(items3)
expected1 = self.combine(items1)
expected2 = self.combine(items2[:-1], large=True)
expected3 = self.combine(items3[:-2], large=True)
self.assert_unchanged(c1, expected1)
self.assert_shortened(c2, expected2)
self.assert_shortened(c3, expected3)
def test_nested(self):
ctype = self.CLASS
for i in range(1, len(SafeRepr.maxcollection)):
items1 = range(SafeRepr.maxcollection[i] - 1)
items2 = range(SafeRepr.maxcollection[i])
items3 = range(SafeRepr.maxcollection[i] + 1)
c1 = self.CLASS(items1)
c2 = self.CLASS(items2)
c3 = self.CLASS(items3)
for _j in range(i):
c1, c2, c3 = ctype((c1,)), ctype((c2,)), ctype((c3,))
expected1 = self.combine_nested(i, items1)
expected2 = self.combine_nested(i, items2[:-1], large=True)
expected3 = self.combine_nested(i, items3[:-2], large=True)
self.assert_unchanged(c1, expected1)
self.assert_shortened(c2, expected2)
self.assert_shortened(c3, expected3)
class TestTuples(ContainerBase, SafeReprTestBase):
CLASS = tuple
LEFT = "("
RIGHT = ")"
class TestLists(ContainerBase, SafeReprTestBase):
CLASS = list
LEFT = "["
RIGHT = "]"
def test_directly_recursive(self):
value = [1, 2]
value.append(value)
self.assert_unchanged(value, "[1, 2, [...]]")
def test_indirectly_recursive(self):
value = [1, 2]
value.append([value])
self.assert_unchanged(value, "[1, 2, [[...]]]")
class TestFrozensets(ContainerBase, SafeReprTestBase):
CLASS = frozenset
class TestSets(ContainerBase, SafeReprTestBase):
CLASS = set
if PY_VER != 2:
LEFT = "{"
RIGHT = "}"
def test_nested(self):
pytest.skip("unsupported")
def test_large_nested(self):
pytest.skip("unsupported")
class TestDicts(SafeReprTestBase):
def test_large_key(self):
value = {
"a" * SafeRepr.maxstring_inner * 3: "",
}
self.assert_shortened_regex(value, r"{'a+\.\.\.a+': ''}")
def test_large_value(self):
value = {
"": "a" * SafeRepr.maxstring_inner * 2,
}
self.assert_shortened_regex(value, r"{'': 'a+\.\.\.a+'}")
def test_large_both(self):
value = {}
key = "a" * SafeRepr.maxstring_inner * 2
value[key] = key
self.assert_shortened_regex(value, r"{'a+\.\.\.a+': 'a+\.\.\.a+'}")
def test_nested_value(self):
d1 = {}
d1_key = "a" * SafeRepr.maxstring_inner * 2
d1[d1_key] = d1_key
d2 = {d1_key: d1}
d3 = {d1_key: d2}
self.assert_shortened_regex(d2, r"{'a+\.\.\.a+': {'a+\.\.\.a+': 'a+\.\.\.a+'}}") # noqa
if len(SafeRepr.maxcollection) == 2:
self.assert_shortened_regex(d3, r"{'a+\.\.\.a+': {'a+\.\.\.a+': {\.\.\.}}}") # noqa
else:
self.assert_shortened_regex(d3, r"{'a+\.\.\.a+': {'a+\.\.\.a+': {'a+\.\.\.a+': 'a+\.\.\.a+'}}}") # noqa
def test_empty(self):
# Ensure empty dicts work
self.assert_unchanged({}, "{}")
def test_sorted(self):
# Ensure dict keys are sorted
d1 = {}
d1["c"] = None
d1["b"] = None
d1["a"] = None
if IS_PY36_OR_GREATER:
self.assert_saferepr(d1, "{'c': None, 'b': None, 'a': None}")
else:
self.assert_saferepr(d1, "{'a': None, 'b': None, 'c': None}")
@pytest.mark.skipif(sys.version_info < (3, 0), reason="Py3 specific test")
def test_unsortable_keys(self):
# Ensure dicts with unsortable keys do not crash
d1 = {}
for _ in range(100):
d1[object()] = None
with pytest.raises(TypeError):
list(sorted(d1))
self.saferepr(d1)
def test_directly_recursive(self):
value = {1: None}
value[2] = value
self.assert_unchanged(value, "{1: None, 2: {...}}")
def test_indirectly_recursive(self):
value = {1: None}
value[2] = {3: value}
self.assert_unchanged(value, "{1: None, 2: {3: {...}}}")
class TestOtherPythonTypes(SafeReprTestBase):
# not critical to test:
# singletons
# <function>
# <class>
# <iterator>
# memoryview
# classmethod
# staticmethod
# property
# enumerate
# reversed
# object
# type
# super
# @pytest.mark.skip(reason='not written') # TODO: finish!
# def test_file(self):
# raise NotImplementedError
def test_range_small(self):
range_name = range.__name__
value = range(1, 42)
self.assert_unchanged(value, "%s(1, 42)" % (range_name,))
@pytest.mark.skipif(sys.version_info < (3, 0), reason="Py3 specific test")
def test_range_large_stop_only(self):
range_name = range.__name__
stop = SafeRepr.maxcollection[0]
value = range(stop)
self.assert_unchanged(value, "%s(0, %s)" % (range_name, stop))
def test_range_large_with_start(self):
range_name = range.__name__
stop = SafeRepr.maxcollection[0] + 1
value = range(1, stop)
self.assert_unchanged(value, "%s(1, %s)" % (range_name, stop))
# @pytest.mark.skip(reason='not written') # TODO: finish!
# def test_named_struct(self):
# # e.g. sys.version_info
# raise NotImplementedError
#
# @pytest.mark.skip(reason='not written') # TODO: finish!
# def test_namedtuple(self):
# raise NotImplementedError
#
# @pytest.mark.skip(reason='not written') # TODO: finish!
# @pytest.mark.skipif(sys.version_info < (3, 0), reason='Py3 specific test')
# def test_SimpleNamespace(self):
# raise NotImplementedError
class TestUserDefinedObjects(SafeReprTestBase):
def test_broken_repr(self):
class TestClass(object):
def __repr__(self):
raise NameError
value = TestClass()
with pytest.raises(NameError):
repr(TestClass())
self.assert_saferepr(value, object.__repr__(value))
def test_large(self):
class TestClass(object):
def __repr__(self):
return "<" + "A" * SafeRepr.maxother_outer * 2 + ">"
value = TestClass()
self.assert_shortened_regex(value, r"\<A+\.\.\.A+\>")
def test_inherit_repr(self):
class TestClass(dict):
pass
value_dict = TestClass()
class TestClass2(list):
pass
value_list = TestClass2()
self.assert_unchanged(value_dict, "{}")
self.assert_unchanged(value_list, "[]")
def test_custom_repr(self):
class TestClass(dict):
def __repr__(self):
return "MyRepr"
value1 = TestClass()
class TestClass2(list):
def __repr__(self):
return "MyRepr"
value2 = TestClass2()
self.assert_unchanged(value1, "MyRepr")
self.assert_unchanged(value2, "MyRepr")
def test_custom_repr_many_items(self):
class TestClass(list):
def __init__(self, it=()):
list.__init__(self, it)
def __repr__(self):
return "MyRepr"
value1 = TestClass(range(0, 15))
value2 = TestClass(range(0, 16))
value3 = TestClass([TestClass(range(0, 10))])
value4 = TestClass([TestClass(range(0, 11))])
self.assert_unchanged(value1, "MyRepr")
self.assert_unchanged(value3, "MyRepr")
def test_custom_repr_large_item(self):
class TestClass(list):
def __init__(self, it=()):
list.__init__(self, it)
def __repr__(self):
return "MyRepr"
value1 = TestClass(["a" * (SafeRepr.maxcollection[1] + 1)])
value2 = TestClass(["a" * (SafeRepr.maxstring_inner + 1)])
self.assert_unchanged(value1, "MyRepr")
self.assert_shortened(value2, "<TestClass, len() = 1>")
@pytest.mark.skipif(np is None, reason="could not import numpy")
class TestNumpy(SafeReprTestBase):
# numpy types should all use their native reprs, even arrays
# exceeding limits.
def test_int32(self):
value = np.int32(123)
self.assert_unchanged(value, repr(value))
def test_float32(self):
value = np.float32(123.456)
self.assert_unchanged(value, repr(value))
def test_zeros(self):
value = np.zeros(SafeRepr.maxcollection[0] + 1)
self.assert_unchanged(value, repr(value))
@pytest.mark.parametrize(
"params",
[
{"maxother_outer": 20, "input": "😄😄😄😄😄😄😄😄😄😄😄😄😄😄😄😄😄😄FFFFFFFF", "output": "😄😄😄😄😄😄😄😄😄😄😄😄😄...FFFFFF"},
{"maxother_outer": 10, "input": "😄😄😄😄😄😄😄😄😄😄😄😄😄😄😄😄😄😄FFFFFFFF", "output": "😄😄😄😄😄😄...FFF"},
{"maxother_outer": 10, "input": "������������FFFFFFFF", "output": "������...FFF"},
# Because we can't return bytes, byte-related tests aren't needed (and str works as it should).
],
)
@pytest.mark.parametrize("use_str", [True, False])
def test_py3_str_slicing(params, use_str):
# Note: much simpler in python because __repr__ is required to return str
safe_repr = SafeRepr()
safe_repr.locale_preferred_encoding = "ascii"
safe_repr.sys_stdout_encoding = params.get("sys_stdout_encoding", "ascii")
safe_repr.maxother_outer = params["maxother_outer"]
if not use_str:
class MyObj(object):
def __repr__(self):
return params["input"]
safe_repr_input = MyObj()
else:
safe_repr_input = params["input"]
expected_output = params["output"]
computed = safe_repr(safe_repr_input)
expected = repr(expected_output)
if use_str:
expected = repr(expected)
assert repr(computed) == expected
# Check that we can json-encode the return.
assert json.dumps(computed)
def test_raw_bytes():
safe_repr = SafeRepr()
safe_repr.raw_value = True
obj = b"\xed\xbd\xbf\xff\xfe\xfa\xfd"
raw_value_repr = safe_repr(obj)
assert isinstance(raw_value_repr, str) # bytes on py2, str on py3
assert raw_value_repr == obj.decode("latin1")
def test_raw_unicode():
safe_repr = SafeRepr()
safe_repr.raw_value = True
obj = "\xed\xbd\xbf\xff\xfe\xfa\xfd"
raw_value_repr = safe_repr(obj)
assert isinstance(raw_value_repr, str) # bytes on py2, str on py3
assert raw_value_repr == obj
def test_no_repr():
class MyBytes(object):
def __init__(self, contents):
self.contents = contents
self.errored = None
def __iter__(self):
return iter(self.contents)
def decode(self, encoding):
self.errored = "decode called"
raise RuntimeError("Should not be called.")
def __repr__(self):
self.errored = "__repr__ called"
raise RuntimeError("Should not be called.")
def __getitem__(self, *args):
return self.contents.__getitem__(*args)
def __len__(self):
return len(self.contents)
safe_repr = SafeRepr()
safe_repr.string_types = (MyBytes,)
safe_repr.bytes = MyBytes
obj = b"f" * (safe_repr.maxstring_outer * 10)
my_bytes = MyBytes(obj)
raw_value_repr = safe_repr(my_bytes)
assert not my_bytes.errored
|