python-docs-fa/c-api/interp-lifecycle.html at gh-pages · python/python-docs-fa

History

1280 lines (1189 loc) · 130 KB

Raw

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

<!DOCTYPE html>

<head>

<title>Interpreter initialization and finalization — مستندات Python3.14.6</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

title="جستجو در مستندات Python3.14.6"

href="../_static/opensearch.xml"/>

<style>

@media only screen {

table.full-width-table {

width: 100%;

}

</style>

</head>

<body>

<input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu">

</label>

</a>

</svg>

</form>

</nav>

Theme

<option value="light">Light</option>

</select>

</label>

<div>

<h3><a href="../contents.html">فهرست عناوین</a></h3>

<ul>

<li><a class="reference internal" href="#">Interpreter initialization and finalization</a><ul>

<li><a class="reference internal" href="#before-python-initialization">Before Python initialization</a></li>

<li><a class="reference internal" href="#global-configuration-variables">Global configuration variables</a></li>

<li><a class="reference internal" href="#initializing-and-finalizing-the-interpreter">Initializing and finalizing the interpreter</a></li>

<li><a class="reference internal" href="#cautions-regarding-runtime-finalization">Cautions regarding runtime finalization</a></li>

<li><a class="reference internal" href="#process-wide-parameters">Process-wide parameters</a></li>

</ul>

</li>

</ul>

</div>

<div>

<h4>موضوع قبلی</h4>

<a href="datetime.html"

title="فصل قبلی">DateTime Objects</a>

</div>

<div>

<h4>موضوع بعدی</h4>

<a href="threads.html"

title="فصل بعدی">Thread states and the global interpreter lock</a>

</div>

document.addEventListener('DOMContentLoaded', () => {

const title = document.querySelector('meta[property="og:title"]').content;

const elements = document.querySelectorAll('.improvepage');

const pageurl = window.location.href.split('?')[0];

elements.forEach(element => {

const url = new URL(element.href.split('?')[0].replace("-nojs", ""));

url.searchParams.set('pagetitle', title);

url.searchParams.set('pageurl', pageurl);

url.searchParams.set('pagesource', "c-api/interp-lifecycle.rst");

element.href = url.toString();

});

</script>

<li><a href="../bugs.html">گزارش یک اشکال</a></li>

<li><a class="improvepage" href="../improve-page-nojs.html">بهبود این صفحه</a></li>

<li>

<a href="https://github.com/python/cpython/blob/main/Doc/c-api/interp-lifecycle.rst?plain=1"

rel="nofollow">نمایش منبع

</a>

</li>

<li>

<a href="https://github.com/python/python-docs-fa/blob/3.14/c-api/interp-lifecycle.po?plain=1"

rel="nofollow">نمایش منبع ترجمه</a>

</li>

</ul>

</div>

</nav>

</div>

<h3>ناوبری</h3>

<ul>

<a href="../genindex.html" title="فهرست کلی"

accesskey="I">فهرست</a></li>

<a href="../py-modindex.html" title="نمایه ی ماژول های پایتون"

>ماژول ها</a> |</li>

<a href="threads.html" title="Thread states and the global interpreter lock"

accesskey="N">بعدی</a> |</li>

<a href="datetime.html" title="DateTime Objects"

accesskey="P">قبلی</a> |</li>

<li><a href="https://www.python.org/">Python</a> »</li>

</li>

<li>

</li>

<a href="../index.html">3.14.6 Documentation</a> »

</li>

<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Python/C API reference manual</a> »</li>

<li class="nav-item nav-item-this"><a href="">Interpreter initialization and finalization</a></li>

</form>

</div>

</li>

Theme

<option value="light">Light</option>

</select>

</label> |</li>

</ul>

</div>

<h1>Interpreter initialization and finalization<a class="headerlink" href="#interpreter-initialization-and-finalization" title="Link to this heading">¶</a></h1>

See <a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a> for details

on how to configure the interpreter prior to initialization.

<h2>Before Python initialization<a class="headerlink" href="#before-python-initialization" title="Link to this heading">¶</a></h2>

In an application embedding Python, the <a class="reference internal" href="#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate">Py_Initialize()</code></a> function must

be called before using any other Python/C API functions; with the exception of

a few functions and the <a class="reference internal" href="#global-conf-vars">global configuration variables</a>.

The following functions can be safely called before Python is initialized:

<li>Functions that initialize the interpreter:

<ul>

<li><a class="reference internal" href="#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate">Py_Initialize()</code></a></li>

<li><a class="reference internal" href="#c.Py_InitializeEx" title="Py_InitializeEx"><code class="xref c c-func docutils literal notranslate">Py_InitializeEx()</code></a></li>

<li><a class="reference internal" href="#c.Py_InitializeFromConfig" title="Py_InitializeFromConfig"><code class="xref c c-func docutils literal notranslate">Py_InitializeFromConfig()</code></a></li>

<li><a class="reference internal" href="#c.Py_BytesMain" title="Py_BytesMain"><code class="xref c c-func docutils literal notranslate">Py_BytesMain()</code></a></li>

<li>the runtime pre-initialization functions covered in <a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a></li>

</ul>

</li>

<li>Configuration functions:

<ul>

<li><a class="reference internal" href="import.html#c.PyImport_AppendInittab" title="PyImport_AppendInittab"><code class="xref c c-func docutils literal notranslate">PyImport_AppendInittab()</code></a></li>

<li><a class="reference internal" href="import.html#c.PyImport_ExtendInittab" title="PyImport_ExtendInittab"><code class="xref c c-func docutils literal notranslate">PyImport_ExtendInittab()</code></a></li>

<li><code class="xref c c-func docutils literal notranslate">PyInitFrozenExtensions()</code></li>

<li><a class="reference internal" href="memory.html#c.PyMem_SetAllocator" title="PyMem_SetAllocator"><code class="xref c c-func docutils literal notranslate">PyMem_SetAllocator()</code></a></li>

<li><a class="reference internal" href="memory.html#c.PyMem_SetupDebugHooks" title="PyMem_SetupDebugHooks"><code class="xref c c-func docutils literal notranslate">PyMem_SetupDebugHooks()</code></a></li>

<li><a class="reference internal" href="memory.html#c.PyObject_SetArenaAllocator" title="PyObject_SetArenaAllocator"><code class="xref c c-func docutils literal notranslate">PyObject_SetArenaAllocator()</code></a></li>

<li><a class="reference internal" href="#c.Py_SetProgramName" title="Py_SetProgramName"><code class="xref c c-func docutils literal notranslate">Py_SetProgramName()</code></a></li>

<li><a class="reference internal" href="#c.Py_SetPythonHome" title="Py_SetPythonHome"><code class="xref c c-func docutils literal notranslate">Py_SetPythonHome()</code></a></li>

<li>the configuration functions covered in <a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a></li>

</ul>

</li>

<li>Informative functions:

<ul>

<li><a class="reference internal" href="#c.Py_IsInitialized" title="Py_IsInitialized"><code class="xref c c-func docutils literal notranslate">Py_IsInitialized()</code></a></li>

<li><a class="reference internal" href="memory.html#c.PyMem_GetAllocator" title="PyMem_GetAllocator"><code class="xref c c-func docutils literal notranslate">PyMem_GetAllocator()</code></a></li>

<li><a class="reference internal" href="memory.html#c.PyObject_GetArenaAllocator" title="PyObject_GetArenaAllocator"><code class="xref c c-func docutils literal notranslate">PyObject_GetArenaAllocator()</code></a></li>

<li><a class="reference internal" href="#c.Py_GetBuildInfo" title="Py_GetBuildInfo"><code class="xref c c-func docutils literal notranslate">Py_GetBuildInfo()</code></a></li>

<li><a class="reference internal" href="#c.Py_GetCompiler" title="Py_GetCompiler"><code class="xref c c-func docutils literal notranslate">Py_GetCompiler()</code></a></li>

<li><a class="reference internal" href="#c.Py_GetCopyright" title="Py_GetCopyright"><code class="xref c c-func docutils literal notranslate">Py_GetCopyright()</code></a></li>

<li><a class="reference internal" href="#c.Py_GetPlatform" title="Py_GetPlatform"><code class="xref c c-func docutils literal notranslate">Py_GetPlatform()</code></a></li>

<li><a class="reference internal" href="#c.Py_GetVersion" title="Py_GetVersion"><code class="xref c c-func docutils literal notranslate">Py_GetVersion()</code></a></li>

</ul>

</li>

<li>Utilities:

<ul>

<li><a class="reference internal" href="sys.html#c.Py_DecodeLocale" title="Py_DecodeLocale"><code class="xref c c-func docutils literal notranslate">Py_DecodeLocale()</code></a></li>

<li>the status reporting and utility functions covered in <a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a></li>

</ul>

</li>

<li>Memory allocators:

<ul>

<li><a class="reference internal" href="memory.html#c.PyMem_RawMalloc" title="PyMem_RawMalloc"><code class="xref c c-func docutils literal notranslate">PyMem_RawMalloc()</code></a></li>

<li><a class="reference internal" href="memory.html#c.PyMem_RawRealloc" title="PyMem_RawRealloc"><code class="xref c c-func docutils literal notranslate">PyMem_RawRealloc()</code></a></li>

<li><a class="reference internal" href="memory.html#c.PyMem_RawCalloc" title="PyMem_RawCalloc"><code class="xref c c-func docutils literal notranslate">PyMem_RawCalloc()</code></a></li>

<li><a class="reference internal" href="memory.html#c.PyMem_RawFree" title="PyMem_RawFree"><code class="xref c c-func docutils literal notranslate">PyMem_RawFree()</code></a></li>

</ul>

</li>

<li>Synchronization:

<ul>

<li><a class="reference internal" href="synchronization.html#c.PyMutex_Lock" title="PyMutex_Lock"><code class="xref c c-func docutils literal notranslate">PyMutex_Lock()</code></a></li>

<li><a class="reference internal" href="synchronization.html#c.PyMutex_Unlock" title="PyMutex_Unlock"><code class="xref c c-func docutils literal notranslate">PyMutex_Unlock()</code></a></li>

</ul>

</li>

</ul>

توجه

Despite their apparent similarity to some of the functions listed above,

the following functions should not be called before the interpreter has

been initialized: <a class="reference internal" href="sys.html#c.Py_EncodeLocale" title="Py_EncodeLocale"><code class="xref c c-func docutils literal notranslate">Py_EncodeLocale()</code></a>, <a class="reference internal" href="threads.html#c.PyEval_InitThreads" title="PyEval_InitThreads"><code class="xref c c-func docutils literal notranslate">PyEval_InitThreads()</code></a>, and

<a class="reference internal" href="#c.Py_RunMain" title="Py_RunMain"><code class="xref c c-func docutils literal notranslate">Py_RunMain()</code></a>.

</div>

</section>

<h2>Global configuration variables<a class="headerlink" href="#global-configuration-variables" title="Link to this heading">¶</a></h2>

Python has variables for the global configuration to control different features

and options. By default, these flags are controlled by <a class="reference internal" href="../using/cmdline.html#using-on-interface-options">command line

options</a>.

When a flag is set by an option, the value of the flag is the number of times

that the option was set. For example, <code class="docutils literal notranslate">-b</code> sets <a class="reference internal" href="#c.Py_BytesWarningFlag" title="Py_BytesWarningFlag"><code class="xref c c-data docutils literal notranslate">Py_BytesWarningFlag</code></a>

to 1 and <code class="docutils literal notranslate">-bb</code> sets <code class="xref c c-data docutils literal notranslate">Py_BytesWarningFlag</code> to 2.

int Py_BytesWarningFlag<a class="headerlink" href="#c.Py_BytesWarningFlag" title="Link to this definition">¶</a> </dt>

<dd>This API is kept for backward compatibility: setting

<a class="reference internal" href="init_config.html#c.PyConfig.bytes_warning" title="PyConfig.bytes_warning"><code class="xref c c-member docutils literal notranslate">PyConfig.bytes_warning</code></a> should be used instead, see <a class="reference internal" href="init_config.html#init-config">Python

Initialization Configuration</a>.

Issue a warning when comparing <a class="reference internal" href="../library/stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> or <a class="reference internal" href="../library/stdtypes.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate">bytearray</code></a> with

<a class="reference internal" href="../library/stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate">str</code></a> or <code class="xref py py-class docutils literal notranslate">bytes</code> with <a class="reference internal" href="../library/functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a>. Issue an error if greater

or equal to <code class="docutils literal notranslate">2</code>.

Set by the <a class="reference internal" href="../using/cmdline.html#cmdoption-b"><code class="xref std std-option docutils literal notranslate">-b</code></a> option.

منسوخ شده از نسخه‌ی 3.12, در نسخه‌ی 3.15 حذف خواهد شد..

</div>

</dd></dl>

int Py_DebugFlag<a class="headerlink" href="#c.Py_DebugFlag" title="Link to this definition">¶</a> </dt>

<dd>This API is kept for backward compatibility: setting

<a class="reference internal" href="init_config.html#c.PyConfig.parser_debug" title="PyConfig.parser_debug"><code class="xref c c-member docutils literal notranslate">PyConfig.parser_debug</code></a> should be used instead, see <a class="reference internal" href="init_config.html#init-config">Python

Initialization Configuration</a>.

Turn on parser debugging output (for expert only, depending on compilation

options).

Set by the <a class="reference internal" href="../using/cmdline.html#cmdoption-d"><code class="xref std std-option docutils literal notranslate">-d</code></a> option and the <a class="reference internal" href="../using/cmdline.html#envvar-PYTHONDEBUG"><code class="xref std std-envvar docutils literal notranslate">PYTHONDEBUG</code></a> environment

variable.

منسوخ شده از نسخه‌ی 3.12, در نسخه‌ی 3.15 حذف خواهد شد..

</div>

</dd></dl>

int Py_DontWriteBytecodeFlag<a class="headerlink" href="#c.Py_DontWriteBytecodeFlag" title="Link to this definition">¶</a> </dt>

<dd>This API is kept for backward compatibility: setting

<a class="reference internal" href="init_config.html#c.PyConfig.write_bytecode" title="PyConfig.write_bytecode"><code class="xref c c-member docutils literal notranslate">PyConfig.write_bytecode</code></a> should be used instead, see <a class="reference internal" href="init_config.html#init-config">Python

Initialization Configuration</a>.

If set to non-zero, Python won't try to write <code class="docutils literal notranslate">.pyc</code> files on the

import of source modules.

Set by the <a class="reference internal" href="../using/cmdline.html#cmdoption-B"><code class="xref std std-option docutils literal notranslate">-B</code></a> option and the <a class="reference internal" href="../using/cmdline.html#envvar-PYTHONDONTWRITEBYTECODE"><code class="xref std std-envvar docutils literal notranslate">PYTHONDONTWRITEBYTECODE</code></a>

environment variable.

منسوخ شده از نسخه‌ی 3.12, در نسخه‌ی 3.15 حذف خواهد شد..

</div>

</dd></dl>

int Py_FrozenFlag<a class="headerlink" href="#c.Py_FrozenFlag" title="Link to this definition">¶</a> </dt>

<dd>This API is kept for backward compatibility: setting

<a class="reference internal" href="init_config.html#c.PyConfig.pathconfig_warnings" title="PyConfig.pathconfig_warnings"><code class="xref c c-member docutils literal notranslate">PyConfig.pathconfig_warnings</code></a> should be used instead, see

<a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a>.

Private flag used by <code class="docutils literal notranslate">_freeze_module</code> and <code class="docutils literal notranslate">frozenmain</code> programs.

منسوخ شده از نسخه‌ی 3.12, در نسخه‌ی 3.15 حذف خواهد شد..

</div>

</dd></dl>

int Py_HashRandomizationFlag<a class="headerlink" href="#c.Py_HashRandomizationFlag" title="Link to this definition">¶</a> </dt>

<dd>This API is kept for backward compatibility: setting

<a class="reference internal" href="init_config.html#c.PyConfig.hash_seed" title="PyConfig.hash_seed"><code class="xref c c-member docutils literal notranslate">PyConfig.hash_seed</code></a> and <a class="reference internal" href="init_config.html#c.PyConfig.use_hash_seed" title="PyConfig.use_hash_seed"><code class="xref c c-member docutils literal notranslate">PyConfig.use_hash_seed</code></a> should

be used instead, see <a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a>.

Set to <code class="docutils literal notranslate">1</code> if the <a class="reference internal" href="../using/cmdline.html#envvar-PYTHONHASHSEED"><code class="xref std std-envvar docutils literal notranslate">PYTHONHASHSEED</code></a> environment variable is set to

a non-empty string.

If the flag is non-zero, read the <a class="reference internal" href="../using/cmdline.html#envvar-PYTHONHASHSEED"><code class="xref std std-envvar docutils literal notranslate">PYTHONHASHSEED</code></a> environment

variable to initialize the secret hash seed.

منسوخ شده از نسخه‌ی 3.12, در نسخه‌ی 3.15 حذف خواهد شد..

</div>

</dd></dl>

int Py_IgnoreEnvironmentFlag<a class="headerlink" href="#c.Py_IgnoreEnvironmentFlag" title="Link to this definition">¶</a> </dt>

<dd>This API is kept for backward compatibility: setting

<a class="reference internal" href="init_config.html#c.PyConfig.use_environment" title="PyConfig.use_environment"><code class="xref c c-member docutils literal notranslate">PyConfig.use_environment</code></a> should be used instead, see

<a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a>.

Ignore all <code class="xref std std-envvar docutils literal notranslate">PYTHON*</code> environment variables, e.g.

<a class="reference internal" href="../using/cmdline.html#envvar-PYTHONPATH"><code class="xref std std-envvar docutils literal notranslate">PYTHONPATH</code></a> and <a class="reference internal" href="../using/cmdline.html#envvar-PYTHONHOME"><code class="xref std std-envvar docutils literal notranslate">PYTHONHOME</code></a>, that might be set.

Set by the <a class="reference internal" href="../using/cmdline.html#cmdoption-E"><code class="xref std std-option docutils literal notranslate">-E</code></a> and <a class="reference internal" href="../using/cmdline.html#cmdoption-I"><code class="xref std std-option docutils literal notranslate">-I</code></a> options.

منسوخ شده از نسخه‌ی 3.12, در نسخه‌ی 3.15 حذف خواهد شد..

</div>

</dd></dl>

int Py_InspectFlag<a class="headerlink" href="#c.Py_InspectFlag" title="Link to this definition">¶</a> </dt>

<dd>This API is kept for backward compatibility: setting

<a class="reference internal" href="init_config.html#c.PyConfig.inspect" title="PyConfig.inspect"><code class="xref c c-member docutils literal notranslate">PyConfig.inspect</code></a> should be used instead, see

<a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a>.

When a script is passed as first argument or the <a class="reference internal" href="../using/cmdline.html#cmdoption-c"><code class="xref std std-option docutils literal notranslate">-c</code></a> option is used,

enter interactive mode after executing the script or the command, even when

<a class="reference internal" href="../library/sys.html#sys.stdin" title="sys.stdin"><code class="xref py py-data docutils literal notranslate">sys.stdin</code></a> does not appear to be a terminal.

Set by the <a class="reference internal" href="../using/cmdline.html#cmdoption-i"><code class="xref std std-option docutils literal notranslate">-i</code></a> option and the <a class="reference internal" href="../using/cmdline.html#envvar-PYTHONINSPECT"><code class="xref std std-envvar docutils literal notranslate">PYTHONINSPECT</code></a> environment

variable.

منسوخ شده از نسخه‌ی 3.12, در نسخه‌ی 3.15 حذف خواهد شد..

</div>

</dd></dl>

int Py_InteractiveFlag<a class="headerlink" href="#c.Py_InteractiveFlag" title="Link to this definition">¶</a> </dt>

<dd>This API is kept for backward compatibility: setting

<a class="reference internal" href="init_config.html#c.PyConfig.interactive" title="PyConfig.interactive"><code class="xref c c-member docutils literal notranslate">PyConfig.interactive</code></a> should be used instead, see

<a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a>.

Set by the <a class="reference internal" href="../using/cmdline.html#cmdoption-i"><code class="xref std std-option docutils literal notranslate">-i</code></a> option.

منسوخ شده از نسخه‌ی 3.12, در نسخه‌ی 3.15 حذف خواهد شد..

</div>

</dd></dl>

int Py_IsolatedFlag<a class="headerlink" href="#c.Py_IsolatedFlag" title="Link to this definition">¶</a> </dt>

<dd>This API is kept for backward compatibility: setting

<a class="reference internal" href="init_config.html#c.PyConfig.isolated" title="PyConfig.isolated"><code class="xref c c-member docutils literal notranslate">PyConfig.isolated</code></a> should be used instead, see

<a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a>.

Run Python in isolated mode. In isolated mode <a class="reference internal" href="../library/sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a> contains

neither the script's directory nor the user's site-packages directory.

Set by the <a class="reference internal" href="../using/cmdline.html#cmdoption-I"><code class="xref std std-option docutils literal notranslate">-I</code></a> option.

Added in version 3.4.

</div>

منسوخ شده از نسخه‌ی 3.12, در نسخه‌ی 3.15 حذف خواهد شد..

</div>

</dd></dl>

int Py_LegacyWindowsFSEncodingFlag<a class="headerlink" href="#c.Py_LegacyWindowsFSEncodingFlag" title="Link to this definition">¶</a> </dt>

<dd>This API is kept for backward compatibility: setting

<a class="reference internal" href="init_config.html#c.PyPreConfig.legacy_windows_fs_encoding" title="PyPreConfig.legacy_windows_fs_encoding"><code class="xref c c-member docutils literal notranslate">PyPreConfig.legacy_windows_fs_encoding</code></a> should be used instead, see

<a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a>.

If the flag is non-zero, use the <code class="docutils literal notranslate">mbcs</code> encoding with <code class="docutils literal notranslate">replace</code> error

handler, instead of the UTF-8 encoding with <code class="docutils literal notranslate">surrogatepass</code> error handler,

for the <a class="reference internal" href="../glossary.html#term-filesystem-encoding-and-error-handler">filesystem encoding and error handler</a>.

Set to <code class="docutils literal notranslate">1</code> if the <a class="reference internal" href="../using/cmdline.html#envvar-PYTHONLEGACYWINDOWSFSENCODING"><code class="xref std std-envvar docutils literal notranslate">PYTHONLEGACYWINDOWSFSENCODING</code></a> environment

variable is set to a non-empty string.

See <a class="pep reference external" href="https://peps.python.org/pep-0529/">PEP 529</a> for more details.

<a class="reference internal" href="../library/intro.html#availability">در دسترس بودن</a>: Windows.

</div>

منسوخ شده از نسخه‌ی 3.12, در نسخه‌ی 3.15 حذف خواهد شد..

</div>

</dd></dl>

int Py_LegacyWindowsStdioFlag<a class="headerlink" href="#c.Py_LegacyWindowsStdioFlag" title="Link to this definition">¶</a> </dt>

<dd>This API is kept for backward compatibility: setting

<a class="reference internal" href="init_config.html#c.PyConfig.legacy_windows_stdio" title="PyConfig.legacy_windows_stdio"><code class="xref c c-member docutils literal notranslate">PyConfig.legacy_windows_stdio</code></a> should be used instead, see

<a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a>.

If the flag is non-zero, use <a class="reference internal" href="../library/io.html#io.FileIO" title="io.FileIO"><code class="xref py py-class docutils literal notranslate">io.FileIO</code></a> instead of

<code class="xref py py-class docutils literal notranslate">io._WindowsConsoleIO</code> for <a class="reference internal" href="../library/sys.html#module-sys" title="sys: Access system-specific parameters and functions."><code class="xref py py-mod docutils literal notranslate">sys</code></a> standard streams.

Set to <code class="docutils literal notranslate">1</code> if the <a class="reference internal" href="../using/cmdline.html#envvar-PYTHONLEGACYWINDOWSSTDIO"><code class="xref std std-envvar docutils literal notranslate">PYTHONLEGACYWINDOWSSTDIO</code></a> environment

variable is set to a non-empty string.

See <a class="pep reference external" href="https://peps.python.org/pep-0528/">PEP 528</a> for more details.

<a class="reference internal" href="../library/intro.html#availability">در دسترس بودن</a>: Windows.

</div>

منسوخ شده از نسخه‌ی 3.12, در نسخه‌ی 3.15 حذف خواهد شد..

</div>

</dd></dl>

int Py_NoSiteFlag<a class="headerlink" href="#c.Py_NoSiteFlag" title="Link to this definition">¶</a> </dt>

<dd>This API is kept for backward compatibility: setting

<a class="reference internal" href="init_config.html#c.PyConfig.site_import" title="PyConfig.site_import"><code class="xref c c-member docutils literal notranslate">PyConfig.site_import</code></a> should be used instead, see

<a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a>.

Disable the import of the module <a class="reference internal" href="../library/site.html#module-site" title="site: Module responsible for site-specific configuration."><code class="xref py py-mod docutils literal notranslate">site</code></a> and the site-dependent

manipulations of <a class="reference internal" href="../library/sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a> that it entails. Also disable these

manipulations if <code class="xref py py-mod docutils literal notranslate">site</code> is explicitly imported later (call

<a class="reference internal" href="../library/site.html#site.main" title="site.main"><code class="xref py py-func docutils literal notranslate">site.main()</code></a> if you want them to be triggered).

Set by the <a class="reference internal" href="../using/cmdline.html#cmdoption-S"><code class="xref std std-option docutils literal notranslate">-S</code></a> option.

منسوخ شده از نسخه‌ی 3.12, در نسخه‌ی 3.15 حذف خواهد شد..

</div>

</dd></dl>

int Py_NoUserSiteDirectory<a class="headerlink" href="#c.Py_NoUserSiteDirectory" title="Link to this definition">¶</a> </dt>

<dd>This API is kept for backward compatibility: setting

<a class="reference internal" href="init_config.html#c.PyConfig.user_site_directory" title="PyConfig.user_site_directory"><code class="xref c c-member docutils literal notranslate">PyConfig.user_site_directory</code></a> should be used instead, see

<a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a>.

Don't add the <a class="reference internal" href="../library/site.html#site.USER_SITE" title="site.USER_SITE"><code class="xref py py-data docutils literal notranslate">user site-packages directory</code></a> to

<a class="reference internal" href="../library/sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a>.

Set by the <a class="reference internal" href="../using/cmdline.html#cmdoption-s"><code class="xref std std-option docutils literal notranslate">-s</code></a> and <a class="reference internal" href="../using/cmdline.html#cmdoption-I"><code class="xref std std-option docutils literal notranslate">-I</code></a> options, and the

<a class="reference internal" href="../using/cmdline.html#envvar-PYTHONNOUSERSITE"><code class="xref std std-envvar docutils literal notranslate">PYTHONNOUSERSITE</code></a> environment variable.

منسوخ شده از نسخه‌ی 3.12, در نسخه‌ی 3.15 حذف خواهد شد..

</div>

</dd></dl>

int Py_OptimizeFlag<a class="headerlink" href="#c.Py_OptimizeFlag" title="Link to this definition">¶</a> </dt>

<dd>This API is kept for backward compatibility: setting

<a class="reference internal" href="init_config.html#c.PyConfig.optimization_level" title="PyConfig.optimization_level"><code class="xref c c-member docutils literal notranslate">PyConfig.optimization_level</code></a> should be used instead, see

<a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a>.

Set by the <a class="reference internal" href="../using/cmdline.html#cmdoption-O"><code class="xref std std-option docutils literal notranslate">-O</code></a> option and the <a class="reference internal" href="../using/cmdline.html#envvar-PYTHONOPTIMIZE"><code class="xref std std-envvar docutils literal notranslate">PYTHONOPTIMIZE</code></a> environment

variable.

منسوخ شده از نسخه‌ی 3.12, در نسخه‌ی 3.15 حذف خواهد شد..

</div>

</dd></dl>

int Py_QuietFlag<a class="headerlink" href="#c.Py_QuietFlag" title="Link to this definition">¶</a> </dt>

<dd>This API is kept for backward compatibility: setting

<a class="reference internal" href="init_config.html#c.PyConfig.quiet" title="PyConfig.quiet"><code class="xref c c-member docutils literal notranslate">PyConfig.quiet</code></a> should be used instead, see <a class="reference internal" href="init_config.html#init-config">Python

Initialization Configuration</a>.

Don't display the copyright and version messages even in interactive mode.

Set by the <a class="reference internal" href="../using/cmdline.html#cmdoption-q"><code class="xref std std-option docutils literal notranslate">-q</code></a> option.

Added in version 3.2.

</div>

منسوخ شده از نسخه‌ی 3.12, در نسخه‌ی 3.15 حذف خواهد شد..

</div>

</dd></dl>

int Py_UnbufferedStdioFlag<a class="headerlink" href="#c.Py_UnbufferedStdioFlag" title="Link to this definition">¶</a> </dt>

<dd>This API is kept for backward compatibility: setting

<a class="reference internal" href="init_config.html#c.PyConfig.buffered_stdio" title="PyConfig.buffered_stdio"><code class="xref c c-member docutils literal notranslate">PyConfig.buffered_stdio</code></a> should be used instead, see <a class="reference internal" href="init_config.html#init-config">Python

Initialization Configuration</a>.

Force the stdout and stderr streams to be unbuffered.

Set by the <a class="reference internal" href="../using/cmdline.html#cmdoption-u"><code class="xref std std-option docutils literal notranslate">-u</code></a> option and the <a class="reference internal" href="../using/cmdline.html#envvar-PYTHONUNBUFFERED"><code class="xref std std-envvar docutils literal notranslate">PYTHONUNBUFFERED</code></a>

environment variable.

منسوخ شده از نسخه‌ی 3.12, در نسخه‌ی 3.15 حذف خواهد شد..

</div>

</dd></dl>

int Py_VerboseFlag<a class="headerlink" href="#c.Py_VerboseFlag" title="Link to this definition">¶</a> </dt>

<dd>This API is kept for backward compatibility: setting

<a class="reference internal" href="init_config.html#c.PyConfig.verbose" title="PyConfig.verbose"><code class="xref c c-member docutils literal notranslate">PyConfig.verbose</code></a> should be used instead, see <a class="reference internal" href="init_config.html#init-config">Python

Initialization Configuration</a>.

Print a message each time a module is initialized, showing the place

(filename or built-in module) from which it is loaded. If greater or equal

to <code class="docutils literal notranslate">2</code>, print a message for each file that is checked for when

searching for a module. Also provides information on module cleanup at exit.

Set by the <a class="reference internal" href="../using/cmdline.html#cmdoption-v"><code class="xref std std-option docutils literal notranslate">-v</code></a> option and the <a class="reference internal" href="../using/cmdline.html#envvar-PYTHONVERBOSE"><code class="xref std std-envvar docutils literal notranslate">PYTHONVERBOSE</code></a> environment

variable.

منسوخ شده از نسخه‌ی 3.12, در نسخه‌ی 3.15 حذف خواهد شد..

</div>

</dd></dl>

</section>

<h2>Initializing and finalizing the interpreter<a class="headerlink" href="#initializing-and-finalizing-the-interpreter" title="Link to this heading">¶</a></h2>

void Py_Initialize()<a class="headerlink" href="#c.Py_Initialize" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Initialize the Python interpreter. In an application embedding Python,

this should be called before using any other Python/C API functions; see

<a class="reference internal" href="#pre-init-safe">Before Python Initialization</a> for the few exceptions.

This initializes the table of loaded modules (<code class="docutils literal notranslate">sys.modules</code>), and creates

the fundamental modules <a class="reference internal" href="../library/builtins.html#module-builtins" title="builtins: The module that provides the built-in namespace."><code class="xref py py-mod docutils literal notranslate">builtins</code></a>, <a class="reference internal" href="../library/__main__.html#module-__main__" title="__main__: The environment where top-level code is run. Covers command-line interfaces, import-time behavior, and ``__name__ == '__main__'``."><code class="xref py py-mod docutils literal notranslate">__main__</code></a> and <a class="reference internal" href="../library/sys.html#module-sys" title="sys: Access system-specific parameters and functions."><code class="xref py py-mod docutils literal notranslate">sys</code></a>.

It also initializes the module search path (<code class="docutils literal notranslate">sys.path</code>). It does not set

<code class="docutils literal notranslate">sys.argv</code>; use the <a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a>

API for that. This is a no-op when called for a second time (without calling

<a class="reference internal" href="#c.Py_FinalizeEx" title="Py_FinalizeEx"><code class="xref c c-func docutils literal notranslate">Py_FinalizeEx()</code></a> first). There is no return value; it is a fatal

error if the initialization fails.

Use <a class="reference internal" href="#c.Py_InitializeFromConfig" title="Py_InitializeFromConfig"><code class="xref c c-func docutils literal notranslate">Py_InitializeFromConfig()</code></a> to customize the

<a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a>.

توجه

On Windows, changes the console mode from <code class="docutils literal notranslate">O_TEXT</code> to <code class="docutils literal notranslate">O_BINARY</code>,

which will also affect non-Python uses of the console using the C Runtime.

</div>

</dd></dl>

void Py_InitializeEx(int initsigs)<a class="headerlink" href="#c.Py_InitializeEx" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.This function works like <a class="reference internal" href="#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate">Py_Initialize()</code></a> if initsigs is <code class="docutils literal notranslate">1</code>. If

initsigs is <code class="docutils literal notranslate">0</code>, it skips initialization registration of signal handlers,

which may be useful when CPython is embedded as part of a larger application.

<a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a>.

</dd></dl>

<a class="reference internal" href="init_config.html#c.PyStatus" title="PyStatus">PyStatus</a> Py_InitializeFromConfig(const <a class="reference internal" href="init_config.html#c.PyConfig" title="PyConfig">PyConfig</a> *config)<a class="headerlink" href="#c.Py_InitializeFromConfig" title="Link to this definition">¶</a> </dt>

<dd>Initialize Python from config configuration, as described in

<a class="reference internal" href="init_config.html#init-from-config">Initialization with PyConfig</a>.

See the <a class="reference internal" href="init_config.html#init-config">Python Initialization Configuration</a> section for details on pre-initializing the

interpreter, populating the runtime configuration structure, and querying

the returned status structure.

</dd></dl>

int Py_IsInitialized()<a class="headerlink" href="#c.Py_IsInitialized" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return true (nonzero) when the Python interpreter has been initialized, false

(zero) if not. After <a class="reference internal" href="#c.Py_FinalizeEx" title="Py_FinalizeEx"><code class="xref c c-func docutils literal notranslate">Py_FinalizeEx()</code></a> is called, this returns false until

<a class="reference internal" href="#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate">Py_Initialize()</code></a> is called again.

</dd></dl>

int Py_IsFinalizing()<a class="headerlink" href="#c.Py_IsFinalizing" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.13.Return true (non-zero) if the main Python interpreter is

<a class="reference internal" href="../glossary.html#term-interpreter-shutdown">shutting down</a>. Return false (zero) otherwise.

Added in version 3.13.

</div>

</dd></dl>

int Py_FinalizeEx()<a class="headerlink" href="#c.Py_FinalizeEx" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.6.Undo all initializations made by <a class="reference internal" href="#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate">Py_Initialize()</code></a> and subsequent use of

Python/C API functions, and destroy all sub-interpreters (see

<a class="reference internal" href="subinterpreters.html#c.Py_NewInterpreter" title="Py_NewInterpreter"><code class="xref c c-func docutils literal notranslate">Py_NewInterpreter()</code></a> below) that were created and not yet destroyed since

the last call to <code class="xref c c-func docutils literal notranslate">Py_Initialize()</code>. This is a no-op when called for a second

time (without calling <code class="xref c c-func docutils literal notranslate">Py_Initialize()</code> again first).

Since this is the reverse of <a class="reference internal" href="#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate">Py_Initialize()</code></a>, it should be called

in the same thread with the same interpreter active. That means

the main thread and the main interpreter.

This should never be called while <a class="reference internal" href="#c.Py_RunMain" title="Py_RunMain"><code class="xref c c-func docutils literal notranslate">Py_RunMain()</code></a> is running.

Normally the return value is <code class="docutils literal notranslate">0</code>.

If there were errors during finalization (flushing buffered data),

<code class="docutils literal notranslate">-1</code> is returned.

Note that Python will do a best effort at freeing all memory allocated by the Python

interpreter. Therefore, any C-Extension should make sure to correctly clean up all

of the previously allocated PyObjects before using them in subsequent calls to

behavior.

This function is provided for a number of reasons. An embedding application

might want to restart Python without having to restart the application itself.

An application that has loaded the Python interpreter from a dynamically

loadable library (or DLL) might want to free all memory allocated by Python

before unloading the DLL. During a hunt for memory leaks in an application a

developer might want to free all memory allocated by Python before exiting from

the application.

Bugs and caveats: The destruction of modules and objects in modules is done

in random order; this may cause destructors (<a class="reference internal" href="../reference/datamodel.html#object.__del__" title="object.__del__"><code class="xref py py-meth docutils literal notranslate">__del__()</code></a> methods) to fail

when they depend on other objects (even functions) or modules. Dynamically

loaded extension modules loaded by Python are not unloaded. Small amounts of

memory allocated by the Python interpreter may not be freed (if you find a leak,

please report it). Memory tied up in circular references between objects is not

freed. Interned strings will all be deallocated regardless of their reference count.

Some memory allocated by extension modules may not be freed. Some extensions may not

work properly if their initialization routine is called more than once; this can

happen if an application calls <a class="reference internal" href="#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate">Py_Initialize()</code></a> and <a class="reference internal" href="#c.Py_FinalizeEx" title="Py_FinalizeEx"><code class="xref c c-func docutils literal notranslate">Py_FinalizeEx()</code></a>

more than once. <code class="xref c c-func docutils literal notranslate">Py_FinalizeEx()</code> must not be called recursively from

within itself. Therefore, it must not be called by any code that may be run

as part of the interpreter shutdown process, such as <a class="reference internal" href="../library/atexit.html#module-atexit" title="atexit: Register and execute cleanup functions."><code class="xref py py-mod docutils literal notranslate">atexit</code></a>

handlers, object finalizers, or any code that may be run while flushing the

stdout and stderr files.

Raises an <a class="reference internal" href="../library/sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">cpython._PySys_ClearAuditHooks</code> with no arguments.

Added in version 3.6.

</div>

</dd></dl>

void Py_Finalize()<a class="headerlink" href="#c.Py_Finalize" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.This is a backwards-compatible version of <a class="reference internal" href="#c.Py_FinalizeEx" title="Py_FinalizeEx"><code class="xref c c-func docutils literal notranslate">Py_FinalizeEx()</code></a> that

disregards the return value.

</dd></dl>

int Py_BytesMain(int argc, char **argv)<a class="headerlink" href="#c.Py_BytesMain" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.8.Similar to <a class="reference internal" href="#c.Py_Main" title="Py_Main"><code class="xref c c-func docutils literal notranslate">Py_Main()</code></a> but argv is an array of bytes strings,

allowing the calling application to delegate the text decoding step to

the CPython runtime.

Added in version 3.8.

</div>

</dd></dl>

int Py_Main(int argc, wchar_t **argv)<a class="headerlink" href="#c.Py_Main" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.The main program for the standard interpreter, encapsulating a full

initialization/finalization cycle, as well as additional

behaviour to implement reading configurations settings from the environment

and command line, and then executing <code class="docutils literal notranslate">__main__</code> in accordance with

<a class="reference internal" href="../using/cmdline.html#using-on-cmdline">Command line</a>.

This is made available for programs which wish to support the full CPython

command line interface, rather than just embedding a Python runtime in a

larger application.

The argc and argv parameters are similar to those which are passed to a

C program's <code class="xref c c-func docutils literal notranslate">main()</code> function, except that the argv entries are first

converted to <code class="docutils literal notranslate">wchar_t</code> using <a class="reference internal" href="sys.html#c.Py_DecodeLocale" title="Py_DecodeLocale"><code class="xref c c-func docutils literal notranslate">Py_DecodeLocale()</code></a>. It is also

important to note that the argument list entries may be modified to point to

strings other than those passed in (however, the contents of the strings

pointed to by the argument list are not modified).

The return value is <code class="docutils literal notranslate">2</code> if the argument list does not represent a valid

Python command line, and otherwise the same as <a class="reference internal" href="#c.Py_RunMain" title="Py_RunMain"><code class="xref c c-func docutils literal notranslate">Py_RunMain()</code></a>.

In terms of the CPython runtime configuration APIs documented in the

<a class="reference internal" href="init_config.html#init-config">runtime configuration</a> section (and without accounting

for error handling), <code class="docutils literal notranslate">Py_Main</code> is approximately equivalent to:

<div class="highlight-c notranslate"><div class="highlight"><pre>PyConfig config;

PyConfig_InitPythonConfig(&config);

PyConfig_SetArgv(&config, argc, argv);

Py_InitializeFromConfig(&config);

PyConfig_Clear(&config);

Py_RunMain();

</pre></div>

</div>

In normal usage, an embedding application will call this function

instead of calling <a class="reference internal" href="#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate">Py_Initialize()</code></a>, <a class="reference internal" href="#c.Py_InitializeEx" title="Py_InitializeEx"><code class="xref c c-func docutils literal notranslate">Py_InitializeEx()</code></a> or

<a class="reference internal" href="#c.Py_InitializeFromConfig" title="Py_InitializeFromConfig"><code class="xref c c-func docutils literal notranslate">Py_InitializeFromConfig()</code></a> directly, and all settings will be applied

as described elsewhere in this documentation. If this function is instead

called after a preceding runtime initialization API call, then exactly

which environmental and command line configuration settings will be updated

is version dependent (as it depends on which settings correctly support

being modified after they have already been set once when the runtime was

first initialized).

</dd></dl>

int Py_RunMain(void)<a class="headerlink" href="#c.Py_RunMain" title="Link to this definition">¶</a> </dt>

<dd>Executes the main module in a fully configured CPython runtime.

Executes the command (<a class="reference internal" href="init_config.html#c.PyConfig.run_command" title="PyConfig.run_command"><code class="xref c c-member docutils literal notranslate">PyConfig.run_command</code></a>), the script

(<a class="reference internal" href="init_config.html#c.PyConfig.run_filename" title="PyConfig.run_filename"><code class="xref c c-member docutils literal notranslate">PyConfig.run_filename</code></a>) or the module

(<a class="reference internal" href="init_config.html#c.PyConfig.run_module" title="PyConfig.run_module"><code class="xref c c-member docutils literal notranslate">PyConfig.run_module</code></a>) specified on the command line or in the

configuration. If none of these values are set, runs the interactive Python

prompt (REPL) using the <code class="docutils literal notranslate">__main__</code> module's global namespace.

will be <code class="docutils literal notranslate">0</code> if the interpreter exits normally (that is, without raising

an exception), the exit status of an unhandled <a class="reference internal" href="../library/exceptions.html#SystemExit" title="SystemExit"><code class="xref py py-exc docutils literal notranslate">SystemExit</code></a>, or <code class="docutils literal notranslate">1</code>

for any other unhandled exception.

If <a class="reference internal" href="init_config.html#c.PyConfig.inspect" title="PyConfig.inspect"><code class="xref c c-member docutils literal notranslate">PyConfig.inspect</code></a> is set (such as when the <a class="reference internal" href="../using/cmdline.html#cmdoption-i"><code class="xref std std-option docutils literal notranslate">-i</code></a> option

is used), rather than returning when the interpreter exits, execution will

instead resume in an interactive Python prompt (REPL) using the <code class="docutils literal notranslate">__main__</code>

module's global namespace. If the interpreter exited with an exception, it

is immediately raised in the REPL session. The function return value is

then determined by the way the REPL session terminates: <code class="docutils literal notranslate">0</code>, <code class="docutils literal notranslate">1</code>, or

the status of a <a class="reference internal" href="../library/exceptions.html#SystemExit" title="SystemExit"><code class="xref py py-exc docutils literal notranslate">SystemExit</code></a>, as specified above.

This function always finalizes the Python interpreter before it returns.

See <a class="reference internal" href="init_config.html#init-python-config">Python Configuration</a> for an example of a

customized Python that always runs in isolated mode using

<a class="reference internal" href="#c.Py_RunMain" title="Py_RunMain"><code class="xref c c-func docutils literal notranslate">Py_RunMain()</code></a>.

</dd></dl>

int PyUnstable_AtExit(<a class="reference internal" href="subinterpreters.html#c.PyInterpreterState" title="PyInterpreterState">PyInterpreterState</a> *interp, void (*func)(void*), void *data)<a class="headerlink" href="#c.PyUnstable_AtExit" title="Link to this definition">¶</a> </dt>

این است <a class="reference internal" href="stable.html#unstable-c-api">API ناپایدار</a>این ممکن است بدون هشدار در نسخه‌های جزئی تغییر کند.</div>

Register an <a class="reference internal" href="../library/atexit.html#module-atexit" title="atexit: Register and execute cleanup functions."><code class="xref py py-mod docutils literal notranslate">atexit</code></a> callback for the target interpreter interp.

This is similar to <a class="reference internal" href="sys.html#c.Py_AtExit" title="Py_AtExit"><code class="xref c c-func docutils literal notranslate">Py_AtExit()</code></a>, but takes an explicit interpreter and

data pointer for the callback.

There must be an <a class="reference internal" href="../glossary.html#term-attached-thread-state">attached thread state</a> for interp.

Added in version 3.13.

</div>

</dd></dl>

</section>

<h2>Cautions regarding runtime finalization<a class="headerlink" href="#cautions-regarding-runtime-finalization" title="Link to this heading">¶</a></h2>

In the late stage of <a class="reference internal" href="../glossary.html#term-interpreter-shutdown">interpreter shutdown</a>, after attempting to wait for

non-daemon threads to exit (though this can be interrupted by

<a class="reference internal" href="../library/exceptions.html#KeyboardInterrupt" title="KeyboardInterrupt"><code class="xref py py-class docutils literal notranslate">KeyboardInterrupt</code></a>) and running the <a class="reference internal" href="../library/atexit.html#module-atexit" title="atexit: Register and execute cleanup functions."><code class="xref py py-mod docutils literal notranslate">atexit</code></a> functions, the runtime

is marked as finalizing: <a class="reference internal" href="#c.Py_IsFinalizing" title="Py_IsFinalizing"><code class="xref c c-func docutils literal notranslate">Py_IsFinalizing()</code></a> and

<a class="reference internal" href="../library/sys.html#sys.is_finalizing" title="sys.is_finalizing"><code class="xref py py-func docutils literal notranslate">sys.is_finalizing()</code></a> return true. At this point, only the finalization

thread that initiated finalization (typically the main thread) is allowed to

acquire the <a class="reference internal" href="../glossary.html#term-GIL">GIL</a>.

If any thread, other than the finalization thread, attempts to attach a <a class="reference internal" href="../glossary.html#term-thread-state">thread state</a>

during finalization, either explicitly or

implicitly, the thread enters a permanently blocked state

where it remains until the program exits. In most cases this is harmless, but this can result

in deadlock if a later stage of finalization attempts to acquire a lock owned by the

blocked thread, or otherwise waits on the blocked thread.

Gross? Yes. This prevents random crashes and/or unexpectedly skipped C++

finalizations further up the call stack when such threads were forcibly exited

here in CPython 3.13 and earlier. The CPython runtime <a class="reference internal" href="../glossary.html#term-thread-state">thread state</a> C APIs

have never had any error reporting or handling expectations at thread state

attachment time that would've allowed for graceful exit from this situation. Changing that

would require new stable C APIs and rewriting the majority of C code in the

CPython ecosystem to use those with error handling.

</section>

<h2>Process-wide parameters<a class="headerlink" href="#process-wide-parameters" title="Link to this heading">¶</a></h2>

void Py_SetProgramName(const wchar_t *name)<a class="headerlink" href="#c.Py_SetProgramName" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.This API is kept for backward compatibility: setting

<a class="reference internal" href="init_config.html#c.PyConfig.program_name" title="PyConfig.program_name"><code class="xref c c-member docutils literal notranslate">PyConfig.program_name</code></a> should be used instead, see <a class="reference internal" href="init_config.html#init-config">Python

Initialization Configuration</a>.

This function should be called before <a class="reference internal" href="#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate">Py_Initialize()</code></a> is called for

the first time, if it is called at all. It tells the interpreter the value

of the <code class="docutils literal notranslate">argv[0]</code> argument to the <code class="xref c c-func docutils literal notranslate">main()</code> function of the program

(converted to wide characters).

This is used by <a class="reference internal" href="#c.Py_GetPath" title="Py_GetPath"><code class="xref c c-func docutils literal notranslate">Py_GetPath()</code></a> and some other functions below to find

the Python run-time libraries relative to the interpreter executable. The

default value is <code class="docutils literal notranslate">'python'</code>. The argument should point to a

zero-terminated wide character string in static storage whose contents will not

change for the duration of the program's execution. No code in the Python

interpreter will change the contents of this storage.

Use <a class="reference internal" href="sys.html#c.Py_DecodeLocale" title="Py_DecodeLocale"><code class="xref c c-func docutils literal notranslate">Py_DecodeLocale()</code></a> to decode a bytes string to get a

wchar_t* string.

منسوخ شده از نسخه‌ی 3.11, در نسخه‌ی 3.15 حذف خواهد شد..

</div>

</dd></dl>

wchar_t *Py_GetProgramName()<a class="headerlink" href="#c.Py_GetProgramName" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return the program name set with <a class="reference internal" href="init_config.html#c.PyConfig.program_name" title="PyConfig.program_name"><code class="xref c c-member docutils literal notranslate">PyConfig.program_name</code></a>, or the default.

The returned string points into static storage; the caller should not modify its

value.

This function should not be called before <a class="reference internal" href="#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate">Py_Initialize()</code></a>, otherwise

it returns <code class="docutils literal notranslate">NULL</code>.

تغییر داده شده در نسخه 3.10: It now returns <code class="docutils literal notranslate">NULL</code> if called before <a class="reference internal" href="#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate">Py_Initialize()</code></a>.

</div>

منسوخ شده از نسخه‌ی 3.13, در نسخه‌ی 3.15 حذف خواهد شد.: Use <a class="reference internal" href="init_config.html#c.PyConfig_Get" title="PyConfig_Get"><code class="xref c c-func docutils literal notranslate">PyConfig_Get("executable")</code></a>

(<a class="reference internal" href="../library/sys.html#sys.executable" title="sys.executable"><code class="xref py py-data docutils literal notranslate">sys.executable</code></a>) instead.

</div>

</dd></dl>

wchar_t *Py_GetPrefix()<a class="headerlink" href="#c.Py_GetPrefix" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return the prefix for installed platform-independent files. This is derived

through a number of complicated rules from the program name set with

<a class="reference internal" href="init_config.html#c.PyConfig.program_name" title="PyConfig.program_name"><code class="xref c c-member docutils literal notranslate">PyConfig.program_name</code></a> and some environment variables; for example, if the

program name is <code class="docutils literal notranslate">'/usr/local/bin/python'</code>, the prefix is <code class="docutils literal notranslate">'/usr/local'</code>. The

returned string points into static storage; the caller should not modify its

value. This corresponds to the prefix variable in the top-level

<code class="file docutils literal notranslate">Makefile</code> and the <a class="reference internal" href="../using/configure.html#cmdoption-prefix"><code class="xref std std-option docutils literal notranslate">--prefix</code></a> argument to the configure

script at build time. The value is available to Python code as <code class="docutils literal notranslate">sys.base_prefix</code>.

It is only useful on Unix. See also the next function.

it returns <code class="docutils literal notranslate">NULL</code>.

</div>

(<a class="reference internal" href="../library/sys.html#sys.base_prefix" title="sys.base_prefix"><code class="xref py py-data docutils literal notranslate">sys.base_prefix</code></a>) instead. Use <code class="xref c c-func docutils literal notranslate">PyConfig_Get("prefix")</code> (<a class="reference internal" href="../library/sys.html#sys.prefix" title="sys.prefix"><code class="xref py py-data docutils literal notranslate">sys.prefix</code></a>) if <a class="reference internal" href="../library/venv.html#venv-def">virtual environments</a> need to be handled.

</div>

</dd></dl>

wchar_t *Py_GetExecPrefix()<a class="headerlink" href="#c.Py_GetExecPrefix" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return the exec-prefix for installed platform-dependent files. This is

derived through a number of complicated rules from the program name set with

<a class="reference internal" href="init_config.html#c.PyConfig.program_name" title="PyConfig.program_name"><code class="xref c c-member docutils literal notranslate">PyConfig.program_name</code></a> and some environment variables; for example, if the

program name is <code class="docutils literal notranslate">'/usr/local/bin/python'</code>, the exec-prefix is

<code class="docutils literal notranslate">'/usr/local'</code>. The returned string points into static storage; the caller

should not modify its value. This corresponds to the exec_prefix

variable in the top-level <code class="file docutils literal notranslate">Makefile</code> and the <code class="docutils literal notranslate">--exec-prefix</code>

argument to the configure script at build time. The value is

available to Python code as <code class="docutils literal notranslate">sys.base_exec_prefix</code>. It is only useful on

Unix.

Background: The exec-prefix differs from the prefix when platform dependent

files (such as executables and shared libraries) are installed in a different

directory tree. In a typical installation, platform dependent files may be

installed in the <code class="file docutils literal notranslate">/usr/local/plat</code> subtree while platform independent may

be installed in <code class="file docutils literal notranslate">/usr/local</code>.

Generally speaking, a platform is a combination of hardware and software

families, e.g. Sparc machines running the Solaris 2.x operating system are

considered the same platform, but Intel machines running Solaris 2.x are another

platform, and Intel machines running Linux are yet another platform. Different

major revisions of the same operating system generally also form different

platforms. Non-Unix operating systems are a different story; the installation

strategies on those systems are so different that the prefix and exec-prefix are

meaningless, and set to the empty string. Note that compiled Python bytecode

files are platform independent (but not independent from the Python version by

which they were compiled!).

System administrators will know how to configure the mount or

automount programs to share <code class="file docutils literal notranslate">/usr/local</code> between platforms

while having <code class="file docutils literal notranslate">/usr/local/plat</code> be a different filesystem for each

platform.

it returns <code class="docutils literal notranslate">NULL</code>.

</div>

(<a class="reference internal" href="../library/sys.html#sys.base_exec_prefix" title="sys.base_exec_prefix"><code class="xref py py-data docutils literal notranslate">sys.base_exec_prefix</code></a>) instead. Use

<code class="xref c c-func docutils literal notranslate">PyConfig_Get("exec_prefix")</code>

(<a class="reference internal" href="../library/sys.html#sys.exec_prefix" title="sys.exec_prefix"><code class="xref py py-data docutils literal notranslate">sys.exec_prefix</code></a>) if <a class="reference internal" href="../library/venv.html#venv-def">virtual environments</a> need

to be handled.

</div>

</dd></dl>

wchar_t *Py_GetProgramFullPath()<a class="headerlink" href="#c.Py_GetProgramFullPath" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return the full program name of the Python executable; this is computed as a

side-effect of deriving the default module search path from the program name

(set by <a class="reference internal" href="init_config.html#c.PyConfig.program_name" title="PyConfig.program_name"><code class="xref c c-member docutils literal notranslate">PyConfig.program_name</code></a>). The returned string points into

static storage; the caller should not modify its value. The value is available

to Python code as <code class="docutils literal notranslate">sys.executable</code>.

it returns <code class="docutils literal notranslate">NULL</code>.

</div>

</div>

</dd></dl>

wchar_t *Py_GetPath()<a class="headerlink" href="#c.Py_GetPath" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return the default module search path; this is computed from the program name

The returned string consists of a series of directory names separated by a

platform dependent delimiter character. The delimiter character is <code class="docutils literal notranslate">':'</code>

on Unix and macOS, <code class="docutils literal notranslate">';'</code> on Windows. The returned string points into

static storage; the caller should not modify its value. The list

<a class="reference internal" href="../library/sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a> is initialized with this value on interpreter startup; it

can be (and usually is) modified later to change the search path for loading

modules.

it returns <code class="docutils literal notranslate">NULL</code>.

</div>

(<a class="reference internal" href="../library/sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a>) instead.

</div>

</dd></dl>

const char *Py_GetVersion()<a class="headerlink" href="#c.Py_GetVersion" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return the version of this Python interpreter. This is a string that looks

something like

<div class="highlight-c notranslate"><div class="highlight"><pre>"3.0a5+ (py3k:63103M, May 12 2008, 00:53:55) \n[GCC 4.2.3]"

</pre></div>

</div>

The first word (up to the first space character) is the current Python version;

the first characters are the major and minor version separated by a

period. The returned string points into static storage; the caller should not

modify its value. The value is available to Python code as <a class="reference internal" href="../library/sys.html#sys.version" title="sys.version"><code class="xref py py-data docutils literal notranslate">sys.version</code></a>.

See also the <a class="reference internal" href="apiabiversion.html#c.Py_Version" title="Py_Version"><code class="xref c c-var docutils literal notranslate">Py_Version</code></a> constant.

</dd></dl>

const char *Py_GetPlatform()<a class="headerlink" href="#c.Py_GetPlatform" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return the platform identifier for the current platform. On Unix, this is

formed from the "official" name of the operating system, converted to lower

case, followed by the major revision number; e.g., for Solaris 2.x, which is

also known as SunOS 5.x, the value is <code class="docutils literal notranslate">'sunos5'</code>. On macOS, it is

<code class="docutils literal notranslate">'darwin'</code>. On Windows, it is <code class="docutils literal notranslate">'win'</code>. The returned string points into

static storage; the caller should not modify its value. The value is available

to Python code as <code class="docutils literal notranslate">sys.platform</code>.

</dd></dl>

const char *Py_GetCopyright()<a class="headerlink" href="#c.Py_GetCopyright" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return the official copyright string for the current Python version, for example

<code class="docutils literal notranslate">'Copyright 1991-1995 Stichting Mathematisch Centrum, Amsterdam'</code>

The returned string points into static storage; the caller should not modify its

value. The value is available to Python code as <code class="docutils literal notranslate">sys.copyright</code>.

</dd></dl>

const char *Py_GetCompiler()<a class="headerlink" href="#c.Py_GetCompiler" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return an indication of the compiler used to build the current Python version,

in square brackets, for example:

<div class="highlight-c notranslate"><div class="highlight"><pre>"[GCC 2.7.2.2]"

</pre></div>

</div>

The returned string points into static storage; the caller should not modify its

value. The value is available to Python code as part of the variable

<code class="docutils literal notranslate">sys.version</code>.

View remainder of file in raw view

Navigation Menu

Uh oh!

Uh oh!

FilesExpand file tree

interp-lifecycle.html

Latest commit

History

interp-lifecycle.html

File metadata and controls