cpython/Include/abstract.h at 3.5 · python/cpython · GitHub

Repository navigation

History

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

#ifndef Py_ABSTRACTOBJECT_H

#define Py_ABSTRACTOBJECT_H

#ifdef __cplusplus

extern "C" {

#endif

#ifdef PY_SSIZE_T_CLEAN

#define PyObject_CallFunction _PyObject_CallFunction_SizeT

#define PyObject_CallMethod _PyObject_CallMethod_SizeT

#define _PyObject_CallMethodId _PyObject_CallMethodId_SizeT

#endif

/* Abstract Object Interface (many thanks to Jim Fulton) */

PROPOSAL: A Generic Python Object Interface for Python C Modules

Problem

Python modules written in C that must access Python objects must do

so through routines whose interfaces are described by a set of

include files. Unfortunately, these routines vary according to the

object accessed. To use these routines, the C programmer must check

the type of the object being used and must call a routine based on

the object type. For example, to access an element of a sequence,

the programmer must determine whether the sequence is a list or a

tuple:

if(is_tupleobject(o))

e=gettupleitem(o,i)

else if(is_listitem(o))

e=getlistitem(o,i)

If the programmer wants to get an item from another type of object

that provides sequence behavior, there is no clear way to do it

correctly.

The persistent programmer may peruse object.h and find that the

_typeobject structure provides a means of invoking up to (currently

about) 41 special operators. So, for example, a routine can get an

item from any object that provides sequence behavior. However, to

use this mechanism, the programmer must make their code dependent on

the current Python implementation.

Also, certain semantics, especially memory management semantics, may

differ by the type of object being used. Unfortunately, these

semantics are not clearly described in the current include files.

An abstract interface providing more consistent semantics is needed.

Proposal

I propose the creation of a standard interface (with an associated

library of routines and/or macros) for generically obtaining the

services of Python objects. This proposal can be viewed as one

components of a Python C interface consisting of several components.

From the viewpoint of C access to Python services, we have (as

suggested by Guido in off-line discussions):

- "Very high level layer": two or three functions that let you exec or

eval arbitrary Python code given as a string in a module whose name is

given, passing C values in and getting C values out using

mkvalue/getargs style format strings. This does not require the user

to declare any variables of type "PyObject *". This should be enough

to write a simple application that gets Python code from the user,

execs it, and returns the output or errors. (Error handling must also

be part of this API.)

- "Abstract objects layer": which is the subject of this proposal.

It has many functions operating on objects, and lest you do many

things from C that you can also write in Python, without going

through the Python parser.

- "Concrete objects layer": This is the public type-dependent

interface provided by the standard built-in types, such as floats,

strings, and lists. This interface exists and is currently

documented by the collection of include files provided with the

Python distributions.

From the point of view of Python accessing services provided by C

modules:

- "Python module interface": this interface consist of the basic

routines used to define modules and their members. Most of the

current extensions-writing guide deals with this interface.

- "Built-in object interface": this is the interface that a new

built-in type must provide and the mechanisms and rules that a

developer of a new built-in type must use and follow.

This proposal is a "first-cut" that is intended to spur

discussion. See especially the lists of notes.

The Python C object interface will provide four protocols: object,

numeric, sequence, and mapping. Each protocol consists of a

collection of related operations. If an operation that is not

provided by a particular type is invoked, then a standard exception,

NotImplementedError is raised with an operation name as an argument.

In addition, for convenience this interface defines a set of

constructors for building objects of built-in types. This is needed

so new objects can be returned from C functions that otherwise treat

objects generically.

Memory Management

For all of the functions described in this proposal, if a function

retains a reference to a Python object passed as an argument, then the

function will increase the reference count of the object. It is

unnecessary for the caller to increase the reference count of an

argument in anticipation of the object's retention.

All Python objects returned from functions should be treated as new

objects. Functions that return objects assume that the caller will

retain a reference and the reference count of the object has already

been incremented to account for this fact. A caller that does not

retain a reference to an object that is returned from a function

must decrement the reference count of the object (using

DECREF(object)) to prevent memory leaks.

Note that the behavior mentioned here is different from the current

behavior for some objects (e.g. lists and tuples) when certain

type-specific routines are called directly (e.g. setlistitem). The

proposed abstraction layer will provide a consistent memory

management interface, correcting for inconsistent behavior for some

built-in types.

Protocols

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/

/* Object Protocol: */

/* Implemented elsewhere:

int PyObject_Print(PyObject *o, FILE *fp, int flags);

Print an object, o, on file, fp. Returns -1 on

error. The flags argument is used to enable certain printing

options. The only option currently supported is Py_Print_RAW.

(What should be said about Py_Print_RAW?)

/* Implemented elsewhere:

int PyObject_HasAttrString(PyObject *o, const char *attr_name);

Returns 1 if o has the attribute attr_name, and 0 otherwise.

This is equivalent to the Python expression:

hasattr(o,attr_name).

This function always succeeds.

/* Implemented elsewhere:

PyObject* PyObject_GetAttrString(PyObject *o, const char *attr_name);

Retrieve an attributed named attr_name form object o.

Returns the attribute value on success, or NULL on failure.

This is the equivalent of the Python expression: o.attr_name.

/* Implemented elsewhere:

int PyObject_HasAttr(PyObject *o, PyObject *attr_name);

Returns 1 if o has the attribute attr_name, and 0 otherwise.

This is equivalent to the Python expression:

hasattr(o,attr_name).

This function always succeeds.

/* Implemented elsewhere:

PyObject* PyObject_GetAttr(PyObject *o, PyObject *attr_name);

Retrieve an attributed named attr_name form object o.

Returns the attribute value on success, or NULL on failure.

This is the equivalent of the Python expression: o.attr_name.

/* Implemented elsewhere:

int PyObject_SetAttrString(PyObject *o, const char *attr_name, PyObject *v);

Set the value of the attribute named attr_name, for object o,

to the value v. Raise an exception and return -1 on failure; return 0 on

success. This is the equivalent of the Python statement o.attr_name=v.

/* Implemented elsewhere:

int PyObject_SetAttr(PyObject *o, PyObject *attr_name, PyObject *v);

Set the value of the attribute named attr_name, for object o,

to the value v. Raise an exception and return -1 on failure; return 0 on

success. This is the equivalent of the Python statement o.attr_name=v.

/* implemented as a macro:

int PyObject_DelAttrString(PyObject *o, const char *attr_name);

Delete attribute named attr_name, for object o. Returns

-1 on failure. This is the equivalent of the Python

statement: del o.attr_name.

#define PyObject_DelAttrString(O,A) PyObject_SetAttrString((O),(A),NULL)

/* implemented as a macro:

int PyObject_DelAttr(PyObject *o, PyObject *attr_name);

Delete attribute named attr_name, for object o. Returns -1

on failure. This is the equivalent of the Python

statement: del o.attr_name.

#define PyObject_DelAttr(O,A) PyObject_SetAttr((O),(A),NULL)

/* Implemented elsewhere:

PyObject *PyObject_Repr(PyObject *o);

Compute the string representation of object, o. Returns the

string representation on success, NULL on failure. This is

the equivalent of the Python expression: repr(o).

Called by the repr() built-in function.

/* Implemented elsewhere:

PyObject *PyObject_Str(PyObject *o);

Compute the string representation of object, o. Returns the

string representation on success, NULL on failure. This is

the equivalent of the Python expression: str(o).)

Called by the str() and print() built-in functions.

/* Declared elsewhere

PyAPI_FUNC(int) PyCallable_Check(PyObject *o);

Determine if the object, o, is callable. Return 1 if the

object is callable and 0 otherwise.

This function always succeeds.

PyAPI_FUNC(PyObject *) PyObject_Call(PyObject *callable_object,

PyObject *args, PyObject *kw);

Call a callable Python object, callable_object, with

arguments and keywords arguments. The 'args' argument can not be

NULL, but the 'kw' argument can be NULL.

#ifndef Py_LIMITED_API

PyAPI_FUNC(PyObject *) _Py_CheckFunctionResult(PyObject *func,

PyObject *result,

const char *where);

#endif

PyAPI_FUNC(PyObject *) PyObject_CallObject(PyObject *callable_object,

PyObject *args);

Call a callable Python object, callable_object, with

arguments given by the tuple, args. If no arguments are

needed, then args may be NULL. Returns the result of the

call on success, or NULL on failure. This is the equivalent

of the Python expression: o(*args).

PyAPI_FUNC(PyObject *) PyObject_CallFunction(PyObject *callable_object,

const char *format, ...);

Call a callable Python object, callable_object, with a

variable number of C arguments. The C arguments are described

using a mkvalue-style format string. The format may be NULL,

indicating that no arguments are provided. Returns the

result of the call on success, or NULL on failure. This is

the equivalent of the Python expression: o(*args).

PyAPI_FUNC(PyObject *) PyObject_CallMethod(PyObject *o,

const char *method,

const char *format, ...);

Call the method named m of object o with a variable number of

C arguments. The C arguments are described by a mkvalue

format string. The format may be NULL, indicating that no

arguments are provided. Returns the result of the call on

success, or NULL on failure. This is the equivalent of the

Python expression: o.method(args).

PyAPI_FUNC(PyObject *) _PyObject_CallMethodId(PyObject *o,

_Py_Identifier *method,

const char *format, ...);

Like PyObject_CallMethod, but expect a _Py_Identifier* as the

method name.

PyAPI_FUNC(PyObject *) _PyObject_CallFunction_SizeT(PyObject *callable,

const char *format,

...);

PyAPI_FUNC(PyObject *) _PyObject_CallMethod_SizeT(PyObject *o,

const char *name,

const char *format,

...);

PyAPI_FUNC(PyObject *) _PyObject_CallMethodId_SizeT(PyObject *o,

_Py_Identifier *name,

const char *format,

...);

PyAPI_FUNC(PyObject *) PyObject_CallFunctionObjArgs(PyObject *callable,

...);

Call a callable Python object, callable_object, with a

variable number of C arguments. The C arguments are provided

as PyObject * values, terminated by a NULL. Returns the

result of the call on success, or NULL on failure. This is

the equivalent of the Python expression: o(*args).

PyAPI_FUNC(PyObject *) PyObject_CallMethodObjArgs(PyObject *o,

PyObject *method, ...);

PyAPI_FUNC(PyObject *) _PyObject_CallMethodIdObjArgs(PyObject *o,

struct _Py_Identifier *method,

...);

Call the method named m of object o with a variable number of

C arguments. The C arguments are provided as PyObject *

values, terminated by NULL. Returns the result of the call

on success, or NULL on failure. This is the equivalent of

the Python expression: o.method(args).

/* Implemented elsewhere:

long PyObject_Hash(PyObject *o);

Compute and return the hash, hash_value, of an object, o. On

failure, return -1. This is the equivalent of the Python

expression: hash(o).

/* Implemented elsewhere:

int PyObject_IsTrue(PyObject *o);

Returns 1 if the object, o, is considered to be true, 0 if o is

considered to be false and -1 on failure. This is equivalent to the

Python expression: not not o

/* Implemented elsewhere:

int PyObject_Not(PyObject *o);

Returns 0 if the object, o, is considered to be true, 1 if o is

considered to be false and -1 on failure. This is equivalent to the

Python expression: not o

PyAPI_FUNC(PyObject *) PyObject_Type(PyObject *o);

On success, returns a type object corresponding to the object

type of object o. On failure, returns NULL. This is

equivalent to the Python expression: type(o).

PyAPI_FUNC(Py_ssize_t) PyObject_Size(PyObject *o);

Return the size of object o. If the object, o, provides

both sequence and mapping protocols, the sequence size is

returned. On error, -1 is returned. This is the equivalent

to the Python expression: len(o).

/* For DLL compatibility */

#undef PyObject_Length

PyAPI_FUNC(Py_ssize_t) PyObject_Length(PyObject *o);

#define PyObject_Length PyObject_Size

#ifndef Py_LIMITED_API

PyAPI_FUNC(int) _PyObject_HasLen(PyObject *o);

PyAPI_FUNC(Py_ssize_t) PyObject_LengthHint(PyObject *o, Py_ssize_t);

#endif

Guess the size of object o using len(o) or o.__length_hint__().

If neither of those return a non-negative value, then return the

default value. If one of the calls fails, this function returns -1.

PyAPI_FUNC(PyObject *) PyObject_GetItem(PyObject *o, PyObject *key);

Return element of o corresponding to the object, key, or NULL

on failure. This is the equivalent of the Python expression:

o[key].

PyAPI_FUNC(int) PyObject_SetItem(PyObject *o, PyObject *key, PyObject *v);

Map the object key to the value v. Raise an exception and return -1

on failure; return 0 on success. This is the equivalent of the Python

statement o[key]=v.

PyAPI_FUNC(int) PyObject_DelItemString(PyObject *o, const char *key);

Remove the mapping for object, key, from the object *o.

Returns -1 on failure. This is equivalent to

the Python statement: del o[key].

PyAPI_FUNC(int) PyObject_DelItem(PyObject *o, PyObject *key);

Delete the mapping for key from *o. Returns -1 on failure.

This is the equivalent of the Python statement: del o[key].

/* old buffer API

FIXME: usage of these should all be replaced in Python itself

but for backwards compatibility we will implement them.

Their usage without a corresponding "unlock" mechanism

may create issues (but they would already be there). */

PyAPI_FUNC(int) PyObject_AsCharBuffer(PyObject *obj,

const char **buffer,

Py_ssize_t *buffer_len);

Takes an arbitrary object which must support the (character,

single segment) buffer interface and returns a pointer to a

read-only memory location useable as character based input

for subsequent processing.

0 is returned on success. buffer and buffer_len are only

set in case no error occurs. Otherwise, -1 is returned and

an exception set.

PyAPI_FUNC(int) PyObject_CheckReadBuffer(PyObject *obj);

Checks whether an arbitrary object supports the (character,

single segment) buffer interface. Returns 1 on success, 0

on failure.

PyAPI_FUNC(int) PyObject_AsReadBuffer(PyObject *obj,

const void **buffer,

Py_ssize_t *buffer_len);

Same as PyObject_AsCharBuffer() except that this API expects

(readable, single segment) buffer interface and returns a

pointer to a read-only memory location which can contain

arbitrary data.

0 is returned on success. buffer and buffer_len are only

set in case no error occurs. Otherwise, -1 is returned and

an exception set.

PyAPI_FUNC(int) PyObject_AsWriteBuffer(PyObject *obj,

void **buffer,

Py_ssize_t *buffer_len);

Takes an arbitrary object which must support the (writable,

single segment) buffer interface and returns a pointer to a

writable memory location in buffer of size buffer_len.

0 is returned on success. buffer and buffer_len are only

set in case no error occurs. Otherwise, -1 is returned and

an exception set.

/* new buffer API */

#ifndef Py_LIMITED_API

#define PyObject_CheckBuffer(obj) \

(((obj)->ob_type->tp_as_buffer != NULL) && \

((obj)->ob_type->tp_as_buffer->bf_getbuffer != NULL))

/* Return 1 if the getbuffer function is available, otherwise

return 0 */

PyAPI_FUNC(int) PyObject_GetBuffer(PyObject *obj, Py_buffer *view,

int flags);

/* This is a C-API version of the getbuffer function call. It checks

to make sure object has the required function pointer and issues the

call. Returns -1 and raises an error on failure and returns 0 on

success

PyAPI_FUNC(void *) PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices);

/* Get the memory area pointed to by the indices for the buffer given.

Note that view->ndim is the assumed size of indices

PyAPI_FUNC(int) PyBuffer_SizeFromFormat(const char *);

/* Return the implied itemsize of the data-format area from a

struct-style description */

/* Implementation in memoryobject.c */

PyAPI_FUNC(int) PyBuffer_ToContiguous(void *buf, Py_buffer *view,

Py_ssize_t len, char order);

PyAPI_FUNC(int) PyBuffer_FromContiguous(Py_buffer *view, void *buf,

Py_ssize_t len, char order);

/* Copy len bytes of data from the contiguous chunk of memory

pointed to by buf into the buffer exported by obj. Return

0 on success and return -1 and raise a PyBuffer_Error on

error (i.e. the object does not have a buffer interface or

it is not working).

If fort is 'F', then if the object is multi-dimensional,

then the data will be copied into the array in

Fortran-style (first dimension varies the fastest). If

fort is 'C', then the data will be copied into the array

in C-style (last dimension varies the fastest). If fort

is 'A', then it does not matter and the copy will be made

in whatever way is more efficient.

PyAPI_FUNC(int) PyObject_CopyData(PyObject *dest, PyObject *src);

/* Copy the data from the src buffer to the buffer of destination

PyAPI_FUNC(int) PyBuffer_IsContiguous(const Py_buffer *view, char fort);

PyAPI_FUNC(void) PyBuffer_FillContiguousStrides(int ndims,

Py_ssize_t *shape,

Py_ssize_t *strides,

int itemsize,

char fort);

/* Fill the strides array with byte-strides of a contiguous

(Fortran-style if fort is 'F' or C-style otherwise)

array of the given shape with the given number of bytes

per element.

PyAPI_FUNC(int) PyBuffer_FillInfo(Py_buffer *view, PyObject *o, void *buf,

Py_ssize_t len, int readonly,

int flags);

/* Fills in a buffer-info structure correctly for an exporter

that can only share a contiguous chunk of memory of

"unsigned bytes" of the given length. Returns 0 on success

and -1 (with raising an error) on error.

PyAPI_FUNC(void) PyBuffer_Release(Py_buffer *view);

/* Releases a Py_buffer obtained from getbuffer ParseTuple's s*.

#endif /* Py_LIMITED_API */

PyAPI_FUNC(PyObject *) PyObject_Format(PyObject* obj,

PyObject *format_spec);

Takes an arbitrary object and returns the result of

calling obj.__format__(format_spec).

/* Iterators */

PyAPI_FUNC(PyObject *) PyObject_GetIter(PyObject *);

/* Takes an object and returns an iterator for it.

This is typically a new iterator but if the argument

is an iterator, this returns itself. */

#define PyIter_Check(obj) \

((obj)->ob_type->tp_iternext != NULL && \

(obj)->ob_type->tp_iternext != &_PyObject_NextNotImplemented)

PyAPI_FUNC(PyObject *) PyIter_Next(PyObject *);

/* Takes an iterator object and calls its tp_iternext slot,

returning the next value. If the iterator is exhausted,

this returns NULL without setting an exception.

NULL with an exception means an error occurred. */

/* Number Protocol:*/

PyAPI_FUNC(int) PyNumber_Check(PyObject *o);

Returns 1 if the object, o, provides numeric protocols, and

false otherwise.

This function always succeeds.

PyAPI_FUNC(PyObject *) PyNumber_Add(PyObject *o1, PyObject *o2);

Returns the result of adding o1 and o2, or null on failure.

This is the equivalent of the Python expression: o1+o2.

PyAPI_FUNC(PyObject *) PyNumber_Subtract(PyObject *o1, PyObject *o2);

Returns the result of subtracting o2 from o1, or null on

failure. This is the equivalent of the Python expression:

o1-o2.

PyAPI_FUNC(PyObject *) PyNumber_Multiply(PyObject *o1, PyObject *o2);

Returns the result of multiplying o1 and o2, or null on

failure. This is the equivalent of the Python expression:

o1*o2.

PyAPI_FUNC(PyObject *) PyNumber_MatrixMultiply(PyObject *o1, PyObject *o2);

This is the equivalent of the Python expression: o1 @ o2.

PyAPI_FUNC(PyObject *) PyNumber_FloorDivide(PyObject *o1, PyObject *o2);

Returns the result of dividing o1 by o2 giving an integral result,

or null on failure.

This is the equivalent of the Python expression: o1//o2.

PyAPI_FUNC(PyObject *) PyNumber_TrueDivide(PyObject *o1, PyObject *o2);

Returns the result of dividing o1 by o2 giving a float result,

or null on failure.

This is the equivalent of the Python expression: o1/o2.

PyAPI_FUNC(PyObject *) PyNumber_Remainder(PyObject *o1, PyObject *o2);

Returns the remainder of dividing o1 by o2, or null on

failure. This is the equivalent of the Python expression:

o1%o2.

PyAPI_FUNC(PyObject *) PyNumber_Divmod(PyObject *o1, PyObject *o2);

See the built-in function divmod. Returns NULL on failure.

This is the equivalent of the Python expression:

divmod(o1,o2).

PyAPI_FUNC(PyObject *) PyNumber_Power(PyObject *o1, PyObject *o2,

PyObject *o3);

See the built-in function pow. Returns NULL on failure.

This is the equivalent of the Python expression:

pow(o1,o2,o3), where o3 is optional.

PyAPI_FUNC(PyObject *) PyNumber_Negative(PyObject *o);

Returns the negation of o on success, or null on failure.

This is the equivalent of the Python expression: -o.

PyAPI_FUNC(PyObject *) PyNumber_Positive(PyObject *o);

Returns the (what?) of o on success, or NULL on failure.

This is the equivalent of the Python expression: +o.

PyAPI_FUNC(PyObject *) PyNumber_Absolute(PyObject *o);

Returns the absolute value of o, or null on failure. This is

the equivalent of the Python expression: abs(o).

PyAPI_FUNC(PyObject *) PyNumber_Invert(PyObject *o);

Returns the bitwise negation of o on success, or NULL on

failure. This is the equivalent of the Python expression:

~o.

PyAPI_FUNC(PyObject *) PyNumber_Lshift(PyObject *o1, PyObject *o2);

Returns the result of left shifting o1 by o2 on success, or

NULL on failure. This is the equivalent of the Python

expression: o1 << o2.

PyAPI_FUNC(PyObject *) PyNumber_Rshift(PyObject *o1, PyObject *o2);

Returns the result of right shifting o1 by o2 on success, or

NULL on failure. This is the equivalent of the Python

expression: o1 >> o2.

PyAPI_FUNC(PyObject *) PyNumber_And(PyObject *o1, PyObject *o2);

Returns the result of bitwise and of o1 and o2 on success, or

NULL on failure. This is the equivalent of the Python

expression: o1&o2.

PyAPI_FUNC(PyObject *) PyNumber_Xor(PyObject *o1, PyObject *o2);

Returns the bitwise exclusive or of o1 by o2 on success, or

NULL on failure. This is the equivalent of the Python

expression: o1^o2.

PyAPI_FUNC(PyObject *) PyNumber_Or(PyObject *o1, PyObject *o2);

Returns the result of bitwise or on o1 and o2 on success, or

NULL on failure. This is the equivalent of the Python

expression: o1|o2.

#define PyIndex_Check(obj) \

((obj)->ob_type->tp_as_number != NULL && \

(obj)->ob_type->tp_as_number->nb_index != NULL)

PyAPI_FUNC(PyObject *) PyNumber_Index(PyObject *o);

Returns the object converted to a Python int

or NULL with an error raised on failure.

PyAPI_FUNC(Py_ssize_t) PyNumber_AsSsize_t(PyObject *o, PyObject *exc);

Returns the object converted to Py_ssize_t by going through

PyNumber_Index first. If an overflow error occurs while

converting the int to Py_ssize_t, then the second argument

is the error-type to return. If it is NULL, then the overflow error

is cleared and the value is clipped.

PyAPI_FUNC(PyObject *) PyNumber_Long(PyObject *o);

Returns the o converted to an integer object on success, or

NULL on failure. This is the equivalent of the Python

expression: int(o).

PyAPI_FUNC(PyObject *) PyNumber_Float(PyObject *o);

Returns the o converted to a float object on success, or NULL

on failure. This is the equivalent of the Python expression:

float(o).

/* In-place variants of (some of) the above number protocol functions */

PyAPI_FUNC(PyObject *) PyNumber_InPlaceAdd(PyObject *o1, PyObject *o2);

Returns the result of adding o2 to o1, possibly in-place, or null

on failure. This is the equivalent of the Python expression:

o1 += o2.

PyAPI_FUNC(PyObject *) PyNumber_InPlaceSubtract(PyObject *o1, PyObject *o2);

Returns the result of subtracting o2 from o1, possibly in-place or

null on failure. This is the equivalent of the Python expression:

o1 -= o2.

PyAPI_FUNC(PyObject *) PyNumber_InPlaceMultiply(PyObject *o1, PyObject *o2);

Returns the result of multiplying o1 by o2, possibly in-place, or

null on failure. This is the equivalent of the Python expression:

o1 *= o2.

PyAPI_FUNC(PyObject *) PyNumber_InPlaceMatrixMultiply(PyObject *o1, PyObject *o2);

This is the equivalent of the Python expression: o1 @= o2.

PyAPI_FUNC(PyObject *) PyNumber_InPlaceFloorDivide(PyObject *o1,

PyObject *o2);

Returns the result of dividing o1 by o2 giving an integral result,

possibly in-place, or null on failure.

This is the equivalent of the Python expression:

o1 /= o2.

PyAPI_FUNC(PyObject *) PyNumber_InPlaceTrueDivide(PyObject *o1,

PyObject *o2);

Returns the result of dividing o1 by o2 giving a float result,

possibly in-place, or null on failure.

This is the equivalent of the Python expression:

o1 /= o2.

PyAPI_FUNC(PyObject *) PyNumber_InPlaceRemainder(PyObject *o1, PyObject *o2);

Returns the remainder of dividing o1 by o2, possibly in-place, or

null on failure. This is the equivalent of the Python expression:

o1 %= o2.

PyAPI_FUNC(PyObject *) PyNumber_InPlacePower(PyObject *o1, PyObject *o2,

PyObject *o3);

Returns the result of raising o1 to the power of o2, possibly

in-place, or null on failure. This is the equivalent of the Python

expression: o1 **= o2, or pow(o1, o2, o3) if o3 is present.

PyAPI_FUNC(PyObject *) PyNumber_InPlaceLshift(PyObject *o1, PyObject *o2);

Returns the result of left shifting o1 by o2, possibly in-place, or

null on failure. This is the equivalent of the Python expression:

o1 <<= o2.

PyAPI_FUNC(PyObject *) PyNumber_InPlaceRshift(PyObject *o1, PyObject *o2);

Returns the result of right shifting o1 by o2, possibly in-place or

null on failure. This is the equivalent of the Python expression:

o1 >>= o2.

PyAPI_FUNC(PyObject *) PyNumber_InPlaceAnd(PyObject *o1, PyObject *o2);

Returns the result of bitwise and of o1 and o2, possibly in-place,

or null on failure. This is the equivalent of the Python

expression: o1 &= o2.

PyAPI_FUNC(PyObject *) PyNumber_InPlaceXor(PyObject *o1, PyObject *o2);

Returns the bitwise exclusive or of o1 by o2, possibly in-place, or

null on failure. This is the equivalent of the Python expression:

o1 ^= o2.

PyAPI_FUNC(PyObject *) PyNumber_InPlaceOr(PyObject *o1, PyObject *o2);

Returns the result of bitwise or of o1 and o2, possibly in-place,

or null on failure. This is the equivalent of the Python

expression: o1 |= o2.

PyAPI_FUNC(PyObject *) PyNumber_ToBase(PyObject *n, int base);

Returns the integer n converted to a string with a base, with a base

marker of 0b, 0o or 0x prefixed if applicable.

If n is not an int object, it is converted with PyNumber_Index first.

/* Sequence protocol:*/

PyAPI_FUNC(int) PySequence_Check(PyObject *o);

Return 1 if the object provides sequence protocol, and zero

otherwise.

This function always succeeds.

PyAPI_FUNC(Py_ssize_t) PySequence_Size(PyObject *o);

Return the size of sequence object o, or -1 on failure.

/* For DLL compatibility */

#undef PySequence_Length

PyAPI_FUNC(Py_ssize_t) PySequence_Length(PyObject *o);

#define PySequence_Length PySequence_Size

PyAPI_FUNC(PyObject *) PySequence_Concat(PyObject *o1, PyObject *o2);

Return the concatenation of o1 and o2 on success, and NULL on

failure. This is the equivalent of the Python

expression: o1+o2.

PyAPI_FUNC(PyObject *) PySequence_Repeat(PyObject *o, Py_ssize_t count);

Return the result of repeating sequence object o count times,

or NULL on failure. This is the equivalent of the Python

expression: o1*count.

PyAPI_FUNC(PyObject *) PySequence_GetItem(PyObject *o, Py_ssize_t i);

Return the ith element of o, or NULL on failure. This is the

equivalent of the Python expression: o[i].

PyAPI_FUNC(PyObject *) PySequence_GetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2);

Return the slice of sequence object o between i1 and i2, or

NULL on failure. This is the equivalent of the Python

expression: o[i1:i2].

PyAPI_FUNC(int) PySequence_SetItem(PyObject *o, Py_ssize_t i, PyObject *v);

Assign object v to the ith element of o. Raise an exception and return

-1 on failure; return 0 on success. This is the equivalent of the

Python statement o[i]=v.

View remainder of file in raw view

cpython/Include/abstract.h at 3.5 · python/cpython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

abstract.h

Latest commit

History

Breadcrumbs

abstract.h

File metadata and controls