python-docs-tr/c-api/init.html at gh-pages · python-docs-tr/python-docs-tr

History

2187 lines (2031 loc) · 239 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>Initialization, Finalization, and Threads — Python 3.11.5 belgelendirmesi</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

title="Python 3.11.5 belgelendirmesi içinde ara"

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">İçindekiler</a></h3>

<ul>

<li><a class="reference internal" href="#">Initialization, Finalization, and Threads</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="#process-wide-parameters">Process-wide parameters</a></li>

<li><a class="reference internal" href="#thread-state-and-the-global-interpreter-lock">Thread State and the Global Interpreter Lock</a><ul>

<li><a class="reference internal" href="#releasing-the-gil-from-extension-code">Releasing the GIL from extension code</a></li>

<li><a class="reference internal" href="#non-python-created-threads">Non-Python created threads</a></li>

<li><a class="reference internal" href="#cautions-about-fork">Cautions about fork()</a></li>

<li><a class="reference internal" href="#high-level-api">High-level API</a></li>

<li><a class="reference internal" href="#low-level-api">Low-level API</a></li>

</ul>

</li>

<li><a class="reference internal" href="#sub-interpreter-support">Sub-interpreter support</a><ul>

<li><a class="reference internal" href="#bugs-and-caveats">Bugs and caveats</a></li>

</ul>

</li>

<li><a class="reference internal" href="#asynchronous-notifications">Asynchronous Notifications</a></li>

<li><a class="reference internal" href="#profiling-and-tracing">Profiling and Tracing</a></li>

<li><a class="reference internal" href="#advanced-debugger-support">Advanced Debugger Support</a></li>

<li><a class="reference internal" href="#thread-local-storage-support">Thread Local Storage Support</a><ul>

<li><a class="reference internal" href="#thread-specific-storage-tss-api">Thread Specific Storage (TSS) API</a><ul>

<li><a class="reference internal" href="#dynamic-allocation">Dynamic Allocation</a></li>

<li><a class="reference internal" href="#methods">Methods</a></li>

</ul>

</li>

<li><a class="reference internal" href="#thread-local-storage-tls-api">Thread Local Storage (TLS) API</a></li>

</ul>

</li>

</ul>

</li>

</ul>

</div>

<div>

<h4>Önceki konu</h4>

<a href="typehints.html"

title="önceki bölüm">Objects for Type Hinting</a>

</div>

<div>

<h4>Sonraki konu</h4>

<a href="init_config.html"

title="sonraki bölüm">Python Initialization Configuration</a>

</div>

<h3>Bu Sayfa</h3>

<li><a href="../bugs.html">Hata Bildir</a></li>

<li>

<a href="https://github.com/python/cpython/blob/3.11/Doc/c-api/init.rst"

rel="nofollow">Kaynağı Göster

</a>

</li>

</ul>

</div>

</nav>

</div>

<h3>Gezinti</h3>

<ul>

<a href="../genindex.html" title="Genel Endeks"

accesskey="I">dizin</a></li>

<a href="../py-modindex.html" title="Python Modül Dizini"

>modülleri</a> |</li>

<a href="init_config.html" title="Python Initialization Configuration"

accesskey="N">sonraki</a> |</li>

<a href="typehints.html" title="Objects for Type Hinting"

accesskey="P">önceki</a> |</li>

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

</li>

<li>

</li>

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

</li>

<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Python/C API Referans Kılavuzu</a> »</li>

<li class="nav-item nav-item-this"><a href="">Initialization, Finalization, and Threads</a></li>

</form>

</div>

</li>

Theme

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

</select>

</label> |</li>

</ul>

</div>

<h1>Initialization, Finalization, and Threads<a class="headerlink" href="#initialization-finalization-and-threads" title="Permalink to this heading">¶</a></h1>

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

<h2>Before Python Initialization<a class="headerlink" href="#before-python-initialization" title="Permalink 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>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_SetPath" title="Py_SetPath"><code class="xref c c-func docutils literal notranslate">Py_SetPath()</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><a class="reference internal" href="#c.Py_SetStandardStreamEncoding" title="Py_SetStandardStreamEncoding"><code class="xref c c-func docutils literal notranslate">Py_SetStandardStreamEncoding()</code></a></li>

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

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

<li><a class="reference internal" href="sys.html#c.PySys_ResetWarnOptions" title="PySys_ResetWarnOptions"><code class="xref c c-func docutils literal notranslate">PySys_ResetWarnOptions()</code></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>

