cpython/Lib/test/test_marshal.py at main · python/cpython

Repository navigation

History

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

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

from test import support

from test.support import is_apple_mobile, os_helper, requires_debug_ranges, is_emscripten

from test.support import threading_helper

from test.support.script_helper import assert_python_ok

import array

import io

import marshal

import struct

import sys

import threading

import unittest

import os

import types

import textwrap

try:

import _testcapi

except ImportError:

_testcapi = None

class HelperMixin:

def helper(self, sample, *extra):

new = marshal.loads(marshal.dumps(sample, *extra))

self.assertEqual(sample, new)

try:

with open(os_helper.TESTFN, "wb") as f:

marshal.dump(sample, f, *extra)

with open(os_helper.TESTFN, "rb") as f:

new = marshal.load(f)

self.assertEqual(sample, new)

finally:

os_helper.unlink(os_helper.TESTFN)

def omit_last_byte(data):

"""return data[:-1]"""

# This file's code is used in CompatibilityTestCase,

# but slices need marshal version 5.

# Avoid the slice literal.

return data[slice(0, -1)]

class IntTestCase(unittest.TestCase, HelperMixin):

def test_ints(self):

# Test a range of Python ints larger than the machine word size.

n = sys.maxsize ** 2

while n:

for expected in (-n, n):

self.helper(expected)

n = n >> 1

n = 1 << 100

while n:

for expected in (-n, -n+1, n-1, n):

self.helper(expected)

n = n >> 1

def test_int64(self):

# Simulate int marshaling with TYPE_INT64.

maxint64 = (1 << 63) - 1

minint64 = -maxint64-1

for base in maxint64, minint64, -maxint64, -(minint64 >> 1):

while base:

s = b'I' + int.to_bytes(base, 8, 'little', signed=True)

got = marshal.loads(s)

self.assertEqual(base, got)

if base == -1: # a fixed-point for shifting right 1

base = 0

else:

base >>= 1

got = marshal.loads(b'I\xfe\xdc\xba\x98\x76\x54\x32\x10')

self.assertEqual(got, 0x1032547698badcfe)

got = marshal.loads(b'I\x01\x23\x45\x67\x89\xab\xcd\xef')

self.assertEqual(got, -0x1032547698badcff)

got = marshal.loads(b'I\x08\x19\x2a\x3b\x4c\x5d\x6e\x7f')

self.assertEqual(got, 0x7f6e5d4c3b2a1908)

got = marshal.loads(b'I\xf7\xe6\xd5\xc4\xb3\xa2\x91\x80')

self.assertEqual(got, -0x7f6e5d4c3b2a1909)

def test_bool(self):

for b in (True, False):

self.helper(b)

class FloatTestCase(unittest.TestCase, HelperMixin):

def test_floats(self):

# Test a few floats

small = 1e-25

n = sys.maxsize * 3.7e250

while n > small:

for expected in (-n, n):

self.helper(float(expected))

n /= 123.4567

f = 0.0

s = marshal.dumps(f, 2)

got = marshal.loads(s)

self.assertEqual(f, got)

# and with version <= 1 (floats marshalled differently then)

s = marshal.dumps(f, 1)

got = marshal.loads(s)

self.assertEqual(f, got)

n = sys.maxsize * 3.7e-250

while n < small:

for expected in (-n, n):

f = float(expected)

self.helper(f)

self.helper(f, 1)

n *= 123.4567

class StringTestCase(unittest.TestCase, HelperMixin):

def test_unicode(self):

for s in ["", "Andr\xe8 Previn", "abc", " "*10000]:

self.helper(marshal.loads(marshal.dumps(s)))

def test_string(self):

for s in ["", "Andr\xe8 Previn", "abc", " "*10000]:

self.helper(s)

def test_bytes(self):

for s in [b"", b"Andr\xe8 Previn", b"abc", b" "*10000]:

self.helper(s)

@support.cpython_only

def test_bytes_singleton(self):

for version in range(marshal.version + 1):

for sample in [b"", b"x"]:

new = marshal.loads(marshal.dumps(sample, version))

self.assertIs(new, sample)

class ExceptionTestCase(unittest.TestCase):

def test_exceptions(self):

new = marshal.loads(marshal.dumps(StopIteration))

self.assertEqual(StopIteration, new)

class CodeTestCase(unittest.TestCase):

def test_code(self):

co = ExceptionTestCase.test_exceptions.__code__

new = marshal.loads(marshal.dumps(co))

self.assertEqual(co, new)

