python-docs-fa/tutorial/controlflow.html at gh-pages · python/python-docs-fa

History

1178 lines (1112 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>4. ابزارهای بیشتر برای کنترل جریان — مستندات 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="#">4. ابزارهای بیشتر برای کنترل جریان</a><ul>

<li><a class="reference internal" href="#if-statements">4.1. دستورهای <code class="xref std std-keyword docutils literal notranslate">if</code></a></li>

<li><a class="reference internal" href="#for-statements">4.2. دستورهای <code class="xref std std-keyword docutils literal notranslate">for</code></a></li>

<li><a class="reference internal" href="#the-range-function">4.3. تابع <code class="xref py py-func docutils literal notranslate">range()</code></a></li>

<li><a class="reference internal" href="#break-and-continue-statements">4.4. دستورهای <code class="xref std std-keyword docutils literal notranslate">break</code> و <code class="xref std std-keyword docutils literal notranslate">continue</code></a></li>

<li><a class="reference internal" href="#pass-statements">4.6. دستورهای <code class="xref std std-keyword docutils literal notranslate">pass</code></a></li>

<li><a class="reference internal" href="#match-statements">4.7. <code class="xref std std-keyword docutils literal notranslate">match</code> دستورات</a></li>

<li><a class="reference internal" href="#defining-functions">4.8. تعریف توابع</a></li>

<li><a class="reference internal" href="#more-on-defining-functions">4.9. اطلاعات بیشتر دربارهٔ تعریف تابع‌ها</a><ul>

<li><a class="reference internal" href="#default-argument-values">4.9.1. مقدارهای پیش‌فرض آرگومان‌ها</a></li>

<li><a class="reference internal" href="#keyword-arguments">4.9.2. آرگومان‌های کلیدواژه‌ای</a></li>

<li><a class="reference internal" href="#special-parameters">4.9.3. پارامترهای ویژه</a><ul>

<li><a class="reference internal" href="#positional-or-keyword-arguments">4.9.3.1. آرگومان‌های موقعیتی یا کلیدواژه‌ای</a></li>

<li><a class="reference internal" href="#positional-only-parameters">4.9.3.2. پارامترهای فقط موقعیتی</a></li>

<li><a class="reference internal" href="#keyword-only-arguments">4.9.3.3. آرگومان‌های فقط کلیدواژه‌ای</a></li>

<li><a class="reference internal" href="#function-examples">4.9.3.4. مثال‌های توابع</a></li>

<li><a class="reference internal" href="#recap">4.9.3.5. خلاصه</a></li>

</ul>

</li>

<li><a class="reference internal" href="#arbitrary-argument-lists">4.9.4. فهرست‌های دلخواه آرگومان‌ها</a></li>

<li><a class="reference internal" href="#unpacking-argument-lists">4.9.5. باز کردن بسته آرگومان‌ها</a></li>

<li><a class="reference internal" href="#lambda-expressions">4.9.6. عبارت‌های لامبدا</a></li>

<li><a class="reference internal" href="#documentation-strings">4.9.7. رشته‌های مستندسازی</a></li>

<li><a class="reference internal" href="#function-annotations">4.9.8. حاشیه‌نویسی‌های تابع</a></li>

</ul>

</li>

<li><a class="reference internal" href="#intermezzo-coding-style">4.10. میان‌پرده: سبک کدنویسی</a></li>

</ul>

</li>

</ul>

</div>

<div>

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

<a href="introduction.html"

title="فصل قبلی">3. معرفی غیررسمی پایتون</a>

</div>

<div>

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

<a href="datastructures.html"

title="فصل بعدی">5. ساختمان داده‌ها</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', "tutorial/controlflow.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/tutorial/controlflow.rst?plain=1"

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

</a>

</li>

<li>

<a href="https://github.com/python/python-docs-fa/blob/3.14/tutorial/controlflow.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="datastructures.html" title="5. ساختمان داده‌ها"

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

<a href="introduction.html" title="3. معرفی غیررسمی پایتون"

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">راهنمای پایتون</a> »</li>

<li class="nav-item nav-item-this"><a href="">4. ابزارهای بیشتر برای کنترل جریان</a></li>

</form>

</div>

</li>

Theme

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

</select>

</label> |</li>

</ul>

</div>

<h1>4. ابزارهای بیشتر برای کنترل جریان<a class="headerlink" href="#more-control-flow-tools" title="Link to this heading">¶</a></h1>

علاوه بر دستور <a class="reference internal" href="../reference/compound_stmts.html#while"><code class="xref std std-keyword docutils literal notranslate">while</code></a> که به‌تازگی معرفی شد، پایتون چند مورد دیگر نیز دارد که در این فصل با آن‌ها آشنا خواهیم شد.

<h2>4.1. دستورهای <code class="xref std std-keyword docutils literal notranslate">if</code><a class="headerlink" href="#if-statements" title="Link to this heading">¶</a></h2>

شاید شناخته‌شده‌ترین نوع دستور، دستور <a class="reference internal" href="../reference/compound_stmts.html#if"><code class="xref std std-keyword docutils literal notranslate">if</code></a> باشد. برای مثال:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> x = int(input("Please enter an integer: "))

Please enter an integer: 42

>>> if x < 0:

... x = 0

... print('Negative changed to zero')

... elif x == 0:

... print('Zero')

... elif x == 1:

... print('Single')

... else:

... print('More')

...

More

</pre></div>

</div>

می‌تواند صفر یا چند بخش <a class="reference internal" href="../reference/compound_stmts.html#elif"><code class="xref std std-keyword docutils literal notranslate">elif</code></a> وجود داشته باشد و بخش <a class="reference internal" href="../reference/compound_stmts.html#else"><code class="xref std std-keyword docutils literal notranslate">else</code></a> اختیاری است. کلیدواژه‌ای '<code class="xref std std-keyword docutils literal notranslate">elif</code>' کوتاه‌شدهٔ 'else if' است و برای جلوگیری از تورفتگی بیش از حد مفید است. یک دنبالهٔ <code class="xref std std-keyword docutils literal notranslate">if</code> ... <code class="xref std std-keyword docutils literal notranslate">elif</code> ... <code class="xref std std-keyword docutils literal notranslate">elif</code> ... جایگزینی برای دستورهای <code class="docutils literal notranslate">switch</code> یا <code class="docutils literal notranslate">case</code> موجود در زبان‌های دیگر است.

اگر یک مقدار یکسان را با چندین مقدار ثابت مقایسه می‌کنید، یا نوع‌ها یا ویژگی‌های خاصی را بررسی می‌کنید، ممکن است دستور <code class="xref std std-keyword docutils literal notranslate">match</code> نیز برایتان مفید باشد. برای جزئیات بیشتر به <a class="reference internal" href="#tut-match">match دستورات</a> مراجعه کنید.

</section>

<h2>4.2. دستورهای <code class="xref std std-keyword docutils literal notranslate">for</code><a class="headerlink" href="#for-statements" title="Link to this heading">¶</a></h2>

دستور <a class="reference internal" href="../reference/compound_stmts.html#for"><code class="xref std std-keyword docutils literal notranslate">for</code></a> در پایتون کمی با چیزی که ممکن است در C یا Pascal به آن عادت کرده باشید تفاوت دارد. به‌جای اینکه همیشه روی یک تصاعد حسابی از اعداد پیمایش کند (مانند Pascal)، یا به کاربر امکان تعریف هم گام پیمایش و هم شرط توقف را بدهد (مانند C)، دستور <code class="xref std std-keyword docutils literal notranslate">for</code> پایتون روی آیتم‌های هر دنباله‌ای (یک فهرست یا یک رشته) به ترتیبی که در دنباله ظاهر شده‌اند پیمایش می‌کند. برای مثال (بدون قصد استعاره):

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> # اندازه‌گیری طول چند رشته:

>>> words = ['cat', 'window', 'defenestrate']

>>> for w in words:

... print(w, len(w))

...

cat 3

window 6

defenestrate 12

</pre></div>

</div>

کدی که هنگام پیمایش روی یک مجموعه، همان مجموعه را تغییر می‌دهد، ممکن است به‌درستی نوشتن دشوار باشد. در عوض، معمولاً ساده‌تر است که روی یک کپی از مجموعه پیمایش کنید یا یک مجموعهٔ جدید ایجاد کنید:

<div class="highlight-python3 notranslate"><div class="highlight"><pre># ایجاد یک مجموعه‌ی نمونه

users = {'Hans': 'active', 'Éléonore': 'inactive', '景太郎': 'active'}

# راهبرد: پیمایش روی یک کپی

for user, status in users.copy().items():

if status == 'inactive':

del users[user]

# راهبرد: ایجاد یک مجموعه‌ی جدید

active_users = {}

if status == 'active':

active_users[user] = status

</pre></div>

</div>

</section>

<h2>4.3. تابع <a class="reference internal" href="../library/stdtypes.html#range" title="range"><code class="xref py py-func docutils literal notranslate">range()</code></a><a class="headerlink" href="#the-range-function" title="Link to this heading">¶</a></h2>

اگر واقعاً نیاز دارید روی یک دنباله از اعداد پیمایش کنید، تابع داخلی <a class="reference internal" href="../library/stdtypes.html#range" title="range"><code class="xref py py-func docutils literal notranslate">range()</code></a> بسیار کاربردی است. این تابع تصاعدهای حسابی تولید می‌کند:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> for i in range(5):

... print(i)

...

0

1

2

3

4

</pre></div>

</div>

نقطهٔ پایانی داده‌شده هرگز بخشی از دنبالهٔ تولیدشده نیست؛ <code class="docutils literal notranslate">range(10)</code> مقدار تولید می‌کند که همان اندیس‌‌های مجاز برای آیتم‌های یک دنباله با طول ۱۰ هستند. امکان این وجود دارد که شروع بازه را از عدد دیگری تعیین کنید، یا افزایشی متفاوت (حتی منفی؛ که گاهی «گام» نامیده می‌شود) مشخص کنید:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> list(range(5, 10))

[5, 6, 7, 8, 9]

>>> list(range(0, 10, 3))

[0, 3, 6, 9]

>>> list(range(-10, -100, -30))

[-10, -40, -70]

</pre></div>

</div>

برای پیمایش روی اندیس‌‌های یک دنباله، می‌توانید <a class="reference internal" href="../library/stdtypes.html#range" title="range"><code class="xref py py-func docutils literal notranslate">range()</code></a> و <a class="reference internal" href="../library/functions.html#len" title="len"><code class="xref py py-func docutils literal notranslate">len()</code></a> را به شکل زیر ترکیب کنید:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> a = ['Mary', 'had', 'a', 'little', 'lamb']

>>> for i in range(len(a)):

... print(i, a[i])

...

0 Mary

1 had

2 a

3 little

4 lamb

</pre></div>

</div>

بااین‌حال، در بیشتر چنین مواردی استفاده از تابع <a class="reference internal" href="../library/functions.html#enumerate" title="enumerate"><code class="xref py py-func docutils literal notranslate">enumerate()</code></a> راحت‌تر است؛ به <a class="reference internal" href="datastructures.html#tut-loopidioms">تکنیک‌های حلقه‌زنی</a> مراجعه کنید.

اگر فقط یک range را چاپ کنید، اتفاق عجیبی رخ می‌دهد:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> range(10)

range(0, 10)

</pre></div>

</div>

از بسیاری جهات، شیئی که توسط <a class="reference internal" href="../library/stdtypes.html#range" title="range"><code class="xref py py-func docutils literal notranslate">range()</code></a> برگردانده می‌شود طوری رفتار می‌کند که گویی یک فهرست است، اما در واقع چنین نیست. این یک شیء است که هنگام پیمایش، آیتم‌های متوالی دنبالهٔ موردنظر را برمی‌گرداند، اما واقعاً فهرست را ایجاد نمی‌کند و در نتیجه در فضا صرفه‌جویی می‌شود.

می‌گوییم چنین شیئی <a class="reference internal" href="../glossary.html#term-iterable">iterable</a> است؛ یعنی برای استفاده به‌عنوان هدف تابع‌ها و ساختارهایی مناسب است که انتظار دارند چیزی وجود داشته باشد که بتوانند از آن آیتم‌های متوالی را تا زمانی که چیزی باقی نمانده است دریافت کنند. دیدیم که دستور <a class="reference internal" href="../reference/compound_stmts.html#for"><code class="xref std std-keyword docutils literal notranslate">for</code></a> چنین ساختاری است، در حالی که نمونه‌ای از تابعی که یک شیء تکرارپذیر دریافت می‌کند <a class="reference internal" href="../library/functions.html#sum" title="sum"><code class="xref py py-func docutils literal notranslate">sum()</code></a> است:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> sum(range(4)) # 0 + 1 + 2 + 3

6

</pre></div>

</div>

بعداً تابع‌های بیشتری را خواهیم دید که اشیای تکرارپذیر برمی‌گردانند و اشیای تکرارپذیر را به‌عنوان آرگومان دریافت می‌کنند. در فصل <a class="reference internal" href="datastructures.html#tut-structures">ساختمان داده‌ها</a>، دربارهٔ <a class="reference internal" href="../library/stdtypes.html#list" title="list"><code class="xref py py-func docutils literal notranslate">list()</code></a> با جزئیات بیشتری صحبت خواهیم کرد.

</section>

<h2>4.4. دستورهای <code class="xref std std-keyword docutils literal notranslate">break</code> و <code class="xref std std-keyword docutils literal notranslate">continue</code><a class="headerlink" href="#break-and-continue-statements" title="Link to this heading">¶</a></h2>

دستور <a class="reference internal" href="../reference/simple_stmts.html#break"><code class="xref std std-keyword docutils literal notranslate">break</code></a> از داخلی‌ترین حلقهٔ محصورکنندهٔ <a class="reference internal" href="../reference/compound_stmts.html#for"><code class="xref std std-keyword docutils literal notranslate">for</code></a> یا <a class="reference internal" href="../reference/compound_stmts.html#while"><code class="xref std std-keyword docutils literal notranslate">while</code></a> خارج می‌شود:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> for n in range(2, 10):

... for x in range(2, n):

... if n % x == 0:

... print(f"{n} equals {x} * {n//x}")

... break

...

4 equals 2 * 2

6 equals 2 * 3

8 equals 2 * 4

9 equals 3 * 3

</pre></div>

</div>

دستور <a class="reference internal" href="../reference/simple_stmts.html#continue"><code class="xref std std-keyword docutils literal notranslate">continue</code></a> به تکرار بعدی حلقه ادامه می‌دهد:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> for num in range(2, 10):

... if num % 2 == 0:

... print(f"Found an even number {num}")

... continue

... print(f"Found an odd number {num}")

...

Found an even number 2

Found an odd number 3

Found an even number 4

Found an odd number 5

Found an even number 6

Found an odd number 7

Found an even number 8

Found an odd number 9

</pre></div>

</div>

</section>

در یک حلقهٔ <code class="xref std std-keyword docutils literal notranslate">for</code> یا <code class="xref std std-keyword docutils literal notranslate">while</code>، دستور <code class="xref std std-keyword docutils literal notranslate">break</code> می‌تواند با یک بخش <code class="xref std std-keyword docutils literal notranslate">else</code> همراه شود. اگر حلقه بدون اجرای <code class="xref std std-keyword docutils literal notranslate">break</code> به پایان برسد، بخش <code class="xref std std-keyword docutils literal notranslate">else</code> اجرا می‌شود.

در یک حلقهٔ <a class="reference internal" href="../reference/compound_stmts.html#for"><code class="xref std std-keyword docutils literal notranslate">for</code></a>، بخش <code class="xref std std-keyword docutils literal notranslate">else</code> پس از پایان آخرین تکرار حلقه اجرا می‌شود؛ یعنی زمانی که هیچ breakای رخ نداده باشد.

در یک حلقهٔ <a class="reference internal" href="../reference/compound_stmts.html#while"><code class="xref std std-keyword docutils literal notranslate">while</code></a>، این بخش پس از نادرست شدن شرط حلقه اجرا می‌شود.

در هر دو نوع حلقه، بخش <code class="xref std std-keyword docutils literal notranslate">else</code> در صورتی اجرا نمی‌شود که حلقه توسط یک <a class="reference internal" href="../reference/simple_stmts.html#break"><code class="xref std std-keyword docutils literal notranslate">break</code></a> خاتمه یافته باشد. البته روش‌های دیگر پایان زودهنگام حلقه، مانند یک <a class="reference internal" href="../reference/simple_stmts.html#return"><code class="xref std std-keyword docutils literal notranslate">return</code></a> یا ایجاد شدن یک استثنا، نیز اجرای بخش <a class="reference internal" href="../reference/compound_stmts.html#else"><code class="xref std std-keyword docutils literal notranslate">else</code></a> را رد می‌کنند.

این موضوع در حلقهٔ <code class="xref std std-keyword docutils literal notranslate">for</code> زیر نشان داده شده است که به دنبال اعداد اول می‌گردد:

... print(n, 'equals', x, '*', n//x)

... break

... else:

... # حلقه بدون پیدا کردن هیچ مقسوم‌علیهی به پایان رسید

... print(n, 'is a prime number')

...

2 is a prime number

3 is a prime number

4 equals 2 * 2

5 is a prime number

6 equals 2 * 3

7 is a prime number

8 equals 2 * 4

9 equals 3 * 3

</pre></div>

</div>

(بله، این کد درست است. با دقت نگاه کنید: بخش <code class="docutils literal notranslate">else</code> به حلقهٔ <code class="docutils literal notranslate">for</code> تعلق دارد، نه به دستور <code class="docutils literal notranslate">if</code>.)

یک راه برای فکر کردن دربارهٔ بخش else این است که تصور کنید با دستور <code class="docutils literal notranslate">if</code> داخل حلقه جفت شده است. هنگام اجرای حلقه، دنباله‌ای مانند if/if/if/else اجرا می‌شود. دستور <code class="docutils literal notranslate">if</code> داخل حلقه قرار دارد و چندین بار بررسی می‌شود. اگر شرط هرگز درست شود، یک <code class="docutils literal notranslate">break</code> رخ می‌دهد. اگر شرط هیچ‌گاه درست نشود، بخش <code class="docutils literal notranslate">else</code> خارج از حلقه اجرا خواهد شد.

هنگام استفاده از یک حلقه، بخش <code class="docutils literal notranslate">else</code> شباهت بیشتری به بخش <code class="docutils literal notranslate">else</code> دستور <a class="reference internal" href="../reference/compound_stmts.html#try"><code class="xref std std-keyword docutils literal notranslate">try</code></a> دارد تا دستورهای <code class="docutils literal notranslate">if</code>: بخش <code class="docutils literal notranslate">else</code> یک دستور <code class="docutils literal notranslate">try</code> زمانی اجرا می‌شود که هیچ استثنایی رخ ندهد، و بخش <code class="docutils literal notranslate">else</code> یک حلقه زمانی اجرا می‌شود که هیچ <code class="docutils literal notranslate">break</code> ای رخ ندهد. برای اطلاعات بیشتر دربارهٔ دستور <code class="docutils literal notranslate">try</code> و استثناها، به <a class="reference internal" href="errors.html#tut-handling">مدیریت استثناها</a> مراجعه کنید.

</section>

<h2>4.6. دستورهای <code class="xref std std-keyword docutils literal notranslate">pass</code><a class="headerlink" href="#pass-statements" title="Link to this heading">¶</a></h2>

دستور <a class="reference internal" href="../reference/simple_stmts.html#pass"><code class="xref std std-keyword docutils literal notranslate">pass</code></a> هیچ کاری انجام نمی‌دهد. زمانی می‌توان از آن استفاده کرد که از نظر نحوی وجود یک دستور لازم باشد، اما برنامه به هیچ عملی نیاز نداشته باشد. برای مثال:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> while True:

... pass # انتظار فعال برای وقفه‌ی صفحه‌کلید (Ctrl+C)

...

</pre></div>

</div>

این دستور معمولاً برای ایجاد کلاس‌های حداقلی استفاده می‌شود:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> class MyEmptyClass:

... pass

...

</pre></div>

</div>

جای دیگری که می‌توان از <a class="reference internal" href="../reference/simple_stmts.html#pass"><code class="xref std std-keyword docutils literal notranslate">pass</code></a> استفاده کرد، به‌عنوان جای‌نگهدار برای بدنهٔ یک تابع یا شرط در زمانی است که روی کد جدید کار می‌کنید؛ این کار به شما اجازه می‌دهد در سطح انتزاعی‌تری به فکر کردن ادامه دهید. <code class="xref std std-keyword docutils literal notranslate">pass</code> به‌صورت بی‌صدا نادیده گرفته می‌شود:

... pass # فراموش نکنید این تابع را پیاده‌سازی کنید!

...

</pre></div>

</div>

برای حالت آخر، بسیاری از افراد به‌جای <code class="code docutils literal notranslate">pass</code> از مقدار لفظی بیضی <code class="code docutils literal notranslate">...</code> استفاده می‌کنند. این استفاده هیچ معنای ویژه‌ای برای پایتون ندارد و بخشی از تعریف زبان نیست (در اینجا می‌توانستید از هر عبارت ثابتی استفاده کنید)، اما <code class="code docutils literal notranslate">...</code> به‌صورت قراردادی به‌عنوان بدنهٔ جای‌نگهدار نیز استفاده می‌شود. به <a class="reference internal" href="../library/stdtypes.html#bltin-ellipsis-object">The Ellipsis Object</a> مراجعه کنید.

</section>

<h2>4.7. <code class="xref std std-keyword docutils literal notranslate">match</code> دستورات<a class="headerlink" href="#match-statements" title="Link to this heading">¶</a></h2>

یک دستور <a class="reference internal" href="../reference/compound_stmts.html#match"><code class="xref std std-keyword docutils literal notranslate">match</code></a> یک عبارت را دریافت می‌کند و مقدار آن را با الگوهای متوالی که در یک یا چند بلوک case ارائه شده‌اند مقایسه می‌کند. این دستور در ظاهر شبیه دستور switch در C، Java یا JavaScript (و بسیاری از زبان‌های دیگر) است، اما شباهت بیشتری به تطبیق الگو (pattern matching) در زبان‌هایی مانند Rust یا Haskell دارد. تنها اولین الگویی که تطبیق پیدا کند اجرا می‌شود و این دستور همچنین می‌تواند اجزا (عناصر دنباله یا ویژگی‌های شیء) را از مقدار استخراج کرده و در متغیرها قرار دهد. اگر هیچ caseای تطبیق پیدا نکند، هیچ‌یک از شاخه‌ها اجرا نمی‌شوند.

ساده‌ترین شکل، یک مقدار موضوع را با یک یا چند مقدار لفظی مقایسه می‌کند:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>def http_error(status):

match status:

case 400:

return "Bad request"

case 404:

return "Not found"

case 418:

return "I'm a teapot"

case _:

return "Something's wrong with the internet"

</pre></div>

</div>

به آخرین بلوک توجه کنید: «نام متغیر» <code class="docutils literal notranslate">_</code> به‌عنوان یک wildcard عمل می‌کند و هرگز در تطبیق شکست نمی‌خورد.

می‌توانید چند مقدار لفظی را با استفاده از <code class="docutils literal notranslate">|</code> («یا») در یک الگو ترکیب کنید:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>case 401 | 403 | 404:

return "Not allowed"

</pre></div>

</div>

الگوها می‌توانند شبیه انتساب‌های واگشایی (unpacking assignments) باشند و برای مقداردهی به متغیرها استفاده شوند:

<div class="highlight-python3 notranslate"><div class="highlight"><pre># نقطه یک تاپل (x, y) است

match point:

case (0, 0):

print("Origin")

case (0, y):

print(f"Y={y}")

case (x, 0):

case (x, y):

print(f"X={x}, Y={y}")

case _:

raise ValueError("Not a point")

</pre></div>

</div>

این مورد را با دقت بررسی کنید! الگوی اول دو مقدار لفظی دارد و می‌توان آن را گسترشی از الگوی لفظی نشان‌داده‌شده در بالا در نظر گرفت. اما دو الگوی بعدی یک مقدار لفظی و یک متغیر را ترکیب می‌کنند، و متغیر یک مقدار را از موضوع (<code class="docutils literal notranslate">point</code>) دریافت می‌کند. الگوی چهارم دو مقدار را دریافت می‌کند، که از نظر مفهومی شبیه به انتساب واگشاییٔ <code class="docutils literal notranslate">(x, y) = point</code> است.

اگر برای ساختاربندی داده‌های خود از کلاس‌ها استفاده می‌کنید، می‌توانید نام کلاس را به‌همراه فهرستی از آرگومان‌ها که شبیه سازنده است استفاده کنید، اما با قابلیت دریافت ویژگی‌ها در متغیرها:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>class Point:

def __init__(self, x, y):

self.x = x

self.y = y

def where_is(point):

match point:

case Point(x=0, y=0):

print("Origin")

case Point(x=x, y=0):

case Point():

print("Somewhere else")

case _:

print("Not a point")

</pre></div>

</div>

می‌توانید از پارامترهای موقعیتی با برخی کلاس‌های داخلی که برای ویژگی‌های خود ترتیب مشخصی ارائه می‌کنند (برای مثال dataclassها) استفاده کنید. همچنین می‌توانید با تنظیم ویژگی ویژهٔ <code class="docutils literal notranslate">__match_args__</code> در کلاس‌های خود، موقعیت مشخصی برای ویژگی‌ها در الگوها تعریف کنید. اگر این ویژگی روی ("x", "y") تنظیم شده باشد، الگوهای زیر همگی معادل هستند (و همگی ویژگی <code class="docutils literal notranslate">y</code> را در متغیر <code class="docutils literal notranslate">var</code> قرار می‌دهند):

<div class="highlight-python3 notranslate"><div class="highlight"><pre>Point(1, var)

Point(1, y=var)

Point(x=1, y=var)

Point(y=var, x=1)

</pre></div>

</div>

روش پیشنهادی برای خواندن الگوها این است که آن‌ها را شکل گسترش‌یافته‌ای از چیزی در نظر بگیرید که در سمت چپ یک انتساب قرار می‌دهید، تا متوجه شوید چه متغیرهایی با چه مقادیری تنظیم خواهند شد. تنها نام‌های مستقل (مانند <code class="docutils literal notranslate">var</code> در بالا) توسط دستور match مقداردهی می‌شوند. نام‌های نقطه‌ای (مانند <code class="docutils literal notranslate">foo.bar</code>)، نام ویژگی‌ها (مانند <code class="docutils literal notranslate">x=</code> و <code class="docutils literal notranslate">y=</code> در بالا) یا نام کلاس‌ها (که با (...) کنار آن‌ها، مانند <code class="docutils literal notranslate">Point</code> در بالا، شناخته می‌شوند) هرگز مقداردهی نمی‌شوند.

الگوها می‌توانند به‌صورت دلخواه تو‌در‌تو باشند. برای مثال، اگر یک فهرست کوتاه از Pointها داشته باشیم و <code class="docutils literal notranslate">__match_args__</code> را به آن‌ها اضافه کرده باشیم، می‌توانیم آن را به این شکل تطبیق دهیم:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>class Point:

__match_args__ = ('x', 'y')

self.x = x

self.y = y

match points:

case []:

print("No points")

print("The origin")

case [Point(x, y)]:

print(f"Single point {x}, {y}")

case [Point(0, y1), Point(0, y2)]:

print(f"Two on the Y axis at {y1}, {y2}")

case _:

print("Something else")

</pre></div>

</div>

می‌توانیم یک بخش <code class="docutils literal notranslate">if</code> به یک الگو اضافه کنیم که به آن «نگهبان» (guard) گفته می‌شود. اگر نگهبان نادرست باشد، <code class="docutils literal notranslate">match</code> به تلاش برای بلوک case بعدی ادامه می‌دهد. توجه کنید که دریافت مقدار پیش از ارزیابی نگهبان انجام می‌شود:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>match point:

case Point(x, y) if x == y:

print(f"Y=X at {x}")

case Point(x, y):

print(f"Not on the diagonal")

</pre></div>

</div>

چند ویژگی کلیدی دیگر این دستور:

<ul>

<li>مانند انتساب‌های واگشایی، الگوهای تاپل و فهرست دقیقاً معنای یکسانی دارند و در واقع با دنباله‌های دلخواه تطبیق پیدا می‌کنند. یک استثنای مهم این است که آن‌ها با تکرارگرها یا رشته‌ها تطبیق پیدا نمی‌کنند.</li>

<li>الگوهای دنباله‌ای از واگشاییٔ گسترده پشتیبانی می‌کنند: <code class="docutils literal notranslate">[x, y, *rest]</code> و <code class="docutils literal notranslate">(x, y, *rest)</code> مشابه انتساب‌های واگشایی عمل می‌کنند. نام پس از <code class="docutils literal notranslate">*</code> نیز می‌تواند <code class="docutils literal notranslate">_</code> باشد، بنابراین <code class="docutils literal notranslate">(x, y, *_)</code> با دنباله‌ای دارای حداقل دو آیتم تطبیق پیدا می‌کند، بدون اینکه آیتم‌های باقی‌مانده را در متغیری قرار دهد.</li>

<li>الگوهای نگاشتی: <code class="docutils literal notranslate">{"bandwidth": b, "latency": l}</code> مقادیر <code class="docutils literal notranslate">"bandwidth"</code> و <code class="docutils literal notranslate">"latency"</code> را از یک دیکشنری دریافت می‌کند. برخلاف الگوهای دنباله‌ای، کلیدهای اضافی نادیده گرفته می‌شوند. واگشایی‌ای مانند <code class="docutils literal notranslate">**rest</code> نیز پشتیبانی می‌شود. (اما <code class="docutils literal notranslate">**_</code> اضافی است، بنابراین مجاز نیست.)</li>

<li>زیرالگوها را می‌توان با استفاده از کلیدواژهٔ <code class="docutils literal notranslate">as</code> دریافت کرد:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>case (Point(x1, y1), Point(x2, y2) as p2): ...

</pre></div>

</div>

عنصر دوم ورودی را به‌عنوان <code class="docutils literal notranslate">p2</code> دریافت می‌کند (تا زمانی که ورودی یک دنبالهٔ دو عضوی از نقاط باشد)

</li>

<li>بیشتر مقادیر لفظی با استفاده از برابری مقایسه می‌شوند، اما تک‌نمونه‌های <code class="docutils literal notranslate">True</code>، <code class="docutils literal notranslate">False</code> و <code class="docutils literal notranslate">None</code> با استفاده از هویت مقایسه می‌شوند.</li>

<li>الگوها می‌توانند از ثابت‌های نام‌گذاری‌شده استفاده کنند. این‌ها باید نام‌های نقطه‌ای باشند تا از تفسیر شدن آن‌ها به‌عنوان متغیرهای دریافت‌کننده جلوگیری شود:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>from enum import Enum

class Color(Enum):

RED = 'red'

GREEN = 'green'

BLUE = 'blue'

color = Color(input("Enter your choice of 'red', 'blue' or 'green': "))

match color:

case Color.RED:

print("I see red!")

case Color.GREEN:

print("Grass is green")

case Color.BLUE:

print("I'm feeling the blues :(")

</pre></div>

</div>

</li>

</ul>

برای توضیح دقیق‌تر و نمونه‌های بیشتر، می‌توانید به <a class="pep reference external" href="https://peps.python.org/pep-0636/">PEP 636</a> مراجعه کنید که با قالب یک آموزش نوشته شده است.

</section>

<h2>4.8. تعریف توابع<a class="headerlink" href="#defining-functions" title="Link to this heading">¶</a></h2>

می‌توانیم تابعی ایجاد کنیم که سری فیبوناچی را تا یک کران دلخواه بنویسد:

... """Print a Fibonacci series less than n."""

... a, b = 0, 1

... while a < n:

... print(a, end=' ')

... a, b = b, a+b

... print()

...

>>> # اکنون تابعی را که تعریف کردیم فراخوانی می‌کنیم:

>>> fib(2000)

0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987 1597

</pre></div>

</div>

کلیدواژهٔ <a class="reference internal" href="../reference/compound_stmts.html#def"><code class="xref std std-keyword docutils literal notranslate">def</code></a> یک تعریف تابع را معرفی می‌کند. این کلیدواژه باید پس از خود نام تابع و فهرست پارامترهای رسمی درون پرانتز بیاید. دستورهایی که بدنهٔ تابع را تشکیل می‌دهند از خط بعدی شروع می‌شوند و باید تورفتگی داشته باشند.

اولین دستور بدنهٔ تابع می‌تواند به‌صورت اختیاری یک رشتهٔ لفظی باشد؛ این رشتهٔ لفظی، رشتهٔ مستندات تابع یا docstring است. (اطلاعات بیشتر دربارهٔ رشته‌های مستندات را می‌توانید در بخش <a class="reference internal" href="#tut-docstrings">رشته‌های مستندسازی</a> پیدا کنید.) ابزارهایی وجود دارند که از docstringها برای تولید خودکار مستندات آنلاین یا چاپی، یا برای اجازه دادن به کاربر جهت مرور تعاملی کد استفاده می‌کنند؛ بهتر است در کدی که می‌نویسید docstringها را قرار دهید، بنابراین آن را به یک عادت تبدیل کنید.

اجرای یک تابع، یک جدول نماد جدید ایجاد می‌کند که برای متغیرهای محلی تابع استفاده می‌شود. به‌طور دقیق‌تر، تمام انتساب‌های متغیر در یک تابع، مقدار را در جدول نماد محلی ذخیره می‌کنند؛ در حالی که ارجاع‌های متغیر ابتدا در جدول نماد محلی، سپس در جدول‌های نماد محلی تابع‌های دربرگیرنده، سپس در جدول نماد سراسری، و در نهایت در جدول نام‌های داخلی جست‌وجو می‌شوند. بنابراین، متغیرهای سراسری و متغیرهای تابع‌های دربرگیرنده نمی‌توانند مستقیماً درون یک تابع مقداردهی شوند (مگر اینکه برای متغیرهای سراسری با یک دستور <a class="reference internal" href="../reference/simple_stmts.html#global"><code class="xref std std-keyword docutils literal notranslate">global</code></a>، یا برای متغیرهای تابع‌های دربرگیرنده با یک دستور <a class="reference internal" href="../reference/simple_stmts.html#nonlocal"><code class="xref std std-keyword docutils literal notranslate">nonlocal</code></a> نام‌گذاری شده باشند)، اگرچه می‌توان به آن‌ها ارجاع داد.

پارامترهای واقعی (آرگومان‌ها) در یک فراخوانی تابع، هنگام فراخوانی تابع در جدول نماد محلی تابع فراخوانی‌شده قرار می‌گیرند؛ بنابراین، آرگومان‌ها با استفاده از انتقال با مقدار (call by value) ارسال می‌شوند (که در آن مقدار همیشه یک ارجاع به شیء است، نه مقدار خود شیء). <a class="footnote-reference brackets" href="#id2" id="id1" role="doc-noteref">[1]</a> هنگامی که یک تابع، تابع دیگری را فراخوانی می‌کند یا به‌صورت بازگشتی خودش را فراخوانی می‌کند، یک جدول نماد محلی جدید برای آن فراخوانی ایجاد می‌شود.

یک تعریف تابع، نام تابع را با شیء تابع در جدول نماد فعلی مرتبط می‌کند. مفسر شیئی را که آن نام به آن اشاره می‌کند به‌عنوان یک تابع تعریف‌شده توسط کاربر تشخیص می‌دهد. نام‌های دیگر نیز می‌توانند به همان شیء تابع اشاره کنند و برای دسترسی به تابع استفاده شوند:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> fib

>>> f = fib

>>> f(100)

0 1 1 2 3 5 8 13 21 34 55 89

</pre></div>

</div>

اگر از زبان‌های دیگر آمده باشید، ممکن است اعتراض کنید که <code class="docutils literal notranslate">fib</code> یک تابع نیست، بلکه یک رویه (procedure) است، زیرا مقداری برنمی‌گرداند. در واقع، حتی تابع‌هایی که دستور <a class="reference internal" href="../reference/simple_stmts.html#return"><code class="xref std std-keyword docutils literal notranslate">return</code></a> ندارند نیز یک مقدار برمی‌گردانند، هرچند مقدار نسبتاً بی‌اهمیتی است. این مقدار <code class="docutils literal notranslate">None</code> نام دارد (که یک نام داخلی است). نوشتن مقدار <code class="docutils literal notranslate">None</code> معمولاً توسط مفسر حذف می‌شود اگر تنها مقداری باشد که قرار است نوشته شود. اگر واقعاً بخواهید می‌توانید آن را با استفاده از <a class="reference internal" href="../library/functions.html#print" title="print"><code class="xref py py-func docutils literal notranslate">print()</code></a> ببینید:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> fib(0)

>>> print(fib(0))

None

</pre></div>

</div>

نوشتن تابعی که به‌جای چاپ کردن سری فیبوناچی، فهرستی از اعداد آن را برگرداند ساده است:

... """Return a list containing the Fibonacci series up to n."""

... result = []

... while a < n:

... result.append(a) # توضیح زیر را ببینید

... return result

...

>>> f100 = fib2(100) # فراخوانی تابع

>>> f100 # نمایش نتیجه

[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]

</pre></div>

</div>

این مثال، مانند همیشه، چند ویژگی جدید پایتون را نشان می‌دهد:

<li>دستور <a class="reference internal" href="../reference/simple_stmts.html#return"><code class="xref std std-keyword docutils literal notranslate">return</code></a> یک مقدار را از یک تابع برمی‌گرداند. <code class="xref std std-keyword docutils literal notranslate">return</code> بدون یک آرگومان عبارت، <code class="docutils literal notranslate">None</code> را برمی‌گرداند. رسیدن به انتهای یک تابع نیز <code class="docutils literal notranslate">None</code> را برمی‌گرداند.</li>

<li>دستور <code class="docutils literal notranslate">result.append(a)</code> یک متد از شیء فهرست <code class="docutils literal notranslate">result</code> را فراخوانی می‌کند. یک متد تابعی است که به یک شیء «تعلق دارد» و با قالب <code class="docutils literal notranslate">obj.methodname</code> نام‌گذاری می‌شود؛ در اینجا <code class="docutils literal notranslate">obj</code> یک شیء (که می‌تواند یک عبارت باشد) و <code class="docutils literal notranslate">methodname</code> نام متدی است که توسط نوع شیء تعریف شده است. نوع‌های مختلف، متدهای متفاوتی تعریف می‌کنند. متدهای نوع‌های مختلف می‌توانند نام یکسانی داشته باشند، بدون اینکه ابهامی ایجاد شود. (می‌توان با استفاده از کلاس‌ها نوع‌ها و متدهای شیء سفارشی خود را تعریف کرد؛ به <a class="reference internal" href="classes.html#tut-classes">کلاسها</a> مراجعه کنید.) متد <a class="reference internal" href="../library/stdtypes.html#list.append" title="list.append"><code class="xref py py-meth docutils literal notranslate">append()</code></a> که در مثال نشان داده شده است برای اشیای فهرست تعریف شده است؛ این متد یک عنصر جدید را به انتهای فهرست اضافه می‌کند. در این مثال، معادل <code class="docutils literal notranslate">result = result + [a]</code> است، اما کارآمدتر است.</li>

</ul>

</section>

<h2>4.9. اطلاعات بیشتر دربارهٔ تعریف تابع‌ها<a class="headerlink" href="#more-on-defining-functions" title="Link to this heading">¶</a></h2>

همچنین امکان تعریف تابع‌هایی با تعداد متغیری از آرگومان‌ها وجود دارد. سه شکل وجود دارد که می‌توان آن‌ها را با یکدیگر ترکیب کرد.

<h3>4.9.1. مقدارهای پیش‌فرض آرگومان‌ها<a class="headerlink" href="#default-argument-values" title="Link to this heading">¶</a></h3>

کاربردی‌ترین شکل، مشخص کردن یک مقدار پیش‌فرض برای یک یا چند آرگومان است. این کار تابعی ایجاد می‌کند که می‌توان آن را با آرگومان‌های کمتری نسبت به تعداد تعریف‌شده فراخوانی کرد. برای مثال:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>def ask_ok(prompt, retries=4, reminder='Please try again!'):

while True:

reply = input(prompt)

if reply in {'y', 'ye', 'yes'}:

return True

if reply in {'n', 'no', 'nop', 'nope'}:

return False

retries = retries - 1

if retries < 0:

raise ValueError('invalid user response')

print(reminder)

</pre></div>

</div>

این تابع را می‌توان به چند روش فراخوانی کرد:

<li>فقط با دادن آرگومان اجباری: <code class="docutils literal notranslate">ask_ok('Do you really want to quit?')</code></li>

<li>با دادن یکی از آرگومان‌های اختیاری: <code class="docutils literal notranslate">ask_ok('OK to overwrite the file?', 2)</code></li>

<li>یا حتی با دادن همهٔ آرگومان‌ها: <code class="docutils literal notranslate">ask_ok('OK to overwrite the file?', 2, 'Come on, only yes or no!')</code></li>

</ul>

این مثال همچنین کلیدواژهٔ <a class="reference internal" href="../reference/expressions.html#in"><code class="xref std std-keyword docutils literal notranslate">in</code></a> را معرفی می‌کند. این کلیدواژه بررسی می‌کند که آیا یک دنباله مقدار مشخصی را در خود دارد یا خیر.

مقدارهای پیش‌فرض در نقطهٔ تعریف تابع و در محدودهٔ تعریف‌کننده (defining scope) ارزیابی می‌شوند، بنابراین

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

def f(arg=i):

print(arg)

i = 6

f()

</pre></div>

</div>

<code class="docutils literal notranslate">5</code> را چاپ خواهد کرد.

هشدار مهم: مقدار پیش‌فرض فقط یک‌بار ارزیابی می‌شود. این موضوع زمانی تفاوت ایجاد می‌کند که مقدار پیش‌فرض یک شیء قابل تغییر مانند یک فهرست، دیکشنری، یا نمونه‌ای از بیشتر کلاس‌ها باشد. برای مثال، تابع زیر آرگومان‌هایی را که در فراخوانی‌های بعدی به آن داده می‌شوند جمع‌آوری می‌کند:

L.append(a)

return L

print(f(1))

print(f(2))

print(f(3))

</pre></div>

</div>

این دستور چاپ خواهد کرد

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

[1, 2]

[1, 2, 3]

</pre></div>

</div>

اگر نمی‌خواهید مقدار پیش‌فرض بین فراخوانی‌های بعدی به اشتراک گذاشته شود، می‌توانید تابع را به این شکل بنویسید:

if L is None:

L = []

L.append(a)

return L

</pre></div>

</div>

</section>

<h3>4.9.2. آرگومان‌های کلیدواژه‌ای<a class="headerlink" href="#keyword-arguments" title="Link to this heading">¶</a></h3>

تابع‌ها همچنین می‌توانند با استفاده از <a class="reference internal" href="../glossary.html#term-keyword-argument">keyword arguments</a> به شکل <code class="docutils literal notranslate">kwarg=value</code> فراخوانی شوند. برای نمونه، تابع زیر:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>def parrot(voltage, state='a stiff', action='voom', type='Norwegian Blue'):

print("-- This parrot wouldn't", action, end=' ')

print("if you put", voltage, "volts through it.")

print("-- Lovely plumage, the", type)

print("-- It's", state, "!")

</pre></div>

</div>

یک آرگومان اجباری (<code class="docutils literal notranslate">voltage</code>) و سه آرگومان اختیاری (<code class="docutils literal notranslate">state</code>، <code class="docutils literal notranslate">action</code> و <code class="docutils literal notranslate">type</code>) را می‌پذیرد. این تابع می‌تواند به هر یک از روش‌های زیر فراخوانی شود:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>parrot(1000) # یک آرگومان موقعیتی

parrot(voltage=1000) # یک آرگومان کلیدواژه‌ای

parrot(voltage=1000000, action='VOOOOOM') # دو آرگومان کلیدواژه‌ای

parrot(action='VOOOOOM', voltage=1000000) # دو آرگومان کلیدواژه‌ای

parrot('a million', 'bereft of life', 'jump') # سه آرگومان موقعیتی

parrot('a thousand', state='pushing up the daisies') # یک آرگومان موقعیتی، یک آرگومان کلیدواژه‌ای

</pre></div>

</div>

اما تمام فراخوانی‌های زیر نامعتبر خواهند بود:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>parrot() # آرگومان الزامی وارد نشده است

parrot(voltage=5.0, 'dead') # آرگومان غیرکلیدواژه‌ای پس از آرگومان کلیدواژه‌ای آمده است

parrot(110, voltage=220) # مقدار تکراری برای یک آرگومان یکسان

parrot(actor='John Cleese') # آرگومان کلیدواژه‌ای ناشناخته

</pre></div>

</div>

در یک فراخوانی تابع، آرگومان‌های کلیدواژه‌ای باید پس از آرگومان‌های موقعیتی بیایند. تمام آرگومان‌های کلیدواژه‌ای ارسال‌شده باید با یکی از آرگومان‌های پذیرفته‌شده توسط تابع مطابقت داشته باشند (برای مثال، <code class="docutils literal notranslate">actor</code> یک آرگومان معتبر برای تابع <code class="docutils literal notranslate">parrot</code> نیست)، و ترتیب آن‌ها اهمیتی ندارد. این موضوع شامل آرگومان‌های غیر‌اختیاری نیز می‌شود (برای مثال، <code class="docutils literal notranslate">parrot(voltage=1000)</code> نیز معتبر است). هیچ آرگومانی نمی‌تواند بیش از یک‌بار مقدار دریافت کند. در اینجا مثالی وجود دارد که به دلیل این محدودیت شکست می‌خورد:

... pass

...

>>> function(0, a=0)

Traceback (most recent call last):

File "<stdin>", line 1, in <module>

TypeError: function() got multiple values for argument 'a'

</pre></div>

</div>

هنگامی که یک پارامتر رسمی نهایی به شکل <code class="docutils literal notranslate">**name</code> وجود داشته باشد، یک فرهنگ لغت (به <a class="reference internal" href="../library/stdtypes.html#typesmapping">Mapping Types --- dict</a> مراجعه کنید) دریافت می‌کند که شامل تمام آرگومان‌های کلیدواژه‌ای است، به‌جز آن‌هایی که متناظر با یک پارامتر رسمی هستند. این مورد می‌تواند با یک پارامتر رسمی به شکل <code class="docutils literal notranslate">*name</code> ترکیب شود (که در زیربخش بعدی توضیح داده شده است)؛ این پارامتر یک <a class="reference internal" href="datastructures.html#tut-tuples">tuple</a> دریافت می‌کند که شامل آرگومان‌های موقعیتی فراتر از فهرست پارامترهای رسمی است. (<code class="docutils literal notranslate">*name</code> باید پیش از <code class="docutils literal notranslate">**name</code> قرار گیرد.) برای مثال، اگر تابعی مانند زیر تعریف کنیم:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>def cheeseshop(kind, *arguments, **keywords):

print("-- Do you have any", kind, "?")

print("-- I'm sorry, we're all out of", kind)

for arg in arguments:

print(arg)

print("-" * 40)

for kw in keywords:

print(kw, ":", keywords[kw])

</pre></div>

</div>

میتواند اینگونه فراخوانده شود:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>cheeseshop("Limburger", "It's very runny, sir.",

"It's really very, VERY runny, sir.",

shopkeeper="Michael Palin",

client="John Cleese",

sketch="Cheese Shop Sketch")

</pre></div>

</div>

و قطعا این دستور چاپ خواهد کرد:

<div class="highlight-none notranslate"><div class="highlight"><pre>-- Do you have any Limburger ?

-- I'm sorry, we're all out of Limburger

It's very runny, sir.

It's really very, VERY runny, sir.

----------------------------------------

shopkeeper : Michael Palin

client : John Cleese

sketch : Cheese Shop Sketch

</pre></div>

</div>

توجه داشته باشید که ترتیب چاپ آرگومان‌های کلیدواژه‌ای تضمین شده است که با ترتیبی که در فراخوانی تابع ارائه شده‌اند مطابقت داشته باشد.

</section>

<h3>4.9.3. پارامترهای ویژه<a class="headerlink" href="#special-parameters" title="Link to this heading">¶</a></h3>

به طور پیش‌فرض، آرگومان‌ها را می‌توان در یک تابع پایتون یا با استفاده از موقعیت یا به‌صورت صریح با کلیدواژه ارسال کرد. برای خوانایی و کارایی، منطقی است که نحوه ارسال آرگومان‌ها را محدود کنیم تا یک توسعه‌دهنده تنها با نگاه کردن به تعریف تابع بتواند تعیین کند که موارد با موقعیت، با موقعیت یا کلیدواژه، یا فقط با کلیدواژه ارسال می‌شوند.

تعریف یک تابع ممکن است به شکل زیر باشد:

<div class="highlight-none notranslate"><div class="highlight"><pre>def f(pos1, pos2, /, pos_or_kwd, *, kwd1, kwd2):

----------- ---------- ----------

| | |

| Positional or keyword |

| - Keyword only

-- Positional only

</pre></div>

</div>

که در آن <code class="docutils literal notranslate">/</code> و <code class="docutils literal notranslate">*</code> اختیاری هستند. اگر استفاده شوند، این نمادها نوع پارامتر را بر اساس نحوه ارسال آرگومان‌ها به تابع مشخص می‌کنند: فقط موقعیتی، موقعیتی یا کلیدواژه‌ای، و فقط کلیدواژه‌ای. پارامترهای کلیدواژه‌ای همچنین به عنوان پارامترهای نام‌دار شناخته می‌شوند.

<h4>4.9.3.1. آرگومان‌های موقعیتی یا کلیدواژه‌ای<a class="headerlink" href="#positional-or-keyword-arguments" title="Link to this heading">¶</a></h4>

اگر <code class="docutils literal notranslate">/</code> و <code class="docutils literal notranslate">*</code> در تعریف تابع وجود نداشته باشند، آرگومان‌ها را می‌توان با موقعیت یا با کلیدواژه به یک تابع ارسال کرد.

</section>

<h4>4.9.3.2. پارامترهای فقط موقعیتی<a class="headerlink" href="#positional-only-parameters" title="Link to this heading">¶</a></h4>

با بررسی دقیق‌تر، می‌توان برخی پارامترها را به صورت فقط موقعیتی مشخص کرد. اگر فقط موقعیتی باشند، ترتیب پارامترها اهمیت دارد و پارامترها نمی‌توانند با کلیدواژه ارسال شوند. پارامترهای فقط موقعیتی قبل از یک <code class="docutils literal notranslate">/</code> (خط مورب) قرار می‌گیرند. <code class="docutils literal notranslate">/</code> برای جدا کردن منطقی پارامترهای فقط موقعیتی از سایر پارامترها استفاده می‌شود. اگر <code class="docutils literal notranslate">/</code> در تعریف تابع وجود نداشته باشد، هیچ پارامتر فقط موقعیتی وجود ندارد.

پارامترهای پس از <code class="docutils literal notranslate">/</code> می‌توانند موقعیتی یا کلیدواژه‌ای یا فقط کلیدواژه‌ای باشند.

</section>

<h4>4.9.3.3. آرگومان‌های فقط کلیدواژه‌ای<a class="headerlink" href="#keyword-only-arguments" title="Link to this heading">¶</a></h4>

برای مشخص کردن پارامترها به‌عنوان فقط کلیدواژه‌ای، که نشان می‌دهد پارامترها باید با آرگومان کلیدواژه‌ای ارسال شوند، یک <code class="docutils literal notranslate">*</code> را در فهرست آرگومان‌ها درست قبل از اولین پارامتر فقط کلیدواژه‌ای قرار دهید.

</section>

<h4>4.9.3.4. مثال‌های توابع<a class="headerlink" href="#function-examples" title="Link to this heading">¶</a></h4>

تعریف‌های تابع زیر را با دقت بررسی کنید و به نشانه‌های <code class="docutils literal notranslate">/</code> و <code class="docutils literal notranslate">*</code> توجه کنید:

... print(arg)

...

>>> def pos_only_arg(arg, /):

... print(arg)

...

>>> def kwd_only_arg(*, arg):

... print(arg)

...

>>> def combined_example(pos_only, /, standard, *, kwd_only):

... print(pos_only, standard, kwd_only)

</pre></div>

</div>

اولین تعریف تابع، یعنی <code class="docutils literal notranslate">standard_arg</code>، آشناترین شکل است؛ هیچ محدودیتی برای شیوه فراخوانی قرار نمی‌دهد و آرگومان‌ها می‌توانند با موقعیت یا کلیدواژه ارسال شوند:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> standard_arg(2)

2

>>> standard_arg(arg=2)

2

</pre></div>

</div>

تابع دوم، <code class="docutils literal notranslate">pos_only_arg</code>، محدود شده است تا فقط از پارامترهای موقعیتی استفاده کند، زیرا یک <code class="docutils literal notranslate">/</code> در تعریف تابع وجود دارد:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> pos_only_arg(1)

1

>>> pos_only_arg(arg=1)

Traceback (most recent call last):

File "<stdin>", line 1, in <module>

TypeError: pos_only_arg() got some positional-only arguments passed as keyword arguments: 'arg'

</pre></div>

</div>

تابع سوم، <code class="docutils literal notranslate">kwd_only_arg</code>، همان‌طور که وجود یک <code class="docutils literal notranslate">*</code> در تعریف تابع نشان می‌دهد، فقط آرگومان‌های کلیدواژه‌ای را می‌پذیرد:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> kwd_only_arg(3)

Traceback (most recent call last):

File "<stdin>", line 1, in <module>

TypeError: kwd_only_arg() takes 0 positional arguments but 1 was given

>>> kwd_only_arg(arg=3)

3

</pre></div>

</div>

و تابع آخر از هر سه شیوه فراخوانی در یک تعریف تابع استفاده می‌کند:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> combined_example(1, 2, 3)

Traceback (most recent call last):

File "<stdin>", line 1, in <module>

TypeError: combined_example() takes 2 positional arguments but 3 were given

>>> combined_example(1, 2, kwd_only=3)

1 2 3

>>> combined_example(1, standard=2, kwd_only=3)

1 2 3

>>> combined_example(pos_only=1, standard=2, kwd_only=3)

Traceback (most recent call last):

File "<stdin>", line 1, in <module>

TypeError: combined_example() got some positional-only arguments passed as keyword arguments: 'pos_only'

</pre></div>

</div>

در نهایت، این تعریف تابع را در نظر بگیرید که در آن بین آرگومان موقعیتی <code class="docutils literal notranslate">name</code> و <code class="docutils literal notranslate">**kwds</code> که دارای کلیدواژه‌ای به نام <code class="docutils literal notranslate">name</code> است، یک برخورد احتمالی وجود دارد:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>def foo(name, **kwds):

return 'name' in kwds

</pre></div>

</div>

هیچ فراخوانی ممکنی وجود ندارد که باعث شود این تابع مقدار <code class="docutils literal notranslate">True</code> را برگرداند، زیرا کلیدواژه <code class="docutils literal notranslate">'name'</code> همیشه به اولین پارامتر متصل می‌شود. برای مثال:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> foo(1, **{'name': 2})

Traceback (most recent call last):

File "<stdin>", line 1, in <module>

TypeError: foo() got multiple values for argument 'name'

>>>

</pre></div>

</div>

اما با استفاده از <code class="docutils literal notranslate">/</code> (آرگومان‌های فقط موقعیتی)، این امکان وجود دارد، زیرا اجازه می‌دهد <code class="docutils literal notranslate">name</code> به‌عنوان یک آرگومان موقعیتی و <code class="docutils literal notranslate">'name'</code> به‌عنوان یک کلید در آرگومان‌های کلیدواژه‌ای استفاده شود:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> def foo(name, /, **kwds):

... return 'name' in kwds

...

>>> foo(1, **{'name': 2})

True

</pre></div>

</div>

به عبارت دیگر، نام پارامترهای فقط موقعیتی می‌تواند بدون ابهام در <code class="docutils literal notranslate">**kwds</code> استفاده شود.

</section>

<h4>4.9.3.5. خلاصه<a class="headerlink" href="#recap" title="Link to this heading">¶</a></h4>

مورد استفاده تعیین می‌کند که کدام پارامترها را در تعریف تابع استفاده کنید:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>def f(pos1, pos2, /, pos_or_kwd, *, kwd1, kwd2):

</pre></div>

</div>

برای راهنمایی:

<li>اگر می‌خواهید نام پارامترها برای کاربر قابل دسترس نباشد، از فقط-موقعیتی استفاده کنید. این زمانی مفید است که نام پارامترها معنای واقعی ندارند، زمانی که می‌خواهید ترتیب آرگومان‌ها هنگام فراخوانی تابع اجباری باشد، یا زمانی که به تعدادی پارامتر موقعیتی و کلیدواژه‌های دلخواه نیاز دارید.</li>

<li>زمانی که نام‌ها دارای معنا هستند و تعریف تابع با مشخص کردن صریح نام‌ها قابل فهم‌تر می‌شود، یا زمانی که می‌خواهید کاربران به موقعیت آرگومان‌های ارسال‌شده وابسته نشوند، از فقط کلیدواژه‌ای استفاده کنید.</li>

<li>برای یک API، از پارامترهای فقط موقعیتی استفاده کنید تا از شکستن تغییرات API در صورت تغییر نام پارامتر در آینده جلوگیری شود.</li>

</ul>

</section>

<h3>4.9.4. فهرست‌های دلخواه آرگومان‌ها<a class="headerlink" href="#arbitrary-argument-lists" title="Link to this heading">¶</a></h3>

در نهایت، کم‌کاربردترین گزینه این است که مشخص کنید یک تابع می‌تواند با تعداد دلخواهی از آرگومان‌ها فراخوانی شود. این آرگومان‌ها در یک تاپل بسته‌بندی می‌شوند (به <a class="reference internal" href="datastructures.html#tut-tuples">تاپل‌ها و دنباله‌ها</a> مراجعه کنید). پیش از آرگومان‌های با تعداد متغیر، می‌توان صفر یا چند آرگومان معمولی داشت.

<div class="highlight-python3 notranslate"><div class="highlight"><pre>def write_multiple_items(file, separator, *args):

file.write(separator.join(args))

</pre></div>

</div>

معمولاً این آرگومان‌های متغیرتعداد در انتهای فهرست پارامترهای رسمی قرار می‌گیرند، زیرا تمام آرگومان‌های ورودی باقی‌مانده‌ای که به تابع ارسال می‌شوند را جمع‌آوری می‌کنند. هر پارامتر رسمی که پس از پارامتر <code class="docutils literal notranslate">*args</code> قرار گیرد، یک آرگومان «فقط کلیدواژه‌ای» است؛ یعنی فقط می‌تواند به‌عنوان کلیدواژه استفاده شود و نه به صورت آرگومان موقعیتی.

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> def concat(*args, sep="/"):

... return sep.join(args)

...

>>> concat("earth", "mars", "venus")

'earth/mars/venus'

'earth.mars.venus'

</pre></div>

</div>

</section>

<h3>4.9.5. باز کردن بسته آرگومان‌ها<a class="headerlink" href="#unpacking-argument-lists" title="Link to this heading">¶</a></h3>

حالت معکوس زمانی رخ می‌دهد که آرگومان‌ها از قبل در یک فهرست یا تاپل قرار دارند، اما برای فراخوانی تابعی که به آرگومان‌های موقعیتی جداگانه نیاز دارد، باید باز شوند. برای مثال، تابع داخلی <a class="reference internal" href="../library/stdtypes.html#range" title="range"><code class="xref py py-func docutils literal notranslate">range()</code></a> آرگومان‌های جداگانه start و stop را انتظار دارد. اگر این آرگومان‌ها به صورت جداگانه در دسترس نیستند، فراخوانی تابع را با عملگر <code class="docutils literal notranslate">*</code> برای باز کردن آرگومان‌ها از یک فهرست یا تاپل بنویسید:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> list(range(3, 6)) # فراخوانی معمولی با آرگومان‌های جداگانه

[3, 4, 5]

>>> args = [3, 6]

>>> list(range(*args)) # فراخوانی با آرگومان‌های بازشده از یک فهرست

[3, 4, 5]

</pre></div>

</div>

به همین شکل، دیکشنری‌ها می‌توانند با عملگر <code class="docutils literal notranslate">**</code> آرگومان‌های کلیدواژه‌ای فراهم کنند:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> def parrot(voltage, state='a stiff', action='voom'):

... print("-- This parrot wouldn't", action, end=' ')

... print("if you put", voltage, "volts through it.", end=' ')

... print("E's", state, "!")

...

>>> d = {"voltage": "four million", "state": "bleedin' demised", "action": "VOOM"}

>>> parrot(**d)

-- This parrot wouldn't VOOM if you put four million volts through it. E's bleedin' demised !

</pre></div>

</div>

</section>

<h3>4.9.6. عبارت‌های لامبدا<a class="headerlink" href="#lambda-expressions" title="Link to this heading">¶</a></h3>

توابع کوچک بی‌نام را می‌توان با کلیدواژه <a class="reference internal" href="../reference/expressions.html#lambda"><code class="xref std std-keyword docutils literal notranslate">lambda</code></a> ایجاد کرد. این تابع مجموع دو آرگومان خود را برمی‌گرداند: <code class="docutils literal notranslate">lambda a, b: a+b</code>. توابع لامبدا را می‌توان هر جا که به اشیای تابع نیاز باشد استفاده کرد. آن‌ها از نظر نحوی به یک عبارت منفرد محدود هستند. از نظر معنایی، آن‌ها تنها شکری نحوی برای یک تعریف معمولی تابع هستند. مانند تعریف‌های توابع تو‌در‌تو، توابع لامبدا می‌توانند به متغیرهای محدوده‌ی دربرگیرنده دسترسی داشته باشند:

... return lambda x: x + n

...

>>> f = make_incrementor(42)

>>> f(0)

42

>>> f(1)

43

</pre></div>

</div>

مثال بالا از یک عبارت لامبدا برای برگرداندن یک تابع استفاده می‌کند. کاربرد دیگر آن، ارسال یک تابع کوچک به‌عنوان آرگومان است. برای مثال، <a class="reference internal" href="../library/stdtypes.html#list.sort" title="list.sort"><code class="xref py py-meth docutils literal notranslate">list.sort()</code></a> یک تابع کلید مرتب‌سازی key می‌گیرد که می‌تواند یک تابع لامبدا باشد:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> pairs = [(1, 'one'), (2, 'two'), (3, 'three'), (4, 'four')]

>>> pairs.sort(key=lambda pair: pair[1])

>>> pairs

[(4, 'four'), (1, 'one'), (3, 'three'), (2, 'two')]

</pre></div>

</div>

</section>

<h3>4.9.7. رشته‌های مستندسازی<a class="headerlink" href="#documentation-strings" title="Link to this heading">¶</a></h3>

در ادامه، برخی قراردادها دربارهٔ محتوا و قالب‌بندی رشته‌های مستندسازی آمده است.

خط اول باید همیشه یک خلاصهٔ کوتاه و مختصر از هدف شیء باشد. برای کوتاه‌تر بودن، نباید به‌طور صریح نام یا نوع شیء را بیان کند، زیرا این موارد از راه‌های دیگری در دسترس هستند (مگر اینکه نام، خود یک فعل باشد که عملکرد یک تابع را توصیف می‌کند). این خط باید با یک حرف بزرگ شروع شود و با نقطه پایان یابد.

اگر خطوط بیشتری در رشتهٔ مستندسازی وجود دارد، خط دوم باید خالی باشد تا به‌صورت بصری خلاصه را از ادامهٔ توضیحات جدا کند. خطوط بعدی باید شامل یک یا چند پاراگراف باشند که قراردادهای فراخوانی شیء، عوارض جانبی آن و موارد مشابه را توضیح می‌دهند.

تجزیه‌گر پایتون هنگام استفاده از رشته‌های چندخطی به‌عنوان رشته‌های مستندسازی ماژول، کلاس یا تابع، تورفتگی را از آن‌ها حذف می‌کند.

در اینجا یک نمونه از یک رشتهٔ مستندسازی چندخطی آمده است:

... """Do nothing, but document it.

...

... No, really, it doesn't do anything:

...

... >>> my_function()

... >>>

... """

... pass

...

>>> print(my_function.__doc__)

Do nothing, but document it.

No, really, it doesn't do anything:

>>> my_function()

>>>

</pre></div>

</div>

</section>

<h3>4.9.8. حاشیه‌نویسی‌های تابع<a class="headerlink" href="#function-annotations" title="Link to this heading">¶</a></h3>

<a class="reference internal" href="../reference/compound_stmts.html#function">حاشیه‌نویسی‌های تابع</a> فراداده‌های کاملاً اختیاری دربارهٔ نوع‌های استفاده‌شده در توابع تعریف‌شده توسط کاربر هستند (برای اطلاعات بیشتر به <a class="pep reference external" href="https://peps.python.org/pep-3107/">PEP 3107</a> و <a class="pep reference external" href="https://peps.python.org/pep-0484/">PEP 484</a> مراجعه کنید).

<a class="reference internal" href="../glossary.html#term-function-annotation">حاشیه‌نویسی‌ها</a> در ویژگی <a class="reference internal" href="../reference/datamodel.html#object.__annotations__" title="object.__annotations__"><code class="xref py py-attr docutils literal notranslate">__annotations__</code></a> تابع، به‌صورت یک دیکشنری ذخیره می‌شوند و هیچ تأثیری بر بخش دیگری از تابع ندارند. حاشیه‌نویسی پارامترها با قرار دادن یک دونقطه پس از نام پارامتر و سپس یک عبارت که مقدار حاشیه‌نویسی را ارزیابی می‌کند، تعریف می‌شود. حاشیه‌نویسی مقدار بازگشتی با قرار دادن یک نشانهٔ لفظی <code class="docutils literal notranslate">-></code> و سپس یک عبارت، بین فهرست پارامترها و دونقطه‌ای که پایان دستور <a class="reference internal" href="../reference/compound_stmts.html#def"><code class="xref std std-keyword docutils literal notranslate">def</code></a> را مشخص می‌کند، تعریف می‌شود. مثال زیر دارای یک آرگومان اجباری، یک آرگومان اختیاری و مقدار بازگشتیِ حاشیه‌نویسی‌شده است:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> def f(ham: str, eggs: str = 'eggs') -> str:

... print("Annotations:", f.__annotations__)

... print("Arguments:", ham, eggs)

... return ham + ' and ' + eggs

...

>>> f('spam')

Annotations: {'ham': <class 'str'>, 'return': <class 'str'>, 'eggs': <class 'str'>}

Arguments: spam eggs

'spam and eggs'

</pre></div>

</div>

</section>

<h2>4.10. میان‌پرده: سبک کدنویسی<a class="headerlink" href="#intermezzo-coding-style" title="Link to this heading">¶</a></h2>

اکنون که قصد دارید بخش‌های طولانی‌تر و پیچیده‌تری از کد پایتون بنویسید، زمان مناسبی است تا دربارهٔ سبک کدنویسی صحبت کنیم. بیشتر زبان‌ها را می‌توان به سبک‌های مختلفی نوشت (یا دقیق‌تر، قالب‌بندی کرد)؛ برخی از این سبک‌ها خواناتر از دیگران هستند. آسان‌تر کردن خواندن کد برای دیگران همیشه ایدهٔ خوبی است و پیروی از یک سبک کدنویسی مناسب کمک بسیار زیادی به این موضوع می‌کند.

برای پایتون، <a class="pep reference external" href="https://peps.python.org/pep-0008/">PEP 8</a> به‌عنوان راهنمای سبکی مطرح شده است که بیشتر پروژه‌ها از آن پیروی می‌کنند؛ این راهنما سبکی بسیار خوانا و چشم‌نواز را ترویج می‌کند. هر توسعه‌دهندهٔ پایتون باید در مقطعی آن را مطالعه کند؛ در ادامه مهم‌ترین نکات آن را برای شما استخراج کرده‌ایم:

<ul>

<li>از تورفتگی ۴ فاصله‌ای استفاده کنید و از Tab استفاده نکنید.

۴ فاصله سازشی مناسب بین تورفتگی کم (که امکان تو‌در‌تو شدن بیشتر را فراهم می‌کند) و تورفتگی زیاد (که خواندن را آسان‌تر می‌کند) است. استفاده از Tab باعث سردرگمی می‌شود و بهتر است کنار گذاشته شود.

</li>

<li>خطوط را طوری شکسته‌بندی کنید که بیشتر از ۷۹ نویسه نباشند.

این کار به کاربرانی که نمایشگرهای کوچک دارند کمک می‌کند و امکان نمایش چندین فایل کد در کنار یکدیگر را در نمایشگرهای بزرگ‌تر فراهم می‌سازد.

</li>

<li>برای جدا کردن توابع و کلاس‌ها، و همچنین بلوک‌های بزرگ‌تر کد درون توابع، از خطوط خالی استفاده کنید.</li>

<li>در صورت امکان، توضیحات را در یک خط جداگانه قرار دهید.</li>

<li>از رشته‌های مستندسازی (docstring) استفاده کنید.</li>

<li>در اطراف عملگرها و پس از ویرگول‌ها فاصله قرار دهید، اما مستقیماً درون سازه‌های محصورکننده فاصله نگذارید: <code class="docutils literal notranslate">a = f(1, 2) + g(3, 4)</code>.</li>

<li>کلاس‌ها و توابع خود را به‌صورت یکدست نام‌گذاری کنید؛ قرارداد رایج این است که برای کلاس‌ها از <code class="docutils literal notranslate">UpperCamelCase</code> و برای توابع و متدها از <code class="docutils literal notranslate">lowercase_with_underscores</code> استفاده شود. همیشه از <code class="docutils literal notranslate">self</code> به‌عنوان نام اولین آرگومان متد استفاده کنید (برای اطلاعات بیشتر دربارهٔ کلاس‌ها و متدها به <a class="reference internal" href="classes.html#tut-firstclasses">در نگاه اول به کلاسها</a> مراجعه کنید).</li>

<li>اگر قرار است کد شما در محیط‌های بین‌المللی استفاده شود، از کدگذاری‌های پیچیده و خاص استفاده نکنید. کدگذاری پیش‌فرض پایتون، یعنی UTF-8، یا حتی ASCII ساده، در هر صورت بهترین انتخاب‌ها هستند.</li>

<li>به همین ترتیب، اگر حتی کوچک‌ترین احتمالی وجود دارد که افرادی با زبان‌های دیگر این کد را بخوانند یا نگهداری کنند، از نویسه‌های غیر ASCII در شناسه‌ها استفاده نکنید.</li>

</ul>

پانویس‌ها

[<a role="doc-backlink" href="#id1">1</a>]

در واقع، فراخوانی با ارجاع به شیء توصیف دقیق‌تری خواهد بود؛ زیرا اگر یک شیء تغییرپذیر ارسال شود، فراخواننده هر تغییری را که فراخوانی‌شونده روی آن اعمال کند مشاهده خواهد کرد (مانند مواردی که به یک فهرست، عنصرهایی اضافه می‌شود).

</aside>

View remainder of file in raw view

Navigation Menu

Uh oh!

Uh oh!

FilesExpand file tree

controlflow.html

Latest commit

History

controlflow.html

File metadata and controls