</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>

</ul>

Not

The following functions 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>: <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="#c.Py_GetPath" title="Py_GetPath"><code class="xref c c-func docutils literal notranslate">Py_GetPath()</code></a>,

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

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

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

</div>

</section>

<h2>Global configuration variables<a class="headerlink" href="#global-configuration-variables" title="Permalink 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 <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 2.

int Py_BytesWarningFlag<a class="headerlink" href="#c.Py_BytesWarningFlag" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd>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 <a class="reference internal" href="../library/stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> 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.

</dd></dl>

int Py_DebugFlag<a class="headerlink" href="#c.Py_DebugFlag" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd>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.

</dd></dl>

int Py_DontWriteBytecodeFlag<a class="headerlink" href="#c.Py_DontWriteBytecodeFlag" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd>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.

</dd></dl>

int Py_FrozenFlag<a class="headerlink" href="#c.Py_FrozenFlag" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd>Suppress error messages when calculating the module search path in

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

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

</dd></dl>

int Py_HashRandomizationFlag<a class="headerlink" href="#c.Py_HashRandomizationFlag" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd>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.

</dd></dl>

int Py_IgnoreEnvironmentFlag<a class="headerlink" href="#c.Py_IgnoreEnvironmentFlag" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd>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.

</dd></dl>

int Py_InspectFlag<a class="headerlink" href="#c.Py_InspectFlag" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd>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.

</dd></dl>

int Py_InteractiveFlag<a class="headerlink" href="#c.Py_InteractiveFlag" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd>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.

</dd></dl>

int Py_IsolatedFlag<a class="headerlink" href="#c.Py_IsolatedFlag" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd>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.

3.4 sürümünde geldi.

</div>

</dd></dl>

int Py_LegacyWindowsFSEncodingFlag<a class="headerlink" href="#c.Py_LegacyWindowsFSEncodingFlag" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd>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">Availability</a>: Windows.

</div>

</dd></dl>

int Py_LegacyWindowsStdioFlag<a class="headerlink" href="#c.Py_LegacyWindowsStdioFlag" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd>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">Availability</a>: Windows.

</div>

</dd></dl>

int Py_NoSiteFlag<a class="headerlink" href="#c.Py_NoSiteFlag" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd>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 <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> 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.

</dd></dl>

int Py_NoUserSiteDirectory<a class="headerlink" href="#c.Py_NoUserSiteDirectory" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd>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.

</dd></dl>

int Py_OptimizeFlag<a class="headerlink" href="#c.Py_OptimizeFlag" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd>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.

</dd></dl>

int Py_QuietFlag<a class="headerlink" href="#c.Py_QuietFlag" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd>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.

3.2 sürümünde geldi.

</div>

</dd></dl>

int Py_UnbufferedStdioFlag<a class="headerlink" href="#c.Py_UnbufferedStdioFlag" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd>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.

</dd></dl>

int Py_VerboseFlag<a class="headerlink" href="#c.Py_VerboseFlag" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd>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-1"><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.

</dd></dl>

</section>

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

void Py_Initialize()<a class="headerlink" href="#c.Py_Initialize" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd> Part of the <a class="reference internal" href="stable.html#stable">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

<a class="reference internal" href="#c.PySys_SetArgvEx" title="PySys_SetArgvEx"><code class="xref c c-func docutils literal notranslate">PySys_SetArgvEx()</code></a> 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.

Not

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="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd> Part of the <a class="reference internal" href="stable.html#stable">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

might be useful when Python is embedded.

</dd></dl>

int Py_IsInitialized()<a class="headerlink" href="#c.Py_IsInitialized" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd> Part of the <a class="reference internal" href="stable.html#stable">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

</dd></dl>

int Py_FinalizeEx()<a class="headerlink" href="#c.Py_FinalizeEx" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 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="#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 <a class="reference internal" href="#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate">Py_Initialize()</code></a>. Ideally, this frees all memory

allocated by the Python interpreter. This is a no-op when called for a second

time (without 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> again first). 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.

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. 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.

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.

3.6 sürümünde geldi.

</div>

</dd></dl>

void Py_Finalize()<a class="headerlink" href="#c.Py_Finalize" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd> Part of the <a class="reference internal" href="stable.html#stable">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>

</section>

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

int Py_SetStandardStreamEncoding(const char *encoding, const char *errors)<a class="headerlink" href="#c.Py_SetStandardStreamEncoding" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

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

