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

History

1050 lines (984 loc) · 101 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>Introduction — 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="#">Introduction</a><ul>

<li><a class="reference internal" href="#coding-standards">Coding standards</a></li>

<li><a class="reference internal" href="#include-files">Include Files</a></li>

<li><a class="reference internal" href="#useful-macros">Useful macros</a></li>

<li><a class="reference internal" href="#objects-types-and-reference-counts">Objects, Types and Reference Counts</a><ul>

<li><a class="reference internal" href="#reference-counts">Reference Counts</a><ul>

<li><a class="reference internal" href="#reference-count-details">Reference Count Details</a></li>

</ul>

</li>

<li><a class="reference internal" href="#types">Types</a></li>

</ul>

</li>

<li><a class="reference internal" href="#exceptions">Exceptions</a></li>

<li><a class="reference internal" href="#embedding-python">Embedding Python</a></li>

<li><a class="reference internal" href="#debugging-builds">Debugging Builds</a></li>

</ul>

</li>

</ul>

</div>

<div>

<h4>Önceki konu</h4>

<a href="index.html"

title="önceki bölüm">Python/C API Referans Kılavuzu</a>

</div>

<div>

<h4>Sonraki konu</h4>

<a href="stable.html"

title="sonraki bölüm">C API Stability</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/intro.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="stable.html" title="C API Stability"

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

<a href="index.html" title="Python/C API Referans Kılavuzu"

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="">Introduction</a></li>

</form>

</div>

</li>

Theme

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

</select>

</label> |</li>

</ul>

</div>

<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this heading">¶</a></h1>

The Application Programmer’s Interface to Python gives C and C++ programmers

access to the Python interpreter at a variety of levels. The API is equally

usable from C++, but for brevity it is generally referred to as the Python/C

API. There are two fundamentally different reasons for using the Python/C API.

The first reason is to write extension modules for specific purposes; these

are C modules that extend the Python interpreter. This is probably the most

common use. The second reason is to use Python as a component in a larger

application; this technique is generally referred to as embedding Python

in an application.

Writing an extension module is a relatively well-understood process, where a

“cookbook” approach works well. There are several tools that automate the

process to some extent. While people have embedded Python in other

applications since its early existence, the process of embedding Python is

less straightforward than writing an extension.

Many API functions are useful independent of whether you’re embedding or

extending Python; moreover, most applications that embed Python will need to

provide a custom extension as well, so it’s probably a good idea to become

familiar with writing an extension before attempting to embed Python in a real

application.

<h2>Coding standards<a class="headerlink" href="#coding-standards" title="Permalink to this heading">¶</a></h2>

If you’re writing C code for inclusion in CPython, you must follow the

guidelines and standards defined in <a class="pep reference external" href="https://peps.python.org/pep-0007/">PEP 7</a>. These guidelines apply

regardless of the version of Python you are contributing to. Following these

conventions is not necessary for your own third party extension modules,

unless you eventually expect to contribute them to Python.

</section>

<h2>Include Files<a class="headerlink" href="#include-files" title="Permalink to this heading">¶</a></h2>

All function, type and macro definitions needed to use the Python/C API are

included in your code by the following line:

<div class="highlight-c notranslate"><div class="highlight"><pre>#define PY_SSIZE_T_CLEAN

#include <Python.h>

</pre></div>

</div>

This implies inclusion of the following standard headers: <code class="docutils literal notranslate"><stdio.h></code>,

(if available).

Not

Since Python may define some pre-processor definitions which affect the standard

headers on some systems, you must include <code class="file docutils literal notranslate">Python.h</code> before any standard

headers are included.

It is recommended to always define <code class="docutils literal notranslate">PY_SSIZE_T_CLEAN</code> before including

<code class="docutils literal notranslate">Python.h</code>. See <a class="reference internal" href="arg.html#arg-parsing">Parsing arguments and building values</a> for a description of this macro.

</div>

All user visible names defined by Python.h (except those defined by the included

standard headers) have one of the prefixes <code class="docutils literal notranslate">Py</code> or <code class="docutils literal notranslate">_Py</code>. Names beginning

with <code class="docutils literal notranslate">_Py</code> are for internal use by the Python implementation and should not be

used by extension writers. Structure member names do not have a reserved prefix.

Not

User code should never define names that begin with <code class="docutils literal notranslate">Py</code> or <code class="docutils literal notranslate">_Py</code>. This

confuses the reader, and jeopardizes the portability of the user code to

future Python versions, which may define additional names beginning with one

of these prefixes.

</div>

The header files are typically installed with Python. On Unix, these are

located in the directories <code class="file docutils literal notranslate">prefix/include/pythonversion/</code> and

<code class="file docutils literal notranslate">exec_prefix/include/pythonversion/</code>, where <a class="reference internal" href="../using/configure.html#cmdoption-prefix"><code class="xref std std-option docutils literal notranslate">prefix</code></a> and

<a class="reference internal" href="../using/configure.html#cmdoption-exec-prefix"><code class="xref std std-option docutils literal notranslate">exec_prefix</code></a> are defined by the corresponding parameters to Python’s

configure script and version is

<code class="docutils literal notranslate">'%d.%d' % sys.version_info[:2]</code>. On Windows, the headers are installed

in <code class="file docutils literal notranslate">prefix/include</code>, where <code class="docutils literal notranslate">prefix</code> is the installation

directory specified to the installer.

To include the headers, place both directories (if different) on your compiler’s

search path for includes. Do not place the parent directories on the search

path and then use <code class="docutils literal notranslate">#include <pythonX.Y/Python.h></code>; this will break on

