python-docs-fa/library/dis.html at gh-pages · python/python-docs-fa

History

2739 lines (2506 loc) · 227 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>dis --- Disassembler for Python bytecode — مستندات 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="#"><code class="xref py py-mod docutils literal notranslate">dis</code> --- Disassembler for Python bytecode</a><ul>

<li><a class="reference internal" href="#command-line-interface">Command-line interface</a></li>

<li><a class="reference internal" href="#bytecode-analysis">Bytecode analysis</a></li>

<li><a class="reference internal" href="#analysis-functions">Analysis functions</a></li>

<li><a class="reference internal" href="#python-bytecode-instructions">Python Bytecode Instructions</a></li>

<li><a class="reference internal" href="#opcode-collections">Opcode collections</a></li>

</ul>

</li>

</ul>

</div>

<div>

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

<a href="compileall.html"

title="فصل قبلی"><code class="xref py py-mod docutils literal notranslate">compileall</code> --- Byte-compile Python libraries</a>

</div>

<div>

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

<a href="pickletools.html"

title="فصل بعدی"><code class="xref py py-mod docutils literal notranslate">pickletools</code> --- Tools for pickle developers</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', "library/dis.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/library/dis.rst?plain=1"

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

</a>

</li>

<li>

<a href="https://github.com/python/python-docs-fa/blob/3.14/library/dis.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="pickletools.html" title="pickletools --- Tools for pickle developers"

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

<a href="compileall.html" title="compileall --- Byte-compile Python libraries"

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" >The Python Standard Library</a> »</li>

<li class="nav-item nav-item-2"><a href="language.html" accesskey="U">Python Language Services</a> »</li>

<li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">dis</code> --- Disassembler for Python bytecode</a></li>

</form>

</div>

</li>

Theme

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

</select>

</label> |</li>

</ul>

</div>

<h1><code class="xref py py-mod docutils literal notranslate">dis</code> --- Disassembler for Python bytecode<a class="headerlink" href="#module-dis" title="Link to this heading">¶</a></h1>

Source code: <a class="extlink-source reference external" href="https://github.com/python/cpython/tree/3.14/Lib/dis.py">Lib/dis.py</a>

The <code class="xref py py-mod docutils literal notranslate">dis</code> module supports the analysis of CPython <a class="reference internal" href="../glossary.html#term-bytecode">bytecode</a> by

disassembling it. The CPython bytecode which this module takes as an input is

defined in the file <code class="file docutils literal notranslate">Include/opcode.h</code> and used by the compiler and the

interpreter.

جزئیات پیاده‌سازی در CPython: Bytecode is an implementation detail of the CPython interpreter. No

guarantees are made that bytecode will not be added, removed, or changed

between versions of Python. Use of this module should not be considered to

work across Python VMs or Python releases.

تغییر داده شده در نسخه 3.6: Use 2 bytes for each instruction. Previously the number of bytes varied

by instruction.

</div>

تغییر داده شده در نسخه 3.10: The argument of jump, exception handling and loop instructions is now

the instruction offset rather than the byte offset.

</div>

تغییر داده شده در نسخه 3.11: Some instructions are accompanied by one or more inline cache entries,

which take the form of <a class="reference internal" href="#opcode-CACHE"><code class="xref std std-opcode docutils literal notranslate">CACHE</code></a> instructions. These instructions

are hidden by default, but can be shown by passing <code class="docutils literal notranslate">show_caches=True</code> to

any <code class="xref py py-mod docutils literal notranslate">dis</code> utility. Furthermore, the interpreter now adapts the

bytecode to specialize it for different runtime conditions. The

adaptive bytecode can be shown by passing <code class="docutils literal notranslate">adaptive=True</code>.

</div>

تغییر داده شده در نسخه 3.12: The argument of a jump is the offset of the target instruction relative

to the instruction that appears immediately after the jump instruction's

<a class="reference internal" href="#opcode-CACHE"><code class="xref std std-opcode docutils literal notranslate">CACHE</code></a> entries.

As a consequence, the presence of the <a class="reference internal" href="#opcode-CACHE"><code class="xref std std-opcode docutils literal notranslate">CACHE</code></a> instructions is

transparent for forward jumps but needs to be taken into account when

reasoning about backward jumps.

</div>

تغییر داده شده در نسخه 3.13: The output shows logical labels rather than instruction offsets

for jump targets and exception handlers. The <code class="docutils literal notranslate">-O</code> command line

option and the <code class="docutils literal notranslate">show_offsets</code> argument were added.

</div>

تغییر داده شده در نسخه 3.14: The <a class="reference internal" href="#cmdoption-dis-P"><code class="xref std std-option docutils literal notranslate">-P</code></a> command-line option

and the <code class="docutils literal notranslate">show_positions</code> argument were added.