<a class="reference internal" href="init_config.html#c.PyConfig.stdio_encoding" title="PyConfig.stdio_encoding"><code class="xref c c-member docutils literal notranslate">PyConfig.stdio_encoding</code></a> and <a class="reference internal" href="init_config.html#c.PyConfig.stdio_errors" title="PyConfig.stdio_errors"><code class="xref c c-member docutils literal notranslate">PyConfig.stdio_errors</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>, if it is

called at all. It specifies which encoding and error handling to use

with standard IO, with the same meanings as in <a class="reference internal" href="../library/stdtypes.html#str.encode" title="str.encode"><code class="xref py py-func docutils literal notranslate">str.encode()</code></a>.

It overrides <a class="reference internal" href="../using/cmdline.html#envvar-PYTHONIOENCODING"><code class="xref std std-envvar docutils literal notranslate">PYTHONIOENCODING</code></a> values, and allows embedding code

to control IO encoding when the environment variable does not work.

encoding and/or errors may be <code class="docutils literal notranslate">NULL</code> to use

<a class="reference internal" href="../using/cmdline.html#envvar-PYTHONIOENCODING"><code class="xref std std-envvar docutils literal notranslate">PYTHONIOENCODING</code></a> and/or default values (depending on other

settings).

Note that <a class="reference internal" href="../library/sys.html#sys.stderr" title="sys.stderr"><code class="xref py py-data docutils literal notranslate">sys.stderr</code></a> always uses the “backslashreplace” error

handler, regardless of this (or any other) setting.

If <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 function will need to be called

again in order to affect subsequent calls to <a class="reference internal" href="#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate">Py_Initialize()</code></a>.

Returns <code class="docutils literal notranslate">0</code> if successful, a nonzero value on error (e.g. calling after the

interpreter has already been initialized).

3.4 sürümünde geldi.

</div>

3.11 sürümünden beri kullanım dışı.

</div>

</dd></dl>

void Py_SetProgramName(const wchar_t *name)<a class="headerlink" href="#c.Py_SetProgramName" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd> Part of the <a class="reference internal" href="stable.html#stable">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>.

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_* string.

3.11 sürümünden beri kullanım dışı.

</div>

</dd></dl>

wchar_t *Py_GetProgramName()<a class="headerlink" href="#c.Py_GetProgramName" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return the program name set with <a class="reference internal" href="#c.Py_SetProgramName" title="Py_SetProgramName"><code class="xref c c-func docutils literal notranslate">Py_SetProgramName()</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 sürümünde değişti: 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>

</dd></dl>

wchar_t *Py_GetPrefix()<a class="headerlink" href="#c.Py_GetPrefix" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd> Part of the <a class="reference internal" href="stable.html#stable">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="#c.Py_SetProgramName" title="Py_SetProgramName"><code class="xref c c-func docutils literal notranslate">Py_SetProgramName()</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.prefix</code>.

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

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

</div>

</dd></dl>

wchar_t *Py_GetExecPrefix()<a class="headerlink" href="#c.Py_GetExecPrefix" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd> Part of the <a class="reference internal" href="stable.html#stable">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

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.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>

</dd></dl>

wchar_t *Py_GetProgramFullPath()<a class="headerlink" href="#c.Py_GetProgramFullPath" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

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

(set by <a class="reference internal" href="#c.Py_SetProgramName" title="Py_SetProgramName"><code class="xref c c-func docutils literal notranslate">Py_SetProgramName()</code></a> above). 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>

</dd></dl>

wchar_t *Py_GetPath()<a class="headerlink" href="#c.Py_GetPath" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

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>

</dd></dl>

void Py_SetPath(const wchar_t*)<a class="headerlink" href="#c.Py_SetPath" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.7.This API is kept for backward compatibility: setting

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

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

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

Set the default module search path. If this function is 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>, then <a class="reference internal" href="#c.Py_GetPath" title="Py_GetPath"><code class="xref c c-func docutils literal notranslate">Py_GetPath()</code></a> won’t attempt to compute a

default search path but uses the one provided instead. This is useful if

Python is embedded by an application that has full knowledge of the location

of all modules. The path components should be separated by the platform

dependent delimiter character, which is <code class="docutils literal notranslate">':'</code> on Unix and macOS, <code class="docutils literal notranslate">';'</code>

on Windows.

This also causes <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> to be set to the program

full path (see <a class="reference internal" href="#c.Py_GetProgramFullPath" title="Py_GetProgramFullPath"><code class="xref c c-func docutils literal notranslate">Py_GetProgramFullPath()</code></a>) and for <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> and

