python-docs-fa/using/cmdline.html at gh-pages · python/python-docs-fa

History

1810 lines (1685 loc) · 157 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>1. Command line and environment — مستندات 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="#">1. Command line and environment</a><ul>

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

<li><a class="reference internal" href="#interface-options">1.1.1. Interface options</a></li>

<li><a class="reference internal" href="#generic-options">1.1.2. Generic options</a></li>

<li><a class="reference internal" href="#miscellaneous-options">1.1.3. Miscellaneous options</a></li>

<li><a class="reference internal" href="#controlling-color">1.1.4. Controlling color</a></li>

</ul>

</li>

<li><a class="reference internal" href="#environment-variables">1.2. Environment variables</a><ul>

<li><a class="reference internal" href="#debug-mode-variables">1.2.1. Debug-mode variables</a></li>

</ul>

</li>

</ul>

</li>

</ul>

</div>

<div>

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

<a href="index.html"

title="فصل قبلی">Python Setup and Usage</a>

</div>

<div>

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

<a href="unix.html"

title="فصل بعدی">2. Using Python on Unix platforms</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', "using/cmdline.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/using/cmdline.rst?plain=1"

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

</a>

</li>

<li>

<a href="https://github.com/python/python-docs-fa/blob/3.14/using/cmdline.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="unix.html" title="2. Using Python on Unix platforms"

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

<a href="index.html" title="Python Setup and Usage"

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

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

</li>

<li>

</li>

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

</li>

<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Python Setup and Usage</a> »</li>

<li class="nav-item nav-item-this"><a href="">1. Command line and environment</a></li>

</form>

</div>

</li>

Theme

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

</select>

</label> |</li>

</ul>

</div>

<h1>1. Command line and environment<a class="headerlink" href="#command-line-and-environment" title="Link to this heading">¶</a></h1>

The CPython interpreter scans the command line and the environment for various

settings.

جزئیات پیاده‌سازی در CPython: Other implementations' command line schemes may differ. See

<a class="reference internal" href="../reference/introduction.html#implementations">Alternate Implementations</a> for further resources.

</div>

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

When invoking Python, you may specify any of these options:

<div class="highlight-sh notranslate"><div class="highlight"><pre>python [-bBdEhiIOPqRsSuvVWx?] [-c command | -m module-name | script | - ] [args]

</pre></div>

</div>

The most common use case is, of course, a simple invocation of a script:

<div class="highlight-sh notranslate"><div class="highlight"><pre>python myscript.py

</pre></div>

</div>

<h3>1.1.1. Interface options<a class="headerlink" href="#interface-options" title="Link to this heading">¶</a></h3>

The interpreter interface resembles that of the UNIX shell, but provides some

additional methods of invocation:

<li>When called with standard input connected to a tty device, it prompts for

commands and executes them until an EOF (an end-of-file character, you can

produce that with <kbd class="kbd docutils literal notranslate">Ctrl</kbd>-<kbd class="kbd docutils literal notranslate">D</kbd> on UNIX or <kbd class="kbd docutils literal notranslate">Ctrl</kbd>-<kbd class="kbd docutils literal notranslate">Z,</kbd> <kbd class="kbd docutils literal notranslate">Enter</kbd> on Windows) is read.

For more on interactive mode, see <a class="reference internal" href="../tutorial/appendix.html#tut-interac">حالت تعاملی</a>.</li>

<li>When called with a file name argument or with a file as standard input, it

reads and executes a script from that file.</li>

<li>When called with a directory name argument, it reads and executes an

appropriately named script from that directory.</li>

<li>When called with <code class="docutils literal notranslate">-c command</code>, it executes the Python statement(s) given as

command. Here command may contain multiple statements separated by

newlines. Leading whitespace is significant in Python statements!</li>

<li>When called with <code class="docutils literal notranslate">-m module-name</code>, the given module is located using the standard

import mechanism and executed as a script.</li>

</ul>

In non-interactive mode, the entire input is parsed before it is executed.

An interface option terminates the list of options consumed by the interpreter,

all consecutive arguments will end up in <a class="reference internal" href="../library/sys.html#sys.argv" title="sys.argv"><code class="xref py py-data docutils literal notranslate">sys.argv</code></a> -- note that the first

element, subscript zero (<code class="docutils literal notranslate">sys.argv[0]</code>), is a string reflecting the program's

source.

-c <command><a class="headerlink" href="#cmdoption-c" title="Link to this definition">¶</a></dt>

<dd>Execute the Python code in command. command can be one or more

statements separated by newlines, with significant leading whitespace as in

normal module code.

If this option is given, the first element of <a class="reference internal" href="../library/sys.html#sys.argv" title="sys.argv"><code class="xref py py-data docutils literal notranslate">sys.argv</code></a> will be

<code class="docutils literal notranslate">"-c"</code> and the current directory will be added to the start of

<a class="reference internal" href="../library/sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a> (allowing modules in that directory to be imported as top

level modules).

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

تغییر داده شده در نسخه 3.14: command is automatically dedented before execution.

</div>

</dd></dl>

-m <module-name><a class="headerlink" href="#cmdoption-m" title="Link to this definition">¶</a></dt>

<dd>Locate the module using the standard import mechanism and execute its contents

as the <a class="reference internal" href="../library/__main__.html#module-__main__" title="__main__: The environment where top-level code is run. Covers command-line interfaces, import-time behavior, and ``__name__ == '__main__'``."><code class="xref py py-mod docutils literal notranslate">__main__</code></a> module.

Since the argument is a module name, you must not give a file extension

(<code class="docutils literal notranslate">.py</code>). The module name should be a valid absolute Python module name, but