multi-platform builds since the platform independent headers under

<a class="reference internal" href="../using/configure.html#cmdoption-prefix"><code class="xref std std-option docutils literal notranslate">prefix</code></a> include the platform specific headers from

<a class="reference internal" href="../using/configure.html#cmdoption-exec-prefix"><code class="xref std std-option docutils literal notranslate">exec_prefix</code></a>.

C++ users should note that although the API is defined entirely using C, the

header files properly declare the entry points to be <code class="docutils literal notranslate">extern "C"</code>. As a result,

there is no need to do anything special to use the API from C++.

</section>

<h2>Useful macros<a class="headerlink" href="#useful-macros" title="Permalink to this heading">¶</a></h2>

Several useful macros are defined in the Python header files. Many are

defined closer to where they are useful (e.g. <a class="reference internal" href="none.html#c.Py_RETURN_NONE" title="Py_RETURN_NONE"><code class="xref c c-macro docutils literal notranslate">Py_RETURN_NONE</code></a>).

Others of a more general utility are defined here. This is not necessarily a

complete listing.

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

<dd>Return the absolute value of <code class="docutils literal notranslate">x</code>.

3.3 sürümünde geldi.

</div>

</dd></dl>

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

<dd>Ask the compiler to always inline a static inline function. The compiler can

ignore it and decides to not inline the function.

It can be used to inline performance critical static inline functions when

building Python in debug mode with function inlining disabled. For example,

MSC disables function inlining when building in debug mode.

Marking blindly a static inline function with Py_ALWAYS_INLINE can result in

worse performances (due to increased code size for example). The compiler is

usually smarter than the developer for the cost/benefit analysis.

If Python is <a class="reference internal" href="../using/configure.html#debug-build">built in debug mode</a> (if the <code class="docutils literal notranslate">Py_DEBUG</code>

macro is defined), the <a class="reference internal" href="#c.Py_ALWAYS_INLINE" title="Py_ALWAYS_INLINE"><code class="xref c c-macro docutils literal notranslate">Py_ALWAYS_INLINE</code></a> macro does nothing.

It must be specified before the function return type. Usage:

<div class="highlight-c notranslate"><div class="highlight"><pre>static inline Py_ALWAYS_INLINE int random(void) { return 4; }

</pre></div>

</div>

3.11 sürümünde geldi.

</div>

</dd></dl>

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

<dd>Argument must be a character or an integer in the range [-128, 127] or [0,

255]. This macro returns <code class="docutils literal notranslate">c</code> cast to an <code class="docutils literal notranslate">unsigned char</code>.

</dd></dl>

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

<dd>Use this for deprecated declarations. The macro must be placed before the

symbol name.

Example:

<div class="highlight-c notranslate"><div class="highlight"><pre>Py_DEPRECATED(3.8) PyAPI_FUNC(int) Py_OldFunction(void);

</pre></div>

</div>

3.8 sürümünde değişti: MSVC support was added.

</div>

</dd></dl>

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

<dd>Like <code class="docutils literal notranslate">getenv(s)</code>, but returns <code class="docutils literal notranslate">NULL</code> if <a class="reference internal" href="../using/cmdline.html#cmdoption-E"><code class="xref std std-option docutils literal notranslate">-E</code></a> was passed on the

command line (i.e. if <code class="docutils literal notranslate">Py_IgnoreEnvironmentFlag</code> is set).

</dd></dl>

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

<dd>Return the maximum value between <code class="docutils literal notranslate">x</code> and <code class="docutils literal notranslate">y</code>.

3.3 sürümünde geldi.

</div>

</dd></dl>

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

<dd>Return the size of a structure (<code class="docutils literal notranslate">type</code>) <code class="docutils literal notranslate">member</code> in bytes.

3.6 sürümünde geldi.

</div>

</dd></dl>

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

<dd>Return the minimum value between <code class="docutils literal notranslate">x</code> and <code class="docutils literal notranslate">y</code>.

3.3 sürümünde geldi.

</div>

</dd></dl>

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

<dd>Disable inlining on a function. For example, it reduces the C stack

consumption: useful on LTO+PGO builds which heavily inline code (see

<a class="reference external" href="https://bugs.python.org/issue?@action=redirect&bpo=33720">bpo-33720</a>).

Usage:

<div class="highlight-c notranslate"><div class="highlight"><pre>Py_NO_INLINE static int random(void) { return 4; }

</pre></div>

</div>

3.11 sürümünde geldi.

</div>

</dd></dl>

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

<dd>Convert <code class="docutils literal notranslate">x</code> to a C string. E.g. <code class="docutils literal notranslate">Py_STRINGIFY(123)</code> returns

<code class="docutils literal notranslate">"123"</code>.

3.4 sürümünde geldi.

</div>

</dd></dl>

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

<dd>Use this when you have a code path that cannot be reached by design.

For example, in the <code class="docutils literal notranslate">default:</code> clause in a <code class="docutils literal notranslate">switch</code> statement for which

all possible values are covered in <code class="docutils literal notranslate">case</code> statements. Use this in places

where you might be tempted to put an <code class="docutils literal notranslate">assert(0)</code> or <code class="docutils literal notranslate">abort()</code> call.

In release mode, the macro helps the compiler to optimize the code, and

avoids a warning about unreachable code. For example, the macro is

implemented with <code class="docutils literal notranslate">__builtin_unreachable()</code> on GCC in release mode.

A use for <code class="docutils literal notranslate">Py_UNREACHABLE()</code> is following a call a function that