def test_many_codeobjects(self):

# Issue2957: bad recursion count on code objects

# more than MAX_MARSHAL_STACK_DEPTH

codes = (ExceptionTestCase.test_exceptions.__code__,) * 10_000

marshal.loads(marshal.dumps(codes))

def test_different_filenames(self):

co1 = compile("x", "f1", "exec")

co2 = compile("y", "f2", "exec")

co1, co2 = marshal.loads(marshal.dumps((co1, co2)))

self.assertEqual(co1.co_filename, "f1")

self.assertEqual(co2.co_filename, "f2")

def test_no_allow_code(self):

data = {'a': [({0},)]}

dump = marshal.dumps(data, allow_code=False)

self.assertEqual(marshal.loads(dump, allow_code=False), data)

f = io.BytesIO()

marshal.dump(data, f, allow_code=False)

f.seek(0)

self.assertEqual(marshal.load(f, allow_code=False), data)

co = ExceptionTestCase.test_exceptions.__code__

data = {'a': [({co, 0},)]}

dump = marshal.dumps(data, allow_code=True)

self.assertEqual(marshal.loads(dump, allow_code=True), data)

with self.assertRaisesRegex(ValueError,

'marshalling code objects is disallowed'):

marshal.dumps(data, allow_code=False)

with self.assertRaises(ValueError):

marshal.loads(dump, allow_code=False)

marshal.dump(data, io.BytesIO(), allow_code=True)

self.assertEqual(marshal.load(io.BytesIO(dump), allow_code=True), data)

with self.assertRaisesRegex(ValueError,

'marshalling code objects is disallowed'):

marshal.dump(data, io.BytesIO(), allow_code=False)

with self.assertRaises(ValueError):

marshal.load(io.BytesIO(dump), allow_code=False)

@requires_debug_ranges()

def test_minimal_linetable_with_no_debug_ranges(self):

# Make sure when demarshalling objects with `-X no_debug_ranges`

# that the columns are None.

co = ExceptionTestCase.test_exceptions.__code__

code = textwrap.dedent("""

import sys

import marshal

with open(sys.argv[1], 'rb') as f:

co = marshal.load(f)

positions = list(co.co_positions())

assert positions[0][2] is None

assert positions[0][3] is None

""")

try:

with open(os_helper.TESTFN, 'wb') as f:

marshal.dump(co, f)

assert_python_ok('-X', 'no_debug_ranges',

'-c', code, os_helper.TESTFN)

finally:

os_helper.unlink(os_helper.TESTFN)

@support.cpython_only

def test_same_filename_used(self):

s = """def f(): pass\ndef g(): pass"""

co = compile(s, "myfile", "exec")

co = marshal.loads(marshal.dumps(co))

for obj in co.co_consts:

if isinstance(obj, types.CodeType):

self.assertIs(co.co_filename, obj.co_filename)

class ContainerTestCase(unittest.TestCase, HelperMixin):

d = {'astring': 'foo@bar.baz.spam',

'afloat': 7283.43,

'anint': 2**20,

'ashortlong': 2,

'alist': ['.zyx.41'],

'atuple': ('.zyx.41',)*10,

'aboolean': False,

'aunicode': "Andr\xe8 Previn"

}

def test_dict(self):

self.helper(self.d)

def test_list(self):

self.helper(list(self.d.items()))

def test_tuple(self):

self.helper(tuple(self.d.keys()))

def test_sets(self):

for constructor in (set, frozenset):

self.helper(constructor(self.d.keys()))

class BufferTestCase(unittest.TestCase, HelperMixin):

def test_bytearray(self):

b = bytearray(b"abc")

self.helper(b)

new = marshal.loads(marshal.dumps(b))

self.assertEqual(type(new), bytes)

def test_memoryview(self):

b = memoryview(b"abc")

self.helper(b)

new = marshal.loads(marshal.dumps(b))

self.assertEqual(type(new), bytes)

def test_array(self):

a = array.array('B', b"abc")

new = marshal.loads(marshal.dumps(a))

self.assertEqual(new, b"abc")

class BugsTestCase(unittest.TestCase):

def test_bug_5888452(self):

# Simple-minded check for SF 588452: Debug build crashes

marshal.dumps([128] * 1000)

def test_patch_873224(self):

self.assertRaises(Exception, marshal.loads, b'0')

self.assertRaises(Exception, marshal.loads, b'f')

self.assertRaises(Exception, marshal.loads,

omit_last_byte(marshal.dumps(2**65)))

