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

History

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

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

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

<style>

@media only screen {

table.full-width-table {

width: 100%;

}

</style>

</head>

<body>

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

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

</label>

</a>

</svg>

</form>

</nav>

Theme

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

</select>

</label>

<div>

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

<ul>

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

<li><a class="reference internal" href="#export-api">Export API</a></li>

<li><a class="reference internal" href="#pylongwriter-api">PyLongWriter API</a></li>

<li><a class="reference internal" href="#deprecated-api">Deprecated API</a></li>

</ul>

</li>

</ul>

</div>

<div>

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

<a href="none.html"

title="فصل قبلی">The <code class="docutils literal notranslate">None</code> Object</a>

</div>

<div>

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

<a href="bool.html"

title="فصل بعدی">اشیاء بولین</a>

</div>

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

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

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

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

elements.forEach(element => {

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

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

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

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

element.href = url.toString();

});

</script>

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

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

<li>

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

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

</a>

</li>

<li>

<a href="https://github.com/python/python-docs-fa/blob/3.14/c-api/long.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="bool.html" title="اشیاء بولین"

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

<a href="none.html" title="The None Object"

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

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

</li>

<li>

</li>

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

</li>

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

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

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

</form>

</div>

</li>

Theme

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

</select>

</label> |</li>

</ul>

</div>

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

All integers are implemented as "long" integer objects of arbitrary size.

On error, most <code class="docutils literal notranslate">PyLong_As*</code> APIs return <code class="docutils literal notranslate">(return type)-1</code> which cannot be

distinguished from a number. Use <a class="reference internal" href="exceptions.html#c.PyErr_Occurred" title="PyErr_Occurred"><code class="xref c c-func docutils literal notranslate">PyErr_Occurred()</code></a> to disambiguate.

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

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">API محدود</a> (به‌عنوان یک ساختار مبهم).This subtype of <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><code class="xref c c-type docutils literal notranslate">PyObject</code></a> represents a Python integer object.

</dd></dl>

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

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

This is the same object as <a class="reference internal" href="../library/functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a> in the Python layer.

</dd></dl>

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

<dd>Return true if its argument is a <a class="reference internal" href="#c.PyLongObject" title="PyLongObject"><code class="xref c c-type docutils literal notranslate">PyLongObject</code></a> or a subtype of

<code class="xref c c-type docutils literal notranslate">PyLongObject</code>. This function always succeeds.

</dd></dl>

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

<code class="xref c c-type docutils literal notranslate">PyLongObject</code>. This function always succeeds.

</dd></dl>

<dd>مقدار بازگشتی: مرجع جدید. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return a new <a class="reference internal" href="#c.PyLongObject" title="PyLongObject"><code class="xref c c-type docutils literal notranslate">PyLongObject</code></a> object from v, or <code class="docutils literal notranslate">NULL</code> on failure.

جزئیات پیاده‌سازی در CPython: CPython keeps an array of integer objects for all integers

between <code class="docutils literal notranslate">-5</code> and <code class="docutils literal notranslate">256</code>. When you create an int in that range

you actually just get back a reference to the existing object.

</div>

</dd></dl>

<dd>مقدار بازگشتی: مرجع جدید. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return a new <a class="reference internal" href="#c.PyLongObject" title="PyLongObject"><code class="xref c c-type docutils literal notranslate">PyLongObject</code></a> object from a C unsigned long, or

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

</dd></dl>

<dd>مقدار بازگشتی: مرجع جدید. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return a new <a class="reference internal" href="#c.PyLongObject" title="PyLongObject"><code class="xref c c-type docutils literal notranslate">PyLongObject</code></a> object from a C <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t"><code class="xref c c-type docutils literal notranslate">Py_ssize_t</code></a>, or

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

</dd></dl>

<dd>مقدار بازگشتی: مرجع جدید. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return a new <a class="reference internal" href="#c.PyLongObject" title="PyLongObject"><code class="xref c c-type docutils literal notranslate">PyLongObject</code></a> object from a C <code class="xref c c-type docutils literal notranslate">size_t</code>, or

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

</dd></dl>

<dd>مقدار بازگشتی: مرجع جدید. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return a new <a class="reference internal" href="#c.PyLongObject" title="PyLongObject"><code class="xref c c-type docutils literal notranslate">PyLongObject</code></a> object from a C long long, or <code class="docutils literal notranslate">NULL</code>

on failure.

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyLong_FromUnsignedLongLong(unsigned long long v)<a class="headerlink" href="#c.PyLong_FromUnsignedLongLong" title="Link to this definition">¶</a> </dt>

<dd>مقدار بازگشتی: مرجع جدید. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return a new <a class="reference internal" href="#c.PyLongObject" title="PyLongObject"><code class="xref c c-type docutils literal notranslate">PyLongObject</code></a> object from a C unsigned long long,

or <code class="docutils literal notranslate">NULL</code> on failure.

</dd></dl>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.14.Return a new <a class="reference internal" href="#c.PyLongObject" title="PyLongObject"><code class="xref c c-type docutils literal notranslate">PyLongObject</code></a> object from a signed C

int32_t or int64_t, or <code class="docutils literal notranslate">NULL</code>

with an exception set on failure.

Added in version 3.14.

</div>

</dd></dl>

uint32_t or uint64_t, or <code class="docutils literal notranslate">NULL</code>

with an exception set on failure.

Added in version 3.14.

</div>

</dd></dl>

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

</dd></dl>

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

is interpreted according to the radix in base, or <code class="docutils literal notranslate">NULL</code> on failure. If

pend is non-<code class="docutils literal notranslate">NULL</code>, *pend will point to the end of str on success or

to the first character that could not be processed on error. If base is <code class="docutils literal notranslate">0</code>,

str is interpreted using the <a class="reference internal" href="../reference/lexical_analysis.html#integers">Integer literals</a> definition; in this case, leading

zeros in a non-zero decimal number raises a <a class="reference internal" href="../library/exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a>. If base is not

<code class="docutils literal notranslate">0</code>, it must be between <code class="docutils literal notranslate">2</code> and <code class="docutils literal notranslate">36</code>, inclusive. Leading and trailing

whitespace and single underscores after a base specifier and between digits are

ignored. If there are no digits or str is not NULL-terminated following the

digits and trailing whitespace, <code class="xref py py-exc docutils literal notranslate">ValueError</code> will be raised.

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

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

<a class="reference internal" href="#c.PyLong_FromNativeBytes" title="PyLong_FromNativeBytes"><code class="xref c c-func docutils literal notranslate">PyLong_FromNativeBytes()</code></a> functions can be used to convert

a <a class="reference internal" href="#c.PyLongObject" title="PyLongObject"><code class="xref c c-type docutils literal notranslate">PyLongObject</code></a> to/from an array of bytes in base <code class="docutils literal notranslate">256</code>.

</div>

</dd></dl>

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

<dd>مقدار بازگشتی: مرجع جدید.Convert a sequence of Unicode digits in the string u to a Python integer

value.

Added in version 3.3.

</div>

</dd></dl>

retrieved from the resulting value using <a class="reference internal" href="#c.PyLong_AsVoidPtr" title="PyLong_AsVoidPtr"><code class="xref c c-func docutils literal notranslate">PyLong_AsVoidPtr()</code></a>.

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyLong_FromNativeBytes(const void *buffer, size_t n_bytes, int flags)<a class="headerlink" href="#c.PyLong_FromNativeBytes" title="Link to this definition">¶</a> </dt>

buffer, interpreted as a two's-complement signed number.

flags are as for <a class="reference internal" href="#c.PyLong_AsNativeBytes" title="PyLong_AsNativeBytes"><code class="xref c c-func docutils literal notranslate">PyLong_AsNativeBytes()</code></a>. Passing <code class="docutils literal notranslate">-1</code> will select

the native endian that CPython was compiled with and assume that the

most-significant bit is a sign bit. Passing

<code class="docutils literal notranslate">Py_ASNATIVEBYTES_UNSIGNED_BUFFER</code> will produce the same result as calling

<a class="reference internal" href="#c.PyLong_FromUnsignedNativeBytes" title="PyLong_FromUnsignedNativeBytes"><code class="xref c c-func docutils literal notranslate">PyLong_FromUnsignedNativeBytes()</code></a>. Other flags are ignored.

Added in version 3.13.

</div>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyLong_FromUnsignedNativeBytes(const void *buffer, size_t n_bytes, int flags)<a class="headerlink" href="#c.PyLong_FromUnsignedNativeBytes" title="Link to this definition">¶</a> </dt>

buffer, interpreted as an unsigned number.

the native endian that CPython was compiled with and assume that the

most-significant bit is not a sign bit. Flags other than endian are ignored.

Added in version 3.13.

</div>

</dd></dl>

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

<dd>Macro for creating a Python integer from a process identifier.

This can be defined as an alias to <a class="reference internal" href="#c.PyLong_FromLong" title="PyLong_FromLong"><code class="xref c c-func docutils literal notranslate">PyLong_FromLong()</code></a> or

PID type.

Added in version 3.2.

</div>

</dd></dl>

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

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return a C long representation of obj. If obj is not an

instance of <a class="reference internal" href="#c.PyLongObject" title="PyLongObject"><code class="xref c c-type docutils literal notranslate">PyLongObject</code></a>, first call its <a class="reference internal" href="../reference/datamodel.html#object.__index__" title="object.__index__"><code class="xref py py-meth docutils literal notranslate">__index__()</code></a> method

(if present) to convert it to a <code class="xref c c-type docutils literal notranslate">PyLongObject</code>.

Raise <a class="reference internal" href="../library/exceptions.html#OverflowError" title="OverflowError"><code class="xref py py-exc docutils literal notranslate">OverflowError</code></a> if the value of obj is out of range for a

long.

Returns <code class="docutils literal notranslate">-1</code> on error. Use <a class="reference internal" href="exceptions.html#c.PyErr_Occurred" title="PyErr_Occurred"><code class="xref c c-func docutils literal notranslate">PyErr_Occurred()</code></a> to disambiguate.

تغییر داده شده در نسخه 3.8: Use <a class="reference internal" href="../reference/datamodel.html#object.__index__" title="object.__index__"><code class="xref py py-meth docutils literal notranslate">__index__()</code></a> if available.

</div>

تغییر داده شده در نسخه 3.10: This function will no longer use <a class="reference internal" href="../reference/datamodel.html#object.__int__" title="object.__int__"><code class="xref py py-meth docutils literal notranslate">__int__()</code></a>.

</div>

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

<dd>Exactly equivalent to the preferred <code class="docutils literal notranslate">PyLong_AsLong</code>. In particular,

it can fail with <a class="reference internal" href="../library/exceptions.html#OverflowError" title="OverflowError"><code class="xref py py-exc docutils literal notranslate">OverflowError</code></a> or another exception.

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

</div>

</dd></dl>

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

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

int instead of a C long.

Added in version 3.13.

</div>

</dd></dl>

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

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return a C long representation of obj. If obj is not an

method (if present) to convert it to a <code class="xref c c-type docutils literal notranslate">PyLongObject</code>.

If the value of obj is greater than <code class="xref c c-macro docutils literal notranslate">LONG_MAX</code> or less than

<code class="xref c c-macro docutils literal notranslate">LONG_MIN</code>, set *overflow to <code class="docutils literal notranslate">1</code> or <code class="docutils literal notranslate">-1</code>, respectively, and

return <code class="docutils literal notranslate">-1</code>; otherwise, set *overflow to <code class="docutils literal notranslate">0</code>. If any other exception

occurs set *overflow to <code class="docutils literal notranslate">0</code> and return <code class="docutils literal notranslate">-1</code> as usual.

</div>

</div>

</dd></dl>

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

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return a C long long representation of obj. If obj is not an

(if present) to convert it to a <code class="xref c c-type docutils literal notranslate">PyLongObject</code>.

long long.

</div>

</div>

</dd></dl>

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

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return a C long long representation of obj. If obj is not an

(if present) to convert it to a <code class="xref c c-type docutils literal notranslate">PyLongObject</code>.

If the value of obj is greater than <code class="xref c c-macro docutils literal notranslate">LLONG_MAX</code> or less than

<code class="xref c c-macro docutils literal notranslate">LLONG_MIN</code>, set *overflow to <code class="docutils literal notranslate">1</code> or <code class="docutils literal notranslate">-1</code>, respectively,

and return <code class="docutils literal notranslate">-1</code>; otherwise, set *overflow to <code class="docutils literal notranslate">0</code>. If any other

exception occurs set *overflow to <code class="docutils literal notranslate">0</code> and return <code class="docutils literal notranslate">-1</code> as usual.

Added in version 3.2.

</div>

</div>

</div>

</dd></dl>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return a C <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t"><code class="xref c c-type docutils literal notranslate">Py_ssize_t</code></a> representation of pylong. pylong must

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

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

</dd></dl>

unsigned long PyLong_AsUnsignedLong(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *pylong)<a class="headerlink" href="#c.PyLong_AsUnsignedLong" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return a C unsigned long representation of pylong. pylong

must be an instance of <a class="reference internal" href="#c.PyLongObject" title="PyLongObject"><code class="xref c c-type docutils literal notranslate">PyLongObject</code></a>.

unsigned long.

Returns <code class="docutils literal notranslate">(unsigned long)-1</code> on error.

Use <a class="reference internal" href="exceptions.html#c.PyErr_Occurred" title="PyErr_Occurred"><code class="xref c c-func docutils literal notranslate">PyErr_Occurred()</code></a> to disambiguate.

</dd></dl>

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

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return a C <code class="xref c c-type docutils literal notranslate">size_t</code> representation of pylong. pylong must be

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

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

Returns <code class="docutils literal notranslate">(size_t)-1</code> on error.

</dd></dl>

unsigned long long PyLong_AsUnsignedLongLong(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *pylong)<a class="headerlink" href="#c.PyLong_AsUnsignedLongLong" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return a C unsigned long long representation of pylong. pylong

unsigned long long.

Returns <code class="docutils literal notranslate">(unsigned long long)-1</code> on error.

تغییر داده شده در نسخه 3.1: A negative pylong now raises <a class="reference internal" href="../library/exceptions.html#OverflowError" title="OverflowError"><code class="xref py py-exc docutils literal notranslate">OverflowError</code></a>, not <a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a>.

</div>

</dd></dl>

unsigned long PyLong_AsUnsignedLongMask(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *obj)<a class="headerlink" href="#c.PyLong_AsUnsignedLongMask" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return a C unsigned long representation of obj. If obj is not

an instance of <a class="reference internal" href="#c.PyLongObject" title="PyLongObject"><code class="xref c c-type docutils literal notranslate">PyLongObject</code></a>, first call its <a class="reference internal" href="../reference/datamodel.html#object.__index__" title="object.__index__"><code class="xref py py-meth docutils literal notranslate">__index__()</code></a>

method (if present) to convert it to a <code class="xref c c-type docutils literal notranslate">PyLongObject</code>.

If the value of obj is out of range for an unsigned long,

return the reduction of that value modulo <code class="docutils literal notranslate">ULONG_MAX + 1</code>.

Returns <code class="docutils literal notranslate">(unsigned long)-1</code> on error. Use <a class="reference internal" href="exceptions.html#c.PyErr_Occurred" title="PyErr_Occurred"><code class="xref c c-func docutils literal notranslate">PyErr_Occurred()</code></a> to

disambiguate.

</div>

</div>

</dd></dl>

unsigned long long PyLong_AsUnsignedLongLongMask(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *obj)<a class="headerlink" href="#c.PyLong_AsUnsignedLongLongMask" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return a C unsigned long long representation of obj. If obj

is not an instance of <a class="reference internal" href="#c.PyLongObject" title="PyLongObject"><code class="xref c c-type docutils literal notranslate">PyLongObject</code></a>, first call its

<a class="reference internal" href="../reference/datamodel.html#object.__index__" title="object.__index__"><code class="xref py py-meth docutils literal notranslate">__index__()</code></a> method (if present) to convert it to a

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

If the value of obj is out of range for an unsigned long long,

return the reduction of that value modulo <code class="docutils literal notranslate">ULLONG_MAX + 1</code>.

Returns <code class="docutils literal notranslate">(unsigned long long)-1</code> on error. Use <a class="reference internal" href="exceptions.html#c.PyErr_Occurred" title="PyErr_Occurred"><code class="xref c c-func docutils literal notranslate">PyErr_Occurred()</code></a>

to disambiguate.

</div>

</div>

</dd></dl>

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

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

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.14.Set *value to a signed C int32_t or int64_t

representation of obj.

If obj is not an instance of <a class="reference internal" href="#c.PyLongObject" title="PyLongObject"><code class="xref c c-type docutils literal notranslate">PyLongObject</code></a>, first call its

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

If the obj value is out of range, raise an <a class="reference internal" href="../library/exceptions.html#OverflowError" title="OverflowError"><code class="xref py py-exc docutils literal notranslate">OverflowError</code></a>.

Set *value and return <code class="docutils literal notranslate">0</code> on success.

Set an exception and return <code class="docutils literal notranslate">-1</code> on error.

value must not be <code class="docutils literal notranslate">NULL</code>.

Added in version 3.14.

</div>

</dd></dl>

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

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

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.14.Set *value to an unsigned C uint32_t or uint64_t

representation of obj.

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

<li>If obj is negative, raise a <a class="reference internal" href="../library/exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a>.</li>

<li>If the obj value is out of range, raise an <a class="reference internal" href="../library/exceptions.html#OverflowError" title="OverflowError"><code class="xref py py-exc docutils literal notranslate">OverflowError</code></a>.</li>

</ul>

Set *value and return <code class="docutils literal notranslate">0</code> on success.

Set an exception and return <code class="docutils literal notranslate">-1</code> on error.

value must not be <code class="docutils literal notranslate">NULL</code>.

Added in version 3.14.

</div>

</dd></dl>

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

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return a C double representation of pylong. pylong must be

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

double.

Returns <code class="docutils literal notranslate">-1.0</code> on error. Use <a class="reference internal" href="exceptions.html#c.PyErr_Occurred" title="PyErr_Occurred"><code class="xref c c-func docutils literal notranslate">PyErr_Occurred()</code></a> to disambiguate.

</dd></dl>

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

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Convert a Python integer pylong to a C void pointer.

If pylong cannot be converted, an <a class="reference internal" href="../library/exceptions.html#OverflowError" title="OverflowError"><code class="xref py py-exc docutils literal notranslate">OverflowError</code></a> will be raised. This

is only assured to produce a usable void pointer for values created

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

Returns <code class="docutils literal notranslate">NULL</code> on error. Use <a class="reference internal" href="exceptions.html#c.PyErr_Occurred" title="PyErr_Occurred"><code class="xref c c-func docutils literal notranslate">PyErr_Occurred()</code></a> to disambiguate.

</dd></dl>

<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> PyLong_AsNativeBytes(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *pylong, void *buffer, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> n_bytes, int flags)<a class="headerlink" href="#c.PyLong_AsNativeBytes" title="Link to this definition">¶</a> </dt>

n_bytes. The flags can be set to <code class="docutils literal notranslate">-1</code> to behave similarly to a C cast,

or to values documented below to control the behavior.

Returns <code class="docutils literal notranslate">-1</code> with an exception raised on error. This may happen if

pylong cannot be interpreted as an integer, or if pylong was negative

and the <code class="docutils literal notranslate">Py_ASNATIVEBYTES_REJECT_NEGATIVE</code> flag was set.

Otherwise, returns the number of bytes required to store the value.

If this is equal to or less than n_bytes, the entire value was copied.

All n_bytes of the buffer are written: remaining bytes filled by

copies of the sign bit.

If the returned value is greater than n_bytes, the value was

truncated: as many of the lowest bits of the value as could fit are written,

and the higher bits are ignored. This matches the typical behavior

of a C-style downcast.

توجه

Overflow is not considered an error. If the returned value

is larger than n_bytes, most significant bits were discarded.

</div>

<code class="docutils literal notranslate">0</code> will never be returned.

Values are always copied as two's-complement.

Usage example:

<div class="highlight-c notranslate"><div class="highlight"><pre>int32_t value;

Py_ssize_t bytes = PyLong_AsNativeBytes(pylong, &value, sizeof(value), -1);

if (bytes < 0) {

// Failed. A Python exception was set with the reason.

return NULL;

}

else if (bytes <= (Py_ssize_t)sizeof(value)) {

// Success!

}

else {

// Overflow occurred, but 'value' contains the truncated

// lowest bits of pylong.

}

</pre></div>

</div>

Passing zero to n_bytes will return the size of a buffer that would

be large enough to hold the value. This may be larger than technically

necessary, but not unreasonably so. If n_bytes=0, buffer may be

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

توجه

Passing n_bytes=0 to this function is not an accurate way to determine

the bit length of the value.

</div>

To get at the entire Python value of an unknown size, the function can be

called twice: first to determine the buffer size, then to fill it:

<div class="highlight-c notranslate"><div class="highlight"><pre>// Ask how much space we need.

Py_ssize_t expected = PyLong_AsNativeBytes(pylong, NULL, 0, -1);

if (expected < 0) {

// Failed. A Python exception was set with the reason.

return NULL;

}

assert(expected != 0); // Impossible per the API definition.

uint8_t *bignum = malloc(expected);

if (!bignum) {

PyErr_SetString(PyExc_MemoryError, "bignum malloc failed.");

return NULL;

}

// Safely get the entire value.

Py_ssize_t bytes = PyLong_AsNativeBytes(pylong, bignum, expected, -1);

free(bignum);

return NULL;

}

else if (bytes > expected) { // This should not be possible.

PyErr_SetString(PyExc_RuntimeError,

"Unexpected bignum truncation after a size check.");

free(bignum);

return NULL;

}

// The expected success given the above pre-check.

// ... use bignum ...

free(bignum);

</pre></div>

</div>

flags is either <code class="docutils literal notranslate">-1</code> (<code class="docutils literal notranslate">Py_ASNATIVEBYTES_DEFAULTS</code>) to select defaults

that behave most like a C cast, or a combination of the other flags in

the table below.

Note that <code class="docutils literal notranslate">-1</code> cannot be combined with other flags.

Currently, <code class="docutils literal notranslate">-1</code> corresponds to

<code class="docutils literal notranslate">Py_ASNATIVEBYTES_NATIVE_ENDIAN | Py_ASNATIVEBYTES_UNSIGNED_BUFFER</code>.

<thead>

<th class="head">Value</th>

</tr>

</thead>

<tbody>

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