the implementation may not always enforce this (e.g. it may allow you to

use a name that includes a hyphen).

Package names (including namespace packages) are also permitted. When a

package name is supplied instead

of a normal module, the interpreter will execute <code class="docutils literal notranslate"><pkg>.__main__</code> as

the main module. This behaviour is deliberately similar to the handling

of directories and zipfiles that are passed to the interpreter as the

script argument.

توجه

This option cannot be used with built-in modules and extension modules

written in C, since they do not have Python module files. However, it

can still be used for precompiled modules, even if the original source

file is not available.

</div>

full path to the module file (while the module file is being located, the

first element will be set to <code class="docutils literal notranslate">"-m"</code>). As with the <a class="reference internal" href="#cmdoption-c"><code class="xref std std-option docutils literal notranslate">-c</code></a> option,

the current directory will be added to the start of <a class="reference internal" href="../library/sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a>.

<a class="reference internal" href="#cmdoption-I"><code class="xref std std-option docutils literal notranslate">-I</code></a> option can be used to run the script in isolated mode where

<a class="reference internal" href="../library/sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a> contains neither the current directory nor the user's

site-packages directory. All <code class="docutils literal notranslate">PYTHON*</code> environment variables are

ignored, too.

Many standard library modules contain code that is invoked on their execution

as a script. An example is the <a class="reference internal" href="../library/timeit.html#module-timeit" title="timeit: Measure the execution time of small code snippets."><code class="xref py py-mod docutils literal notranslate">timeit</code></a> module:

<div class="highlight-sh notranslate"><div class="highlight"><pre>python -m timeit -s "setup here" "benchmarked code here"

python -m timeit -h # for details

</pre></div>

</div>

Raises an <a class="reference internal" href="../library/sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">cpython.run_module</code> with argument <code class="docutils literal notranslate">module-name</code>.

همچنین ملاحظه نمائید

<dt><a class="reference internal" href="../library/runpy.html#runpy.run_module" title="runpy.run_module"><code class="xref py py-func docutils literal notranslate">runpy.run_module()</code></a></dt><dd>Equivalent functionality directly available to Python code

</dd>

</dl>

<a class="pep reference external" href="https://peps.python.org/pep-0338/">PEP 338</a> -- Executing modules as scripts

</div>

تغییر داده شده در نسخه 3.1: Supply the package name to run a <code class="docutils literal notranslate">__main__</code> submodule.

</div>

تغییر داده شده در نسخه 3.4: namespace packages are also supported

</div>

</dd></dl>

-</dt>

<dd>Read commands from standard input (<a class="reference internal" href="../library/sys.html#sys.stdin" title="sys.stdin"><code class="xref py py-data docutils literal notranslate">sys.stdin</code></a>). If standard input is

a terminal, <a class="reference internal" href="#cmdoption-i"><code class="xref std std-option docutils literal notranslate">-i</code></a> is implied.

<code class="docutils literal notranslate">"-"</code> and the current directory will be added to the start of

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

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

</dd></dl>

<dd>Execute the Python code contained in script, which must be a filesystem

path (absolute or relative) referring to either a Python file, a directory

containing a <code class="docutils literal notranslate">__main__.py</code> file, or a zipfile containing a

<code class="docutils literal notranslate">__main__.py</code> file.

script name as given on the command line.

If the script name refers directly to a Python file, the directory

containing that file is added to the start of <a class="reference internal" href="../library/sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a>, and the

file is executed as the <a class="reference internal" href="../library/__main__.html#module-__main__" title="__main__: The environment where top-level code is run. Covers command-line interfaces, import-time behavior, and ``__name__ == '__main__'``."><code class="xref py py-mod docutils literal notranslate">__main__</code></a> module.

If the script name refers to a directory or zipfile, the script name is

added to the start of <a class="reference internal" href="../library/sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a> and the <code class="docutils literal notranslate">__main__.py</code> file in

that location is executed as the <a class="reference internal" href="../library/__main__.html#module-__main__" title="__main__: The environment where top-level code is run. Covers command-line interfaces, import-time behavior, and ``__name__ == '__main__'``."><code class="xref py py-mod docutils literal notranslate">__main__</code></a> module.

<a class="reference internal" href="../library/sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a> contains neither the script's directory nor the user's

site-packages directory. All <code class="docutils literal notranslate">PYTHON*</code> environment variables are

ignored, too.

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

همچنین ملاحظه نمائید

<dt><a class="reference internal" href="../library/runpy.html#runpy.run_path" title="runpy.run_path"><code class="xref py py-func docutils literal notranslate">runpy.run_path()</code></a></dt><dd>Equivalent functionality directly available to Python code

</dd>

</dl>

</div>

</dd></dl>

If no interface option is given, <a class="reference internal" href="#cmdoption-i"><code class="xref std std-option docutils literal notranslate">-i</code></a> is implied, <code class="docutils literal notranslate">sys.argv[0]</code> is

an empty string (<code class="docutils literal notranslate">""</code>) and the current directory will be added to the

start of <a class="reference internal" href="../library/sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a>. Also, tab-completion and history editing is

automatically enabled, if available on your platform (see

<a class="reference internal" href="../library/site.html#rlcompleter-config">Readline configuration</a>).

همچنین ملاحظه نمائید

<a class="reference internal" href="../tutorial/interpreter.html#tut-invoking">فراخوانی مفسر</a>

</div>

تغییر داده شده در نسخه 3.4: Automatic enabling of tab-completion and history editing.

</div>

</section>

<h3>1.1.2. Generic options<a class="headerlink" href="#generic-options" title="Link to this heading">¶</a></h3>