never returns but that is not declared <code class="xref c c-macro docutils literal notranslate">_Py_NO_RETURN</code>.

If a code path is very unlikely code but can be reached under exceptional

case, this macro must not be used. For example, under low memory condition

or if a system call returns a value out of the expected range. In this

case, it’s better to report the error to the caller. If the error cannot

be reported to caller, <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> can be used.

3.7 sürümünde geldi.

</div>

</dd></dl>

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

<dd>Use this for unused arguments in a function definition to silence compiler

warnings. Example: <code class="docutils literal notranslate">int func(int a, int Py_UNUSED(b)) { return a; }</code>.

3.4 sürümünde geldi.

</div>

</dd></dl>

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

<dd>Creates a variable with name <code class="docutils literal notranslate">name</code> that can be used in docstrings.

If Python is built without docstrings, the value will be empty.

Use <a class="reference internal" href="#c.PyDoc_STRVAR" title="PyDoc_STRVAR"><code class="xref c c-macro docutils literal notranslate">PyDoc_STRVAR</code></a> for docstrings to support building

Python without docstrings, as specified in <a class="pep reference external" href="https://peps.python.org/pep-0007/">PEP 7</a>.

Example:

<div class="highlight-c notranslate"><div class="highlight"><pre>PyDoc_STRVAR(pop_doc, "Remove and return the rightmost element.");

static PyMethodDef deque_methods[] = {

// ...

{"pop", (PyCFunction)deque_pop, METH_NOARGS, pop_doc},

// ...

}

</pre></div>

</div>

</dd></dl>

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

<dd>Creates a docstring for the given input string or an empty string

if docstrings are disabled.

Use <a class="reference internal" href="#c.PyDoc_STR" title="PyDoc_STR"><code class="xref c c-macro docutils literal notranslate">PyDoc_STR</code></a> in specifying docstrings to support

building Python without docstrings, as specified in <a class="pep reference external" href="https://peps.python.org/pep-0007/">PEP 7</a>.

Example:

<div class="highlight-c notranslate"><div class="highlight"><pre>static PyMethodDef pysqlite_row_methods[] = {

{"keys", (PyCFunction)pysqlite_row_keys, METH_NOARGS,

PyDoc_STR("Returns the keys of the row.")},

{NULL, NULL}

};

</pre></div>

</div>

</dd></dl>

</section>

<h2>Objects, Types and Reference Counts<a class="headerlink" href="#objects-types-and-reference-counts" title="Permalink to this heading">¶</a></h2>

Most Python/C API functions have one or more arguments as well as a return value

of type <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>*. This type is a pointer to an opaque data type

representing an arbitrary Python object. Since all Python object types are

treated the same way by the Python language in most situations (e.g.,

assignments, scope rules, and argument passing), it is only fitting that they

should be represented by a single C type. Almost all Python objects live on the

heap: you never declare an automatic or static variable of type

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><code class="xref c c-type docutils literal notranslate">PyObject</code></a>, only pointer variables of type <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* can be

declared. The sole exception are the type objects; since these must never be

deallocated, they are typically static <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject"><code class="xref c c-type docutils literal notranslate">PyTypeObject</code></a> objects.

All Python objects (even Python integers) have a type and a

reference count. An object’s type determines what kind of object it is

(e.g., an integer, a list, or a user-defined function; there are many more as

explained in <a class="reference internal" href="../reference/datamodel.html#types">The standard type hierarchy</a>). For each of the well-known types there is a macro

to check whether an object is of that type; for instance, <code class="docutils literal notranslate">PyList_Check(a)</code> is

true if (and only if) the object pointed to by a is a Python list.

<h3>Reference Counts<a class="headerlink" href="#reference-counts" title="Permalink to this heading">¶</a></h3>

The reference count is important because today’s computers have a finite

(and often severely limited) memory size; it counts how many different

places there are that have a <a class="reference internal" href="../glossary.html#term-strong-reference">strong reference</a> to an object.

Such a place could be another object, or a global (or static) C variable,

or a local variable in some C function.

When the last <a class="reference internal" href="../glossary.html#term-strong-reference">strong reference</a> to an object is released

(i.e. its reference count becomes zero), the object is deallocated.

If it contains references to other objects, those references are released.

Those other objects may be deallocated in turn, if there are no more

references to them, and so on. (There’s an obvious problem with

objects that reference each other here; for now, the solution

is “don’t do that.”)

Reference counts are always manipulated explicitly. The normal way is

to use the macro <a class="reference internal" href="refcounting.html#c.Py_INCREF" title="Py_INCREF"><code class="xref c c-func docutils literal notranslate">Py_INCREF()</code></a> to take a new reference to an

object (i.e. increment its reference count by one),

and <a class="reference internal" href="refcounting.html#c.Py_DECREF" title="Py_DECREF"><code class="xref c c-func docutils literal notranslate">Py_DECREF()</code></a> to release that reference (i.e. decrement the

reference count by one). The <a class="reference internal" href="refcounting.html#c.Py_DECREF" title="Py_DECREF"><code class="xref c c-func docutils literal notranslate">Py_DECREF()</code></a> macro

is considerably more complex than the incref one, since it must check whether

the reference count becomes zero and then cause the object’s deallocator to be

called. The deallocator is a function pointer contained in the object’s type

structure. The type-specific deallocator takes care of releasing references

for other objects contained in the object if this is a compound

object type, such as a list, as well as performing any additional finalization

that’s needed. There’s no chance that the reference count can overflow; at

least as many bits are used to hold the reference count as there are distinct