The <a class="reference internal" href="#cmdoption-dis-S"><code class="xref std std-option docutils literal notranslate">-S</code></a> command-line option is added.

</div>

Example: Given the function <code class="xref py py-func docutils literal notranslate">myfunc()</code>:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>def myfunc(alist):

return len(alist)

</pre></div>

</div>

the following command can be used to display the disassembly of

<code class="xref py py-func docutils literal notranslate">myfunc()</code>:

<div class="highlight-pycon notranslate"><div class="highlight"><pre>>>> dis.dis(myfunc)

2 RESUME 0

3 LOAD_GLOBAL 1 (len + NULL)

LOAD_FAST_BORROW 0 (alist)

CALL 1

RETURN_VALUE

</pre></div>

</div>

(The "2" is a line number).

<h2>Command-line interface<a class="headerlink" href="#command-line-interface" title="Link to this heading">¶</a></h2>

The <code class="xref py py-mod docutils literal notranslate">dis</code> module can be invoked as a script from the command line:

<div class="highlight-sh notranslate"><div class="highlight"><pre>python -m dis [-h] [-C] [-O] [-P] [-S] [infile]

</pre></div>

</div>

The following options are accepted:

-h, --help<a class="headerlink" href="#cmdoption-dis-h" title="Link to this definition">¶</a></dt>

<dd>Display usage and exit.

</dd></dl>

-C, --show-caches<a class="headerlink" href="#cmdoption-dis-C" title="Link to this definition">¶</a></dt>

<dd>Show inline caches.

Added in version 3.13.

</div>

</dd></dl>

-O, --show-offsets<a class="headerlink" href="#cmdoption-dis-O" title="Link to this definition">¶</a></dt>

<dd>Show offsets of instructions.

Added in version 3.13.

</div>

</dd></dl>

-P, --show-positions<a class="headerlink" href="#cmdoption-dis-P" title="Link to this definition">¶</a></dt>

<dd>Show positions of instructions in the source code.

Added in version 3.14.

</div>

</dd></dl>

-S, --specialized<a class="headerlink" href="#cmdoption-dis-S" title="Link to this definition">¶</a></dt>

<dd>Show specialized bytecode.

Added in version 3.14.

</div>

</dd></dl>

If <code class="file docutils literal notranslate">infile</code> is specified, its disassembled code will be written to stdout.

Otherwise, disassembly is performed on compiled source code received from stdin.

</section>

<h2>Bytecode analysis<a class="headerlink" href="#bytecode-analysis" title="Link to this heading">¶</a></h2>

Added in version 3.4.

</div>

The bytecode analysis API allows pieces of Python code to be wrapped in a

<a class="reference internal" href="#dis.Bytecode" title="dis.Bytecode"><code class="xref py py-class docutils literal notranslate">Bytecode</code></a> object that provides easy access to details of the compiled

code.

class dis.Bytecode(x, <abbr title="Keyword-only parameters separator (PEP 3102)">*</abbr>, first_line=None, current_offset=None, show_caches=False, adaptive=False, show_offsets=False, show_positions=False)<a class="headerlink" href="#dis.Bytecode" title="Link to this definition">¶</a></dt>

<dd>Analyse the bytecode corresponding to a function, generator, asynchronous

generator, coroutine, method, string of source code, or a code object (as

returned by <a class="reference internal" href="functions.html#compile" title="compile"><code class="xref py py-func docutils literal notranslate">compile()</code></a>).

This is a convenience wrapper around many of the functions listed below, most

notably <a class="reference internal" href="#dis.get_instructions" title="dis.get_instructions"><code class="xref py py-func docutils literal notranslate">get_instructions()</code></a>, as iterating over a <code class="xref py py-class docutils literal notranslate">Bytecode</code>

instance yields the bytecode operations as <a class="reference internal" href="#dis.Instruction" title="dis.Instruction"><code class="xref py py-class docutils literal notranslate">Instruction</code></a> instances.

If first_line is not <code class="docutils literal notranslate">None</code>, it indicates the line number that should be

reported for the first source line in the disassembled code. Otherwise, the

source line information (if any) is taken directly from the disassembled code

object.

If current_offset is not <code class="docutils literal notranslate">None</code>, it refers to an instruction offset in the

disassembled code. Setting this means <a class="reference internal" href="#dis.Bytecode.dis" title="dis.Bytecode.dis"><code class="xref py py-meth docutils literal notranslate">dis()</code></a> will display a "current

instruction" marker against the specified opcode.

If show_caches is <code class="docutils literal notranslate">True</code>, <a class="reference internal" href="#dis.Bytecode.dis" title="dis.Bytecode.dis"><code class="xref py py-meth docutils literal notranslate">dis()</code></a> will display inline cache

entries used by the interpreter to specialize the bytecode.

If adaptive is <code class="docutils literal notranslate">True</code>, <a class="reference internal" href="#dis.Bytecode.dis" title="dis.Bytecode.dis"><code class="xref py py-meth docutils literal notranslate">dis()</code></a> will display specialized bytecode