-?<a class="headerlink" href="#cmdoption-0" title="Link to this definition">¶</a></dt>

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

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

<dd>Print a short description of all command line options and corresponding

environment variables and exit.

</dd></dl>

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

<dd>Print a short description of Python-specific environment variables

and exit.

Added in version 3.11.

</div>

</dd></dl>

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

<dd>Print a description of implementation-specific <a class="reference internal" href="#cmdoption-X"><code class="xref std std-option docutils literal notranslate">-X</code></a> options

and exit.

Added in version 3.11.

</div>

</dd></dl>

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

<dd>Print complete usage information and exit.

Added in version 3.11.

</div>

</dd></dl>

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

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

<dd>Print the Python version number and exit. Example output could be:

<div class="highlight-none notranslate"><div class="highlight"><pre>Python 3.8.0b2+

</pre></div>

</div>

When given twice, print more information about the build, like:

<div class="highlight-none notranslate"><div class="highlight"><pre>Python 3.8.0b2+ (3.8:0c076caaa8, Apr 20 2019, 21:55:00)

[GCC 6.2.0 20161005]

</pre></div>

</div>

Added in version 3.6: The <code class="docutils literal notranslate">-VV</code> option.

</div>

</dd></dl>

</section>

<h3>1.1.3. Miscellaneous options<a class="headerlink" href="#miscellaneous-options" title="Link to this heading">¶</a></h3>

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

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

<a class="reference internal" href="../library/stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate">str</code></a> without specifying encoding or comparing <code class="xref py py-class docutils literal notranslate">bytes</code> or

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

Issue an error when the option is given twice (<code class="xref std std-option docutils literal notranslate">-bb</code>).

تغییر داده شده در نسخه 3.5: Affects also comparisons of <a class="reference internal" href="../library/stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> with <a class="reference internal" href="../library/functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a>.

</div>

</dd></dl>

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

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

import of source modules. See also <a class="reference internal" href="#envvar-PYTHONDONTWRITEBYTECODE"><code class="xref std std-envvar docutils literal notranslate">PYTHONDONTWRITEBYTECODE</code></a>.

</dd></dl>

--check-hash-based-pycs default|always|never<a class="headerlink" href="#cmdoption-check-hash-based-pycs" title="Link to this definition">¶</a></dt>

<dd>Control the validation behavior of hash-based <code class="docutils literal notranslate">.pyc</code> files. See

<a class="reference internal" href="../reference/import.html#pyc-invalidation">Cached bytecode invalidation</a>. When set to <code class="docutils literal notranslate">default</code>, checked and unchecked

hash-based bytecode cache files are validated according to their default

semantics. When set to <code class="docutils literal notranslate">always</code>, all hash-based <code class="docutils literal notranslate">.pyc</code> files, whether

checked or unchecked, are validated against their corresponding source

file. When set to <code class="docutils literal notranslate">never</code>, hash-based <code class="docutils literal notranslate">.pyc</code> files are not validated

against their corresponding source files.

The semantics of timestamp-based <code class="docutils literal notranslate">.pyc</code> files are unaffected by this

option.

</dd></dl>

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

<dd>Turn on parser debugging output (for expert only).

See also the <a class="reference internal" href="#envvar-PYTHONDEBUG"><code class="xref std std-envvar docutils literal notranslate">PYTHONDEBUG</code></a> environment variable.

This option requires a <a class="reference internal" href="configure.html#debug-build">debug build of Python</a>, otherwise

it's ignored.

</dd></dl>

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

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

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

See also the <a class="reference internal" href="#cmdoption-P"><code class="xref std std-option docutils literal notranslate">-P</code></a> and <a class="reference internal" href="#cmdoption-I"><code class="xref std std-option docutils literal notranslate">-I</code></a> (isolated) options.

</dd></dl>

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

<dd>Enter interactive mode after execution.

Using the <a class="reference internal" href="#cmdoption-i"><code class="xref std std-option docutils literal notranslate">-i</code></a> option will enter interactive mode in any of the following circumstances:

<li>When a script is passed as first argument</li>

<li>When the <a class="reference internal" href="#cmdoption-c"><code class="xref std std-option docutils literal notranslate">-c</code></a> option is used</li>

<li>When the <a class="reference internal" href="#cmdoption-m"><code class="xref std std-option docutils literal notranslate">-m</code></a> option is used</li>

</ul>

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

<a class="reference internal" href="#envvar-PYTHONSTARTUP"><code class="xref std std-envvar docutils literal notranslate">PYTHONSTARTUP</code></a> file is not read.

This can be useful to inspect global variables or a stack trace when a script

raises an exception. See also <a class="reference internal" href="#envvar-PYTHONINSPECT"><code class="xref std std-envvar docutils literal notranslate">PYTHONINSPECT</code></a>.

</dd></dl>

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

<dd>Run Python in isolated mode. This also implies <a class="reference internal" href="#cmdoption-E"><code class="xref std std-option docutils literal notranslate">-E</code></a>, <a class="reference internal" href="#cmdoption-P"><code class="xref std std-option docutils literal notranslate">-P</code></a>

and <a class="reference internal" href="#cmdoption-s"><code class="xref std std-option docutils literal notranslate">-s</code></a> options.

In isolated mode <a class="reference internal" href="../library/sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a> contains neither the script's directory nor

the user's site-packages directory. All <code class="docutils literal notranslate">PYTHON*</code> environment

variables are ignored, too. Further restrictions may be imposed to prevent

the user from injecting malicious code.

Added in version 3.4.

</div>

</dd></dl>

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

<dd>Remove assert statements and any code conditional on the value of