memory locations in virtual memory (assuming <code class="docutils literal notranslate">sizeof(Py_ssize_t) >= sizeof(void*)</code>).

Thus, the reference count increment is a simple operation.

It is not necessary to hold a <a class="reference internal" href="../glossary.html#term-strong-reference">strong reference</a> (i.e. increment

the reference count) for every local variable that contains a pointer

to an object. In theory, the object’s

reference count goes up by one when the variable is made to point to it and it

goes down by one when the variable goes out of scope. However, these two

cancel each other out, so at the end the reference count hasn’t changed. The

only real reason to use the reference count is to prevent the object from being

deallocated as long as our variable is pointing to it. If we know that there

is at least one other reference to the object that lives at least as long as

our variable, there is no need to take a new <a class="reference internal" href="../glossary.html#term-strong-reference">strong reference</a>

(i.e. increment the reference count) temporarily.

An important situation where this arises is in objects that are passed as

arguments to C functions in an extension module that are called from Python;

the call mechanism guarantees to hold a reference to every argument for the

duration of the call.

However, a common pitfall is to extract an object from a list and hold on to it

for a while without taking a new reference. Some other operation might

conceivably remove the object from the list, releasing that reference,

and possibly deallocating it. The real danger is that innocent-looking

operations may invoke arbitrary Python code which could do this; there is a code

path which allows control to flow back to the user from a <a class="reference internal" href="refcounting.html#c.Py_DECREF" title="Py_DECREF"><code class="xref c c-func docutils literal notranslate">Py_DECREF()</code></a>, so

almost any operation is potentially dangerous.

A safe approach is to always use the generic operations (functions whose name

begins with <code class="docutils literal notranslate">PyObject_</code>, <code class="docutils literal notranslate">PyNumber_</code>, <code class="docutils literal notranslate">PySequence_</code> or <code class="docutils literal notranslate">PyMapping_</code>).

These operations always create a new <a class="reference internal" href="../glossary.html#term-strong-reference">strong reference</a>

(i.e. increment the reference count) of the object they return.

This leaves the caller with the responsibility to call <a class="reference internal" href="refcounting.html#c.Py_DECREF" title="Py_DECREF"><code class="xref c c-func docutils literal notranslate">Py_DECREF()</code></a> when

they are done with the result; this soon becomes second nature.

<h4>Reference Count Details<a class="headerlink" href="#reference-count-details" title="Permalink to this heading">¶</a></h4>

The reference count behavior of functions in the Python/C API is best explained

in terms of ownership of references. Ownership pertains to references, never

to objects (objects are not owned: they are always shared). “Owning a

reference” means being responsible for calling Py_DECREF on it when the

reference is no longer needed. Ownership can also be transferred, meaning that

the code that receives ownership of the reference then becomes responsible for

eventually releasing it by calling <a class="reference internal" href="refcounting.html#c.Py_DECREF" title="Py_DECREF"><code class="xref c c-func docutils literal notranslate">Py_DECREF()</code></a> or <a class="reference internal" href="refcounting.html#c.Py_XDECREF" title="Py_XDECREF"><code class="xref c c-func docutils literal notranslate">Py_XDECREF()</code></a>

when it’s no longer needed—or passing on this responsibility (usually to its

caller). When a function passes ownership of a reference on to its caller, the

caller is said to receive a new reference. When no ownership is transferred,

the caller is said to borrow the reference. Nothing needs to be done for a

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

Conversely, when a calling function passes in a reference to an object, there

are two possibilities: the function steals a reference to the object, or it

does not. Stealing a reference means that when you pass a reference to a

function, that function assumes that it now owns that reference, and you are not

responsible for it any longer.

Few functions steal references; the two notable exceptions are

<a class="reference internal" href="list.html#c.PyList_SetItem" title="PyList_SetItem"><code class="xref c c-func docutils literal notranslate">PyList_SetItem()</code></a> and <a class="reference internal" href="tuple.html#c.PyTuple_SetItem" title="PyTuple_SetItem"><code class="xref c c-func docutils literal notranslate">PyTuple_SetItem()</code></a>, which steal a reference

to the item (but not to the tuple or list into which the item is put!). These

functions were designed to steal a reference because of a common idiom for

populating a tuple or list with newly created objects; for example, the code to

create the tuple <code class="docutils literal notranslate">(1, 2, "three")</code> could look like this (forgetting about

error handling for the moment; a better way to code this is shown below):

t = PyTuple_New(3);

PyTuple_SetItem(t, 0, PyLong_FromLong(1L));

PyTuple_SetItem(t, 1, PyLong_FromLong(2L));

PyTuple_SetItem(t, 2, PyUnicode_FromString("three"));

</pre></div>

</div>

Here, <a class="reference internal" href="long.html#c.PyLong_FromLong" title="PyLong_FromLong"><code class="xref c c-func docutils literal notranslate">PyLong_FromLong()</code></a> returns a new reference which is immediately

stolen by <a class="reference internal" href="tuple.html#c.PyTuple_SetItem" title="PyTuple_SetItem"><code class="xref c c-func docutils literal notranslate">PyTuple_SetItem()</code></a>. When you want to keep using an object

although the reference to it will be stolen, use <a class="reference internal" href="refcounting.html#c.Py_INCREF" title="Py_INCREF"><code class="xref c c-func docutils literal notranslate">Py_INCREF()</code></a> to grab

another reference before calling the reference-stealing function.