that may be different from the original bytecode.

If show_offsets is <code class="docutils literal notranslate">True</code>, <a class="reference internal" href="#dis.Bytecode.dis" title="dis.Bytecode.dis"><code class="xref py py-meth docutils literal notranslate">dis()</code></a> will include instruction

offsets in the output.

If show_positions is <code class="docutils literal notranslate">True</code>, <a class="reference internal" href="#dis.Bytecode.dis" title="dis.Bytecode.dis"><code class="xref py py-meth docutils literal notranslate">dis()</code></a> will include instruction

source code positions in the output.

classmethod from_traceback(tb, <abbr title="Keyword-only parameters separator (PEP 3102)">*</abbr>, show_caches=False)<a class="headerlink" href="#dis.Bytecode.from_traceback" title="Link to this definition">¶</a></dt>

<dd>Construct a <code class="xref py py-class docutils literal notranslate">Bytecode</code> instance from the given traceback, setting

current_offset to the instruction responsible for the exception.

</dd></dl>

codeobj<a class="headerlink" href="#dis.Bytecode.codeobj" title="Link to this definition">¶</a></dt>

<dd>The compiled code object.

</dd></dl>

first_line<a class="headerlink" href="#dis.Bytecode.first_line" title="Link to this definition">¶</a></dt>

<dd>The first source line of the code object (if available)

</dd></dl>

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

<dd>Return a formatted view of the bytecode operations (the same as printed by

<a class="reference internal" href="#dis.dis" title="dis.dis"><code class="xref py py-func docutils literal notranslate">dis.dis()</code></a>, but returned as a multi-line string).

</dd></dl>

info()<a class="headerlink" href="#dis.Bytecode.info" title="Link to this definition">¶</a></dt>

<dd>Return a formatted multi-line string with detailed information about the

code object, like <a class="reference internal" href="#dis.code_info" title="dis.code_info"><code class="xref py py-func docutils literal notranslate">code_info()</code></a>.

</dd></dl>

تغییر داده شده در نسخه 3.7: This can now handle coroutine and asynchronous generator objects.

</div>

تغییر داده شده در نسخه 3.11: Added the show_caches and adaptive parameters.

</div>

تغییر داده شده در نسخه 3.13: Added the show_offsets parameter

</div>

تغییر داده شده در نسخه 3.14: Added the show_positions parameter.

</div>

</dd></dl>

Example:

<div class="highlight-pycon notranslate"><div class="highlight"><pre>>>> bytecode = dis.Bytecode(myfunc)

>>> for instr in bytecode:

... print(instr.opname)

...

RESUME

LOAD_GLOBAL

LOAD_FAST_BORROW

CALL

RETURN_VALUE

</pre></div>

</div>

</section>

<h2>Analysis functions<a class="headerlink" href="#analysis-functions" title="Link to this heading">¶</a></h2>

The <code class="xref py py-mod docutils literal notranslate">dis</code> module also defines the following analysis functions that convert

the input directly to the desired output. They can be useful if only a single

operation is being performed, so the intermediate analysis object isn't useful:

dis.code_info(x)<a class="headerlink" href="#dis.code_info" title="Link to this definition">¶</a></dt>

<dd>Return a formatted multi-line string with detailed code object information

for the supplied function, generator, asynchronous generator, coroutine,

method, source code string or code object.

Note that the exact contents of code info strings are highly implementation

dependent and they may change arbitrarily across Python VMs or Python

releases.

Added in version 3.2.

</div>

تغییر داده شده در نسخه 3.7: This can now handle coroutine and asynchronous generator objects.

</div>

</dd></dl>

dis.show_code(x, <abbr title="Keyword-only parameters separator (PEP 3102)">*</abbr>, file=None)<a class="headerlink" href="#dis.show_code" title="Link to this definition">¶</a></dt>

<dd>Print detailed code object information for the supplied function, method,

source code string or code object to file (or <code class="docutils literal notranslate">sys.stdout</code> if file

is not specified).

This is a convenient shorthand for <code class="docutils literal notranslate">print(code_info(x), file=file)</code>,

intended for interactive exploration at the interpreter prompt.

Added in version 3.2.

</div>

تغییر داده شده در نسخه 3.4: Added file parameter.

</div>

</dd></dl>

dis.dis(x=None, <abbr title="Keyword-only parameters separator (PEP 3102)">*</abbr>, file=None, depth=None, show_caches=False, adaptive=False, show_offsets=False, show_positions=False)<a class="headerlink" href="#dis.dis" title="Link to this definition">¶</a></dt>

<dd>Disassemble the x object. x can denote either a module, a class, a

method, a function, a generator, an asynchronous generator, a coroutine,

a code object, a string of source code or a byte sequence of raw bytecode.

