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
|
#!/usr/bin/env python
from ipaddress import IPv4Address
import os
import json
import sys
import pytest
import datetime
import numpy as np
import hashlib
import base64
from typing import NamedTuple, Optional, Union, List, Dict
from pickle import UnpicklingError
from decimal import Decimal
from collections import Counter
from pydantic import BaseModel, IPvAnyAddress
from deepdiff import DeepDiff
from deepdiff.helper import pypy3, py_current_version, np_ndarray, Opcode, SetOrdered
from deepdiff.serialization import (
pickle_load, pickle_dump, ForbiddenModule, ModuleNotFoundError,
MODULE_NOT_FOUND_MSG, FORBIDDEN_MODULE_MSG, pretty_print_diff,
load_path_content, UnsupportedFormatErr, json_dumps, json_loads)
from conftest import FIXTURES_DIR
from tests import PicklableClass
import logging
logging.disable(logging.CRITICAL)
t1 = {1: 1, 2: 2, 3: 3, 4: {"a": "hello", "b": [1, 2, 3]}}
t2 = {1: 1, 2: 2, 3: 3, 4: {"a": "hello", "b": "world\n\n\nEnd"}}
class SampleSchema(BaseModel):
works: bool = False
ips: List[IPvAnyAddress]
class SomeStats(NamedTuple):
counter: Optional[Counter]
context_aware_counter: Optional[Counter] = None
min_int: Optional[int] = 0
max_int: Optional[int] = 0
field_stats1 = SomeStats(
counter=Counter(["a", "a", "b"]),
max_int=10
)
class TestSerialization:
"""Tests for Serializations."""
def test_serialization_text(self):
ddiff = DeepDiff(t1, t2)
assert "builtins.list" in ddiff.to_json_pickle()
jsoned = ddiff.to_json()
assert "world" in jsoned
def test_serialization_text_force_builtin_json(self):
ddiff = DeepDiff(t1, t2)
with pytest.raises(TypeError) as excinfo:
jsoned = ddiff.to_json(sort_keys=True)
assert str(excinfo.value).startswith("orjson does not accept the sort_keys parameter.")
jsoned = ddiff.to_json(sort_keys=True, force_use_builtin_json=True)
assert "world" in jsoned
def test_deserialization(self):
ddiff = DeepDiff(t1, t2)
jsoned = ddiff.to_json_pickle()
ddiff2 = DeepDiff.from_json_pickle(jsoned)
assert ddiff == ddiff2
def test_serialization_tree(self):
ddiff = DeepDiff(t1, t2, view='tree')
pickle_jsoned = ddiff.to_json_pickle()
assert "world" in pickle_jsoned
jsoned = ddiff.to_json()
assert "world" in jsoned
def test_deserialization_tree(self):
ddiff = DeepDiff(t1, t2, view='tree')
jsoned = ddiff.to_json_pickle()
ddiff2 = DeepDiff.from_json_pickle(jsoned)
assert 'type_changes' in ddiff2
def test_serialize_custom_objects_throws_error(self):
class A:
pass
class B:
pass
t1 = A()
t2 = B()
ddiff = DeepDiff(t1, t2)
assert r'{"type_changes":{"root":{"old_type":"A","new_type":"B","old_value":{},"new_value":{}}}}' == ddiff.to_json()
def test_serialize_custom_objects_with_default_mapping(self):
class A:
pass
class B:
pass
t1 = A()
t2 = B()
ddiff = DeepDiff(t1, t2)
default_mapping = {A: lambda x: 'obj A', B: lambda x: 'obj B'}
result = ddiff.to_json(default_mapping=default_mapping)
expected_result = {"type_changes": {"root": {"old_type": "A", "new_type": "B", "old_value": "obj A", "new_value": "obj B"}}}
assert expected_result == json.loads(result)
# These lines are long but make it easier to notice the difference:
@pytest.mark.parametrize('verbose_level, expected', [
(0, {"type_changes": {"root[0]": {"old_type": str, "new_type": int}}, "dictionary_item_added": ["root[1][5]"], "dictionary_item_removed": ["root[1][3]"], "iterable_item_added": {"root[2]": "d"}}),
(1, {"type_changes": {"root[0]": {"old_type": str, "new_type": int, "old_value": "a", "new_value": 10}}, "dictionary_item_added": ["root[1][5]"], "dictionary_item_removed": ["root[1][3]"], "values_changed": {"root[1][1]": {"new_value": 2, "old_value": 1}}, "iterable_item_added": {"root[2]": "d"}}),
(2, {"type_changes": {"root[0]": {"old_type": str, "new_type": int, "old_value": "a", "new_value": 10}}, "dictionary_item_added": {"root[1][5]": 6}, "dictionary_item_removed": {"root[1][3]": 4}, "values_changed": {"root[1][1]": {"new_value": 2, "old_value": 1}}, "iterable_item_added": {"root[2]": "d"}}),
])
def test_to_dict_at_different_verbose_level(self, verbose_level, expected):
t1 = ['a', {1: 1, 3: 4}, ]
t2 = [10, {1: 2, 5: 6}, 'd']
ddiff = DeepDiff(t1, t2, verbose_level=verbose_level)
assert expected == ddiff.to_dict()
def test_serialize_pydantic_model(self):
obj = SampleSchema(
works=True,
ips=["128.0.0.1"]
)
serialized = json_dumps(obj)
obj_again = json_loads(serialized)
assert {'works': True, 'ips': ['128.0.0.1']} == obj_again
assert {'works': True, 'ips': [IPv4Address('128.0.0.1')]} == obj.model_dump()
@pytest.mark.skipif(pypy3, reason='clevercsv is not supported in pypy3')
class TestLoadContet:
@pytest.mark.parametrize('path1, validate', [
('t1.json', lambda x: x[0]['key1'] == 'value1'),
('t1.yaml', lambda x: x[0][0] == 'name'),
('t1.toml', lambda x: x['servers']['alpha']['ip'] == '10.0.0.1'),
('t1.csv', lambda x: x[0]['last_name'] == 'Nobody'),
('t1.pickle', lambda x: x[1] == 1),
])
def test_load_path_content(self, path1, validate):
path = os.path.join(FIXTURES_DIR, path1)
result = load_path_content(path)
assert validate(result)
def test_load_path_content_when_unsupported_format(self):
path = os.path.join(FIXTURES_DIR, 't1.unsupported')
with pytest.raises(UnsupportedFormatErr):
load_path_content(path)
class TestPickling:
def test_serialize(self):
obj = [1, 2, 3, None, {10: 11E2}, frozenset(['a', 'c']), SetOrdered([2, 1]),
datetime.datetime(2022, 4, 10, 0, 40, 41, 357857), datetime.time(11), Decimal('11.2'), 123.11]
serialized = pickle_dump(obj)
loaded = pickle_load(serialized)
assert obj == loaded
@pytest.mark.skipif(pypy3, reason='short pickle not supported in pypy3')
def test_pickle_that_is_string(self):
serialized_str = 'DeepDiff Delta Payload v0-0-1\nBlah'
with pytest.raises(UnpicklingError):
pickle_load(serialized_str)
def test_custom_object_deserialization_fails_without_explicit_permission(self):
obj = PicklableClass(10)
module_dot_name = 'tests.{}'.format(PicklableClass.__name__)
serialized = pickle_dump(obj)
expected_msg = FORBIDDEN_MODULE_MSG.format(module_dot_name)
with pytest.raises(ForbiddenModule) as excinfo:
pickle_load(serialized)
assert expected_msg == str(excinfo.value)
# Explicitly allowing the module to be loaded
loaded = pickle_load(serialized, safe_to_import={module_dot_name})
assert obj == loaded
# Explicitly allowing the module to be loaded. It can take a list instead of a set.
loaded2 = pickle_load(serialized, safe_to_import=[module_dot_name])
assert obj == loaded2
def test_unpickling_object_that_is_not_imported_raises_error(self):
def get_the_pickle():
import wave
obj = wave.Error
return pickle_dump(obj)
serialized = get_the_pickle()
# Making sure that the module is unloaded.
del sys.modules['wave']
module_dot_name = 'wave.Error'
expected_msg = MODULE_NOT_FOUND_MSG.format(module_dot_name)
with pytest.raises(ModuleNotFoundError) as excinfo:
pickle_load(serialized, safe_to_import=module_dot_name)
assert expected_msg == str(excinfo.value)
def test_seriaize_property(self):
class Sample:
@property
def something(self):
return 10
sample = Sample()
serialized = json_dumps(sample)
assert '{"something":10}' == serialized
class TestDeepDiffPretty:
"""Tests for pretty() method of DeepDiff"""
class TestingClass:
one = 1
testing_class = TestingClass
@pytest.mark.parametrize('t1, t2, item_path, old_type, new_type, old_val_displayed, new_val_displayed',
[
[{2: 2, 4: 4}, {2: 'b', 4: 4}, 'root[2]', 'int', 'str', '2', '"b"'],
[[1, 2, 3], [1, '2', 3], 'root[1]', 'int', 'str', '2', '"2"'],
[[1, 2, 3], {1, 2, 3}, 'root', 'list', 'set', '[1, 2, 3]', '{1, 2, 3}']
])
def test_pretty_print_diff_type_changes(self, t1, t2, item_path, old_type, new_type, old_val_displayed,
new_val_displayed):
ddiff = DeepDiff(t1, t2, view='tree')
result = pretty_print_diff(ddiff.tree['type_changes'][0])
assert result == 'Type of {} changed from {} to {} and value changed from {} to {}.'.format(item_path, old_type, new_type, old_val_displayed, new_val_displayed)
@pytest.mark.parametrize('t1, t2, item_path, verbose_level',
[
[{2: 2, 4: 4}, {2: 2, 4: 4, 5: 5}, 'root[5]', 1],
[{2: 2, 4: 4}, {2: 2, 4: 4, 5: 5}, 'root[5] (5)', 2],
[{"foo": "bar", "foo1": "bar1"}, {"foo": "bar", "foo1": "bar1", "foo2": "bar2"},
'root[\'foo2\']', 0],
[{"foo": "bar", "foo1": "bar1"}, {"foo": "bar", "foo1": "bar1", "foo2": "bar2"},
'root[\'foo2\'] ("bar2")', 2]
])
def test_pretty_print_diff_dictionary_item_added(self, t1, t2, item_path, verbose_level):
ddiff = DeepDiff(t1, t2, view='tree', verbose_level=verbose_level)
result = pretty_print_diff(ddiff.tree['dictionary_item_added'][0])
assert result == 'Item {} added to dictionary.'.format(item_path)
@pytest.mark.parametrize('t1, t2, item_path, verbose_level',
[
[{2: 2, 4: 4}, {2: 2}, 'root[4]', 0],
[{2: 2, 4: 4}, {2: 2}, 'root[4] (4)', 2],
[{"foo": "bar", "foo1": "bar1"}, {"foo": "bar"},
'root[\'foo1\']', 1],
[{"foo": "bar", "foo1": "bar1"}, {"foo": "bar"},
'root[\'foo1\'] ("bar1")', 2],
])
def test_pretty_print_diff_dictionary_item_removed(self, t1, t2, item_path, verbose_level):
ddiff = DeepDiff(t1, t2, view='tree', verbose_level=verbose_level)
result = pretty_print_diff(ddiff.tree['dictionary_item_removed'][0])
assert result == 'Item {} removed from dictionary.'.format(item_path)
@pytest.mark.parametrize('t1, t2, item_path, old_val_displayed, new_val_displayed',
[
[{2: 2, 4: 4}, {2: 3, 4: 4}, 'root[2]', '2', '3'],
[['a', 'b', 'c'], ['a', 'b', 'd'], 'root[2]', '"c"', '"d"']
])
def test_pretty_print_diff_values_changed(self, t1, t2, item_path, old_val_displayed, new_val_displayed):
ddiff = DeepDiff(t1, t2, view='tree')
result = pretty_print_diff(ddiff.tree['values_changed'][0])
assert result == 'Value of {} changed from {} to {}.'.format(item_path, old_val_displayed, new_val_displayed)
@pytest.mark.parametrize('t1, t2, item_path, verbose_level',
[
[[1, 2, 3], [1, 2, 3, 4], 'root[3]', 1],
[[1, 2, 3], [1, 2, 3, 4], 'root[3] (4)', 2],
[["foo", "bar"], ["foo", "bar", "barbar"], 'root[2]', 0],
[["foo", "bar"], ["foo", "bar", "barbar"], 'root[2] ("barbar")', 2]
])
def test_pretty_print_diff_iterable_item_added(self, t1, t2, item_path, verbose_level):
ddiff = DeepDiff(t1, t2, view='tree', verbose_level=verbose_level)
result = pretty_print_diff(ddiff.tree['iterable_item_added'][0])
assert result == 'Item {} added to iterable.'.format(item_path)
@pytest.mark.parametrize('t1, t2, item_path, verbose_level',
[
[[1, 2, 3], [1, 2], 'root[2]', 0],
[[1, 2, 3], [1, 2], 'root[2] (3)', 2],
[["foo", "bar", "barbar"], ["foo", "bar"], 'root[2]', 1],
[["foo", "bar", "barbar"], ["foo", "bar"], 'root[2] ("barbar")', 2]
])
def test_pretty_print_diff_iterable_item_removed(self, t1, t2, item_path, verbose_level):
ddiff = DeepDiff(t1, t2, view='tree', verbose_level=verbose_level)
result = pretty_print_diff(ddiff.tree['iterable_item_removed'][0])
assert result == 'Item {} removed from iterable.'.format(item_path)
@pytest.mark.parametrize("verbose_level", range(3))
def test_pretty_print_diff_attribute_added(self, verbose_level):
t1 = self.testing_class()
t2 = self.testing_class()
t2.two = 2
ddiff = DeepDiff(t1, t2, view='tree', verbose_level=verbose_level)
result = pretty_print_diff(ddiff.tree['attribute_added'][0])
assert result == 'Attribute root.two (2) added.' if verbose_level == 2 else 'Attribute root.two added.'
@pytest.mark.parametrize("verbose_level", range(3))
def test_pretty_print_diff_attribute_removed(self, verbose_level):
t1 = self.testing_class()
t1.two = 2
t2 = self.testing_class()
ddiff = DeepDiff(t1, t2, view='tree', verbose_level=verbose_level)
result = pretty_print_diff(ddiff.tree['attribute_removed'][0])
assert result == 'Attribute root.two (2) removed.' if verbose_level == 2 else 'Attribute root.two removed.'
@pytest.mark.parametrize('t1, t2, item_path',
[
[{1, 2}, {1, 2, 3}, 'root[3]'],
])
def test_pretty_print_diff_set_item_added(self, t1, t2, item_path):
ddiff = DeepDiff(t1, t2, view='tree')
result = pretty_print_diff(ddiff.tree['set_item_added'][0])
assert result == 'Item {} added to set.'.format(item_path)
@pytest.mark.parametrize('t1, t2, item_path',
[
[{1, 2, 3}, {1, 2}, 'root[3]'],
])
def test_pretty_print_diff_set_item_removed(self, t1, t2, item_path):
ddiff = DeepDiff(t1, t2, view='tree')
result = pretty_print_diff(ddiff.tree['set_item_removed'][0])
assert result == 'Item {} removed from set.'.format(item_path)
@pytest.mark.parametrize('t1, t2, item_path',
[
[[1, 2, 3, 2], [1, 2, 3], 'root[1]'],
])
def test_pretty_print_diff_repetition_change(self, t1, t2, item_path):
ddiff = DeepDiff(t1, t2, view='tree', ignore_order=True, report_repetition=True)
result = pretty_print_diff(ddiff.tree['repetition_change'][0])
assert result == 'Repetition change for item {}.'.format(item_path)
@pytest.mark.parametrize("expected, verbose_level",
(
('Item root[5] added to dictionary.'
'\nItem root[3] removed from dictionary.'
'\nType of root[2] changed from int to str and value changed from 2 to "b".'
'\nValue of root[4] changed from 4 to 5.', 0),
('Item root[5] (5) added to dictionary.'
'\nItem root[3] (3) removed from dictionary.'
'\nType of root[2] changed from int to str and value changed from 2 to "b".'
'\nValue of root[4] changed from 4 to 5.', 2),
), ids=("verbose=0", "verbose=2")
)
def test_pretty_form_method(self, expected, verbose_level):
t1 = {2: 2, 3: 3, 4: 4}
t2 = {2: 'b', 4: 5, 5: 5}
ddiff = DeepDiff(t1, t2, view='tree', verbose_level=verbose_level)
result = ddiff.pretty()
assert result == expected
@pytest.mark.parametrize("expected, verbose_level",
(
('\t\tItem root[5] added to dictionary.'
'\n\t\tItem root[3] removed from dictionary.'
'\n\t\tType of root[2] changed from int to str and value changed from 2 to "b".'
'\n\t\tValue of root[4] changed from 4 to 5.', 0),
('\t\tItem root[5] (5) added to dictionary.'
'\n\t\tItem root[3] (3) removed from dictionary.'
'\n\t\tType of root[2] changed from int to str and value changed from 2 to "b".'
'\n\t\tValue of root[4] changed from 4 to 5.', 2),
), ids=("verbose=0", "verbose=2")
)
def test_pretty_form_method_prefixed_simple(self, expected, verbose_level):
t1 = {2: 2, 3: 3, 4: 4}
t2 = {2: 'b', 4: 5, 5: 5}
ddiff = DeepDiff(t1, t2, verbose_level=verbose_level)
result = ddiff.pretty(prefix="\t\t")
assert result == expected
@pytest.mark.parametrize("expected, verbose_level",
(
('Diff #1: Item root[5] added to dictionary.'
'\nDiff #2: Item root[3] removed from dictionary.'
'\nDiff #3: Type of root[2] changed from int to str and value changed from 2 to "b".'
'\nDiff #4: Value of root[4] changed from 4 to 5.', 0),
('Diff #1: Item root[5] (5) added to dictionary.'
'\nDiff #2: Item root[3] (3) removed from dictionary.'
'\nDiff #3: Type of root[2] changed from int to str and value changed from 2 to "b".'
'\nDiff #4: Value of root[4] changed from 4 to 5.', 2),
), ids=("verbose=0", "verbose=2")
)
def test_pretty_form_method_prefixed_callback(self, expected, verbose_level):
def prefix_callback(**kwargs):
"""Helper function using a hidden variable on the diff that tracks which count prints next"""
kwargs['diff']._diff_count = 1 + getattr(kwargs['diff'], '_diff_count', 0)
return f"Diff #{kwargs['diff']._diff_count}: "
t1 = {2: 2, 3: 3, 4: 4}
t2 = {2: 'b', 4: 5, 5: 5}
ddiff = DeepDiff(t1, t2, verbose_level=verbose_level)
result = ddiff.pretty(prefix=prefix_callback)
assert result == expected
def sig_to_bytes(inp: Dict[str, Union[str, bytes]]):
inp['signature'] = inp['signature'].encode('utf-8')
return inp
@pytest.mark.parametrize('test_num, value, func_to_convert_back', [
(1, {'10': None}, None),
(2, {"type_changes": {"root": {"old_type": None, "new_type": list, "new_value": ["你好", 2, 3, 5]}}}, None),
(3, {'10': Decimal(2017)}, None),
(4, Decimal(2017.1), None),
(5, {1, 2, 10}, set),
(6, datetime.datetime(2023, 10, 11), datetime.datetime.fromisoformat),
(7, datetime.datetime.utcnow(), datetime.datetime.fromisoformat),
(8, field_stats1, lambda x: SomeStats(**x)),
(9, np.array([[ 101, 3533, 1998, 4532, 2024, 3415, 1012, 102]]), np.array),
(10, memoryview(b"hello"), lambda x: memoryview(x.encode('utf-8'))),
(11, {'file_type': 'xlsx', 'signature': b'52bd9907785'}, sig_to_bytes)
])
def test_json_dumps_and_loads(self, test_num, value, func_to_convert_back):
serialized = json_dumps(value)
back = json_loads(serialized)
if func_to_convert_back:
back = func_to_convert_back(back)
if isinstance(back, np_ndarray):
assert np.array_equal(value, back), f"test_json_dumps_and_loads test #{test_num} failed"
else:
assert value == back, f"test_json_dumps_and_loads test #{test_num} failed"
def test_namedtuple_seriazliation(self):
op_code = Opcode(tag="replace", t1_from_index=0, t1_to_index=1, t2_from_index=10, t2_to_index=20)
serialized = json_dumps(op_code)
expected = '{"tag":"replace","t1_from_index":0,"t1_to_index":1,"t2_from_index":10,"t2_to_index":20,"old_values":null,"new_values":null}'
assert serialized == expected
def test_reversed_list(self):
items = reversed([1, 2, 3])
serialized = json_dumps(items)
serialized2 = json_dumps(items)
assert '[3,2,1]' == serialized
assert '[3,2,1]' == serialized2, "We should have copied the original list. If this returns empty, it means we exhausted the original list."
def test_dict_keys(self):
dic = {"foo": "bar", "apple": "too sweet"}
serialized = json_dumps(dic.keys())
assert '["foo","apple"]' == serialized
def test_non_utf8_bytes_serialization(self):
"""Test that non-UTF-8 bytes are properly base64 encoded"""
# Create binary data that cannot be decoded as UTF-8
binary_data = b'\x80\x81\x82\x83\x84\x85\x86\x87\x88\x89\x8a\x8b\x8c\x8d\x8e\x8f'
# Verify it's not UTF-8 decodable
with pytest.raises(UnicodeDecodeError):
binary_data.decode('utf-8')
# Test serialization
test_data = {"binary": binary_data}
serialized = json_dumps(test_data)
# Should contain base64 encoded data
expected_b64 = base64.b64encode(binary_data).decode('ascii')
assert expected_b64 in serialized
# Should be deserializable
deserialized = json_loads(serialized)
assert deserialized == {"binary": expected_b64}
def test_hash_bytes_serialization(self):
"""Test serialization of hash-like binary data (blake3, sha256, etc.)"""
# Generate various hash-like byte sequences
test_cases = [
hashlib.md5(b"test").digest(),
hashlib.sha1(b"test").digest(),
hashlib.sha256(b"test").digest(),
hashlib.sha512(b"test").digest()[:16], # Truncated
b'\xff\xfe\xfd\xfc' * 8, # Artificial binary pattern
]
for i, hash_bytes in enumerate(test_cases):
test_data = {"hash": hash_bytes}
# Should not raise UnicodeDecodeError
serialized = json_dumps(test_data)
assert serialized # Should produce valid JSON
# Should contain base64 if not UTF-8 decodable, or string if UTF-8 decodable
try:
utf8_decoded = hash_bytes.decode('utf-8')
# If UTF-8 decodable, should be in JSON as string
assert utf8_decoded in serialized
except UnicodeDecodeError:
# If not UTF-8 decodable, should be base64 encoded
expected_b64 = base64.b64encode(hash_bytes).decode('ascii')
assert expected_b64 in serialized
def test_mixed_utf8_and_binary_bytes(self):
"""Test data structure with both UTF-8 decodable and binary bytes"""
test_data = {
"utf8_text": b"hello world", # UTF-8 decodable
"binary_hash": hashlib.sha256(b"secret").digest(), # Binary
"empty_bytes": b"", # Edge case
"utf8_unicode": "café".encode('utf-8'), # UTF-8 with unicode
"non_utf8_byte": b"\xff\xfe\xfd", # Non-UTF-8 bytes
}
# Should serialize without errors
serialized = json_dumps(test_data)
deserialized = json_loads(serialized)
# UTF-8 decodable bytes should remain as strings
assert "hello world" in serialized
assert deserialized["utf8_text"] == "hello world"
# Unicode UTF-8 should work
assert deserialized["utf8_unicode"] == "café"
# Binary data should be base64 encoded
expected_hash_b64 = base64.b64encode(test_data["binary_hash"]).decode('ascii')
assert expected_hash_b64 in serialized
assert deserialized["binary_hash"] == expected_hash_b64
# Empty bytes should be empty string
assert deserialized["empty_bytes"] == ""
# Non-UTF-8 bytes should be base64 encoded
expected_non_utf8_b64 = base64.b64encode(test_data["non_utf8_byte"]).decode('ascii')
assert expected_non_utf8_b64 in serialized
assert deserialized["non_utf8_byte"] == expected_non_utf8_b64
def test_bytes_in_deepdiff_serialization(self):
"""Test that bytes work correctly in DeepDiff JSON serialization"""
t1 = {
"text": b"hello",
"hash": hashlib.sha256(b"data1").digest(),
}
t2 = {
"text": b"world",
"hash": hashlib.sha256(b"data2").digest(),
}
diff = DeepDiff(t1, t2)
# Should serialize without errors
json_output = diff.to_json()
assert json_output
# Should contain both UTF-8 decoded strings and base64 encoded hashes
assert "hello" in json_output
assert "world" in json_output
# Hash values should be base64 encoded
expected_hash1 = base64.b64encode(t1["hash"]).decode('ascii')
expected_hash2 = base64.b64encode(t2["hash"]).decode('ascii')
assert expected_hash1 in json_output
assert expected_hash2 in json_output
|