<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> to be empty. It is up to the caller to modify these

if required after 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>.

wchar_* string.

The path argument is copied internally, so the caller may free it after the

call completes.

3.8 sürümünde değişti: The program full path is now used for <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

of the program name.

</div>

3.11 sürümünden beri kullanım dışı.

</div>

</dd></dl>

const char *Py_GetVersion()<a class="headerlink" href="#c.Py_GetVersion" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd> Part of the <a class="reference internal" href="stable.html#stable">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="Bu tanım için kalıcı bağlantı">¶</a> </dt>

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="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd> Part of the <a class="reference internal" href="stable.html#stable">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="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd> Part of the <a class="reference internal" href="stable.html#stable">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>.

</dd></dl>

const char *Py_GetBuildInfo()<a class="headerlink" href="#c.Py_GetBuildInfo" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return information about the sequence number and build date and time of the

current Python interpreter instance, for example

<div class="highlight-c notranslate"><div class="highlight"><pre>"#67, Aug 1 1997, 22:34:28"

</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>.

</dd></dl>

void PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)<a class="headerlink" href="#c.PySys_SetArgvEx" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

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

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

Initialization Configuration</a>.

Set <a class="reference internal" href="../library/sys.html#sys.argv" title="sys.argv"><code class="xref py py-data docutils literal notranslate">sys.argv</code></a> based on argc and argv. These parameters are

similar to those passed to the program’s <code class="xref c c-func docutils literal notranslate">main()</code> function with the

difference that the first entry should refer to the script file to be

executed rather than the executable hosting the Python interpreter. If there

isn’t a script that will be run, the first entry in argv can be an empty

string. If this function fails to initialize <a class="reference internal" href="../library/sys.html#sys.argv" title="sys.argv"><code class="xref py py-data docutils literal notranslate">sys.argv</code></a>, a fatal

condition is signalled using <a class="reference internal" href="sys.html#c.Py_FatalError" title="Py_FatalError"><code class="xref c c-func docutils literal notranslate">Py_FatalError()</code></a>.

If updatepath is zero, this is all the function does. If updatepath

is non-zero, the function also modifies <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> according to the

following algorithm:

<li>If the name of an existing script is passed in <code class="docutils literal notranslate">argv[0]</code>, the absolute

path of the directory where the script is located is prepended to

<li>Otherwise (that is, if argc is <code class="docutils literal notranslate">0</code> or <code class="docutils literal notranslate">argv[0]</code> doesn’t point

to an existing file name), an empty string is prepended 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>, which is the same as prepending the current working

directory (<code class="docutils literal notranslate">"."</code>).</li>

</ul>

wchar_* string.

See also <a class="reference internal" href="init_config.html#c.PyConfig.orig_argv" title="PyConfig.orig_argv"><code class="xref c c-member docutils literal notranslate">PyConfig.orig_argv</code></a> and <a class="reference internal" href="init_config.html#c.PyConfig.argv" title="PyConfig.argv"><code class="xref c c-member docutils literal notranslate">PyConfig.argv</code></a>

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

Not

It is recommended that applications embedding the Python interpreter

for purposes other than executing a single script pass <code class="docutils literal notranslate">0</code> as updatepath,

and update <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> themselves if desired.

See <a class="reference external" href="https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2008-5983">CVE-2008-5983</a>.

On versions before 3.1.3, you can achieve the same effect by manually

popping the first <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> element after having called

<a class="reference internal" href="#c.PySys_SetArgv" title="PySys_SetArgv"><code class="xref c c-func docutils literal notranslate">PySys_SetArgv()</code></a>, for example using:

<div class="highlight-c notranslate"><div class="highlight"><pre>PyRun_SimpleString("import sys; sys.path.pop(0)\n");

</pre></div>

</div>

3.1.3 sürümünde geldi.

</div>

3.11 sürümünden beri kullanım dışı.

</div>

</dd></dl>

void PySys_SetArgv(int argc, wchar_t **argv)<a class="headerlink" href="#c.PySys_SetArgv" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.This API is kept for backward compatibility: setting

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

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

This function works like <a class="reference internal" href="#c.PySys_SetArgvEx" title="PySys_SetArgvEx"><code class="xref c c-func docutils literal notranslate">PySys_SetArgvEx()</code></a> with updatepath set

to <code class="docutils literal notranslate">1</code> unless the python interpreter was started with the

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

wchar_* string.

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

