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

History

1158 lines (1052 loc) · 115 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>Module Objects — مستندات Python3.14.6</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

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

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

<style>

@media only screen {

table.full-width-table {

width: 100%;

}

</style>

</head>

<body>

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

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

</label>

</a>

</svg>

</form>

</nav>

Theme

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

</select>

</label>

<div>

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

<ul>

<li><a class="reference internal" href="#">Module Objects</a></li>

<li><a class="reference internal" href="#module-definitions">Module definitions</a><ul>

<li><a class="reference internal" href="#module-slots">Module slots</a></li>

</ul>

</li>

<li><a class="reference internal" href="#creating-extension-modules-dynamically">Creating extension modules dynamically</a></li>

<li><a class="reference internal" href="#support-functions">Support functions</a><ul>

<li><a class="reference internal" href="#module-lookup-single-phase-initialization">Module lookup (single-phase initialization)</a></li>

</ul>

</li>

</ul>

</div>

<div>

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

<a href="file.html"

title="فصل قبلی">File objects</a>

</div>

<div>

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

<a href="iterator.html"

title="فصل بعدی">Iterator Objects</a>

</div>

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

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

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

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

elements.forEach(element => {

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

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

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

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

element.href = url.toString();

});

</script>

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

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

<li>

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

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

</a>

</li>

<li>

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

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

</li>

</ul>

</div>

</nav>

</div>

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

<ul>

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

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

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

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

<a href="iterator.html" title="Iterator Objects"

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

<a href="file.html" title="File objects"

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

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

</li>

<li>

</li>

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

</li>

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

<li class="nav-item nav-item-2"><a href="concrete.html" accesskey="U">Concrete Objects Layer</a> »</li>

<li class="nav-item nav-item-this"><a href="">Module Objects</a></li>

</form>

</div>

</li>

Theme

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

</select>

</label> |</li>

</ul>

</div>

<h1>Module Objects<a class="headerlink" href="#module-objects" title="Link to this heading">¶</a></h1>

<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> PyModule_Type<a class="headerlink" href="#c.PyModule_Type" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.This instance of <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject"><code class="xref c c-type docutils literal notranslate">PyTypeObject</code></a> represents the Python module type. This

is exposed to Python programs as <a class="reference internal" href="../library/types.html#types.ModuleType" title="types.ModuleType"><code class="xref py py-class docutils literal notranslate">types.ModuleType</code></a>.

</dd></dl>

int PyModule_Check(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p)<a class="headerlink" href="#c.PyModule_Check" title="Link to this definition">¶</a> </dt>

<dd>Return true if p is a module object, or a subtype of a module object.

This function always succeeds.

</dd></dl>

int PyModule_CheckExact(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p)<a class="headerlink" href="#c.PyModule_CheckExact" title="Link to this definition">¶</a> </dt>

<dd>Return true if p is a module object, but not a subtype of

<a class="reference internal" href="#c.PyModule_Type" title="PyModule_Type"><code class="xref c c-data docutils literal notranslate">PyModule_Type</code></a>. This function always succeeds.

</dd></dl>

<dd>مقدار بازگشتی: مرجع جدید. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.7.Return a new module object with <a class="reference internal" href="../reference/datamodel.html#module.__name__" title="module.__name__"><code class="xref py py-attr docutils literal notranslate">module.__name__</code></a> set to name.

The module's <code class="xref py py-attr docutils literal notranslate">__name__</code>, <a class="reference internal" href="../reference/datamodel.html#module.__doc__" title="module.__doc__"><code class="xref py py-attr docutils literal notranslate">__doc__</code></a>,

<a class="reference internal" href="../reference/datamodel.html#module.__package__" title="module.__package__"><code class="xref py py-attr docutils literal notranslate">__package__</code></a> and <a class="reference internal" href="../reference/datamodel.html#module.__loader__" title="module.__loader__"><code class="xref py py-attr docutils literal notranslate">__loader__</code></a> attributes are

filled in (all but <code class="xref py py-attr docutils literal notranslate">__name__</code> are set to <code class="docutils literal notranslate">None</code>). The caller is

responsible for setting a <a class="reference internal" href="../reference/datamodel.html#module.__file__" title="module.__file__"><code class="xref py py-attr docutils literal notranslate">__file__</code></a> attribute.

Return <code class="docutils literal notranslate">NULL</code> with an exception set on error.

Added in version 3.3.

</div>

تغییر داده شده در نسخه 3.4: <a class="reference internal" href="../reference/datamodel.html#module.__package__" title="module.__package__"><code class="xref py py-attr docutils literal notranslate">__package__</code></a> and <a class="reference internal" href="../reference/datamodel.html#module.__loader__" title="module.__loader__"><code class="xref py py-attr docutils literal notranslate">__loader__</code></a> are now set to

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

</div>

</dd></dl>

<dd>مقدار بازگشتی: مرجع جدید. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Similar to <a class="reference internal" href="#c.PyModule_NewObject" title="PyModule_NewObject"><code class="xref c c-func docutils literal notranslate">PyModule_NewObject()</code></a>, but the name is a UTF-8 encoded

string instead of a Unicode object.

</dd></dl>

<dd>مقدار بازگشتی: مرجع قرضی. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return the dictionary object that implements module's namespace; this object

is the same as the <a class="reference internal" href="../reference/datamodel.html#object.__dict__" title="object.__dict__"><code class="xref py py-attr docutils literal notranslate">__dict__</code></a> attribute of the module object.

If module is not a module object (or a subtype of a module object),

<a class="reference internal" href="../library/exceptions.html#SystemError" title="SystemError"><code class="xref py py-exc docutils literal notranslate">SystemError</code></a> is raised and <code class="docutils literal notranslate">NULL</code> is returned.

It is recommended extensions use other <code class="docutils literal notranslate">PyModule_*</code> and

<code class="docutils literal notranslate">PyObject_*</code> functions rather than directly manipulate a module's

<a class="reference internal" href="../reference/datamodel.html#object.__dict__" title="object.__dict__"><code class="xref py py-attr docutils literal notranslate">__dict__</code></a>.

The returned reference is borrowed from the module; it is valid until

the module is destroyed.

</dd></dl>

<dd>مقدار بازگشتی: مرجع جدید. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.7.Return module's <a class="reference internal" href="../reference/datamodel.html#module.__name__" title="module.__name__"><code class="xref py py-attr docutils literal notranslate">__name__</code></a> value. If the module does not

provide one, or if it is not a string, <a class="reference internal" href="../library/exceptions.html#SystemError" title="SystemError"><code class="xref py py-exc docutils literal notranslate">SystemError</code></a> is raised and

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

Added in version 3.3.

</div>

</dd></dl>

const char *PyModule_GetName(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module)<a class="headerlink" href="#c.PyModule_GetName" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Similar to <a class="reference internal" href="#c.PyModule_GetNameObject" title="PyModule_GetNameObject"><code class="xref c c-func docutils literal notranslate">PyModule_GetNameObject()</code></a> but return the name encoded to

<code class="docutils literal notranslate">'utf-8'</code>.

The returned buffer is only valid until the module is renamed or destroyed.

Note that Python code may rename a module by setting its <a class="reference internal" href="../reference/datamodel.html#module.__name__" title="module.__name__"><code class="xref py py-attr docutils literal notranslate">__name__</code></a>

attribute.

</dd></dl>

void *PyModule_GetState(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module)<a class="headerlink" href="#c.PyModule_GetState" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return the "state" of the module, that is, a pointer to the block of memory

allocated at module creation time, or <code class="docutils literal notranslate">NULL</code>. See

<a class="reference internal" href="#c.PyModuleDef.m_size" title="PyModuleDef.m_size"><code class="xref c c-member docutils literal notranslate">PyModuleDef.m_size</code></a>.

</dd></dl>

<a class="reference internal" href="#c.PyModuleDef" title="PyModuleDef">PyModuleDef</a> *PyModule_GetDef(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module)<a class="headerlink" href="#c.PyModule_GetDef" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return a pointer to the <a class="reference internal" href="#c.PyModuleDef" title="PyModuleDef"><code class="xref c c-type docutils literal notranslate">PyModuleDef</code></a> struct from which the module was

created, or <code class="docutils literal notranslate">NULL</code> if the module wasn't created from a definition.

On error, return <code class="docutils literal notranslate">NULL</code> with an exception set.

Use <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> to tell this case apart from a missing

<code class="xref c c-type docutils literal notranslate">PyModuleDef</code>.

</dd></dl>

<a class="reference internal" href="../reference/datamodel.html#module.__file__" title="module.__file__"><code class="xref py py-attr docutils literal notranslate">__file__</code></a> attribute. If this is not defined, or if it is not a

string, raise <a class="reference internal" href="../library/exceptions.html#SystemError" title="SystemError"><code class="xref py py-exc docutils literal notranslate">SystemError</code></a> and return <code class="docutils literal notranslate">NULL</code>; otherwise return

a reference to a Unicode object.

Added in version 3.2.

</div>

</dd></dl>

const char *PyModule_GetFilename(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module)<a class="headerlink" href="#c.PyModule_GetFilename" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Similar to <a class="reference internal" href="#c.PyModule_GetFilenameObject" title="PyModule_GetFilenameObject"><code class="xref c c-func docutils literal notranslate">PyModule_GetFilenameObject()</code></a> but return the filename

encoded to 'utf-8'.

The returned buffer is only valid until the module's <a class="reference internal" href="../reference/datamodel.html#module.__file__" title="module.__file__"><code class="xref py py-attr docutils literal notranslate">__file__</code></a> attribute

is reassigned or the module is destroyed.

منسوخ شده از نسخه 3.2: <a class="reference internal" href="#c.PyModule_GetFilename" title="PyModule_GetFilename"><code class="xref c c-func docutils literal notranslate">PyModule_GetFilename()</code></a> raises <a class="reference internal" href="../library/exceptions.html#UnicodeEncodeError" title="UnicodeEncodeError"><code class="xref py py-exc docutils literal notranslate">UnicodeEncodeError</code></a> on

unencodable filenames, use <a class="reference internal" href="#c.PyModule_GetFilenameObject" title="PyModule_GetFilenameObject"><code class="xref c c-func docutils literal notranslate">PyModule_GetFilenameObject()</code></a> instead.

</div>

</dd></dl>

</section>

<h1>Module definitions<a class="headerlink" href="#module-definitions" title="Link to this heading">¶</a></h1>

The functions in the previous section work on any module object, including

modules imported from Python code.

Modules defined using the C API typically use a module definition,

<a class="reference internal" href="#c.PyModuleDef" title="PyModuleDef"><code class="xref c c-type docutils literal notranslate">PyModuleDef</code></a> -- a statically allocated, constant “description" of

how a module should be created.

The definition is usually used to define an extension's “main” module object

(see <a class="reference internal" href="extension-modules.html#extension-modules">Defining extension modules</a> for details).

It is also used to

<a class="reference internal" href="#moduledef-dynamic">create extension modules dynamically</a>.

Unlike <a class="reference internal" href="#c.PyModule_New" title="PyModule_New"><code class="xref c c-func docutils literal notranslate">PyModule_New()</code></a>, the definition allows management of

module state -- a piece of memory that is allocated and cleared together

with the module object.

Unlike the module's Python attributes, Python code cannot replace or delete

data stored in module state.

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

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> شامل تمام اعضا.The module definition struct, which holds all information needed to create

a module object.

This structure must be statically allocated (or be otherwise guaranteed

to be valid while any modules created from it exist).

Usually, there is only one variable of this type for each extension module.

PyModuleDef_Base m_base<a class="headerlink" href="#c.PyModuleDef.m_base" title="Link to this definition">¶</a> </dt>

<dd>Always initialize this member to <code class="xref c c-macro docutils literal notranslate">PyModuleDef_HEAD_INIT</code>.

</dd></dl>

<dd>Name for the new module.

</dd></dl>

<dd>Docstring for the module; usually a docstring variable created with

<a class="reference internal" href="intro.html#c.PyDoc_STRVAR" title="PyDoc_STRVAR"><code class="xref c c-macro docutils literal notranslate">PyDoc_STRVAR</code></a> is used.

</dd></dl>

<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> m_size<a class="headerlink" href="#c.PyModuleDef.m_size" title="Link to this definition">¶</a> </dt>

<dd>Module state may be kept in a per-module memory area that can be

retrieved with <a class="reference internal" href="#c.PyModule_GetState" title="PyModule_GetState"><code class="xref c c-func docutils literal notranslate">PyModule_GetState()</code></a>, rather than in static globals.

This makes modules safe for use in multiple sub-interpreters.

This memory area is allocated based on m_size on module creation,

and freed when the module object is deallocated, after the

<a class="reference internal" href="#c.PyModuleDef.m_free" title="PyModuleDef.m_free"><code class="xref c c-member docutils literal notranslate">m_free</code></a> function has been called, if present.

Setting it to a non-negative value means that the module can be

re-initialized and specifies the additional amount of memory it requires

for its state.

Setting <code class="docutils literal notranslate">m_size</code> to <code class="docutils literal notranslate">-1</code> means that the module does not support

sub-interpreters, because it has global state.

Negative <code class="docutils literal notranslate">m_size</code> is only allowed when using

<a class="reference internal" href="extension-modules.html#single-phase-initialization">legacy single-phase initialization</a>

or when <a class="reference internal" href="#moduledef-dynamic">creating modules dynamically</a>.

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

</dd></dl>

<a class="reference internal" href="structures.html#c.PyMethodDef" title="PyMethodDef">PyMethodDef</a> *m_methods<a class="headerlink" href="#c.PyModuleDef.m_methods" title="Link to this definition">¶</a> </dt>

<dd>A pointer to a table of module-level functions, described by

<a class="reference internal" href="structures.html#c.PyMethodDef" title="PyMethodDef"><code class="xref c c-type docutils literal notranslate">PyMethodDef</code></a> values. Can be <code class="docutils literal notranslate">NULL</code> if no functions are present.

</dd></dl>

<a class="reference internal" href="#c.PyModuleDef_Slot" title="PyModuleDef_Slot">PyModuleDef_Slot</a> *m_slots<a class="headerlink" href="#c.PyModuleDef.m_slots" title="Link to this definition">¶</a> </dt>

<dd>An array of slot definitions for multi-phase initialization, terminated by

a <code class="docutils literal notranslate">{0, NULL}</code> entry.

When using legacy single-phase initialization, m_slots must be <code class="docutils literal notranslate">NULL</code>.

تغییر داده شده در نسخه 3.5: Prior to version 3.5, this member was always set to <code class="docutils literal notranslate">NULL</code>,

and was defined as:

<a class="reference internal" href="gcsupport.html#c.inquiry" title="inquiry">inquiry</a> m_reload<a class="headerlink" href="#c.PyModuleDef.m_slots.m_reload" title="Link to this definition">¶</a> </dt>

</div></blockquote>

</div>

</dd></dl>

<a class="reference internal" href="gcsupport.html#c.traverseproc" title="traverseproc">traverseproc</a> m_traverse<a class="headerlink" href="#c.PyModuleDef.m_traverse" title="Link to this definition">¶</a> </dt>

<dd>A traversal function to call during GC traversal of the module object, or

<code class="docutils literal notranslate">NULL</code> if not needed.

This function is not called if the module state was requested but is not

allocated yet. This is the case immediately after the module is created

and before the module is executed (<a class="reference internal" href="#c.Py_mod_exec" title="Py_mod_exec"><code class="xref c c-data docutils literal notranslate">Py_mod_exec</code></a> function). More

precisely, this function is not called if <a class="reference internal" href="#c.PyModuleDef.m_size" title="PyModuleDef.m_size"><code class="xref c c-member docutils literal notranslate">m_size</code></a> is greater

than 0 and the module state (as returned by <a class="reference internal" href="#c.PyModule_GetState" title="PyModule_GetState"><code class="xref c c-func docutils literal notranslate">PyModule_GetState()</code></a>)

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

تغییر داده شده در نسخه 3.9: No longer called before the module state is allocated.

</div>

</dd></dl>

<a class="reference internal" href="gcsupport.html#c.inquiry" title="inquiry">inquiry</a> m_clear<a class="headerlink" href="#c.PyModuleDef.m_clear" title="Link to this definition">¶</a> </dt>

<dd>A clear function to call during GC clearing of the module object, or

<code class="docutils literal notranslate">NULL</code> if not needed.

This function is not called if the module state was requested but is not

allocated yet. This is the case immediately after the module is created

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

Like <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_clear" title="PyTypeObject.tp_clear"><code class="xref c c-member docutils literal notranslate">PyTypeObject.tp_clear</code></a>, this function is not always

called before a module is deallocated. For example, when reference

counting is enough to determine that an object is no longer used,

the cyclic garbage collector is not involved and

تغییر داده شده در نسخه 3.9: No longer called before the module state is allocated.

</div>

</dd></dl>

<a class="reference internal" href="typeobj.html#c.freefunc" title="freefunc">freefunc</a> m_free<a class="headerlink" href="#c.PyModuleDef.m_free" title="Link to this definition">¶</a> </dt>

<dd>A function to call during deallocation of the module object, or <code class="docutils literal notranslate">NULL</code>

if not needed.

This function is not called if the module state was requested but is not

allocated yet. This is the case immediately after the module is created

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

تغییر داده شده در نسخه 3.9: No longer called before the module state is allocated.

</div>

</dd></dl>

<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> PyModuleDef_Type<a class="headerlink" href="#c.PyModuleDef_Type" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.5.The type of <code class="docutils literal notranslate">PyModuleDef</code> objects.

</dd></dl>

<h2>Module slots<a class="headerlink" href="#module-slots" title="Link to this heading">¶</a></h2>

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

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> شامل تمام اعضا از نسخه‌ی 3.5.<dl class="c member">

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

<dd>A slot ID, chosen from the available values explained below.

</dd></dl>

void *value<a class="headerlink" href="#c.PyModuleDef_Slot.value" title="Link to this definition">¶</a> </dt>

<dd>Value of the slot, whose meaning depends on the slot ID.

</dd></dl>

Added in version 3.5.

</div>

</dd></dl>

The available slot types are:

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

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.5.Specifies a function that is called to create the module object itself.

The value pointer of this slot must point to a function of the signature:

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *create_module(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *spec, <a class="reference internal" href="#c.PyModuleDef" title="PyModuleDef">PyModuleDef</a> *def)<a class="headerlink" href="#c.Py_mod_create.create_module" title="Link to this definition">¶</a> </dt>

The function receives a <a class="reference internal" href="../library/importlib.html#importlib.machinery.ModuleSpec" title="importlib.machinery.ModuleSpec"><code class="xref py py-class docutils literal notranslate">ModuleSpec</code></a>

instance, as defined in <a class="pep reference external" href="https://peps.python.org/pep-0451/">PEP 451</a>, and the module definition.

It should return a new module object, or set an error

and return <code class="docutils literal notranslate">NULL</code>.

This function should be kept minimal. In particular, it should not

call arbitrary Python code, as trying to import the same module again may

result in an infinite loop.

Multiple <code class="docutils literal notranslate">Py_mod_create</code> slots may not be specified in one module

definition.

If <code class="docutils literal notranslate">Py_mod_create</code> is not specified, the import machinery will create

a normal module object using <a class="reference internal" href="#c.PyModule_New" title="PyModule_New"><code class="xref c c-func docutils literal notranslate">PyModule_New()</code></a>. The name is taken from

spec, not the definition, to allow extension modules to dynamically adjust

to their place in the module hierarchy and be imported under different

names through symlinks, all while sharing a single module definition.

There is no requirement for the returned object to be an instance of

<a class="reference internal" href="#c.PyModule_Type" title="PyModule_Type"><code class="xref c c-type docutils literal notranslate">PyModule_Type</code></a>. Any type can be used, as long as it supports

setting and getting import-related attributes.

However, only <code class="docutils literal notranslate">PyModule_Type</code> instances may be returned if the

<code class="docutils literal notranslate">PyModuleDef</code> has non-<code class="docutils literal notranslate">NULL</code> <code class="docutils literal notranslate">m_traverse</code>, <code class="docutils literal notranslate">m_clear</code>,

<code class="docutils literal notranslate">m_free</code>; non-zero <code class="docutils literal notranslate">m_size</code>; or slots other than <code class="docutils literal notranslate">Py_mod_create</code>.

Added in version 3.5.

</div>

</dd></dl>

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

This is equivalent to executing the code of a Python module: typically,

this function adds classes and constants to the module.

The signature of the function is:

int exec_module(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module)<a class="headerlink" href="#c.Py_mod_exec.exec_module" title="Link to this definition">¶</a> </dt>

If multiple <code class="docutils literal notranslate">Py_mod_exec</code> slots are specified, they are processed in the

order they appear in the m_slots array.

Added in version 3.5.

</div>

</dd></dl>

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

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.12.Specifies one of the following values:

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

<dd>The module does not support being imported in subinterpreters.

</dd></dl>

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

<dd>The module supports being imported in subinterpreters,

but only when they share the main interpreter's GIL.

(See <a class="reference internal" href="../howto/isolating-extensions.html#isolating-extensions-howto">Isolating Extension Modules</a>.)

</dd></dl>

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

<dd>The module supports being imported in subinterpreters,

even when they have their own GIL.

(See <a class="reference internal" href="../howto/isolating-extensions.html#isolating-extensions-howto">Isolating Extension Modules</a>.)

</dd></dl>

This slot determines whether or not importing this module

in a subinterpreter will fail.

Multiple <code class="docutils literal notranslate">Py_mod_multiple_interpreters</code> slots may not be specified

in one module definition.

If <code class="docutils literal notranslate">Py_mod_multiple_interpreters</code> is not specified, the import

machinery defaults to <code class="docutils literal notranslate">Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED</code>.

Added in version 3.12.

</div>

</dd></dl>

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

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

<dd>The module depends on the presence of the global interpreter lock (GIL),

and may access global state without synchronization.

</dd></dl>

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

<dd>The module is safe to run without an active GIL.

</dd></dl>

This slot is ignored by Python builds not configured with

<a class="reference internal" href="../using/configure.html#cmdoption-disable-gil"><code class="xref std std-option docutils literal notranslate">--disable-gil</code></a>. Otherwise, it determines whether or not importing

this module will cause the GIL to be automatically enabled. See

<a class="reference internal" href="../whatsnew/3.13.html#whatsnew313-free-threaded-cpython">Free-threaded CPython</a> for more detail.

Multiple <code class="docutils literal notranslate">Py_mod_gil</code> slots may not be specified in one module definition.

If <code class="docutils literal notranslate">Py_mod_gil</code> is not specified, the import machinery defaults to

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

Added in version 3.13.

</div>

</dd></dl>

</section>

<h1>Creating extension modules dynamically<a class="headerlink" href="#creating-extension-modules-dynamically" title="Link to this heading">¶</a></h1>

The following functions may be used to create a module outside of an

extension's <a class="reference internal" href="extension-modules.html#extension-export-hook">initialization function</a>.

They are also used in

<a class="reference internal" href="extension-modules.html#single-phase-initialization">single-phase initialization</a>.

<dd>مقدار بازگشتی: مرجع جدید.Create a new module object, given the definition in def.

This is a macro that calls <a class="reference internal" href="#c.PyModule_Create2" title="PyModule_Create2"><code class="xref c c-func docutils literal notranslate">PyModule_Create2()</code></a> with

module_api_version set to <a class="reference internal" href="#c.PYTHON_API_VERSION" title="PYTHON_API_VERSION"><code class="xref c c-macro docutils literal notranslate">PYTHON_API_VERSION</code></a>, or

to <a class="reference internal" href="#c.PYTHON_ABI_VERSION" title="PYTHON_ABI_VERSION"><code class="xref c c-macro docutils literal notranslate">PYTHON_ABI_VERSION</code></a> if using the

<a class="reference internal" href="stable.html#limited-c-api">limited API</a>.

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyModule_Create2(<a class="reference internal" href="#c.PyModuleDef" title="PyModuleDef">PyModuleDef</a> *def, int module_api_version)<a class="headerlink" href="#c.PyModule_Create2" title="Link to this definition">¶</a> </dt>

API version module_api_version. If that version does not match the version

of the running interpreter, a <a class="reference internal" href="../library/exceptions.html#RuntimeWarning" title="RuntimeWarning"><code class="xref py py-exc docutils literal notranslate">RuntimeWarning</code></a> is emitted.

Return <code class="docutils literal notranslate">NULL</code> with an exception set on error.

This function does not support slots.

The <a class="reference internal" href="#c.PyModuleDef.m_slots" title="PyModuleDef.m_slots"><code class="xref c c-member docutils literal notranslate">m_slots</code></a> member of def must be <code class="docutils literal notranslate">NULL</code>.

توجه

Most uses of this function should be using <a class="reference internal" href="#c.PyModule_Create" title="PyModule_Create"><code class="xref c c-func docutils literal notranslate">PyModule_Create()</code></a>

instead; only use this if you are sure you need it.

</div>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyModule_FromDefAndSpec(<a class="reference internal" href="#c.PyModuleDef" title="PyModuleDef">PyModuleDef</a> *def, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *spec)<a class="headerlink" href="#c.PyModule_FromDefAndSpec" title="Link to this definition">¶</a> </dt>

<dd>مقدار بازگشتی: مرجع جدید.This macro calls <a class="reference internal" href="#c.PyModule_FromDefAndSpec2" title="PyModule_FromDefAndSpec2"><code class="xref c c-func docutils literal notranslate">PyModule_FromDefAndSpec2()</code></a> with

<a class="reference internal" href="stable.html#limited-c-api">limited API</a>.

Added in version 3.5.

</div>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyModule_FromDefAndSpec2(<a class="reference internal" href="#c.PyModuleDef" title="PyModuleDef">PyModuleDef</a> *def, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *spec, int module_api_version)<a class="headerlink" href="#c.PyModule_FromDefAndSpec2" title="Link to this definition">¶</a> </dt>

ModuleSpec spec, assuming the API version module_api_version.

If that version does not match the version of the running interpreter,

a <a class="reference internal" href="../library/exceptions.html#RuntimeWarning" title="RuntimeWarning"><code class="xref py py-exc docutils literal notranslate">RuntimeWarning</code></a> is emitted.

Return <code class="docutils literal notranslate">NULL</code> with an exception set on error.

Note that this does not process execution slots (<a class="reference internal" href="#c.Py_mod_exec" title="Py_mod_exec"><code class="xref c c-data docutils literal notranslate">Py_mod_exec</code></a>).

Both <code class="docutils literal notranslate">PyModule_FromDefAndSpec</code> and <code class="docutils literal notranslate">PyModule_ExecDef</code> must be called

to fully initialize a module.

توجه

Most uses of this function should be using <a class="reference internal" href="#c.PyModule_FromDefAndSpec" title="PyModule_FromDefAndSpec"><code class="xref c c-func docutils literal notranslate">PyModule_FromDefAndSpec()</code></a>

instead; only use this if you are sure you need it.

</div>

Added in version 3.5.

</div>

</dd></dl>

int PyModule_ExecDef(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module, <a class="reference internal" href="#c.PyModuleDef" title="PyModuleDef">PyModuleDef</a> *def)<a class="headerlink" href="#c.PyModule_ExecDef" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.7.Process any execution slots (<a class="reference internal" href="#c.Py_mod_exec" title="Py_mod_exec"><code class="xref c c-data docutils literal notranslate">Py_mod_exec</code></a>) given in def.

Added in version 3.5.

</div>

</dd></dl>

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

<dd>The C API version. Defined for backwards compatibility.

Currently, this constant is not updated in new Python versions, and is not

useful for versioning. This may change in the future.

</dd></dl>

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

<dd>Defined as <code class="docutils literal notranslate">3</code> for backwards compatibility.

Currently, this constant is not updated in new Python versions, and is not

useful for versioning. This may change in the future.

</dd></dl>

</section>

<h1>Support functions<a class="headerlink" href="#support-functions" title="Link to this heading">¶</a></h1>

The following functions are provided to help initialize a module

state.

They are intended for a module's execution slots (<a class="reference internal" href="#c.Py_mod_exec" title="Py_mod_exec"><code class="xref c c-data docutils literal notranslate">Py_mod_exec</code></a>),

the initialization function for legacy <a class="reference internal" href="extension-modules.html#single-phase-initialization">single-phase initialization</a>,

or code that creates modules dynamically.

int PyModule_AddObjectRef(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module, const char *name, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *value)<a class="headerlink" href="#c.PyModule_AddObjectRef" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.10.Add an object to module as name. This is a convenience function which

can be used from the module's initialization function.

On success, return <code class="docutils literal notranslate">0</code>. On error, raise an exception and return <code class="docutils literal notranslate">-1</code>.

Example usage:

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

add_spam(PyObject *module, int value)

{

PyObject *obj = PyLong_FromLong(value);

if (obj == NULL) {

return -1;

}

int res = PyModule_AddObjectRef(module, "spam", obj);

Py_DECREF(obj);

return res;

}

</pre></div>

</div>

To be convenient, the function accepts <code class="docutils literal notranslate">NULL</code> value with an exception

set. In this case, return <code class="docutils literal notranslate">-1</code> and just leave the raised exception

unchanged.

The example can also be written without checking explicitly if obj is

<code class="docutils literal notranslate">NULL</code>:

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

{

Py_XDECREF(obj);

return res;

}

</pre></div>

</div>

Note that <code class="docutils literal notranslate">Py_XDECREF()</code> should be used instead of <code class="docutils literal notranslate">Py_DECREF()</code> in

this case, since obj can be <code class="docutils literal notranslate">NULL</code>.

The number of different name strings passed to this function

should be kept small, usually by only using statically allocated strings

as name.

For names that aren't known at compile time, prefer calling

<a class="reference internal" href="unicode.html#c.PyUnicode_FromString" title="PyUnicode_FromString"><code class="xref c c-func docutils literal notranslate">PyUnicode_FromString()</code></a> and <a class="reference internal" href="object.html#c.PyObject_SetAttr" title="PyObject_SetAttr"><code class="xref c c-func docutils literal notranslate">PyObject_SetAttr()</code></a> directly.

For more details, see <a class="reference internal" href="unicode.html#c.PyUnicode_InternFromString" title="PyUnicode_InternFromString"><code class="xref c c-func docutils literal notranslate">PyUnicode_InternFromString()</code></a>, which may be

used internally to create a key object.

Added in version 3.10.

</div>

</dd></dl>

int PyModule_Add(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module, const char *name, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *value)<a class="headerlink" href="#c.PyModule_Add" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.13.Similar to <a class="reference internal" href="#c.PyModule_AddObjectRef" title="PyModule_AddObjectRef"><code class="xref c c-func docutils literal notranslate">PyModule_AddObjectRef()</code></a>, but "steals" a reference

to value.

It can be called with a result of function that returns a new reference

without bothering to check its result or even saving it to a variable.

Example usage:

<div class="highlight-c notranslate"><div class="highlight"><pre>if (PyModule_Add(module, "spam", PyBytes_FromString(value)) < 0) {

goto error;

}

</pre></div>

</div>

Added in version 3.13.

</div>

</dd></dl>

int PyModule_AddObject(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module, const char *name, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *value)<a class="headerlink" href="#c.PyModule_AddObject" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Similar to <a class="reference internal" href="#c.PyModule_AddObjectRef" title="PyModule_AddObjectRef"><code class="xref c c-func docutils literal notranslate">PyModule_AddObjectRef()</code></a>, but steals a reference to

value on success (if it returns <code class="docutils literal notranslate">0</code>).

The new <a class="reference internal" href="#c.PyModule_Add" title="PyModule_Add"><code class="xref c c-func docutils literal notranslate">PyModule_Add()</code></a> or <a class="reference internal" href="#c.PyModule_AddObjectRef" title="PyModule_AddObjectRef"><code class="xref c c-func docutils literal notranslate">PyModule_AddObjectRef()</code></a>

functions are recommended, since it is

easy to introduce reference leaks by misusing the

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

توجه

Unlike other functions that steal references, <code class="docutils literal notranslate">PyModule_AddObject()</code>

only releases the reference to value on success.

This means that its return value must be checked, and calling code must

<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> value manually on error.

</div>

Example usage:

<div class="highlight-c notranslate"><div class="highlight"><pre>PyObject *obj = PyBytes_FromString(value);

if (PyModule_AddObject(module, "spam", obj) < 0) {

// If 'obj' is not NULL and PyModule_AddObject() failed,

// 'obj' strong reference must be deleted with Py_XDECREF().

// If 'obj' is NULL, Py_XDECREF() does nothing.

Py_XDECREF(obj);

goto error;

}

// PyModule_AddObject() stole a reference to obj:

// Py_XDECREF(obj) is not needed here.

</pre></div>

</div>

<a class="reference internal" href="../glossary.html#term-soft-deprecated">منسوخ‌سازی نرم <Soft deprecated></a> از نسخه‌ی 3.13.

</div>

</dd></dl>

int PyModule_AddIntConstant(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module, const char *name, long value)<a class="headerlink" href="#c.PyModule_AddIntConstant" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Add an integer constant to module as name. This convenience function can be

used from the module's initialization function.

Return <code class="docutils literal notranslate">-1</code> with an exception set on error, <code class="docutils literal notranslate">0</code> on success.

This is a convenience function that calls <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> and

<a class="reference internal" href="#c.PyModule_AddObjectRef" title="PyModule_AddObjectRef"><code class="xref c c-func docutils literal notranslate">PyModule_AddObjectRef()</code></a>; see their documentation for details.

</dd></dl>

int PyModule_AddStringConstant(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module, const char *name, const char *value)<a class="headerlink" href="#c.PyModule_AddStringConstant" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Add a string constant to module as name. This convenience function can be

used from the module's initialization function. The string value must be

<code class="docutils literal notranslate">NULL</code>-terminated.

This is a convenience function that calls

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

see their documentation for details.

</dd></dl>

PyModule_AddIntMacro(module, macro)<a class="headerlink" href="#c.PyModule_AddIntMacro" title="Link to this definition">¶</a> </dt>

<dd>Add an int constant to module. The name and the value are taken from

macro. For example <code class="docutils literal notranslate">PyModule_AddIntMacro(module, AF_INET)</code> adds the int

constant AF_INET with the value of AF_INET to module.

</dd></dl>

PyModule_AddStringMacro(module, macro)<a class="headerlink" href="#c.PyModule_AddStringMacro" title="Link to this definition">¶</a> </dt>

<dd>Add a string constant to module.

</dd></dl>

int PyModule_AddType(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module, <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyModule_AddType" title="Link to this definition">¶</a> </dt>

The type object is finalized by calling internally <a class="reference internal" href="type.html#c.PyType_Ready" title="PyType_Ready"><code class="xref c c-func docutils literal notranslate">PyType_Ready()</code></a>.

The name of the type object is taken from the last component of

<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_name" title="PyTypeObject.tp_name"><code class="xref c c-member docutils literal notranslate">tp_name</code></a> after dot.

Added in version 3.9.

</div>

</dd></dl>

int PyModule_AddFunctions(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module, <a class="reference internal" href="structures.html#c.PyMethodDef" title="PyMethodDef">PyMethodDef</a> *functions)<a class="headerlink" href="#c.PyModule_AddFunctions" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.7.Add the functions from the <code class="docutils literal notranslate">NULL</code> terminated functions array to module.

Refer to the <a class="reference internal" href="structures.html#c.PyMethodDef" title="PyMethodDef"><code class="xref c c-type docutils literal notranslate">PyMethodDef</code></a> documentation for details on individual

entries (due to the lack of a shared module namespace, module level

"functions" implemented in C typically receive the module as their first

parameter, making them similar to instance methods on Python classes).

This function is called automatically when creating a module from

<code class="docutils literal notranslate">PyModuleDef</code> (such as when using <a class="reference internal" href="extension-modules.html#multi-phase-initialization">Multi-phase initialization</a>,

<code class="docutils literal notranslate">PyModule_Create</code>, or <code class="docutils literal notranslate">PyModule_FromDefAndSpec</code>).

Some module authors may prefer defining functions in multiple

<a class="reference internal" href="structures.html#c.PyMethodDef" title="PyMethodDef"><code class="xref c c-type docutils literal notranslate">PyMethodDef</code></a> arrays; in that case they should call this function

directly.

The functions array must be statically allocated (or otherwise guaranteed

to outlive the module object).

Added in version 3.5.

</div>

</dd></dl>

int PyModule_SetDocString(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module, const char *docstring)<a class="headerlink" href="#c.PyModule_SetDocString" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.7.Set the docstring for module to docstring.

This function is called automatically when creating a module from

<code class="docutils literal notranslate">PyModule_Create</code>, or <code class="docutils literal notranslate">PyModule_FromDefAndSpec</code>).

Return <code class="docutils literal notranslate">0</code> on success.

Return <code class="docutils literal notranslate">-1</code> with an exception set on error.

Added in version 3.5.

</div>

</dd></dl>

int PyUnstable_Module_SetGIL(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module, void *gil)<a class="headerlink" href="#c.PyUnstable_Module_SetGIL" title="Link to this definition">¶</a> </dt>

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

Indicate that module does or does not support running without the global

interpreter lock (GIL), using one of the values from

<a class="reference internal" href="#c.Py_mod_gil" title="Py_mod_gil"><code class="xref c c-macro docutils literal notranslate">Py_mod_gil</code></a>. It must be called during module's initialization

function when using <a class="reference internal" href="extension-modules.html#single-phase-initialization">Legacy single-phase initialization</a>.

If this function is not called during module initialization, the

import machinery assumes the module does not support running without the

GIL. This function is only available in Python builds configured with

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

Added in version 3.13.

</div>

</dd></dl>

<h2>Module lookup (single-phase initialization)<a class="headerlink" href="#module-lookup-single-phase-initialization" title="Link to this heading">¶</a></h2>

The legacy <a class="reference internal" href="extension-modules.html#single-phase-initialization">single-phase initialization</a>

initialization scheme creates singleton modules that can be looked up

in the context of the current interpreter. This allows the module object to be

retrieved later with only a reference to the module definition.

These functions will not work on modules created using multi-phase initialization,

since multiple such modules can be created from a single definition.

<dd>مقدار بازگشتی: مرجع قرضی. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Returns the module object that was created from def for the current interpreter.

This method requires that the module object has been attached to the interpreter state with

<a class="reference internal" href="#c.PyState_AddModule" title="PyState_AddModule"><code class="xref c c-func docutils literal notranslate">PyState_AddModule()</code></a> beforehand. In case the corresponding module object is not

found or has not been attached to the interpreter state yet, it returns <code class="docutils literal notranslate">NULL</code>.

</dd></dl>

int PyState_AddModule(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module, <a class="reference internal" href="#c.PyModuleDef" title="PyModuleDef">PyModuleDef</a> *def)<a class="headerlink" href="#c.PyState_AddModule" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.3.Attaches the module object passed to the function to the interpreter state. This allows

the module object to be accessible via <a class="reference internal" href="#c.PyState_FindModule" title="PyState_FindModule"><code class="xref c c-func docutils literal notranslate">PyState_FindModule()</code></a>.

Only effective on modules created using single-phase initialization.

Python calls <code class="docutils literal notranslate">PyState_AddModule</code> automatically after importing a module

that uses <a class="reference internal" href="extension-modules.html#single-phase-initialization">single-phase initialization</a>,

so it is unnecessary (but harmless) to call it from module initialization

code. An explicit call is needed only if the module's own init code

subsequently calls <code class="docutils literal notranslate">PyState_FindModule</code>.

The function is mainly intended for implementing alternative import

mechanisms (either by calling it directly, or by referring to its

implementation for details of the required state updates).

If a module was attached previously using the same def, it is replaced

by the new module.

The caller must have an <a class="reference internal" href="../glossary.html#term-attached-thread-state">attached thread state</a>.

Return <code class="docutils literal notranslate">-1</code> with an exception set on error, <code class="docutils literal notranslate">0</code> on success.

Added in version 3.3.

</div>

</dd></dl>

int PyState_RemoveModule(<a class="reference internal" href="#c.PyModuleDef" title="PyModuleDef">PyModuleDef</a> *def)<a class="headerlink" href="#c.PyState_RemoveModule" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.3.Removes the module object created from def from the interpreter state.

The caller must have an <a class="reference internal" href="../glossary.html#term-attached-thread-state">attached thread state</a>.

Added in version 3.3.

</div>

</dd></dl>

</section>

View remainder of file in raw view

Navigation Menu

Uh oh!

Uh oh!

FilesExpand file tree

module.html

Latest commit

History

module.html

File metadata and controls