Incidentally, <a class="reference internal" href="tuple.html#c.PyTuple_SetItem" title="PyTuple_SetItem"><code class="xref c c-func docutils literal notranslate">PyTuple_SetItem()</code></a> is the only way to set tuple items;

<a class="reference internal" href="sequence.html#c.PySequence_SetItem" title="PySequence_SetItem"><code class="xref c c-func docutils literal notranslate">PySequence_SetItem()</code></a> and <a class="reference internal" href="object.html#c.PyObject_SetItem" title="PyObject_SetItem"><code class="xref c c-func docutils literal notranslate">PyObject_SetItem()</code></a> refuse to do this

since tuples are an immutable data type. You should only use

<a class="reference internal" href="tuple.html#c.PyTuple_SetItem" title="PyTuple_SetItem"><code class="xref c c-func docutils literal notranslate">PyTuple_SetItem()</code></a> for tuples that you are creating yourself.

Equivalent code for populating a list can be written using <a class="reference internal" href="list.html#c.PyList_New" title="PyList_New"><code class="xref c c-func docutils literal notranslate">PyList_New()</code></a>

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

However, in practice, you will rarely use these ways of creating and populating

a tuple or list. There’s a generic function, <a class="reference internal" href="arg.html#c.Py_BuildValue" title="Py_BuildValue"><code class="xref c c-func docutils literal notranslate">Py_BuildValue()</code></a>, that can

create most common objects from C values, directed by a format string.

For example, the above two blocks of code could be replaced by the following

(which also takes care of the error checking):

<div class="highlight-c notranslate"><div class="highlight"><pre>PyObject *tuple, *list;

tuple = Py_BuildValue("(iis)", 1, 2, "three");

list = Py_BuildValue("[iis]", 1, 2, "three");

</pre></div>

</div>

It is much more common to use <a class="reference internal" href="object.html#c.PyObject_SetItem" title="PyObject_SetItem"><code class="xref c c-func docutils literal notranslate">PyObject_SetItem()</code></a> and friends with items

whose references you are only borrowing, like arguments that were passed in to

the function you are writing. In that case, their behaviour regarding references

is much saner, since you don’t have to take a new reference just so you

can give that reference away (“have it be stolen”). For example, this function

sets all items of a list (actually, any mutable sequence) to a given item:

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

set_all(PyObject *target, PyObject *item)

{

Py_ssize_t i, n;

n = PyObject_Length(target);

if (n < 0)

return -1;

for (i = 0; i < n; i++) {

PyObject *index = PyLong_FromSsize_t(i);

if (!index)

return -1;

if (PyObject_SetItem(target, index, item) < 0) {

Py_DECREF(index);

return -1;

}

Py_DECREF(index);

}

return 0;

}

</pre></div>

</div>

The situation is slightly different for function return values. While passing

a reference to most functions does not change your ownership responsibilities

for that reference, many functions that return a reference to an object give

you ownership of the reference. The reason is simple: in many cases, the

returned object is created on the fly, and the reference you get is the only

reference to the object. Therefore, the generic functions that return object

references, like <a class="reference internal" href="object.html#c.PyObject_GetItem" title="PyObject_GetItem"><code class="xref c c-func docutils literal notranslate">PyObject_GetItem()</code></a> and <a class="reference internal" href="sequence.html#c.PySequence_GetItem" title="PySequence_GetItem"><code class="xref c c-func docutils literal notranslate">PySequence_GetItem()</code></a>,

always return a new reference (the caller becomes the owner of the reference).

It is important to realize that whether you own a reference returned by a

function depends on which function you call only — the plumage (the type of

the object passed as an argument to the function) doesn’t enter into it!

Thus, if you extract an item from a list using <a class="reference internal" href="list.html#c.PyList_GetItem" title="PyList_GetItem"><code class="xref c c-func docutils literal notranslate">PyList_GetItem()</code></a>, you

don’t own the reference — but if you obtain the same item from the same list

using <a class="reference internal" href="sequence.html#c.PySequence_GetItem" title="PySequence_GetItem"><code class="xref c c-func docutils literal notranslate">PySequence_GetItem()</code></a> (which happens to take exactly the same

arguments), you do own a reference to the returned object.

Here is an example of how you could write a function that computes the sum of

the items in a list of integers; once using <a class="reference internal" href="list.html#c.PyList_GetItem" title="PyList_GetItem"><code class="xref c c-func docutils literal notranslate">PyList_GetItem()</code></a>, and once

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

sum_list(PyObject *list)

{

long total = 0, value;

PyObject *item;

n = PyList_Size(list);

return -1; /* Not a list */

item = PyList_GetItem(list, i); /* Can't fail */

if (!PyLong_Check(item)) continue; /* Skip non-integers */

value = PyLong_AsLong(item);

if (value == -1 && PyErr_Occurred())

/* Integer too big to fit in a C long, bail out */

return -1;

total += value;

}

return total;

}

</pre></div>

</div>

<div class="highlight-c notranslate" id="index-8"><div class="highlight"><pre>long

sum_sequence(PyObject *sequence)

{

PyObject *item;

n = PySequence_Length(sequence);

return -1; /* Has no length */

item = PySequence_GetItem(sequence, i);

if (item == NULL)

return -1; /* Not a sequence, or other failure */

if (PyLong_Check(item)) {

Py_DECREF(item);

/* Integer too big to fit in a C long, bail out */

return -1;

total += value;

}

else {

Py_DECREF(item); /* Discard reference ownership */

}

return total;

}

</pre></div>

</div>

</section>

<h3>Types<a class="headerlink" href="#types" title="Permalink to this heading">¶</a></h3>

