cpython/Lib/test/test_embed.py at e5c5a5f703088580ea89b81484ec89fdce19f23a · 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

# Run the tests in Programs/_testembed.c (tests for the CPython embedding APIs)

from test import support

from test.support import import_helper, os_helper, MS_WINDOWS

import unittest

from collections import namedtuple

import contextlib

import json

import os

import os.path

import re

import shutil

import subprocess

import sys

import sysconfig

import tempfile

import textwrap

if not support.has_subprocess_support:

raise unittest.SkipTest("test module requires subprocess")

try:

import _testinternalcapi

except ImportError:

_testinternalcapi = None

MACOS = (sys.platform == 'darwin')

PYMEM_ALLOCATOR_NOT_SET = 0

PYMEM_ALLOCATOR_DEBUG = 2

PYMEM_ALLOCATOR_MALLOC = 3

PYMEM_ALLOCATOR_MIMALLOC = 7

if support.Py_GIL_DISABLED:

ALLOCATOR_FOR_CONFIG = PYMEM_ALLOCATOR_MIMALLOC

else:

ALLOCATOR_FOR_CONFIG = PYMEM_ALLOCATOR_MALLOC

Py_STATS = hasattr(sys, '_stats_on')

# _PyCoreConfig_InitCompatConfig()

API_COMPAT = 1

# _PyCoreConfig_InitPythonConfig()

API_PYTHON = 2

# _PyCoreConfig_InitIsolatedConfig()

API_ISOLATED = 3

INIT_LOOPS = 4

MAX_HASH_SEED = 4294967295

# If we are running from a build dir, but the stdlib has been installed,

# some tests need to expect different results.

STDLIB_INSTALL = os.path.join(sys.prefix, sys.platlibdir,

f'python{sys.version_info.major}.{sys.version_info.minor}')

if not os.path.isfile(os.path.join(STDLIB_INSTALL, 'os.py')):

STDLIB_INSTALL = None

def debug_build(program):

program = os.path.basename(program)

name = os.path.splitext(program)[0]

return name.casefold().endswith("_d".casefold())

def remove_python_envvars():

env = dict(os.environ)

# Remove PYTHON* environment variables to get deterministic environment

for key in list(env):

if key.startswith('PYTHON'):

del env[key]

return env

class EmbeddingTestsMixin:

def setUp(self):

exename = "_testembed"

builddir = os.path.dirname(sys.executable)

if MS_WINDOWS:

ext = ("_d" if debug_build(sys.executable) else "") + ".exe"

exename += ext

exepath = builddir

else:

exepath = os.path.join(builddir, 'Programs')

self.test_exe = exe = os.path.join(exepath, exename)

if not os.path.exists(exe):

self.skipTest("%r doesn't exist" % exe)

# This is needed otherwise we get a fatal error:

# "Py_Initialize: Unable to get the locale encoding

# LookupError: no codec search functions registered: can't find encoding"

self.oldcwd = os.getcwd()

os.chdir(builddir)

def tearDown(self):

os.chdir(self.oldcwd)

ANY_FAILURE = object()

def run_embedded_interpreter(self, *args, env=None,

timeout=None, returncode=0, input=None,

cwd=None):

"""Runs a test in the embedded interpreter"""

cmd = [self.test_exe]

cmd.extend(args)

if env is not None and MS_WINDOWS:

# Windows requires at least the SYSTEMROOT environment variable to

# start Python.

env = env.copy()

env['SYSTEMROOT'] = os.environ['SYSTEMROOT']

p = subprocess.Popen(cmd,

stdout=subprocess.PIPE,

stderr=subprocess.PIPE,

universal_newlines=True,

env=env,

cwd=cwd)

try:

(out, err) = p.communicate(input=input, timeout=timeout)

except:

p.terminate()

p.wait()

raise

if returncode is self.ANY_FAILURE:

returncode = 1 if p.returncode == 0 else p.returncode

if p.returncode != returncode and support.verbose:

print(f"--- {cmd} failed ---")

print(f"stdout:\n{out}")

print(f"stderr:\n{err}")

print("------")

self.assertEqual(p.returncode, returncode,

"bad returncode %d, stderr is %r" %

(p.returncode, err))

return out, err

def run_repeated_init_and_subinterpreters(self):

out, err = self.run_embedded_interpreter("test_repeated_init_and_subinterpreters")