<a class="reference internal" href="../library/constants.html#debug__" title="__debug__"><code class="xref py py-const docutils literal notranslate">__debug__</code></a>. Augment the filename for compiled

(<a class="reference internal" href="../glossary.html#term-bytecode">bytecode</a>) files by adding <code class="docutils literal notranslate">.opt-1</code> before the <code class="docutils literal notranslate">.pyc</code>

extension (see <a class="pep reference external" href="https://peps.python.org/pep-0488/">PEP 488</a>). See also <a class="reference internal" href="#envvar-PYTHONOPTIMIZE"><code class="xref std std-envvar docutils literal notranslate">PYTHONOPTIMIZE</code></a>.

تغییر داده شده در نسخه 3.5: Modify <code class="docutils literal notranslate">.pyc</code> filenames according to <a class="pep reference external" href="https://peps.python.org/pep-0488/">PEP 488</a>.

</div>

</dd></dl>

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

<dd>Do <a class="reference internal" href="#cmdoption-O"><code class="xref std std-option docutils literal notranslate">-O</code></a> and also discard docstrings. Augment the filename

for compiled (<a class="reference internal" href="../glossary.html#term-bytecode">bytecode</a>) files by adding <code class="docutils literal notranslate">.opt-2</code> before the

<code class="docutils literal notranslate">.pyc</code> extension (see <a class="pep reference external" href="https://peps.python.org/pep-0488/">PEP 488</a>).

تغییر داده شده در نسخه 3.5: Modify <code class="docutils literal notranslate">.pyc</code> filenames according to <a class="pep reference external" href="https://peps.python.org/pep-0488/">PEP 488</a>.

</div>

</dd></dl>

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

<dd>Don't prepend a potentially unsafe path to <a class="reference internal" href="../library/sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a>:

<li><code class="docutils literal notranslate">python -m module</code> command line: Don't prepend the current working

directory.</li>

<li><code class="docutils literal notranslate">python script.py</code> command line: Don't prepend the script's directory.

If it's a symbolic link, resolve symbolic links.</li>

<li><code class="docutils literal notranslate">python -c code</code> and <code class="docutils literal notranslate">python</code> (REPL) command lines: Don't prepend an

empty string, which means the current working directory.</li>

</ul>

See also the <a class="reference internal" href="#envvar-PYTHONSAFEPATH"><code class="xref std std-envvar docutils literal notranslate">PYTHONSAFEPATH</code></a> environment variable, and <a class="reference internal" href="#cmdoption-E"><code class="xref std std-option docutils literal notranslate">-E</code></a>

and <a class="reference internal" href="#cmdoption-I"><code class="xref std std-option docutils literal notranslate">-I</code></a> (isolated) options.

Added in version 3.11.

</div>

</dd></dl>

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

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

Added in version 3.2.

</div>

</dd></dl>

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

<dd>Turn on hash randomization. This option only has an effect if the

<a class="reference internal" href="#envvar-PYTHONHASHSEED"><code class="xref std std-envvar docutils literal notranslate">PYTHONHASHSEED</code></a> environment variable is set to anything other

than <code class="docutils literal notranslate">random</code>, since hash randomization is enabled by default.

On previous versions of Python, this option turns on hash randomization,

so that the <a class="reference internal" href="../reference/datamodel.html#object.__hash__" title="object.__hash__"><code class="xref py py-meth docutils literal notranslate">__hash__()</code></a> values of str and bytes objects

are "salted" with an unpredictable random value. Although they remain

constant within an individual Python process, they are not predictable

between repeated invocations of Python.

Hash randomization is intended to provide protection against a

denial-of-service caused by carefully chosen inputs that exploit the worst

case performance of a dict construction, O(n2) complexity. See

<a class="reference external" href="https://ocert.org/advisories/ocert-2011-003.html">https://ocert.org/advisories/ocert-2011-003.html</a> for details.

<a class="reference internal" href="#envvar-PYTHONHASHSEED"><code class="xref std std-envvar docutils literal notranslate">PYTHONHASHSEED</code></a> allows you to set a fixed value for the hash

seed secret.

Added in version 3.2.3.

</div>

تغییر داده شده در نسخه 3.7: The option is no longer ignored.

</div>

</dd></dl>

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

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

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

See also <a class="reference internal" href="#envvar-PYTHONNOUSERSITE"><code class="xref std std-envvar docutils literal notranslate">PYTHONNOUSERSITE</code></a>.

همچنین ملاحظه نمائید

<a class="pep reference external" href="https://peps.python.org/pep-0370/">PEP 370</a> -- Per user site-packages directory

</div>

</dd></dl>

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

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

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

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

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

</dd></dl>

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

<dd>Force the stdout and stderr streams to be unbuffered. This option has no

effect on the stdin stream.

See also <a class="reference internal" href="#envvar-PYTHONUNBUFFERED"><code class="xref std std-envvar docutils literal notranslate">PYTHONUNBUFFERED</code></a>.

تغییر داده شده در نسخه 3.7: The text layer of the stdout and stderr streams now is unbuffered.

</div>

</dd></dl>

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

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

(filename or built-in module) from which it is loaded. When given twice

(<code class="xref std std-option docutils literal notranslate">-vv</code>), print a message for each file that is checked for when

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

تغییر داده شده در نسخه 3.10: The <a class="reference internal" href="../library/site.html#module-site" title="site: Module responsible for site-specific configuration."><code class="xref py py-mod docutils literal notranslate">site</code></a> module reports the site-specific paths

and <code class="file docutils literal notranslate">.pth</code> files being processed.

</div>