def test_version_argument(self):

# Python 2.4.0 crashes for any call to marshal.dumps(x, y)

self.assertEqual(marshal.loads(marshal.dumps(5, 0)), 5)

self.assertEqual(marshal.loads(marshal.dumps(5, 1)), 5)

def test_fuzz(self):

# simple test that it's at least not *totally* trivial to

# crash from bad marshal data

for i in range(256):

c = bytes([i])

try:

marshal.loads(c)

except Exception:

pass

def test_loads_recursion(self):

def run_tests(N, check):

# (((...None...),),)

check(b')\x01' * N + b'N')

check(b'(\x01\x00\x00\x00' * N + b'N')

# [[[...None...]]]

check(b'[\x01\x00\x00\x00' * N + b'N')

# {None: {None: {None: ...None...}}}

check(b'{N' * N + b'N' + b'0' * N)

# frozenset([frozenset([frozenset([...None...])])])

check(b'>\x01\x00\x00\x00' * N + b'N')

# Check that the generated marshal data is valid and marshal.loads()

# works for moderately deep nesting

run_tests(100, marshal.loads)

# Very deeply nested structure shouldn't blow the stack

def check(s):

self.assertRaises(ValueError, marshal.loads, s)

run_tests(2**20, check)

def test_recursion_limit(self):

# Create a deeply nested structure.

head = last = []

# The max stack depth should match the value in Python/marshal.c.

# BUG: https://bugs.python.org/issue33720

# Windows always limits the maximum depth on release and debug builds

#if os.name == 'nt' and support.Py_DEBUG:

if os.name == 'nt':

MAX_MARSHAL_STACK_DEPTH = 1000

elif sys.platform == 'wasi' or is_emscripten or is_apple_mobile:

MAX_MARSHAL_STACK_DEPTH = 1500

else:

MAX_MARSHAL_STACK_DEPTH = 2000

for i in range(MAX_MARSHAL_STACK_DEPTH - 2):

last.append([0])

last = last[-1]

# Verify we don't blow out the stack with dumps/load.

data = marshal.dumps(head)

new_head = marshal.loads(data)

# Don't use == to compare objects, it can exceed the recursion limit.

self.assertEqual(len(new_head), len(head))

self.assertEqual(len(new_head[0]), len(head[0]))

self.assertEqual(len(new_head[-1]), len(head[-1]))

last.append([0])

self.assertRaises(ValueError, marshal.dumps, head)

def test_reference_loop_list(self):

a = []

a.append(a)

for v in range(3):

self.assertRaises(ValueError, marshal.dumps, a, v)

for v in range(3, marshal.version + 1):

d = marshal.dumps(a, v)

b = marshal.loads(d)

self.assertIsInstance(b, list)

self.assertIs(b[0], b)

def test_reference_loop_dict(self):

a = {}

a[None] = a

for v in range(3):

self.assertRaises(ValueError, marshal.dumps, a, v)

for v in range(3, marshal.version + 1):

d = marshal.dumps(a, v)

b = marshal.loads(d)

self.assertIsInstance(b, dict)

self.assertIs(b[None], b)

def check_reference_loop(self, a, typename, minversion,

oldmsg='object too deeply nested to marshal'):

# Only versions supporting references to the type detect the loop;

# older versions fail for a different reason.

for v in range(minversion):

with self.subTest(version=v):

with self.assertRaisesRegex(ValueError, oldmsg):

marshal.dumps(a, v)

for v in range(minversion, marshal.version + 1):

with self.subTest(version=v):

with self.assertRaisesRegex(

ValueError,

f'cannot marshal recursion {typename} objects'):

marshal.dumps(a, v)

def test_reference_loop_tuple(self):

a = ([],)

a[0].append(a)

self.check_reference_loop(a, 'tuple', 3)

a = ({},)

a[0][None] = a

self.check_reference_loop(a, 'tuple', 3)

def test_shared_reference_tuple(self):

# A tuple referenced more than once still round-trips with the

# shared identity preserved.

a = (1, 2)

for v in range(3, marshal.version + 1):

b = marshal.loads(marshal.dumps([a, a], v))

self.assertEqual(b[0], a)

self.assertIs(b[0], b[1])

big = tuple(range(300)) # too large for TYPE_SMALL_TUPLE

b = marshal.loads(marshal.dumps([big, big]))

self.assertEqual(b[0], big)

self.assertIs(b[0], b[1])

def test_reference_loop_code(self):

def f():