self.assertEqual(err, "")

# The output from _testembed looks like this:

# --- Pass 1 ---

# interp 0 <0x1cf9330>, thread state <0x1cf9700>: id(modules) = 139650431942728

# interp 1 <0x1d4f690>, thread state <0x1d35350>: id(modules) = 139650431165784

# interp 2 <0x1d5a690>, thread state <0x1d99ed0>: id(modules) = 139650413140368

# interp 3 <0x1d4f690>, thread state <0x1dc3340>: id(modules) = 139650412862200

# interp 0 <0x1cf9330>, thread state <0x1cf9700>: id(modules) = 139650431942728

# --- Pass 2 ---

# ...

interp_pat = (r"^interp (\d+) <(0x[\dA-F]+)>, "

r"thread state <(0x[\dA-F]+)>: "

r"id$modules$ = ([\d]+)$")

Interp = namedtuple("Interp", "id interp tstate modules")

numloops = 1

current_run = []

for line in out.splitlines():

if line == "--- Pass {} ---".format(numloops):

self.assertEqual(len(current_run), 0)

if support.verbose > 1:

print(line)

numloops += 1

continue

self.assertLess(len(current_run), 5)

match = re.match(interp_pat, line)

if match is None:

self.assertRegex(line, interp_pat)

# Parse the line from the loop. The first line is the main

# interpreter and the 3 afterward are subinterpreters.

interp = Interp(*match.groups())

if support.verbose > 1:

print(interp)

self.assertTrue(interp.interp)

self.assertTrue(interp.tstate)

self.assertTrue(interp.modules)

current_run.append(interp)

# The last line in the loop should be the same as the first.

if len(current_run) == 5:

main = current_run[0]

self.assertEqual(interp, main)

yield current_run

current_run = []

class EmbeddingTests(EmbeddingTestsMixin, unittest.TestCase):

maxDiff = 100 * 50

def test_subinterps_main(self):

for run in self.run_repeated_init_and_subinterpreters():

main = run[0]

self.assertEqual(main.id, '0')

def test_subinterps_different_ids(self):

for run in self.run_repeated_init_and_subinterpreters():

main, *subs, _ = run

mainid = int(main.id)

for i, sub in enumerate(subs):

self.assertEqual(sub.id, str(mainid + i + 1))

def test_subinterps_distinct_state(self):

for run in self.run_repeated_init_and_subinterpreters():

main, *subs, _ = run

if '0x0' in main:

# XXX Fix on Windows (and other platforms): something

# is going on with the pointers in Programs/_testembed.c.

# interp.interp is 0x0 and interp.modules is the same

# between interpreters.

raise unittest.SkipTest('platform prints pointers as 0x0')

for sub in subs:

# A new subinterpreter may have the same

# PyInterpreterState pointer as a previous one if

# the earlier one has already been destroyed. So

# we compare with the main interpreter. The same

# applies to tstate.

self.assertNotEqual(sub.interp, main.interp)

self.assertNotEqual(sub.tstate, main.tstate)

self.assertNotEqual(sub.modules, main.modules)

def test_repeated_init_and_inittab(self):

out, err = self.run_embedded_interpreter("test_repeated_init_and_inittab")

self.assertEqual(err, "")

lines = [f"--- Pass {i} ---" for i in range(1, INIT_LOOPS+1)]

lines = "\n".join(lines) + "\n"

self.assertEqual(out, lines)

def test_replace_main_tstate(self):

for reuse in (True, False):

with self.subTest(reuse=reuse, exec=False):

self.run_embedded_interpreter(

'test_replace_main_tstate',

# At the moment, this fails because main_tstate gets broken.

returncode=self.ANY_FAILURE,

)

with self.subTest(reuse=reuse, exec=True):

out, rc = self.run_embedded_interpreter(

'test_replace_main_tstate',

'print("spam!")',

# At the moment, this fails because main_tstate gets broken.

returncode=self.ANY_FAILURE,

)

if rc == 0:

self.assertEqual(out.strip(), 'spam!')

def test_fini_in_subthread(self):

self.run_embedded_interpreter(

'test_fini_in_subthread',

# At the moment, this actually succeeds on all platforms,

# except for Windows (STATUS_ACCESS_VIOLATION).

returncode=self.ANY_FAILURE if MS_WINDOWS else 0,

)