See also <a class="reference internal" href="#envvar-PYTHONVERBOSE"><code class="xref std std-envvar docutils literal notranslate">PYTHONVERBOSE</code></a>.

</dd></dl>

-W arg<a class="headerlink" href="#cmdoption-W" title="Link to this definition">¶</a></dt>

<dd>Warning control. Python's warning machinery by default prints warning

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

The simplest settings apply a particular action unconditionally to all

warnings emitted by a process (even those that are otherwise ignored by

default):

<div class="highlight-sh notranslate"><div class="highlight"><pre>-Wdefault # Warn once per call location

-Werror # Convert to exceptions

-Walways # Warn every time

-Wall # Same as -Walways

-Wmodule # Warn once per calling module

-Wonce # Warn once per Python process

-Wignore # Never warn

</pre></div>

</div>

The action names can be abbreviated as desired and the interpreter will

resolve them to the appropriate action name. For example, <code class="docutils literal notranslate">-Wi</code> is the

same as <code class="docutils literal notranslate">-Wignore</code>.

The full form of argument is:

<div class="highlight-sh notranslate"><div class="highlight"><pre>action:message:category:module:lineno

</pre></div>

</div>

Empty fields match all values; trailing empty fields may be omitted. For

example <code class="docutils literal notranslate">-W ignore::DeprecationWarning</code> ignores all DeprecationWarning

warnings.

The action field is as explained above but only applies to warnings that

match the remaining fields.

The message field must match the whole warning message; this match is

case-insensitive.

The category field matches the warning category

(ex: <code class="docutils literal notranslate">DeprecationWarning</code>). This must be a class name; the match test

whether the actual warning category of the message is a subclass of the

specified warning category.

The module field matches the (fully qualified) module name; this match is

case-sensitive.

The lineno field matches the line number, where zero matches all line

numbers and is thus equivalent to an omitted line number.

Multiple <a class="reference internal" href="#cmdoption-W"><code class="xref std std-option docutils literal notranslate">-W</code></a> options can be given; when a warning matches more than

one option, the action for the last matching option is performed. Invalid

<code class="xref std std-option docutils literal notranslate">-W</code> options are ignored (though, a warning message is printed about

invalid options when the first warning is issued).

Warnings can also be controlled using the <a class="reference internal" href="#envvar-PYTHONWARNINGS"><code class="xref std std-envvar docutils literal notranslate">PYTHONWARNINGS</code></a>

environment variable and from within a Python program using the

<a class="reference internal" href="../library/warnings.html#module-warnings" title="warnings: Issue warning messages and control their disposition."><code class="xref py py-mod docutils literal notranslate">warnings</code></a> module. For example, the <a class="reference internal" href="../library/warnings.html#warnings.filterwarnings" title="warnings.filterwarnings"><code class="xref py py-func docutils literal notranslate">warnings.filterwarnings()</code></a>

function can be used to use a regular expression on the warning message.

See <a class="reference internal" href="../library/warnings.html#warning-filter">The Warnings Filter</a> and <a class="reference internal" href="../library/warnings.html#describing-warning-filters">Describing Warning Filters</a> for more

details.

</dd></dl>

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

<dd>Skip the first line of the source, allowing use of non-Unix forms of

<code class="docutils literal notranslate">#!cmd</code>. This is intended for a DOS specific hack only.

</dd></dl>

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

<dd>Reserved for various implementation-specific options. CPython currently

defines the following possible values:

<ul>

<li><code class="docutils literal notranslate">-X faulthandler</code> to enable <a class="reference internal" href="../library/faulthandler.html#module-faulthandler" title="faulthandler: Dump the Python traceback."><code class="xref py py-mod docutils literal notranslate">faulthandler</code></a>.

See also <a class="reference internal" href="#envvar-PYTHONFAULTHANDLER"><code class="xref std std-envvar docutils literal notranslate">PYTHONFAULTHANDLER</code></a>.

Added in version 3.3.

</div>

</li>

<li><code class="docutils literal notranslate">-X showrefcount</code> to output the total reference count and number of used

memory blocks when the program finishes or after each statement in the

interactive interpreter. This only works on <a class="reference internal" href="configure.html#debug-build">debug builds</a>.

Added in version 3.4.

</div>

</li>

<li><code class="docutils literal notranslate">-X tracemalloc</code> to start tracing Python memory allocations using the

<a class="reference internal" href="../library/tracemalloc.html#module-tracemalloc" title="tracemalloc: Trace memory allocations."><code class="xref py py-mod docutils literal notranslate">tracemalloc</code></a> module. By default, only the most recent frame is

stored in a traceback of a trace. Use <code class="docutils literal notranslate">-X tracemalloc=NFRAME</code> to start

tracing with a traceback limit of NFRAME frames.

See <a class="reference internal" href="../library/tracemalloc.html#tracemalloc.start" title="tracemalloc.start"><code class="xref py py-func docutils literal notranslate">tracemalloc.start()</code></a> and <a class="reference internal" href="#envvar-PYTHONTRACEMALLOC"><code class="xref std std-envvar docutils literal notranslate">PYTHONTRACEMALLOC</code></a>

for more information.

Added in version 3.4.

</div>

</li>

<li><code class="docutils literal notranslate">-X int_max_str_digits</code> configures the <a class="reference internal" href="../library/stdtypes.html#int-max-str-digits">integer string conversion

length limitation</a>. See also

<a class="reference internal" href="#envvar-PYTHONINTMAXSTRDIGITS"><code class="xref std std-envvar docutils literal notranslate">PYTHONINTMAXSTRDIGITS</code></a>.

Added in version 3.11.

</div>

</li>

<li><code class="docutils literal notranslate">-X importtime</code> to show how long each import takes. It shows module