For a module, it disassembles all functions. For a class, it disassembles

all methods (including class and static methods). For a code object or

sequence of raw bytecode, it prints one line per bytecode instruction.

It also recursively disassembles nested code objects. These can include

generator expressions, nested functions, the bodies of nested classes,

and the code objects used for <a class="reference internal" href="../reference/executionmodel.html#annotation-scopes">annotation scopes</a>.

Strings are first compiled to code objects with the <a class="reference internal" href="functions.html#compile" title="compile"><code class="xref py py-func docutils literal notranslate">compile()</code></a>

built-in function before being disassembled. If no object is provided, this

function disassembles the last traceback.

The disassembly is written as text to the supplied file argument if

provided and to <code class="docutils literal notranslate">sys.stdout</code> otherwise.

The maximal depth of recursion is limited by depth unless it is <code class="docutils literal notranslate">None</code>.

<code class="docutils literal notranslate">depth=0</code> means no recursion.

If show_caches is <code class="docutils literal notranslate">True</code>, this function will display inline cache

entries used by the interpreter to specialize the bytecode.

If adaptive is <code class="docutils literal notranslate">True</code>, this function will display specialized bytecode

that may be different from the original bytecode.

تغییر داده شده در نسخه 3.4: Added file parameter.

</div>

تغییر داده شده در نسخه 3.7: Implemented recursive disassembling and added depth parameter.

</div>

تغییر داده شده در نسخه 3.7: This can now handle coroutine and asynchronous generator objects.

</div>

تغییر داده شده در نسخه 3.11: Added the show_caches and adaptive parameters.

</div>

تغییر داده شده در نسخه 3.13: Added the show_offsets parameter.

</div>

تغییر داده شده در نسخه 3.14: Added the show_positions parameter.

</div>

</dd></dl>

dis.distb(tb=None, <abbr title="Keyword-only parameters separator (PEP 3102)">*</abbr>, file=None, show_caches=False, adaptive=False, show_offset=False, show_positions=False)<a class="headerlink" href="#dis.distb" title="Link to this definition">¶</a></dt>

<dd>Disassemble the top-of-stack function of a traceback, using the last

traceback if none was passed. The instruction causing the exception is

indicated.

The disassembly is written as text to the supplied file argument if

provided and to <code class="docutils literal notranslate">sys.stdout</code> otherwise.

تغییر داده شده در نسخه 3.4: Added file parameter.

</div>

تغییر داده شده در نسخه 3.11: Added the show_caches and adaptive parameters.

</div>

تغییر داده شده در نسخه 3.13: Added the show_offsets parameter.

</div>

تغییر داده شده در نسخه 3.14: Added the show_positions parameter.

</div>

</dd></dl>

dis.disassemble(code, lasti=-1, <abbr title="Keyword-only parameters separator (PEP 3102)">*</abbr>, file=None, show_caches=False, adaptive=False, show_offsets=False, show_positions=False)<a class="headerlink" href="#dis.disassemble" title="Link to this definition">¶</a></dt>

dis.disco(code, lasti=-1, <abbr title="Keyword-only parameters separator (PEP 3102)">*</abbr>, file=None, show_caches=False, adaptive=False, show_offsets=False, show_positions=False)<a class="headerlink" href="#dis.disco" title="Link to this definition">¶</a></dt>

<dd>Disassemble a code object, indicating the last instruction if lasti was

provided. The output is divided in the following columns:

<li>the source code location of the instruction. Complete location information

is shown if show_positions is true. Otherwise (the default) only the

line number is displayed.</li>

<li>the current instruction, indicated as <code class="docutils literal notranslate">--></code>,</li>

<li>a labelled instruction, indicated with <code class="docutils literal notranslate">>></code>,</li>

<li>the address of the instruction,</li>

<li>the operation code name,</li>

<li>operation parameters, and</li>

<li>interpretation of the parameters in parentheses.</li>

</ol>

The parameter interpretation recognizes local and global variable names,

constant values, branch targets, and compare operators.

The disassembly is written as text to the supplied file argument if

provided and to <code class="docutils literal notranslate">sys.stdout</code> otherwise.

تغییر داده شده در نسخه 3.4: Added file parameter.

</div>

تغییر داده شده در نسخه 3.11: Added the show_caches and adaptive parameters.

</div>

تغییر داده شده در نسخه 3.13: Added the show_offsets parameter.

</div>

تغییر داده شده در نسخه 3.14: Added the show_positions parameter.

</div>

</dd></dl>

dis.get_instructions(x, <abbr title="Keyword-only parameters separator (PEP 3102)">*</abbr>, first_line=None, show_caches=False, adaptive=False)<a class="headerlink" href="#dis.get_instructions" title="Link to this definition">¶</a></dt>

<dd>Return an iterator over the instructions in the supplied function, method,

source code string or code object.