def test_fini_in_main_thread_with_other_tstate(self):

self.run_embedded_interpreter(

'test_fini_in_main_thread_with_other_tstate',

# At the moment, this actually succeeds on all platforms.

returncode=0,

)

def test_fini_in_main_thread_with_subinterpreter(self):

self.run_embedded_interpreter(

'test_fini_in_main_thread_with_subinterpreter',

# At the moment, this actually succeeds on all platforms.

returncode=0,

)

def test_forced_io_encoding(self):

# Checks forced configuration of embedded interpreter IO streams

env = dict(os.environ, PYTHONIOENCODING="utf-8:surrogateescape")

out, err = self.run_embedded_interpreter("test_forced_io_encoding", env=env)

if support.verbose > 1:

print()

print(out)

print(err)

expected_stream_encoding = "utf-8"

expected_errors = "surrogateescape"

expected_output = '\n'.join([

"--- Use defaults ---",

"Expected encoding: default",

"Expected errors: default",

"stdin: {in_encoding}:{errors}",

"stdout: {out_encoding}:{errors}",

"stderr: {out_encoding}:backslashreplace",

"--- Set errors only ---",

"Expected encoding: default",

"Expected errors: ignore",

"stdin: {in_encoding}:ignore",

"stdout: {out_encoding}:ignore",

"stderr: {out_encoding}:backslashreplace",

"--- Set encoding only ---",

"Expected encoding: iso8859-1",

"Expected errors: default",

"stdin: iso8859-1:{errors}",

"stdout: iso8859-1:{errors}",

"stderr: iso8859-1:backslashreplace",

"--- Set encoding and errors ---",

"Expected encoding: iso8859-1",

"Expected errors: replace",

"stdin: iso8859-1:replace",

"stdout: iso8859-1:replace",

"stderr: iso8859-1:backslashreplace"])

expected_output = expected_output.format(

in_encoding=expected_stream_encoding,

out_encoding=expected_stream_encoding,

errors=expected_errors)

# This is useful if we ever trip over odd platform behaviour

self.maxDiff = None

self.assertEqual(out.strip(), expected_output)

def test_pre_initialization_api(self):

"""

Checks some key parts of the C-API that need to work before the runtime

is initialized (via Py_Initialize()).

"""

env = dict(os.environ, PYTHONPATH=os.pathsep.join(sys.path))

out, err = self.run_embedded_interpreter("test_pre_initialization_api", env=env)

if MS_WINDOWS:

expected_path = self.test_exe

else:

expected_path = os.path.join(os.getcwd(), "spam")

expected_output = f"sys.executable: {expected_path}\n"

self.assertIn(expected_output, out)

self.assertEqual(err, '')

def test_pre_initialization_sys_options(self):

"""

Checks that sys.warnoptions and sys._xoptions can be set before the

runtime is initialized (otherwise they won't be effective).

"""

env = remove_python_envvars()

env['PYTHONPATH'] = os.pathsep.join(sys.path)

out, err = self.run_embedded_interpreter(

"test_pre_initialization_sys_options", env=env)

expected_output = (

"sys.warnoptions: ['once', 'module', 'default']\n"

"sys._xoptions: {'not_an_option': '1', 'also_not_an_option': '2'}\n"

"warnings.filters[:3]: ['default', 'module', 'once']\n"

)

self.assertIn(expected_output, out)

self.assertEqual(err, '')

def test_bpo20891(self):

"""

bpo-20891: Calling PyGILState_Ensure in a non-Python thread must not

crash.

"""

out, err = self.run_embedded_interpreter("test_bpo20891")

self.assertEqual(out, '')

self.assertEqual(err, '')

def test_initialize_twice(self):

"""

bpo-33932: Calling Py_Initialize() twice should do nothing (and not

crash!).

"""

out, err = self.run_embedded_interpreter("test_initialize_twice")

self.assertEqual(out, '')

self.assertEqual(err, '')

def test_initialize_pymain(self):

"""

bpo-34008: Calling Py_Main() after Py_Initialize() must not fail.

"""

out, err = self.run_embedded_interpreter("test_initialize_pymain")

self.assertEqual(out.rstrip(), "Py_Main() after Py_Initialize: sys.argv=['-c', 'arg2']")

self.assertEqual(err, '')