return 1234.5

code = f.__code__

a = []

code = code.replace(co_consts=code.co_consts + (a,))

# This test creates a reference loop which leads to reference leaks,

# so we need to break the loop manually. See gh-148722.

self.addCleanup(a.clear)

a.append(code)

self.check_reference_loop(code, 'code', 3)

def test_reference_loop_slice(self):

oldmsg = 'marshalling slice objects requires version 5 or higher'

a = slice([], None)

a.start.append(a)

self.check_reference_loop(a, 'slice', 5, oldmsg)

a = slice(None, [])

a.stop.append(a)

self.check_reference_loop(a, 'slice', 5, oldmsg)

a = slice(None, None, [])

a.step.append(a)

self.check_reference_loop(a, 'slice', 5, oldmsg)

def test_reference_loop_frozendict(self):

a = frozendict({None: []})

a[None].append(a)

self.check_reference_loop(

a, 'frozendict', 6,

'marshalling frozendict objects requires version 6 or higher')

def test_shared_reference_frozendict(self):

# A frozendict referenced more than once must round-trip with the

# shared identity preserved, like frozenset.

fd = frozendict({'a': 1, 'b': 2})

out = marshal.loads(marshal.dumps([fd, fd]))

self.assertEqual(out[0], fd)

self.assertIs(out[0], out[1])

nested = marshal.loads(marshal.dumps(frozendict({'x': fd, 'y': fd})))

self.assertIs(nested['x'], nested['y'])

def test_loads_reference_loop_list(self):

data = b'\xdb\x01\x00\x00\x00r\x00\x00\x00\x00' # [<R>]

a = marshal.loads(data)

self.assertIsInstance(a, list)

self.assertIs(a[0], a)

def test_loads_reference_loop_dict(self):

data = b'\xfbNr\x00\x00\x00\x000' # {None: <R>}

a = marshal.loads(data)

self.assertIsInstance(a, dict)

self.assertIs(a[None], a)

def test_loads_abnormal_reference_loops(self):

# Direct self-references which cannot be created in Python

# because of unhashability.

data = b'\xfbr\x00\x00\x00\x00N0' # {<R>: None}

self.assertRaises(TypeError, marshal.loads, data)

data = b'\xbc\x01\x00\x00\x00r\x00\x00\x00\x00' # {<R>}

self.assertRaises(TypeError, marshal.loads, data)