There are few other data types that play a significant role in the Python/C

API; most are simple C types such as int, long,

double and char*. A few structure types are used to

describe static tables used to list the functions exported by a module or the

data attributes of a new object type, and another is used to describe the value

of a complex number. These will be discussed together with the functions that

use them.

type Py_ssize_t<a class="headerlink" href="#c.Py_ssize_t" 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>.A signed integral type such that <code class="docutils literal notranslate">sizeof(Py_ssize_t) == sizeof(size_t)</code>.

C99 doesn’t define such a thing directly (size_t is an unsigned integral type).

See <a class="pep reference external" href="https://peps.python.org/pep-0353/">PEP 353</a> for details. <code class="docutils literal notranslate">PY_SSIZE_T_MAX</code> is the largest positive value

of type <a class="reference internal" href="#c.Py_ssize_t" title="Py_ssize_t"><code class="xref c c-type docutils literal notranslate">Py_ssize_t</code></a>.

</dd></dl>

</section>

<h2>Exceptions<a class="headerlink" href="#exceptions" title="Permalink to this heading">¶</a></h2>

The Python programmer only needs to deal with exceptions if specific error

handling is required; unhandled exceptions are automatically propagated to the

caller, then to the caller’s caller, and so on, until they reach the top-level

interpreter, where they are reported to the user accompanied by a stack

traceback.

For C programmers, however, error checking always has to be explicit. All

functions in the Python/C API can raise exceptions, unless an explicit claim is

made otherwise in a function’s documentation. In general, when a function

encounters an error, it sets an exception, discards any object references that

it owns, and returns an error indicator. If not documented otherwise, this

indicator is either <code class="docutils literal notranslate">NULL</code> or <code class="docutils literal notranslate">-1</code>, depending on the function’s return type.

A few functions return a Boolean true/false result, with false indicating an

error. Very few functions return no explicit error indicator or have an

ambiguous return value, and require explicit testing for errors with

<a class="reference internal" href="exceptions.html#c.PyErr_Occurred" title="PyErr_Occurred"><code class="xref c c-func docutils literal notranslate">PyErr_Occurred()</code></a>. These exceptions are always explicitly documented.

Exception state is maintained in per-thread storage (this is equivalent to

using global storage in an unthreaded application). A thread can be in one of

two states: an exception has occurred, or not. The function

<a class="reference internal" href="exceptions.html#c.PyErr_Occurred" title="PyErr_Occurred"><code class="xref c c-func docutils literal notranslate">PyErr_Occurred()</code></a> can be used to check for this: it returns a borrowed

reference to the exception type object when an exception has occurred, and

<code class="docutils literal notranslate">NULL</code> otherwise. There are a number of functions to set the exception state:

<a class="reference internal" href="exceptions.html#c.PyErr_SetString" title="PyErr_SetString"><code class="xref c c-func docutils literal notranslate">PyErr_SetString()</code></a> is the most common (though not the most general)

function to set the exception state, and <a class="reference internal" href="exceptions.html#c.PyErr_Clear" title="PyErr_Clear"><code class="xref c c-func docutils literal notranslate">PyErr_Clear()</code></a> clears the

exception state.

The full exception state consists of three objects (all of which can be

<code class="docutils literal notranslate">NULL</code>): the exception type, the corresponding exception value, and the

traceback. These have the same meanings as the Python result of

<code class="docutils literal notranslate">sys.exc_info()</code>; however, they are not the same: the Python objects represent

the last exception being handled by a Python <a class="reference internal" href="../reference/compound_stmts.html#try"><code class="xref std std-keyword docutils literal notranslate">try</code></a> …

<a class="reference internal" href="../reference/compound_stmts.html#except"><code class="xref std std-keyword docutils literal notranslate">except</code></a> statement, while the C level exception state only exists while

an exception is being passed on between C functions until it reaches the Python

bytecode interpreter’s main loop, which takes care of transferring it to

<code class="docutils literal notranslate">sys.exc_info()</code> and friends.

Note that starting with Python 1.5, the preferred, thread-safe way to access the

exception state from Python code is to call the function <a class="reference internal" href="../library/sys.html#sys.exc_info" title="sys.exc_info"><code class="xref py py-func docutils literal notranslate">sys.exc_info()</code></a>,

which returns the per-thread exception state for Python code. Also, the

semantics of both ways to access the exception state have changed so that a

function which catches an exception will save and restore its thread’s exception

state so as to preserve the exception state of its caller. This prevents common

bugs in exception handling code caused by an innocent-looking function

overwriting the exception being handled; it also reduces the often unwanted

lifetime extension for objects that are referenced by the stack frames in the

traceback.

As a general principle, a function that calls another function to perform some

task should check whether the called function raised an exception, and if so,

pass the exception state on to its caller. It should discard any object

references that it owns, and return an error indicator, but it should not set

another exception — that would overwrite the exception that was just raised,

and lose important information about the exact cause of the error.

A simple example of detecting exceptions and passing them on is shown in the

<code class="xref c c-func docutils literal notranslate">sum_sequence()</code> example above. It so happens that this example doesn’t

need to clean up any owned references when it detects an error. The following

example function shows some error cleanup. First, to remind you why you like

Python, we show the equivalent Python code:

<div class="highlight-c notranslate"><div class="highlight"><pre>def incr_item(dict, key):

try:

item = dict[key]

except KeyError:

item = 0

dict[key] = item + 1

</pre></div>

</div>

Here is the corresponding C code, in all its glory:

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

incr_item(PyObject *dict, PyObject *key)