def test_run_main(self):

out, err = self.run_embedded_interpreter("test_run_main")

self.assertEqual(out.rstrip(), "Py_RunMain(): sys.argv=['-c', 'arg2']")

self.assertEqual(err, '')

def test_run_main_loop(self):

# bpo-40413: Calling Py_InitializeFromConfig()+Py_RunMain() multiple

# times must not crash.

nloop = 5

out, err = self.run_embedded_interpreter("test_run_main_loop")

self.assertEqual(out, "Py_RunMain(): sys.argv=['-c', 'arg2']\n" * nloop)

self.assertEqual(err, '')

def test_finalize_structseq(self):

# bpo-46417: Py_Finalize() clears structseq static types. Check that

# sys attributes using struct types still work when

# Py_Finalize()/Py_Initialize() is called multiple times.

# print() calls type->tp_repr(instance) and so checks that the types

# are still working properly.

script = support.findfile('_test_embed_structseq.py')

with open(script, encoding="utf-8") as fp:

code = fp.read()

out, err = self.run_embedded_interpreter("test_repeated_init_exec", code)

self.assertEqual(out, 'Tests passed\n' * INIT_LOOPS)

def test_simple_initialization_api(self):

# _testembed now uses Py_InitializeFromConfig by default

# This case specifically checks Py_Initialize(Ex) still works

out, err = self.run_embedded_interpreter("test_repeated_simple_init")

self.assertEqual(out, 'Finalized\n' * INIT_LOOPS)

@support.requires_specialization

@unittest.skipUnless(support.TEST_MODULES_ENABLED, "requires test modules")

def test_specialized_static_code_gets_unspecialized_at_Py_FINALIZE(self):

# https://github.com/python/cpython/issues/92031

code = textwrap.dedent("""\

import dis

import importlib._bootstrap

import opcode

import test.test_dis

def is_specialized(f):

for instruction in dis.get_instructions(f, adaptive=True):

opname = instruction.opname

if (

opname in opcode._specialized_opmap

# Exclude superinstructions:

and "__" not in opname

return True

return False

func = importlib._bootstrap._handle_fromlist

# "copy" the code to un-specialize it:

func.__code__ = func.__code__.replace()

assert not is_specialized(func), "specialized instructions found"

for i in range(test.test_dis.ADAPTIVE_WARMUP_DELAY):

func(importlib._bootstrap, ["x"], lambda *args: None)

assert is_specialized(func), "no specialized instructions found"

print("Tests passed")

""")

run = self.run_embedded_interpreter

out, err = run("test_repeated_init_exec", code)

self.assertEqual(out, 'Tests passed\n' * INIT_LOOPS)

def test_ucnhash_capi_reset(self):

# bpo-47182: unicodeobject.c:ucnhash_capi was not reset on shutdown.

code = "print('\\N{digit nine}')"

out, err = self.run_embedded_interpreter("test_repeated_init_exec", code)

self.assertEqual(out, '9\n' * INIT_LOOPS)

def test_datetime_reset_strptime(self):

code = (

"import datetime;"

"d = datetime.datetime.strptime('2000-01-01', '%Y-%m-%d');"

"print(d.strftime('%Y%m%d'))"

)

out, err = self.run_embedded_interpreter("test_repeated_init_exec", code)

self.assertEqual(out, '20000101\n' * INIT_LOOPS)

@unittest.skipIf(_testinternalcapi is None, "requires _testinternalcapi")

class InitConfigTests(EmbeddingTestsMixin, unittest.TestCase):

maxDiff = 4096

UTF8_MODE_ERRORS = ('surrogatepass' if MS_WINDOWS else 'surrogateescape')

# Marker to read the default configuration: get_default_config()

GET_DEFAULT_CONFIG = object()

# Marker to ignore a configuration parameter

IGNORE_CONFIG = object()

PRE_CONFIG_COMPAT = {

'_config_init': API_COMPAT,

'allocator': PYMEM_ALLOCATOR_NOT_SET,

'parse_argv': 0,

'configure_locale': 1,

'coerce_c_locale': 0,

'coerce_c_locale_warn': 0,

'utf8_mode': 0,

}

if MS_WINDOWS:

PRE_CONFIG_COMPAT.update({

'legacy_windows_fs_encoding': 0,

})