3.4 sürümünde değişti: The updatepath value depends on <a class="reference internal" href="../using/cmdline.html#cmdoption-I"><code class="xref std std-option docutils literal notranslate">-I</code></a>.

</div>

3.11 sürümünden beri kullanım dışı.

</div>

</dd></dl>

void Py_SetPythonHome(const wchar_t *home)<a class="headerlink" href="#c.Py_SetPythonHome" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

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

Initialization Configuration</a>.

Set the default “home” directory, that is, the location of the standard

Python libraries. See <a class="reference internal" href="../using/cmdline.html#envvar-PYTHONHOME"><code class="xref std std-envvar docutils literal notranslate">PYTHONHOME</code></a> for the meaning of the

argument string.

The argument should point to a zero-terminated 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.

wchar_* string.

3.11 sürümünden beri kullanım dışı.

</div>

</dd></dl>

wchar_t *Py_GetPythonHome()<a class="headerlink" href="#c.Py_GetPythonHome" title="Bu tanım için kalıcı bağlantı">¶</a> </dt>

<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return the default “home”, that is, the value set by a previous call to

<a class="reference internal" href="#c.Py_SetPythonHome" title="Py_SetPythonHome"><code class="xref c c-func docutils literal notranslate">Py_SetPythonHome()</code></a>, or the value of the <a class="reference internal" href="../using/cmdline.html#envvar-PYTHONHOME"><code class="xref std std-envvar docutils literal notranslate">PYTHONHOME</code></a>

environment variable if it is set.

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

</div>

</dd></dl>

</section>

<h2>Thread State and the Global Interpreter Lock<a class="headerlink" href="#thread-state-and-the-global-interpreter-lock" title="Permalink to this heading">¶</a></h2>

The Python interpreter is not fully thread-safe. In order to support

multi-threaded Python programs, there’s a global lock, called the <a class="reference internal" href="../glossary.html#term-global-interpreter-lock">global

interpreter lock</a> or <a class="reference internal" href="../glossary.html#term-GIL">GIL</a>, that must be held by the current thread before

it can safely access Python objects. Without the lock, even the simplest

operations could cause problems in a multi-threaded program: for example, when

two threads simultaneously increment the reference count of the same object, the

reference count could end up being incremented only once instead of twice.

Therefore, the rule exists that only the thread that has acquired the

<a class="reference internal" href="../glossary.html#term-GIL">GIL</a> may operate on Python objects or call Python/C API functions.

In order to emulate concurrency of execution, the interpreter regularly

tries to switch threads (see <a class="reference internal" href="../library/sys.html#sys.setswitchinterval" title="sys.setswitchinterval"><code class="xref py py-func docutils literal notranslate">sys.setswitchinterval()</code></a>). The lock is also

released around potentially blocking I/O operations like reading or writing

a file, so that other Python threads can run in the meantime.

The Python interpreter keeps some thread-specific bookkeeping information

inside a data structure called <a class="reference internal" href="#c.PyThreadState" title="PyThreadState"><code class="xref c c-type docutils literal notranslate">PyThreadState</code></a>. There’s also one

global variable pointing to the current <a class="reference internal" href="#c.PyThreadState" title="PyThreadState"><code class="xref c c-type docutils literal notranslate">PyThreadState</code></a>: it can

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

<h3>Releasing the GIL from extension code<a class="headerlink" href="#releasing-the-gil-from-extension-code" title="Permalink to this heading">¶</a></h3>

Most extension code manipulating the <a class="reference internal" href="../glossary.html#term-GIL">GIL</a> has the following simple

structure:

<div class="highlight-c notranslate"><div class="highlight"><pre>Save the thread state in a local variable.

Release the global interpreter lock.

... Do some blocking I/O operation ...

Reacquire the global interpreter lock.

Restore the thread state from the local variable.

</pre></div>

</div>

This is so common that a pair of macros exists to simplify it:

<div class="highlight-c notranslate"><div class="highlight"><pre>Py_BEGIN_ALLOW_THREADS

Py_END_ALLOW_THREADS

</pre></div>

</div>

The <a class="reference internal" href="#c.Py_BEGIN_ALLOW_THREADS" title="Py_BEGIN_ALLOW_THREADS"><code class="xref c c-macro docutils literal notranslate">Py_BEGIN_ALLOW_THREADS</code></a> macro opens a new block and declares a

hidden local variable; the <a class="reference internal" href="#c.Py_END_ALLOW_THREADS" title="Py_END_ALLOW_THREADS"><code class="xref c c-macro docutils literal notranslate">Py_END_ALLOW_THREADS</code></a> macro closes the