name, cumulative time (including nested imports) and self time (excluding

nested imports). Note that its output may be broken in multi-threaded

application. Typical usage is <code class="docutils literal notranslate">python -X importtime -c 'import asyncio'</code>.

<code class="docutils literal notranslate">-X importtime=2</code> enables additional output that indicates when an

imported module has already been loaded. In such cases, the string

<code class="docutils literal notranslate">cached</code> will be printed in both time columns.

See also <a class="reference internal" href="#envvar-PYTHONPROFILEIMPORTTIME"><code class="xref std std-envvar docutils literal notranslate">PYTHONPROFILEIMPORTTIME</code></a>.

Added in version 3.7.

</div>

تغییر داده شده در نسخه 3.14: Added <code class="docutils literal notranslate">-X importtime=2</code> to also trace imports of loaded modules,

and reserved values other than <code class="docutils literal notranslate">1</code> and <code class="docutils literal notranslate">2</code> for future use.

</div>

</li>

<li><code class="docutils literal notranslate">-X dev</code>: enable <a class="reference internal" href="../library/devmode.html#devmode">Python Development Mode</a>, introducing

additional runtime checks that are too expensive to be enabled by

default. See also <a class="reference internal" href="#envvar-PYTHONDEVMODE"><code class="xref std std-envvar docutils literal notranslate">PYTHONDEVMODE</code></a>.

Added in version 3.7.

</div>

</li>

<li><code class="docutils literal notranslate">-X utf8</code> enables the <a class="reference internal" href="../library/os.html#utf8-mode">Python UTF-8 Mode</a>.

<code class="docutils literal notranslate">-X utf8=0</code> explicitly disables <a class="reference internal" href="../library/os.html#utf8-mode">Python UTF-8 Mode</a>

(even when it would otherwise activate automatically).

See also <a class="reference internal" href="#envvar-PYTHONUTF8"><code class="xref std std-envvar docutils literal notranslate">PYTHONUTF8</code></a>.

Added in version 3.7.

</div>

</li>

<li><code class="docutils literal notranslate">-X pycache_prefix=PATH</code> enables writing <code class="docutils literal notranslate">.pyc</code> files to a parallel

tree rooted at the given directory instead of to the code tree. See also

<a class="reference internal" href="#envvar-PYTHONPYCACHEPREFIX"><code class="xref std std-envvar docutils literal notranslate">PYTHONPYCACHEPREFIX</code></a>.

Added in version 3.8.

</div>

</li>

<li><code class="docutils literal notranslate">-X warn_default_encoding</code> issues a <a class="reference internal" href="../library/exceptions.html#EncodingWarning" title="EncodingWarning"><code class="xref py py-class docutils literal notranslate">EncodingWarning</code></a> when the

locale-specific default encoding is used for opening files.

See also <a class="reference internal" href="#envvar-PYTHONWARNDEFAULTENCODING"><code class="xref std std-envvar docutils literal notranslate">PYTHONWARNDEFAULTENCODING</code></a>.

Added in version 3.10.

</div>

</li>

<li><code class="docutils literal notranslate">-X no_debug_ranges</code> disables the inclusion of the tables mapping extra

location information (end line, start column offset and end column offset)

to every instruction in code objects. This is useful when smaller code

objects and pyc files are desired as well as suppressing the extra visual

location indicators when the interpreter displays tracebacks. See also

<a class="reference internal" href="#envvar-PYTHONNODEBUGRANGES"><code class="xref std std-envvar docutils literal notranslate">PYTHONNODEBUGRANGES</code></a>.

Added in version 3.11.

</div>

</li>

<li><code class="docutils literal notranslate">-X frozen_modules</code> determines whether or not frozen modules are

ignored by the import machinery. A value of <code class="docutils literal notranslate">on</code> means they get

imported and <code class="docutils literal notranslate">off</code> means they are ignored. The default is <code class="docutils literal notranslate">on</code>

if this is an installed Python (the normal case). If it's under

development (running from the source tree) then the default is <code class="docutils literal notranslate">off</code>.

Note that the <code class="xref py py-mod docutils literal notranslate">importlib_bootstrap</code> and

<code class="xref py py-mod docutils literal notranslate">importlib_bootstrap_external</code> frozen modules are always used, even

if this flag is set to <code class="docutils literal notranslate">off</code>. See also <a class="reference internal" href="#envvar-PYTHON_FROZEN_MODULES"><code class="xref std std-envvar docutils literal notranslate">PYTHON_FROZEN_MODULES</code></a>.

Added in version 3.11.

</div>

</li>

<li><code class="docutils literal notranslate">-X perf</code> enables support for the Linux <code class="docutils literal notranslate">perf</code> profiler.

When this option is provided, the <code class="docutils literal notranslate">perf</code> profiler will be able to

report Python calls. This option is only available on some platforms and

will do nothing if is not supported on the current system. The default value

is "off". See also <a class="reference internal" href="#envvar-PYTHONPERFSUPPORT"><code class="xref std std-envvar docutils literal notranslate">PYTHONPERFSUPPORT</code></a> and <a class="reference internal" href="../howto/perf_profiling.html#perf-profiling">Python support for the Linux perf profiler</a>.

Added in version 3.12.

</div>

</li>

<li><code class="docutils literal notranslate">-X perf_jit</code> enables support for the Linux <code class="docutils literal notranslate">perf</code> profiler with DWARF

support. When this option is provided, the <code class="docutils literal notranslate">perf</code> profiler will be able

to report Python calls using DWARF information. This option is only available on

some platforms and will do nothing if is not supported on the current