The iterator generates a series of <a class="reference internal" href="#dis.Instruction" title="dis.Instruction"><code class="xref py py-class docutils literal notranslate">Instruction</code></a> named tuples giving

the details of each operation in the supplied code.

If first_line is not <code class="docutils literal notranslate">None</code>, it indicates the line number that should be

reported for the first source line in the disassembled code. Otherwise, the

source line information (if any) is taken directly from the disassembled code

object.

The adaptive parameter works as it does in <a class="reference internal" href="#module-dis" title="dis: Disassembler for Python bytecode."><code class="xref py py-func docutils literal notranslate">dis()</code></a>.

Added in version 3.4.

</div>

تغییر داده شده در نسخه 3.11: Added the show_caches and adaptive parameters.

</div>

تغییر داده شده در نسخه 3.13: The show_caches parameter is deprecated and has no effect. The iterator

generates the <a class="reference internal" href="#dis.Instruction" title="dis.Instruction"><code class="xref py py-class docutils literal notranslate">Instruction</code></a> instances with the cache_info

field populated (regardless of the value of show_caches) and it no longer

generates separate items for the cache entries.

</div>

</dd></dl>

dis.findlinestarts(code)<a class="headerlink" href="#dis.findlinestarts" title="Link to this definition">¶</a></dt>

<dd>This generator function uses the <a class="reference internal" href="../reference/datamodel.html#codeobject.co_lines" title="codeobject.co_lines"><code class="xref py py-meth docutils literal notranslate">co_lines()</code></a> method

of the <a class="reference internal" href="../reference/datamodel.html#code-objects">code object</a> code to find the offsets which

are starts of

lines in the source code. They are generated as <code class="docutils literal notranslate">(offset, lineno)</code> pairs.

تغییر داده شده در نسخه 3.6: Line numbers can be decreasing. Before, they were always increasing.

</div>

تغییر داده شده در نسخه 3.10: The <a class="pep reference external" href="https://peps.python.org/pep-0626/">PEP 626</a> <a class="reference internal" href="../reference/datamodel.html#codeobject.co_lines" title="codeobject.co_lines"><code class="xref py py-meth docutils literal notranslate">co_lines()</code></a> method is used instead of the

<a class="reference internal" href="../reference/datamodel.html#codeobject.co_firstlineno" title="codeobject.co_firstlineno"><code class="xref py py-attr docutils literal notranslate">co_firstlineno</code></a> and <a class="reference internal" href="../reference/datamodel.html#codeobject.co_lnotab" title="codeobject.co_lnotab"><code class="xref py py-attr docutils literal notranslate">co_lnotab</code></a>

attributes of the <a class="reference internal" href="../reference/datamodel.html#code-objects">code object</a>.

</div>

تغییر داده شده در نسخه 3.13: Line numbers can be <code class="docutils literal notranslate">None</code> for bytecode that does not map to source lines.

</div>

</dd></dl>

dis.findlabels(code)<a class="headerlink" href="#dis.findlabels" title="Link to this definition">¶</a></dt>

<dd>Detect all offsets in the raw compiled bytecode string code which are jump targets, and

return a list of these offsets.

</dd></dl>

dis.stack_effect(opcode, oparg=None, <abbr title="Keyword-only parameters separator (PEP 3102)">*</abbr>, jump=None)<a class="headerlink" href="#dis.stack_effect" title="Link to this definition">¶</a></dt>

<dd>Compute the stack effect of opcode with argument oparg.

If the code has a jump target and jump is <code class="docutils literal notranslate">True</code>, <code class="xref py py-func docutils literal notranslate">stack_effect()</code>

will return the stack effect of jumping. If jump is <code class="docutils literal notranslate">False</code>,

it will return the stack effect of not jumping. And if jump is

<code class="docutils literal notranslate">None</code> (default), it will return the maximal stack effect of both cases.

Added in version 3.4.

</div>

تغییر داده شده در نسخه 3.8: Added jump parameter.

</div>

تغییر داده شده در نسخه 3.13: If <code class="docutils literal notranslate">oparg</code> is omitted (or <code class="docutils literal notranslate">None</code>), the stack effect is now returned

for <code class="docutils literal notranslate">oparg=0</code>. Previously this was an error for opcodes that use their

arg. It is also no longer an error to pass an integer <code class="docutils literal notranslate">oparg</code> when

the <code class="docutils literal notranslate">opcode</code> does not use it; the <code class="docutils literal notranslate">oparg</code> in this case is ignored.

</div>

</dd></dl>

</section>

<h2>Python Bytecode Instructions<a class="headerlink" href="#python-bytecode-instructions" title="Link to this heading">¶</a></h2>

The <a class="reference internal" href="#dis.get_instructions" title="dis.get_instructions"><code class="xref py py-func docutils literal notranslate">get_instructions()</code></a> function and <a class="reference internal" href="#dis.Bytecode" title="dis.Bytecode"><code class="xref py py-class docutils literal notranslate">Bytecode</code></a> class provide