PRE_CONFIG_PYTHON = dict(PRE_CONFIG_COMPAT,

_config_init=API_PYTHON,

parse_argv=1,

coerce_c_locale=GET_DEFAULT_CONFIG,

utf8_mode=GET_DEFAULT_CONFIG,

)

PRE_CONFIG_ISOLATED = dict(PRE_CONFIG_COMPAT,

_config_init=API_ISOLATED,

configure_locale=0,

isolated=1,

use_environment=0,

utf8_mode=0,

dev_mode=0,

coerce_c_locale=0,

)

COPY_PRE_CONFIG = [

'dev_mode',

'isolated',

'use_environment',

]

CONFIG_COMPAT = {

'_config_init': API_COMPAT,

'isolated': False,

'use_environment': True,

'dev_mode': False,

'install_signal_handlers': True,

'use_hash_seed': False,

'hash_seed': 0,

'int_max_str_digits': sys.int_info.default_max_str_digits,

'cpu_count': -1,

'faulthandler': False,

'tracemalloc': 0,

'perf_profiling': False,

'import_time': False,

'code_debug_ranges': True,

'show_ref_count': False,

'dump_refs': False,

'dump_refs_file': None,

'malloc_stats': False,

'filesystem_encoding': GET_DEFAULT_CONFIG,

'filesystem_errors': GET_DEFAULT_CONFIG,

'pycache_prefix': None,

'program_name': GET_DEFAULT_CONFIG,

'parse_argv': False,

'argv': [""],

'orig_argv': [],

'xoptions': [],

'warnoptions': [],

'pythonpath_env': None,

'home': None,

'executable': GET_DEFAULT_CONFIG,

'base_executable': GET_DEFAULT_CONFIG,

'prefix': GET_DEFAULT_CONFIG,

'base_prefix': GET_DEFAULT_CONFIG,

'exec_prefix': GET_DEFAULT_CONFIG,

'base_exec_prefix': GET_DEFAULT_CONFIG,

'module_search_paths': GET_DEFAULT_CONFIG,

'module_search_paths_set': True,

'platlibdir': sys.platlibdir,

'stdlib_dir': GET_DEFAULT_CONFIG,

'site_import': True,

'bytes_warning': 0,

'warn_default_encoding': False,

'inspect': False,

'interactive': False,

'optimization_level': 0,

'parser_debug': False,

'write_bytecode': True,

'verbose': 0,

'quiet': False,

'user_site_directory': True,

'configure_c_stdio': False,

'buffered_stdio': True,

'stdio_encoding': GET_DEFAULT_CONFIG,

'stdio_errors': GET_DEFAULT_CONFIG,

'skip_source_first_line': False,

'run_command': None,

'run_module': None,

'run_filename': None,

'sys_path_0': None,

'_install_importlib': True,

'check_hash_pycs_mode': 'default',

'pathconfig_warnings': True,

'_init_main': True,

'use_frozen_modules': not support.Py_DEBUG,

'safe_path': False,

'_is_python_build': IGNORE_CONFIG,

}

if Py_STATS:

CONFIG_COMPAT['_pystats'] = 0

if support.Py_DEBUG:

CONFIG_COMPAT['run_presite'] = None

if support.Py_GIL_DISABLED:

CONFIG_COMPAT['enable_gil'] = -1

if MS_WINDOWS:

CONFIG_COMPAT.update({

'legacy_windows_stdio': 0,

})

CONFIG_PYTHON = dict(CONFIG_COMPAT,

_config_init=API_PYTHON,

configure_c_stdio=True,

parse_argv=True,

)

CONFIG_ISOLATED = dict(CONFIG_COMPAT,

_config_init=API_ISOLATED,

isolated=True,

use_environment=False,

user_site_directory=False,

safe_path=True,

dev_mode=False,

install_signal_handlers=False,

use_hash_seed=False,

faulthandler=False,

tracemalloc=0,

perf_profiling=False,

pathconfig_warnings=False,

)

if MS_WINDOWS:

CONFIG_ISOLATED['legacy_windows_stdio'] = 0

# global config

DEFAULT_GLOBAL_CONFIG = {

'Py_HasFileSystemDefaultEncoding': 0,

'Py_HashRandomizationFlag': 1,

'_Py_HasFileSystemDefaultEncodeErrors': 0,

}