system. The default value is "off". See also <a class="reference internal" href="#envvar-PYTHON_PERF_JIT_SUPPORT"><code class="xref std std-envvar docutils literal notranslate">PYTHON_PERF_JIT_SUPPORT</code></a>

and <a class="reference internal" href="../howto/perf_profiling.html#perf-profiling">Python support for the Linux perf profiler</a>.

Added in version 3.13.

</div>

</li>

<li><code class="docutils literal notranslate">-X disable_remote_debug</code> disables the remote debugging support as described

in <a class="pep reference external" href="https://peps.python.org/pep-0768/">PEP 768</a>. This includes both the functionality to schedule code for

execution in another process and the functionality to receive code for

execution in the current process.

This option is only available on some platforms and will do nothing

if is not supported on the current system. See also

<a class="reference internal" href="#envvar-PYTHON_DISABLE_REMOTE_DEBUG"><code class="xref std std-envvar docutils literal notranslate">PYTHON_DISABLE_REMOTE_DEBUG</code></a> and <a class="pep reference external" href="https://peps.python.org/pep-0768/">PEP 768</a>.

Added in version 3.14.

</div>

</li>

<li><code class="samp docutils literal notranslate">-X cpu_count=n</code> overrides <a class="reference internal" href="../library/os.html#os.cpu_count" title="os.cpu_count"><code class="xref py py-func docutils literal notranslate">os.cpu_count()</code></a>,

<a class="reference internal" href="../library/os.html#os.process_cpu_count" title="os.process_cpu_count"><code class="xref py py-func docutils literal notranslate">os.process_cpu_count()</code></a>, and <a class="reference internal" href="../library/multiprocessing.html#multiprocessing.cpu_count" title="multiprocessing.cpu_count"><code class="xref py py-func docutils literal notranslate">multiprocessing.cpu_count()</code></a>.

n must be greater than or equal to 1.

This option may be useful for users who need to limit CPU resources of a

container system. See also <a class="reference internal" href="#envvar-PYTHON_CPU_COUNT"><code class="xref std std-envvar docutils literal notranslate">PYTHON_CPU_COUNT</code></a>.

If n is <code class="docutils literal notranslate">default</code>, nothing is overridden.

Added in version 3.13.

</div>

</li>

<li><code class="samp docutils literal notranslate">-X presite=package.module</code> specifies a module that should be

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

<a class="reference internal" href="../library/__main__.html#module-__main__" title="__main__: The environment where top-level code is run. Covers command-line interfaces, import-time behavior, and ``__name__ == '__main__'``."><code class="xref py py-mod docutils literal notranslate">__main__</code></a> module exists. Therefore, the imported module isn't

<code class="xref py py-mod docutils literal notranslate">__main__</code>. This can be used to execute code early during Python

initialization. Python needs to be <a class="reference internal" href="configure.html#debug-build">built in debug mode</a>

for this option to exist. See also <a class="reference internal" href="#envvar-PYTHON_PRESITE"><code class="xref std std-envvar docutils literal notranslate">PYTHON_PRESITE</code></a>.

Added in version 3.13.

</div>

</li>

<li><code class="samp docutils literal notranslate">-X gil=0,1</code> forces the GIL to be disabled or enabled,

respectively. Setting to <code class="docutils literal notranslate">0</code> is only available in builds configured with

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

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

Added in version 3.13.

</div>

</li>

<li><code class="samp docutils literal notranslate">-X thread_inherit_context=0,1</code> causes <a class="reference internal" href="../library/threading.html#threading.Thread" title="threading.Thread"><code class="xref py py-class docutils literal notranslate">Thread</code></a>

to, by default, use a copy of context of the caller of

<code class="docutils literal notranslate">Thread.start()</code> when starting. Otherwise, threads will start

with an empty context. If unset, the value of this option defaults

to <code class="docutils literal notranslate">1</code> on free-threaded builds and to <code class="docutils literal notranslate">0</code> otherwise. See also

<a class="reference internal" href="#envvar-PYTHON_THREAD_INHERIT_CONTEXT"><code class="xref std std-envvar docutils literal notranslate">PYTHON_THREAD_INHERIT_CONTEXT</code></a>.

Added in version 3.14.

</div>

</li>

<li><code class="samp docutils literal notranslate">-X context_aware_warnings=0,1</code> causes the

<a class="reference internal" href="../library/warnings.html#warnings.catch_warnings" title="warnings.catch_warnings"><code class="xref py py-class docutils literal notranslate">warnings.catch_warnings</code></a> context manager to use a

<a class="reference internal" href="../library/contextvars.html#contextvars.ContextVar" title="contextvars.ContextVar"><code class="xref py py-class docutils literal notranslate">ContextVar</code></a> to store warnings filter state. If

unset, the value of this option defaults to <code class="docutils literal notranslate">1</code> on free-threaded builds

and to <code class="docutils literal notranslate">0</code> otherwise. See also <a class="reference internal" href="#envvar-PYTHON_CONTEXT_AWARE_WARNINGS"><code class="xref std std-envvar docutils literal notranslate">PYTHON_CONTEXT_AWARE_WARNINGS</code></a>.

Added in version 3.14.

</div>

</li>

<li><code class="samp docutils literal notranslate">-X tlbc=0,1</code> enables (1, the default) or disables (0) thread-local

bytecode in builds configured with <a class="reference internal" href="configure.html#cmdoption-disable-gil"><code class="xref std std-option docutils literal notranslate">--disable-gil</code></a>. When disabled,

this also disables the specializing interpreter. See also

<a class="reference internal" href="#envvar-PYTHON_TLBC"><code class="xref std std-envvar docutils literal notranslate">PYTHON_TLBC</code></a>.