details of bytecode instructions as <a class="reference internal" href="#dis.Instruction" title="dis.Instruction"><code class="xref py py-class docutils literal notranslate">Instruction</code></a> instances:

<dd>Details for a bytecode operation

opcode<a class="headerlink" href="#dis.Instruction.opcode" title="Link to this definition">¶</a></dt>

<dd>numeric code for operation, corresponding to the opcode values listed

below and the bytecode values in the <a class="reference internal" href="#opcode-collections">Opcode collections</a>.

</dd></dl>

opname<a class="headerlink" href="#dis.Instruction.opname" title="Link to this definition">¶</a></dt>

<dd>human readable name for operation

</dd></dl>

baseopcode<a class="headerlink" href="#dis.Instruction.baseopcode" title="Link to this definition">¶</a></dt>

<dd>numeric code for the base operation if operation is specialized;

otherwise equal to <a class="reference internal" href="#dis.Instruction.opcode" title="dis.Instruction.opcode"><code class="xref py py-data docutils literal notranslate">opcode</code></a>

</dd></dl>

baseopname<a class="headerlink" href="#dis.Instruction.baseopname" title="Link to this definition">¶</a></dt>

<dd>human readable name for the base operation if operation is specialized;

otherwise equal to <a class="reference internal" href="#dis.opname" title="dis.opname"><code class="xref py py-data docutils literal notranslate">opname</code></a>

</dd></dl>

arg<a class="headerlink" href="#dis.Instruction.arg" title="Link to this definition">¶</a></dt>

<dd>numeric argument to operation (if any), otherwise <code class="docutils literal notranslate">None</code>

</dd></dl>

oparg<a class="headerlink" href="#dis.Instruction.oparg" title="Link to this definition">¶</a></dt>

<dd>alias for <a class="reference internal" href="#dis.Instruction.arg" title="dis.Instruction.arg"><code class="xref py py-data docutils literal notranslate">arg</code></a>

</dd></dl>

argval<a class="headerlink" href="#dis.Instruction.argval" title="Link to this definition">¶</a></dt>

<dd>resolved arg value (if any), otherwise <code class="docutils literal notranslate">None</code>

</dd></dl>

argrepr<a class="headerlink" href="#dis.Instruction.argrepr" title="Link to this definition">¶</a></dt>

<dd>human readable description of operation argument (if any),

otherwise an empty string.

</dd></dl>

offset<a class="headerlink" href="#dis.Instruction.offset" title="Link to this definition">¶</a></dt>

<dd>start index of operation within bytecode sequence

</dd></dl>

start_offset<a class="headerlink" href="#dis.Instruction.start_offset" title="Link to this definition">¶</a></dt>

<dd>start index of operation within bytecode sequence, including prefixed

<code class="docutils literal notranslate">EXTENDED_ARG</code> operations if present; otherwise equal to <a class="reference internal" href="#dis.Instruction.offset" title="dis.Instruction.offset"><code class="xref py py-data docutils literal notranslate">offset</code></a>

</dd></dl>

cache_offset<a class="headerlink" href="#dis.Instruction.cache_offset" title="Link to this definition">¶</a></dt>

<dd>start index of the cache entries following the operation

</dd></dl>

end_offset<a class="headerlink" href="#dis.Instruction.end_offset" title="Link to this definition">¶</a></dt>

<dd>end index of the cache entries following the operation

</dd></dl>

starts_line<a class="headerlink" href="#dis.Instruction.starts_line" title="Link to this definition">¶</a></dt>

<dd><code class="docutils literal notranslate">True</code> if this opcode starts a source line, otherwise <code class="docutils literal notranslate">False</code>

</dd></dl>

line_number<a class="headerlink" href="#dis.Instruction.line_number" title="Link to this definition">¶</a></dt>

<dd>source line number associated with this opcode (if any), otherwise <code class="docutils literal notranslate">None</code>

</dd></dl>

is_jump_target<a class="headerlink" href="#dis.Instruction.is_jump_target" title="Link to this definition">¶</a></dt>

<dd><code class="docutils literal notranslate">True</code> if other code jumps to here, otherwise <code class="docutils literal notranslate">False</code>

</dd></dl>

jump_target<a class="headerlink" href="#dis.Instruction.jump_target" title="Link to this definition">¶</a></dt>

<dd>bytecode index of the jump target if this is a jump operation,

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

</dd></dl>

positions<a class="headerlink" href="#dis.Instruction.positions" title="Link to this definition">¶</a></dt>

<dd><a class="reference internal" href="#dis.Positions" title="dis.Positions"><code class="xref py py-class docutils literal notranslate">dis.Positions</code></a> object holding the

start and end locations that are covered by this instruction.

</dd></dl>