COPY_GLOBAL_PRE_CONFIG = [

('Py_UTF8Mode', 'utf8_mode'),

]

COPY_GLOBAL_CONFIG = [

# Copy core config to global config for expected values

# True means that the core config value is inverted (0 => 1 and 1 => 0)

('Py_BytesWarningFlag', 'bytes_warning'),

('Py_DebugFlag', 'parser_debug'),

('Py_DontWriteBytecodeFlag', 'write_bytecode', True),

('Py_FileSystemDefaultEncodeErrors', 'filesystem_errors'),

('Py_FileSystemDefaultEncoding', 'filesystem_encoding'),

('Py_FrozenFlag', 'pathconfig_warnings', True),

('Py_IgnoreEnvironmentFlag', 'use_environment', True),

('Py_InspectFlag', 'inspect'),

('Py_InteractiveFlag', 'interactive'),

('Py_IsolatedFlag', 'isolated'),

('Py_NoSiteFlag', 'site_import', True),

('Py_NoUserSiteDirectory', 'user_site_directory', True),

('Py_OptimizeFlag', 'optimization_level'),

('Py_QuietFlag', 'quiet'),

('Py_UnbufferedStdioFlag', 'buffered_stdio', True),

('Py_VerboseFlag', 'verbose'),

]

if MS_WINDOWS:

COPY_GLOBAL_PRE_CONFIG.extend((

('Py_LegacyWindowsFSEncodingFlag', 'legacy_windows_fs_encoding'),

))

COPY_GLOBAL_CONFIG.extend((

('Py_LegacyWindowsStdioFlag', 'legacy_windows_stdio'),

))

EXPECTED_CONFIG = None

@classmethod

def tearDownClass(cls):

# clear cache

cls.EXPECTED_CONFIG = None

def main_xoptions(self, xoptions_list):

xoptions = {}

for opt in xoptions_list:

if '=' in opt:

key, value = opt.split('=', 1)

xoptions[key] = value

else:

xoptions[opt] = True

return xoptions

def _get_expected_config_impl(self):

env = remove_python_envvars()

code = textwrap.dedent('''

import json

import sys

import _testinternalcapi

configs = _testinternalcapi.get_configs()

data = json.dumps(configs)

data = data.encode('utf-8')

sys.stdout.buffer.write(data)

sys.stdout.buffer.flush()

''')

# Use -S to not import the site module: get the proper configuration

# when test_embed is run from a venv (bpo-35313)

args = [sys.executable, '-S', '-c', code]

proc = subprocess.run(args, env=env,

stdout=subprocess.PIPE,

stderr=subprocess.PIPE)

if proc.returncode:

raise Exception(f"failed to get the default config: "

f"stdout={proc.stdout!r} stderr={proc.stderr!r}")

stdout = proc.stdout.decode('utf-8')

# ignore stderr

try:

return json.loads(stdout)

except json.JSONDecodeError:

self.fail(f"fail to decode stdout: {stdout!r}")

def _get_expected_config(self):

cls = InitConfigTests

if cls.EXPECTED_CONFIG is None:

cls.EXPECTED_CONFIG = self._get_expected_config_impl()

# get a copy

configs = {}

for config_key, config_value in cls.EXPECTED_CONFIG.items():

config = {}

for key, value in config_value.items():

if isinstance(value, list):

value = value.copy()

config[key] = value

configs[config_key] = config

return configs

def get_expected_config(self, expected_preconfig, expected,

env, api, modify_path_cb=None):

configs = self._get_expected_config()

pre_config = configs['pre_config']

for key, value in expected_preconfig.items():

if value is self.GET_DEFAULT_CONFIG:

expected_preconfig[key] = pre_config[key]

if not expected_preconfig['configure_locale'] or api == API_COMPAT:

# there is no easy way to get the locale encoding before

# setlocale(LC_CTYPE, "") is called: don't test encodings

for key in ('filesystem_encoding', 'filesystem_errors',

'stdio_encoding', 'stdio_errors'):

expected[key] = self.IGNORE_CONFIG

if not expected_preconfig['configure_locale']:

# UTF-8 Mode depends on the locale. There is no easy way

# to guess if UTF-8 Mode will be enabled or not if the locale

# is not configured.

expected_preconfig['utf8_mode'] = self.IGNORE_CONFIG