Added in version 3.14.

</div>

</li>

</ul>

It also allows passing arbitrary values and retrieving them through the

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

Added in version 3.2.

</div>

تغییر داده شده در نسخه 3.9: Removed the <code class="docutils literal notranslate">-X showalloccount</code> option.

</div>

تغییر داده شده در نسخه 3.10: Removed the <code class="docutils literal notranslate">-X oldparser</code> option.

</div>

</dd></dl>

Removed in version 3.14: <code class="xref std std-option docutils literal notranslate">-J</code> is no longer reserved for use by <a class="reference external" href="https://www.jython.org/">Jython</a>,

and now has no special meaning.

</div>

</section>

<h3>1.1.4. Controlling color<a class="headerlink" href="#controlling-color" title="Link to this heading">¶</a></h3>

The Python interpreter is configured by default to use colors to highlight

output in certain situations such as when displaying tracebacks. This

behavior can be controlled by setting different environment variables.

Setting the environment variable <code class="docutils literal notranslate">TERM</code> to <code class="docutils literal notranslate">dumb</code> will disable color.

If the <a class="reference external" href="https://force-color.org/"><code class="docutils literal notranslate">FORCE_COLOR</code></a> environment variable is set, then color will be

enabled regardless of the value of TERM. This is useful on CI systems which

aren’t terminals but can still display ANSI escape sequences.

If the <a class="reference external" href="https://no-color.org/"><code class="docutils literal notranslate">NO_COLOR</code></a> environment variable is set, Python will disable all color

in the output. This takes precedence over <code class="docutils literal notranslate">FORCE_COLOR</code>.

All these environment variables are used also by other tools to control color

output. To control the color output only in the Python interpreter, the

<a class="reference internal" href="#envvar-PYTHON_COLORS"><code class="xref std std-envvar docutils literal notranslate">PYTHON_COLORS</code></a> environment variable can be used. This variable takes

precedence over <code class="docutils literal notranslate">NO_COLOR</code>, which in turn takes precedence over

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

</section>

<h2>1.2. Environment variables<a class="headerlink" href="#environment-variables" title="Link to this heading">¶</a></h2>

These environment variables influence Python's behavior, they are processed

before the command-line switches other than -E or -I. It is customary that

command-line switches override environmental variables where there is a

conflict.

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

<dd>Change the location of the standard Python libraries. By default, the

libraries are searched in <code class="file docutils literal notranslate">prefix/lib/pythonversion</code> and

<code class="file docutils literal notranslate">exec_prefix/lib/pythonversion</code>, where <code class="file docutils literal notranslate">prefix</code> and

<code class="file docutils literal notranslate">exec_prefix</code> are installation-dependent directories, both defaulting

to <code class="file docutils literal notranslate">/usr/local</code>.

When <a class="reference internal" href="#envvar-PYTHONHOME"><code class="xref std std-envvar docutils literal notranslate">PYTHONHOME</code></a> is set to a single directory, its value replaces

both <code class="file docutils literal notranslate">prefix</code> and <code class="file docutils literal notranslate">exec_prefix</code>. To specify different values

for these, set <code class="xref std std-envvar docutils literal notranslate">PYTHONHOME</code> to <code class="file docutils literal notranslate">prefix:exec_prefix</code>.

</dd></dl>

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

<dd>Augment the default search path for module files. The format is the same as

the shell's <code class="xref std std-envvar docutils literal notranslate">PATH</code>: one or more directory pathnames separated by

<a class="reference internal" href="../library/os.html#os.pathsep" title="os.pathsep"><code class="xref py py-data docutils literal notranslate">os.pathsep</code></a> (e.g. colons on Unix or semicolons on Windows).

Non-existent directories are silently ignored.

In addition to normal directories, individual <a class="reference internal" href="#envvar-PYTHONPATH"><code class="xref std std-envvar docutils literal notranslate">PYTHONPATH</code></a> entries

may refer to zipfiles containing pure Python modules (in either source or

compiled form). Extension modules cannot be imported from zipfiles.

The default search path is installation dependent, but generally begins with

<code class="file docutils literal notranslate">prefix/lib/pythonversion</code> (see <a class="reference internal" href="#envvar-PYTHONHOME"><code class="xref std std-envvar docutils literal notranslate">PYTHONHOME</code></a> above). It

is always appended to <a class="reference internal" href="#envvar-PYTHONPATH"><code class="xref std std-envvar docutils literal notranslate">PYTHONPATH</code></a>.

An additional directory will be inserted in the search path in front of

<a class="reference internal" href="#envvar-PYTHONPATH"><code class="xref std std-envvar docutils literal notranslate">PYTHONPATH</code></a> as described above under

<a class="reference internal" href="#using-on-interface-options">Interface options</a>. The search path can be manipulated from

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

</dd></dl>

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

<dd>If this is set to a non-empty string, don't prepend a potentially unsafe

path to <a class="reference internal" href="../library/sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a>: see the <a class="reference internal" href="#cmdoption-P"><code class="xref std std-option docutils literal notranslate">-P</code></a> option for details.

Added in version 3.11.

</div>

</dd></dl>

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

<dd>If this is set to a non-empty string, it overrides the <a class="reference internal" href="../library/sys.html#sys.platlibdir" title="sys.platlibdir"><code class="xref py py-data docutils literal notranslate">sys.platlibdir</code></a>

value.

Added in version 3.9.

</div>

</dd></dl>

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

View remainder of file in raw view

Navigation Menu

Uh oh!

Uh oh!

FilesExpand file tree

cmdline.html

Latest commit

History

cmdline.html

File metadata and controls