cache_info<a class="headerlink" href="#dis.Instruction.cache_info" title="Link to this definition">¶</a></dt>

<dd>Information about the cache entries of this instruction, as

triplets of the form <code class="docutils literal notranslate">(name, size, data)</code>, where the <code class="docutils literal notranslate">name</code>

and <code class="docutils literal notranslate">size</code> describe the cache format and data is the contents

of the cache. <code class="docutils literal notranslate">cache_info</code> is <code class="docutils literal notranslate">None</code> if the instruction does not have

caches.

</dd></dl>

Added in version 3.4.

</div>

تغییر داده شده در نسخه 3.11: Field <code class="docutils literal notranslate">positions</code> is added.

</div>

تغییر داده شده در نسخه 3.13: Changed field <code class="docutils literal notranslate">starts_line</code>.

Added fields <code class="docutils literal notranslate">start_offset</code>, <code class="docutils literal notranslate">cache_offset</code>, <code class="docutils literal notranslate">end_offset</code>,

<code class="docutils literal notranslate">baseopname</code>, <code class="docutils literal notranslate">baseopcode</code>, <code class="docutils literal notranslate">jump_target</code>, <code class="docutils literal notranslate">oparg</code>,

<code class="docutils literal notranslate">line_number</code> and <code class="docutils literal notranslate">cache_info</code>.

</div>

</dd></dl>

<dd>In case the information is not available, some fields might be <code class="docutils literal notranslate">None</code>.

lineno<a class="headerlink" href="#dis.Positions.lineno" title="Link to this definition">¶</a></dt>

end_lineno<a class="headerlink" href="#dis.Positions.end_lineno" title="Link to this definition">¶</a></dt>

col_offset<a class="headerlink" href="#dis.Positions.col_offset" title="Link to this definition">¶</a></dt>

end_col_offset<a class="headerlink" href="#dis.Positions.end_col_offset" title="Link to this definition">¶</a></dt>

Added in version 3.11.

</div>

</dd></dl>

The Python compiler currently generates the following bytecode instructions.

General instructions

In the following, We will refer to the interpreter stack as <code class="docutils literal notranslate">STACK</code> and describe

operations on it as if it was a Python list. The top of the stack corresponds to

<code class="docutils literal notranslate">STACK[-1]</code> in this language.

NOP<a class="headerlink" href="#opcode-NOP" title="Link to this definition">¶</a></dt>

<dd>Do nothing code. Used as a placeholder by the bytecode optimizer, and to

generate line tracing events.

</dd></dl>

NOT_TAKEN<a class="headerlink" href="#opcode-NOT_TAKEN" title="Link to this definition">¶</a></dt>

<dd>Do nothing code.

Used by the interpreter to record <a class="reference internal" href="sys.monitoring.html#monitoring-event-BRANCH_LEFT"><code class="xref std std-monitoring-event docutils literal notranslate">BRANCH_LEFT</code></a>

and <a class="reference internal" href="sys.monitoring.html#monitoring-event-BRANCH_RIGHT"><code class="xref std std-monitoring-event docutils literal notranslate">BRANCH_RIGHT</code></a> events for <a class="reference internal" href="sys.monitoring.html#module-sys.monitoring" title="sys.monitoring: Access and control event monitoring"><code class="xref py py-mod docutils literal notranslate">sys.monitoring</code></a>.

Added in version 3.14.

</div>

</dd></dl>

POP_ITER<a class="headerlink" href="#opcode-POP_ITER" title="Link to this definition">¶</a></dt>

<dd>Removes the iterator from the top of the stack.

Added in version 3.14.

</div>

</dd></dl>

POP_TOP<a class="headerlink" href="#opcode-POP_TOP" title="Link to this definition">¶</a></dt>

<dd>Removes the top-of-stack item:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>STACK.pop()

</pre></div>

</div>

</dd></dl>

END_FOR<a class="headerlink" href="#opcode-END_FOR" title="Link to this definition">¶</a></dt>

<dd>Removes the top-of-stack item.

Equivalent to <code class="docutils literal notranslate">POP_TOP</code>.

Used to clean up at the end of loops, hence the name.

Added in version 3.12.

</div>

</dd></dl>

END_SEND<a class="headerlink" href="#opcode-END_SEND" title="Link to this definition">¶</a></dt>

<dd>Implements <code class="docutils literal notranslate">del STACK[-2]</code>.

Used to clean up when a generator exits.

Added in version 3.12.

</div>

</dd></dl>

COPY(i)<a class="headerlink" href="#opcode-COPY" title="Link to this definition">¶</a></dt>

<dd>Push the i-th item to the top of the stack without removing it from its original

location:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>assert i > 0

STACK.append(STACK[-i])

</pre></div>

</div>

Added in version 3.11.

</div>

</dd></dl>

SWAP(i)<a class="headerlink" href="#opcode-SWAP" title="Link to this definition">¶</a></dt>