if expected_preconfig['utf8_mode'] == 1:

if expected['filesystem_encoding'] is self.GET_DEFAULT_CONFIG:

expected['filesystem_encoding'] = 'utf-8'

if expected['filesystem_errors'] is self.GET_DEFAULT_CONFIG:

expected['filesystem_errors'] = self.UTF8_MODE_ERRORS

if expected['stdio_encoding'] is self.GET_DEFAULT_CONFIG:

expected['stdio_encoding'] = 'utf-8'

if expected['stdio_errors'] is self.GET_DEFAULT_CONFIG:

expected['stdio_errors'] = 'surrogateescape'

if MS_WINDOWS:

default_executable = self.test_exe

elif expected['program_name'] is not self.GET_DEFAULT_CONFIG:

default_executable = os.path.abspath(expected['program_name'])

else:

default_executable = os.path.join(os.getcwd(), '_testembed')

if expected['executable'] is self.GET_DEFAULT_CONFIG:

expected['executable'] = default_executable

if expected['base_executable'] is self.GET_DEFAULT_CONFIG:

expected['base_executable'] = default_executable

if expected['program_name'] is self.GET_DEFAULT_CONFIG:

expected['program_name'] = './_testembed'

config = configs['config']

for key, value in expected.items():

if value is self.GET_DEFAULT_CONFIG:

expected[key] = config[key]

if expected['module_search_paths'] is not self.IGNORE_CONFIG:

pythonpath_env = expected['pythonpath_env']

if pythonpath_env is not None:

paths = pythonpath_env.split(os.path.pathsep)

expected['module_search_paths'] = [*paths, *expected['module_search_paths']]

if modify_path_cb is not None:

expected['module_search_paths'] = expected['module_search_paths'].copy()

modify_path_cb(expected['module_search_paths'])

for key in self.COPY_PRE_CONFIG:

if key not in expected_preconfig:

expected_preconfig[key] = expected[key]

def check_pre_config(self, configs, expected):

pre_config = dict(configs['pre_config'])

for key, value in list(expected.items()):

if value is self.IGNORE_CONFIG:

pre_config.pop(key, None)

del expected[key]

self.assertEqual(pre_config, expected)

def check_config(self, configs, expected):

config = dict(configs['config'])

if MS_WINDOWS:

value = config.get(key := 'program_name')

if value and isinstance(value, str):

value = value[:len(value.lower().removesuffix('.exe'))]

if debug_build(sys.executable):

value = value[:len(value.lower().removesuffix('_d'))]

config[key] = value

for key, value in list(expected.items()):

if value is self.IGNORE_CONFIG:

config.pop(key, None)

del expected[key]

# Resolve bool/int mismatches to reduce noise in diffs

if isinstance(value, (bool, int)) and isinstance(config.get(key), (bool, int)):

expected[key] = type(config[key])(expected[key])

self.assertEqual(config, expected)

def check_global_config(self, configs):

pre_config = configs['pre_config']

config = configs['config']

expected = dict(self.DEFAULT_GLOBAL_CONFIG)

for item in self.COPY_GLOBAL_CONFIG:

if len(item) == 3:

global_key, core_key, opposite = item

expected[global_key] = 0 if config[core_key] else 1

else:

global_key, core_key = item

expected[global_key] = config[core_key]

for item in self.COPY_GLOBAL_PRE_CONFIG:

if len(item) == 3:

global_key, core_key, opposite = item

expected[global_key] = 0 if pre_config[core_key] else 1

else:

global_key, core_key = item

expected[global_key] = pre_config[core_key]

self.assertEqual(configs['global_config'], expected)

def check_all_configs(self, testname, expected_config=None,

expected_preconfig=None,

modify_path_cb=None,

stderr=None, *, api, preconfig_api=None,

env=None, ignore_stderr=False, cwd=None):

new_env = remove_python_envvars()

if env is not None:

new_env.update(env)

env = new_env

if preconfig_api is None:

preconfig_api = api

if preconfig_api == API_ISOLATED:

default_preconfig = self.PRE_CONFIG_ISOLATED

elif preconfig_api == API_PYTHON:

default_preconfig = self.PRE_CONFIG_PYTHON

else:

default_preconfig = self.PRE_CONFIG_COMPAT

if expected_preconfig is None:

expected_preconfig = {}