block.

The block above expands to the following code:

<div class="highlight-c notranslate"><div class="highlight"><pre>PyThreadState *_save;

_save = PyEval_SaveThread();

PyEval_RestoreThread(_save);

</pre></div>

</div>

Here is how these functions work: the global interpreter lock is used to protect the pointer to the

current thread state. When releasing the lock and saving the thread state,

the current thread state pointer must be retrieved before the lock is released

(since another thread could immediately acquire the lock and store its own thread

state in the global variable). Conversely, when acquiring the lock and restoring

the thread state, the lock must be acquired before storing the thread state

pointer.

Not

Calling system I/O functions is the most common use case for releasing

the GIL, but it can also be useful before calling long-running computations

which don’t need access to Python objects, such as compression or

cryptographic functions operating over memory buffers. For example, the

standard <a class="reference internal" href="../library/zlib.html#module-zlib" title="zlib: Low-level interface to compression and decompression routines compatible with gzip."><code class="xref py py-mod docutils literal notranslate">zlib</code></a> and <a class="reference internal" href="../library/hashlib.html#module-hashlib" title="hashlib: Secure hash and message digest algorithms."><code class="xref py py-mod docutils literal notranslate">hashlib</code></a> modules release the GIL when

compressing or hashing data.

</div>

</section>

<h3>Non-Python created threads<a class="headerlink" href="#non-python-created-threads" title="Permalink to this heading">¶</a></h3>

When threads are created using the dedicated Python APIs (such as the

<a class="reference internal" href="../library/threading.html#module-threading" title="threading: Thread-based parallelism."><code class="xref py py-mod docutils literal notranslate">threading</code></a> module), a thread state is automatically associated to them

and the code showed above is therefore correct. However, when threads are

created from C (for example by a third-party library with its own thread

management), they don’t hold the GIL, nor is there a thread state structure

for them.

If you need to call Python code from these threads (often this will be part

of a callback API provided by the aforementioned third-party library),

you must first register these threads with the interpreter by

creating a thread state data structure, then acquiring the GIL, and finally

storing their thread state pointer, before you can start using the Python/C

API. When you are done, you should reset the thread state pointer, release

the GIL, and finally free the thread state data structure.

The <a class="reference internal" href="#c.PyGILState_Ensure" title="PyGILState_Ensure"><code class="xref c c-func docutils literal notranslate">PyGILState_Ensure()</code></a> and <a class="reference internal" href="#c.PyGILState_Release" title="PyGILState_Release"><code class="xref c c-func docutils literal notranslate">PyGILState_Release()</code></a> functions do

all of the above automatically. The typical idiom for calling into Python

from a C thread is:

<div class="highlight-c notranslate"><div class="highlight"><pre>PyGILState_STATE gstate;

gstate = PyGILState_Ensure();

/* Perform Python actions here. */

result = CallSomeFunction();

/* evaluate result or handle exception */

/* Release the thread. No Python API allowed beyond this point. */

PyGILState_Release(gstate);

</pre></div>

</div>

Note that the <code class="docutils literal notranslate">PyGILState_*</code> functions assume there is only one global

interpreter (created automatically 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>). Python

supports the creation of additional interpreters (using

<code class="docutils literal notranslate">PyGILState_*</code> API is unsupported.

</section>

<h3>Cautions about fork()<a class="headerlink" href="#cautions-about-fork" title="Permalink to this heading">¶</a></h3>

Another important thing to note about threads is their behaviour in the face

of the C <code class="xref c c-func docutils literal notranslate">fork()</code> call. On most systems with <code class="xref c c-func docutils literal notranslate">fork()</code>, after a

process forks only the thread that issued the fork will exist. This has a

concrete impact both on how locks must be handled and on all stored state

in CPython’s runtime.

The fact that only the “current” thread remains

means any locks held by other threads will never be released. Python solves

this for <a class="reference internal" href="../library/os.html#os.fork" title="os.fork"><code class="xref py py-func docutils literal notranslate">os.fork()</code></a> by acquiring the locks it uses internally before

the fork, and releasing them afterwards. In addition, it resets any

<a class="reference internal" href="../library/threading.html#lock-objects">Lock Objects</a> in the child. When extending or embedding Python, there

is no way to inform Python of additional (non-Python) locks that need to be

acquired before or reset after a fork. OS facilities such as

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

init.html

Latest commit

History

init.html

File metadata and controls