{

/* Objects all initialized to NULL for Py_XDECREF */

PyObject *item = NULL, *const_one = NULL, *incremented_item = NULL;

int rv = -1; /* Return value initialized to -1 (failure) */

item = PyObject_GetItem(dict, key);

/* Handle KeyError only: */

if (!PyErr_ExceptionMatches(PyExc_KeyError))

goto error;

/* Clear the error and use zero: */

PyErr_Clear();

item = PyLong_FromLong(0L);

goto error;

}

const_one = PyLong_FromLong(1L);

if (const_one == NULL)

goto error;

incremented_item = PyNumber_Add(item, const_one);

if (incremented_item == NULL)

goto error;

if (PyObject_SetItem(dict, key, incremented_item) < 0)

goto error;

rv = 0; /* Success */

/* Continue with cleanup code */

error:

/* Cleanup code, shared by success and failure path */

/* Use Py_XDECREF() to ignore NULL references */

Py_XDECREF(item);

Py_XDECREF(const_one);

Py_XDECREF(incremented_item);

return rv; /* -1 for error, 0 for success */

}

</pre></div>

</div>

This example represents an endorsed use of the <code class="docutils literal notranslate">goto</code> statement in C!

It illustrates the use of <a class="reference internal" href="exceptions.html#c.PyErr_ExceptionMatches" title="PyErr_ExceptionMatches"><code class="xref c c-func docutils literal notranslate">PyErr_ExceptionMatches()</code></a> and

<a class="reference internal" href="exceptions.html#c.PyErr_Clear" title="PyErr_Clear"><code class="xref c c-func docutils literal notranslate">PyErr_Clear()</code></a> to handle specific exceptions, and the use of

<a class="reference internal" href="refcounting.html#c.Py_XDECREF" title="Py_XDECREF"><code class="xref c c-func docutils literal notranslate">Py_XDECREF()</code></a> to dispose of owned references that may be <code class="docutils literal notranslate">NULL</code> (note the

<code class="docutils literal notranslate">'X'</code> in the name; <a class="reference internal" href="refcounting.html#c.Py_DECREF" title="Py_DECREF"><code class="xref c c-func docutils literal notranslate">Py_DECREF()</code></a> would crash when confronted with a

<code class="docutils literal notranslate">NULL</code> reference). It is important that the variables used to hold owned

references are initialized to <code class="docutils literal notranslate">NULL</code> for this to work; likewise, the proposed

return value is initialized to <code class="docutils literal notranslate">-1</code> (failure) and only set to success after

the final call made is successful.

</section>

<h2>Embedding Python<a class="headerlink" href="#embedding-python" title="Permalink to this heading">¶</a></h2>

The one important task that only embedders (as opposed to extension writers) of

the Python interpreter have to worry about is the initialization, and possibly

the finalization, of the Python interpreter. Most functionality of the

interpreter can only be used after the interpreter has been initialized.

The basic initialization function is <a class="reference internal" href="init.html#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate">Py_Initialize()</code></a>. This initializes

the table of loaded modules, 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>).

<a class="reference internal" href="init.html#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate">Py_Initialize()</code></a> does not set the “script argument list” (<code class="docutils literal notranslate">sys.argv</code>).

If this variable is needed by Python code that will be executed later, 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> must be set: see

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

On most systems (in particular, on Unix and Windows, although the details are

slightly different), <a class="reference internal" href="init.html#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate">Py_Initialize()</code></a> calculates the module search path

based upon its best guess for the location of the standard Python interpreter

executable, assuming that the Python library is found in a fixed location

relative to the Python interpreter executable. In particular, it looks for a

directory named <code class="file docutils literal notranslate">lib/pythonX.Y</code> relative to the parent directory

where the executable named <code class="file docutils literal notranslate">python</code> is found on the shell command search

path (the environment variable <code class="xref std std-envvar docutils literal notranslate">PATH</code>).

For instance, if the Python executable is found in

<code class="file docutils literal notranslate">/usr/local/bin/python</code>, it will assume that the libraries are in

<code class="file docutils literal notranslate">/usr/local/lib/pythonX.Y</code>. (In fact, this particular path is also

the “fallback” location, used when no executable file named <code class="file docutils literal notranslate">python</code> is

found along <code class="xref std std-envvar docutils literal notranslate">PATH</code>.) The user can override this behavior by setting the

environment variable <a class="reference internal" href="../using/cmdline.html#envvar-PYTHONHOME"><code class="xref std std-envvar docutils literal notranslate">PYTHONHOME</code></a>, or insert additional directories in

front of the standard path by setting <a class="reference internal" href="../using/cmdline.html#envvar-PYTHONPATH"><code class="xref std std-envvar docutils literal notranslate">PYTHONPATH</code></a>.

The embedding application can steer the search by calling

<code class="docutils literal notranslate">Py_SetProgramName(file)</code> before calling <a class="reference internal" href="init.html#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate">Py_Initialize()</code></a>. Note that

<a class="reference internal" href="../using/cmdline.html#envvar-PYTHONHOME"><code class="xref std std-envvar docutils literal notranslate">PYTHONHOME</code></a> still overrides this and <a class="reference internal" href="../using/cmdline.html#envvar-PYTHONPATH"><code class="xref std std-envvar docutils literal notranslate">PYTHONPATH</code></a> is still

inserted in front of the standard path. An application that requires total

control has to provide its own implementation of <a class="reference internal" href="init.html#c.Py_GetPath" title="Py_GetPath"><code class="xref c c-func docutils literal notranslate">Py_GetPath()</code></a>,

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