for data in [

# Indirect self-references of immutable objects.

b'\xa8\x01\x00\x00\x00[\x01\x00\x00\x00r\x00\x00\x00\x00', # ([<R>],)

b'\xa8\x01\x00\x00\x00{Nr\x00\x00\x00\x000', # ({None: <R>},)

b'\xba[\x01\x00\x00\x00r\x00\x00\x00\x00NN', # slice([<R>], None)

b'\xbaN[\x01\x00\x00\x00r\x00\x00\x00\x00N', # slice(None, [<R>])

b'\xbaNN[\x01\x00\x00\x00r\x00\x00\x00\x00', # slice(None, None, [<R>])

b'\xba{Nr\x00\x00\x00\x000NN', # slice({None: <R>}, None)

b'\xbaN{Nr\x00\x00\x00\x000N', # slice(None, {None: <R>})

b'\xbaNN{Nr\x00\x00\x00\x000', # slice(None, None, {None: <R>})

b'\xfdN[\x01\x00\x00\x00r\x00\x00\x00\x000', # frozendict({None: [<R>]})

b'\xfdN{Nr\x00\x00\x00\x0000', # frozendict({None: {None: <R>})

# Direct self-references which cannot be created in Python.

b'\xa8\x01\x00\x00\x00r\x00\x00\x00\x00', # (<R>,)

b'\xbe\x01\x00\x00\x00r\x00\x00\x00\x00', # frozenset({<R>})

b'\xfdNr\x00\x00\x00\x000', # frozendict({None: <R>})

b'\xfdr\x00\x00\x00\x00N0', # frozendict({<R>: None})

b'\xbar\x00\x00\x00\x00NN', # slice(<R>, None)

b'\xbaNr\x00\x00\x00\x00N', # slice(None, <R>)

b'\xbaNNr\x00\x00\x00\x00', # slice(None, None, <R>)

# Indirect self-references which cannot be created in Python

# because of unhashability.

b'\xa8\x01\x00\x00\x00{r\x00\x00\x00\x00N0', # ({<R>: None},)

b'\xa8\x01\x00\x00\x00<\x01\x00\x00\x00r\x00\x00\x00\x00', # ({<R>},)

with self.subTest(data=data):

self.assertRaises(ValueError, marshal.loads, data)

def test_exact_type_match(self):

# Former bug:

# >>> class Int(int): pass

# >>> type(loads(dumps(Int())))

# <type 'int'>

for typ in (int, float, complex, tuple, list, dict, set, frozenset):

# Note: str subclasses are not tested because they get handled

# by marshal's routines for objects supporting the buffer API.

subtyp = type('subtyp', (typ,), {})

with self.assertRaisesRegex(ValueError,

r'cannot marshal \S*subtyp objects'):

marshal.dumps(subtyp())

# Issue #1792 introduced a change in how marshal increases the size of its

# internal buffer; this test ensures that the new code is exercised.

def test_large_marshal(self):

size = int(1e6)

testString = 'abc' * size

marshal.dumps(testString)

def test_invalid_longs(self):

# Issue #7019: marshal.loads shouldn't produce unnormalized PyLongs

invalid_string = b'l\x02\x00\x00\x00\x00\x00\x00\x00'

self.assertRaises(ValueError, marshal.loads, invalid_string)

def test_multiple_dumps_and_loads(self):

# Issue 12291: marshal.load() should be callable multiple times

# with interleaved data written by non-marshal code

# Adapted from a patch by Engelbert Gruber.

data = (1, 'abc', b'def', 1.0, (2, 'a', ['b', b'c']))

for interleaved in (b'', b'0123'):

ilen = len(interleaved)

positions = []

try:

with open(os_helper.TESTFN, 'wb') as f:

for d in data:

marshal.dump(d, f)

if ilen:

f.write(interleaved)

positions.append(f.tell())

with open(os_helper.TESTFN, 'rb') as f:

for i, d in enumerate(data):

self.assertEqual(d, marshal.load(f))

if ilen:

f.read(ilen)

self.assertEqual(positions[i], f.tell())

finally:

os_helper.unlink(os_helper.TESTFN)

def test_loads_reject_unicode_strings(self):

# Issue #14177: marshal.loads() should not accept unicode strings

unicode_string = 'T'

self.assertRaises(TypeError, marshal.loads, unicode_string)

def test_bad_reader(self):

class BadReader(io.BytesIO):

def readinto(self, buf):

n = super().readinto(buf)

if n is not None and n > 4:

n += 10**6

return n

for value in (1.0, 1j, b'0123456789', '0123456789'):

self.assertRaises(ValueError, marshal.load,

BadReader(marshal.dumps(value)))

def test_eof(self):

data = marshal.dumps(("hello", "dolly", None))

for i in range(len(data)):

self.assertRaises(EOFError, marshal.loads, data[0: i])

def test_deterministic_sets(self):

# bpo-37596: To support reproducible builds, sets and frozensets need to

# have their elements serialized in a consistent order (even when they

# have been scrambled by hash randomization):

for kind in ("set", "frozenset"):

for elements in (

"float('nan'), b'a', b'b', b'c', 'x', 'y', 'z'",

# Also test for bad interactions with backreferencing:

"('Spam', 0), ('Spam', 1), ('Spam', 2), ('Spam', 3), ('Spam', 4), ('Spam', 5)",

s = f"{kind}([{elements}])"

with self.subTest(s):

# First, make sure that our test case still has different

# orders under hash seeds 0 and 1. If this check fails, we

# need to update this test with different elements. Skip

# this part if we are configured to use any other hash

# algorithm (for example, using Py_HASH_EXTERNAL):

if sys.hash_info.algorithm in {"fnv", "siphash24"}:

args = ["-c", f"print({s})"]

_, repr_0, _ = assert_python_ok(*args, PYTHONHASHSEED="0")

_, repr_1, _ = assert_python_ok(*args, PYTHONHASHSEED="1")

self.assertNotEqual(repr_0, repr_1)

# Then, perform the actual test:

args = ["-c", f"import marshal; print(marshal.dumps({s}))"]

_, dump_0, _ = assert_python_ok(*args, PYTHONHASHSEED="0")

_, dump_1, _ = assert_python_ok(*args, PYTHONHASHSEED="1")

self.assertEqual(dump_0, dump_1)

def test_unmarshallable(self):

# Check no crash after encountering unmarshallable objects.

# See https://github.com/python/cpython/issues/106287.

fset = frozenset([int])

code = compile("a = 1", "<string>", "exec")

code = code.replace(co_consts=(1, fset, None))

cases = (('tuple', (fset,)),

('list', [fset]),

('set', fset),

('dict key', {fset: 'x'}),

('dict value', {'x': fset}),

('dict key & value', {fset: fset}),

('slice', slice(fset, fset)),

('code', code))

for name, arg in cases:

with self.subTest(name, arg=arg):

with self.assertRaisesRegex(ValueError,

"cannot marshal type objects"):

marshal.dumps((arg, memoryview(b'')))

def test_unorderable_set_items(self):

# Set items are sorted by their marshalled representation, they

# are not compared, even if NaNs which are distinct objects have

# the same marshalled representation.

nan = float('nan')

for kind in set, frozenset:

for version in range(marshal.version + 1):

with self.subTest(kind=kind, version=version):

sample = kind([complex(nan, 0), complex(nan, 0), 1j,

(complex(nan, 0),), (complex(nan, 0),),

float('nan'), float('nan')])

self.assertEqual(len(sample), 7)

new = marshal.loads(marshal.dumps(sample, version))

self.assertIs(type(new), kind)

self.assertEqual(sorted(map(repr, new)),

sorted(map(repr, sample)))

def test_unorderable_set_items_in_code(self):

# A constant set containing NaNs which are distinct objects.

# Run in a subprocess: constants of code objects are immortal

# in the free-threaded build.

script = textwrap.dedent("""

import marshal

source = 'x in {(1e999-1e999)*1j, (1e999-1e999)*2j, 1.5}'

code = compile(source, '<marshal test>', 'eval')

def consts(code):

return [sorted(map(repr, x)) if isinstance(x, frozenset) else x

for x in code.co_consts]

assert ['(nan+nanj)', '(nan+nanj)', '1.5'] in consts(code)

for version in range(marshal.version + 1):

new = marshal.loads(marshal.dumps(code, version))

assert new.co_code == code.co_code

assert consts(new) == consts(code)

assert eval(new, {'x': 1.5}) is True

assert eval(new, {'x': complex('nan')}) is False

""")

assert_python_ok('-c', script)

def test_set_changed_size(self):

# A set is modified while its items are being marshalled.

class Item:

def __hash__(self):

return 0

def __buffer__(self, flags):

change(sample)

return memoryview(b'abc')

def grow(sample):

sample.update(range(1000, 1400))

def shrink(sample):

sample.difference_update(range(1, 60))

for change in grow, shrink:

for version in range(marshal.version + 1):

with self.subTest(change=change.__name__, version=version):

# The first item of the set modifies it.

sample = {Item()}

sample.update(range(1, 60))

self.assertIsInstance(next(iter(sample)), Item)

with self.assertRaisesRegex(RuntimeError,

"set changed size"):

marshal.dumps(sample, version)

def test_error_in_buffer(self):

# The BufferError raised for a non-contiguous buffer is not replaced

# with a generic error.

step2 = slice(None, None, 2)

with self.assertRaises(BufferError):

marshal.dumps(memoryview(bytearray(b'abcdef'))[step2])

LARGE_SIZE = 2**31

pointer_size = 8 if sys.maxsize > 0xFFFFFFFF else 4

class NullWriter:

def write(self, s):

pass

@unittest.skipIf(LARGE_SIZE > sys.maxsize, "test cannot run on 32-bit systems")

class LargeValuesTestCase(unittest.TestCase):

def check_unmarshallable(self, data, msg='object too large to marshal'):

with self.assertRaisesRegex(ValueError, msg):

marshal.dump(data, NullWriter())

@support.bigmemtest(size=LARGE_SIZE, memuse=4, dry_run=False)

def test_int(self, size):

# An int with more than SIZE32_MAX 15-bit digits.

self.check_unmarshallable(1 << (15 * size), 'int too large to marshal')

@support.bigmemtest(size=LARGE_SIZE, memuse=2, dry_run=False)

def test_bytes(self, size):

self.check_unmarshallable(b'x' * size)

@support.bigmemtest(size=LARGE_SIZE, memuse=2, dry_run=False)

def test_str(self, size):

self.check_unmarshallable('x' * size)

@support.bigmemtest(size=LARGE_SIZE, memuse=pointer_size + 1, dry_run=False)

def test_tuple(self, size):

self.check_unmarshallable((None,) * size)

@support.bigmemtest(size=LARGE_SIZE, memuse=pointer_size + 1, dry_run=False)

def test_list(self, size):

self.check_unmarshallable([None] * size)

@support.bigmemtest(size=LARGE_SIZE,

memuse=pointer_size*12 + sys.getsizeof(LARGE_SIZE-1),

dry_run=False)

def test_set(self, size):

self.check_unmarshallable(set(range(size)))

@support.bigmemtest(size=LARGE_SIZE,

memuse=pointer_size*12 + sys.getsizeof(LARGE_SIZE-1),

dry_run=False)

def test_frozenset(self, size):

self.check_unmarshallable(frozenset(range(size)))

@support.bigmemtest(size=LARGE_SIZE, memuse=2, dry_run=False)

def test_bytearray(self, size):

self.check_unmarshallable(bytearray(size))

def CollectObjectIDs(ids, obj):

"""Collect object ids seen in a structure"""

if id(obj) in ids:

return

ids.add(id(obj))

if isinstance(obj, (list, tuple, set, frozenset)):

for e in obj:

CollectObjectIDs(ids, e)

elif isinstance(obj, dict):

for k, v in obj.items():

CollectObjectIDs(ids, k)

CollectObjectIDs(ids, v)

return len(ids)

class InstancingTestCase(unittest.TestCase, HelperMixin):

keys = (123, 1.2345, 'abc', (123, 'abc'), frozenset({123, 'abc'}))

def helper3(self, rsample, recursive=False, simple=False):

#we have two instances

sample = (rsample, rsample)

n0 = CollectObjectIDs(set(), sample)

for v in range(3, marshal.version + 1):

s3 = marshal.dumps(sample, v)

n3 = CollectObjectIDs(set(), marshal.loads(s3))

#same number of instances generated

self.assertEqual(n3, n0)

if not recursive:

#can compare with version 2

s2 = marshal.dumps(sample, 2)

n2 = CollectObjectIDs(set(), marshal.loads(s2))

#old format generated more instances

self.assertGreater(n2, n0)

#if complex objects are in there, old format is larger

if not simple:

self.assertGreater(len(s2), len(s3))

else:

self.assertGreaterEqual(len(s2), len(s3))

def testInt(self):

intobj = 123321

self.helper(intobj)

self.helper3(intobj, simple=True)

def testFloat(self):

floatobj = 1.2345

self.helper(floatobj)

self.helper3(floatobj)

def testStr(self):

strobj = "abcde"*3

self.helper(strobj)

self.helper3(strobj)

def testBytes(self):

bytesobj = b"abcde"*3

self.helper(bytesobj)

self.helper3(bytesobj)

def testList(self):

for obj in self.keys:

listobj = [obj, obj]

self.helper(listobj)

self.helper3(listobj)

def testTuple(self):

for obj in self.keys:

tupleobj = (obj, obj)

self.helper(tupleobj)

self.helper3(tupleobj)

def testSet(self):

for obj in self.keys:

setobj = {(obj, 1), (obj, 2)}

self.helper(setobj)

self.helper3(setobj)

def testFrozenSet(self):

for obj in self.keys:

frozensetobj = frozenset({(obj, 1), (obj, 2)})

self.helper(frozensetobj)

self.helper3(frozensetobj)

def testDict(self):

for obj in self.keys:

dictobj = {"hello": obj, "goodbye": obj, obj: "hello"}

self.helper(dictobj)

self.helper3(dictobj)

def testFrozenDict(self):

for obj in self.keys:

dictobj = frozendict({"hello": obj, "goodbye": obj, obj: "hello"})

self.helper(dictobj)

for version in range(6):

with self.assertRaisesRegex(

ValueError,

'marshalling frozendict objects requires '

'version 6 or higher'):

marshal.dumps(dictobj, version)

def testModule(self):

with open(__file__, "rb") as f:

code = f.read()

if __file__.endswith(".py"):

code = compile(code, __file__, "exec")

self.helper(code)

self.helper3(code)

def testRecursion(self):

obj = 1.2345

d = {"hello": obj, "goodbye": obj, obj: "hello"}

d["self"] = d

self.helper3(d, recursive=True)

l = [obj, obj]

l.append(l)

self.helper3(l, recursive=True)

class CompatibilityTestCase(unittest.TestCase):

def _test(self, version):

with open(__file__, "rb") as f:

code = f.read()

if __file__.endswith(".py"):

code = compile(code, __file__, "exec")

data = marshal.dumps(code, version)

marshal.loads(data)

def test0To3(self):

self._test(0)

def test1To3(self):

self._test(1)

def test2To3(self):

self._test(2)

def test3To3(self):

self._test(3)

class InterningTestCase(unittest.TestCase, HelperMixin):

strobj = "this is an interned string"

strobj = sys.intern(strobj)

def testIntern(self):

s = marshal.loads(marshal.dumps(self.strobj))

self.assertEqual(s, self.strobj)

self.assertEqual(id(s), id(self.strobj))

s2 = sys.intern(s)

self.assertEqual(id(s2), id(s))

def testNoIntern(self):

s = marshal.loads(marshal.dumps(self.strobj, 2))

self.assertEqual(s, self.strobj)

self.assertNotEqual(id(s), id(self.strobj))

s2 = sys.intern(s)

self.assertNotEqual(id(s2), id(s))

class SliceTestCase(unittest.TestCase, HelperMixin):

def test_slice(self):

for obj in (

slice(None), slice(1), slice(1, 2), slice(1, 2, 3),

slice({'set'}, ('tuple', {'with': 'dict'}, ), self.helper.__code__)

with self.subTest(obj=str(obj)):

self.helper(obj)

for version in range(5):

with self.assertRaisesRegex(

ValueError,

'marshalling slice objects requires '

'version 5 or higher'):

marshal.dumps(obj, version)

def reachable_objects(obj):

"""Return a list of all objects marshalled as a part of obj."""

result = []

seen = set()

def visit(x):

if id(x) in seen:

return

seen.add(id(x))

result.append(x)

if isinstance(x, (tuple, list, set, frozenset)):

for item in x:

visit(item)

elif isinstance(x, (dict, frozendict)):

for key, value in x.items():

visit(key)

visit(value)

elif isinstance(x, slice):

visit(x.start)

visit(x.stop)

visit(x.step)

elif isinstance(x, types.CodeType):

for name in ('co_code', 'co_consts', 'co_names', 'co_varnames',

'co_freevars', 'co_cellvars', 'co_filename',

'co_name', 'co_qualname', 'co_linetable',

'co_exceptiontable'):

visit(getattr(x, name))

visit(obj)

return result

class ReferenceTestCase(unittest.TestCase):

# The output must only depend on the marshalled objects, not on

# the number of references to them in the rest of the process:

# an object is written with FLAG_REF if and only if it occurs more

# than once in the marshalled object graph.

FLAG_REF = 0x80

# The tests comparing the output with literal data use this version.

VERSION = 6

@staticmethod

def make_sample(version=marshal.version):

# Create new objects on every call, so that nothing else

# refers to them.

bigint = int('1234567890' * 4)

flt = float('1.25')

cplx = complex('1.5+2.5j')

data = bytes(range(16))

text = ' '.join(['spam', 'eggs'])

nonascii = '\u20ac' + text

inner = (bigint, flt, cplx, data, text, nonascii)

sample = [

inner,

(flt, (data, (bigint,))),

[text, [cplx]],

{flt: inner, text: [data]},

{(bigint, 1), (data, 2)},

frozenset([(text, 1), (flt, 2), nonascii]),

(inner, bigint, inner),

]

if version >= 5:

sample.append(slice(bigint, (flt, text), data))

if version >= 6:

sample.append(frozendict({text: inner, 'key': (cplx,)}))

return sample

def check_extra_references(self, obj, version):

expected = marshal.dumps(obj, version)

extra = reachable_objects(obj)

self.assertEqual(marshal.dumps(obj, version), expected)

extra2 = [list(extra), tuple(extra)]

self.assertEqual(marshal.dumps(obj, version), expected)

del extra, extra2

self.assertEqual(marshal.dumps(obj, version), expected)

return expected

def test_extra_references(self):

for version in range(marshal.version + 1):

with self.subTest(version=version):

sample = self.make_sample(version)

data = self.check_extra_references(sample, version)

# Equal graphs give equal output.

self.assertEqual(marshal.dumps(self.make_sample(version),

version), data)

self.assertEqual(marshal.loads(data), sample)

def test_extra_references_code(self):

source = textwrap.dedent("""

def f(a, b=(1, 2.5, 'spam eggs')):

x = {'ham', 12345678901234567890, b'bytes'}

def g(c):

return (a, b, c, x, (1, 2.5, 'spam eggs'), 6.25j)

return g

class C:

attr = (None, ..., 2**70)

def method(self):

return self.attr, 'spam eggs'

""")

for version in range(marshal.version + 1):

View remainder of file in raw view

FilesExpand file tree

test_marshal.py

Latest commit

History

test_marshal.py

File metadata and controls