expected_preconfig = dict(default_preconfig, **expected_preconfig)

if expected_config is None:

expected_config = {}

if api == API_PYTHON:

default_config = self.CONFIG_PYTHON

elif api == API_ISOLATED:

default_config = self.CONFIG_ISOLATED

else:

default_config = self.CONFIG_COMPAT

expected_config = dict(default_config, **expected_config)

self.get_expected_config(expected_preconfig,

expected_config,

env,

api, modify_path_cb)

out, err = self.run_embedded_interpreter(testname,

env=env, cwd=cwd)

if stderr is None and not expected_config['verbose']:

stderr = ""

if stderr is not None and not ignore_stderr:

self.assertEqual(err.rstrip(), stderr)

try:

configs = json.loads(out)

except json.JSONDecodeError:

self.fail(f"fail to decode stdout: {out!r}")

self.check_pre_config(configs, expected_preconfig)

self.check_config(configs, expected_config)

self.check_global_config(configs)

return configs

def test_init_default_config(self):

self.check_all_configs("test_init_initialize_config", api=API_COMPAT)

def test_preinit_compat_config(self):

self.check_all_configs("test_preinit_compat_config", api=API_COMPAT)

def test_init_compat_config(self):

self.check_all_configs("test_init_compat_config", api=API_COMPAT)

def test_init_global_config(self):

preconfig = {

'utf8_mode': 1,

}

config = {

'program_name': './globalvar',

'site_import': 0,

'bytes_warning': 1,

'warnoptions': ['default::BytesWarning'],

'inspect': 1,

'interactive': 1,

'optimization_level': 2,

'write_bytecode': 0,

'verbose': 1,

'quiet': 1,

'buffered_stdio': 0,

'user_site_directory': 0,

'pathconfig_warnings': 0,

}

self.check_all_configs("test_init_global_config", config, preconfig,

api=API_COMPAT)

def test_init_from_config(self):

preconfig = {

'allocator': ALLOCATOR_FOR_CONFIG,

'utf8_mode': 1,

}

config = {

'install_signal_handlers': False,

'use_hash_seed': True,

'hash_seed': 123,

'tracemalloc': 2,

'perf_profiling': False,

'import_time': True,

'code_debug_ranges': False,

'show_ref_count': True,

'malloc_stats': True,

'stdio_encoding': 'iso8859-1',

'stdio_errors': 'replace',

'pycache_prefix': 'conf_pycache_prefix',

'program_name': './conf_program_name',

'argv': ['-c', 'arg2'],

'orig_argv': ['python3',

'-W', 'cmdline_warnoption',

'-X', 'cmdline_xoption',

'-c', 'pass',

'arg2'],

'parse_argv': True,

'xoptions': [

'config_xoption1=3',

'config_xoption2=',

'config_xoption3',

'cmdline_xoption',

'warnoptions': [

'cmdline_warnoption',

'default::BytesWarning',

'config_warnoption',

'run_command': 'pass\n',

'site_import': False,

'bytes_warning': 1,

'inspect': True,

'interactive': True,

'optimization_level': 2,

'write_bytecode': False,

'verbose': 1,

'quiet': True,

'configure_c_stdio': True,

'buffered_stdio': False,

'user_site_directory': False,

'faulthandler': True,

'platlibdir': 'my_platlibdir',

'module_search_paths': self.IGNORE_CONFIG,

'safe_path': True,

'int_max_str_digits': 31337,

'cpu_count': 4321,

'check_hash_pycs_mode': 'always',

'pathconfig_warnings': False,

}

if Py_STATS:

config['_pystats'] = 1

self.check_all_configs("test_init_from_config", config, preconfig,

api=API_COMPAT)

def test_init_compat_env(self):

preconfig = {

'allocator': ALLOCATOR_FOR_CONFIG,

}

config = {

'use_hash_seed': True,

'hash_seed': 42,

'tracemalloc': 2,

'perf_profiling': False,

'import_time': True,

'code_debug_ranges': False,

'malloc_stats': True,

'inspect': True,

'optimization_level': 2,

'pythonpath_env': '/my/path',

'pycache_prefix': 'env_pycache_prefix',

'write_bytecode': False,

'verbose': 1,

View remainder of file in raw view

FilesExpand file tree

test_embed.py

Latest commit

History

test_embed.py

File metadata and controls