<a class="reference internal" href="init.html#c.Py_GetProgramFullPath" title="Py_GetProgramFullPath"><code class="xref c c-func docutils literal notranslate">Py_GetProgramFullPath()</code></a> (all defined in <code class="file docutils literal notranslate">Modules/getpath.c</code>).

Sometimes, it is desirable to “uninitialize” Python. For instance, the

application may want to start over (make another call to

<a class="reference internal" href="init.html#c.Py_Initialize" title="Py_Initialize"><code class="xref c c-func docutils literal notranslate">Py_Initialize()</code></a>) or the application is simply done with its use of

Python and wants to free memory allocated by Python. This can be accomplished

by calling <a class="reference internal" href="init.html#c.Py_FinalizeEx" title="Py_FinalizeEx"><code class="xref c c-func docutils literal notranslate">Py_FinalizeEx()</code></a>. The function <a class="reference internal" href="init.html#c.Py_IsInitialized" title="Py_IsInitialized"><code class="xref c c-func docutils literal notranslate">Py_IsInitialized()</code></a> returns

true if Python is currently in the initialized state. More information about

these functions is given in a later chapter. Notice that <a class="reference internal" href="init.html#c.Py_FinalizeEx" title="Py_FinalizeEx"><code class="xref c c-func docutils literal notranslate">Py_FinalizeEx()</code></a>

does not free all memory allocated by the Python interpreter, e.g. memory

allocated by extension modules currently cannot be released.

</section>

<h2>Debugging Builds<a class="headerlink" href="#debugging-builds" title="Permalink to this heading">¶</a></h2>

Python can be built with several macros to enable extra checks of the

interpreter and extension modules. These checks tend to add a large amount of

overhead to the runtime so they are not enabled by default.

A full list of the various types of debugging builds is in the file

<code class="file docutils literal notranslate">Misc/SpecialBuilds.txt</code> in the Python source distribution. Builds are

available that support tracing of reference counts, debugging the memory

allocator, or low-level profiling of the main interpreter loop. Only the most

frequently used builds will be described in the remainder of this section.

Compiling the interpreter with the <code class="xref c c-macro docutils literal notranslate">Py_DEBUG</code> macro defined produces

what is generally meant by <a class="reference internal" href="../using/configure.html#debug-build">a debug build of Python</a>.

<code class="xref c c-macro docutils literal notranslate">Py_DEBUG</code> is enabled in the Unix build by adding

<a class="reference internal" href="../using/configure.html#cmdoption-with-pydebug"><code class="xref std std-option docutils literal notranslate">--with-pydebug</code></a> to the <code class="file docutils literal notranslate">./configure</code> command.

It is also implied by the presence of the

not-Python-specific <code class="xref c c-macro docutils literal notranslate">_DEBUG</code> macro. When <code class="xref c c-macro docutils literal notranslate">Py_DEBUG</code> is enabled

in the Unix build, compiler optimization is disabled.

In addition to the reference count debugging described below, extra checks are

performed, see <a class="reference internal" href="../using/configure.html#debug-build">Python Debug Build</a>.

Defining <code class="xref c c-macro docutils literal notranslate">Py_TRACE_REFS</code> enables reference tracing

(see the <a class="reference internal" href="../using/configure.html#cmdoption-with-trace-refs"><code class="xref std std-option docutils literal notranslate">configure --with-trace-refs option</code></a>).

When defined, a circular doubly linked list of active objects is maintained by adding two extra

fields to every <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><code class="xref c c-type docutils literal notranslate">PyObject</code></a>. Total allocations are tracked as well. Upon

exit, all existing references are printed. (In interactive mode this happens

after every statement run by the interpreter.)

Please refer to <code class="file docutils literal notranslate">Misc/SpecialBuilds.txt</code> in the Python source distribution

for more detailed information.

</section>

</div>

<div>

<h3><a href="../contents.html">İçindekiler</a></h3>

<ul>

<li><a class="reference internal" href="#">Introduction</a><ul>

<li><a class="reference internal" href="#coding-standards">Coding standards</a></li>

<li><a class="reference internal" href="#include-files">Include Files</a></li>

<li><a class="reference internal" href="#useful-macros">Useful macros</a></li>

<li><a class="reference internal" href="#objects-types-and-reference-counts">Objects, Types and Reference Counts</a><ul>

<li><a class="reference internal" href="#reference-counts">Reference Counts</a><ul>

<li><a class="reference internal" href="#reference-count-details">Reference Count Details</a></li>

</ul>

</li>

<li><a class="reference internal" href="#types">Types</a></li>

</ul>

</li>

<li><a class="reference internal" href="#exceptions">Exceptions</a></li>

<li><a class="reference internal" href="#embedding-python">Embedding Python</a></li>

<li><a class="reference internal" href="#debugging-builds">Debugging Builds</a></li>

</ul>

</li>

</ul>

</div>

<div>

<h4>Önceki konu</h4>

<a href="index.html"

title="önceki bölüm">Python/C API Referans Kılavuzu</a>

</div>

<div>

<h4>Sonraki konu</h4>

<a href="stable.html"

title="sonraki bölüm">C API Stability</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/intro.rst"

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

</a>

</li>

</ul>

</div>

«

</div>

</div>

<h3>Gezinti</h3>

<ul>

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

>dizin</a></li>

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

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

<a href="stable.html" title="C API Stability"

>sonraki</a> |</li>

<a href="index.html" title="Python/C API Referans Kılavuzu"

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

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

intro.html

Latest commit

History

intro.html

File metadata and controls