<dd>Swap the top of the stack with the i-th element:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>STACK[-i], STACK[-1] = STACK[-1], STACK[-i]

</pre></div>

</div>

Added in version 3.11.

</div>

</dd></dl>

CACHE<a class="headerlink" href="#opcode-CACHE" title="Link to this definition">¶</a></dt>

<dd>Rather than being an actual instruction, this opcode is used to mark extra

space for the interpreter to cache useful data directly in the bytecode

itself. It is automatically hidden by all <code class="docutils literal notranslate">dis</code> utilities, but can be

viewed with <code class="docutils literal notranslate">show_caches=True</code>.

Logically, this space is part of the preceding instruction. Many opcodes

expect to be followed by an exact number of caches, and will instruct the

interpreter to skip over them at runtime.

Populated caches can look like arbitrary instructions, so great care should

be taken when reading or modifying raw, adaptive bytecode containing

quickened data.

Added in version 3.11.

</div>

</dd></dl>

Unary operations

Unary operations take the top of the stack, apply the operation, and push the

result back on the stack.

UNARY_NEGATIVE<a class="headerlink" href="#opcode-UNARY_NEGATIVE" title="Link to this definition">¶</a></dt>

<dd>Implements <code class="docutils literal notranslate">STACK[-1] = -STACK[-1]</code>.

</dd></dl>

UNARY_NOT<a class="headerlink" href="#opcode-UNARY_NOT" title="Link to this definition">¶</a></dt>

<dd>Implements <code class="docutils literal notranslate">STACK[-1] = not STACK[-1]</code>.

تغییر داده شده در نسخه 3.13: This instruction now requires an exact <a class="reference internal" href="functions.html#bool" title="bool"><code class="xref py py-class docutils literal notranslate">bool</code></a> operand.

</div>

</dd></dl>

UNARY_INVERT<a class="headerlink" href="#opcode-UNARY_INVERT" title="Link to this definition">¶</a></dt>

<dd>Implements <code class="docutils literal notranslate">STACK[-1] = ~STACK[-1]</code>.

</dd></dl>

GET_ITER<a class="headerlink" href="#opcode-GET_ITER" title="Link to this definition">¶</a></dt>

<dd>Implements <code class="docutils literal notranslate">STACK[-1] = iter(STACK[-1])</code>.

</dd></dl>

GET_YIELD_FROM_ITER<a class="headerlink" href="#opcode-GET_YIELD_FROM_ITER" title="Link to this definition">¶</a></dt>

<dd>If <code class="docutils literal notranslate">STACK[-1]</code> is a <a class="reference internal" href="../glossary.html#term-generator-iterator">generator iterator</a> or <a class="reference internal" href="../glossary.html#term-coroutine">coroutine</a> object

it is left as is. Otherwise, implements <code class="docutils literal notranslate">STACK[-1] = iter(STACK[-1])</code>.

Added in version 3.5.

</div>

</dd></dl>

TO_BOOL<a class="headerlink" href="#opcode-TO_BOOL" title="Link to this definition">¶</a></dt>

<dd>Implements <code class="docutils literal notranslate">STACK[-1] = bool(STACK[-1])</code>.

Added in version 3.13.

</div>

</dd></dl>

Binary and in-place operations

Binary operations remove the top two items from the stack (<code class="docutils literal notranslate">STACK[-1]</code> and

<code class="docutils literal notranslate">STACK[-2]</code>). They perform the operation, then put the result back on the stack.

In-place operations are like binary operations, but the operation is done in-place

when <code class="docutils literal notranslate">STACK[-2]</code> supports it, and the resulting <code class="docutils literal notranslate">STACK[-1]</code> may be (but does

not have to be) the original <code class="docutils literal notranslate">STACK[-2]</code>.

BINARY_OP(op)<a class="headerlink" href="#opcode-BINARY_OP" title="Link to this definition">¶</a></dt>

<dd>Implements the binary and in-place operators (depending on the value of

op):

<div class="highlight-python3 notranslate"><div class="highlight"><pre>rhs = STACK.pop()

lhs = STACK.pop()

STACK.append(lhs op rhs)

</pre></div>

</div>

Added in version 3.11.

</div>

تغییر داده شده در نسخه 3.14: With oparg :<code class="docutils literal notranslate">NB_SUBSCR</code>, implements binary subscript (replaces opcode <code class="docutils literal notranslate">BINARY_SUBSCR</code>)

</div>

</dd></dl>

STORE_SUBSCR<a class="headerlink" href="#opcode-STORE_SUBSCR" title="Link to this definition">¶</a></dt>

<dd>Implements:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>key = STACK.pop()

container = STACK.pop()

View remainder of file in raw view

Navigation Menu

Uh oh!

Uh oh!

FilesExpand file tree

dis.html

Latest commit

History

dis.html

File metadata and controls