python-doc-tw.github.io/c-api/object.html at master · python-doc-tw/python-doc-tw.github.io

History

616 lines (553 loc) · 59.9 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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>Object Protocol — Python 3.7.0 說明文件</title>

title="在 Python 3.7.0 說明文件中搜尋"

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

</head><body>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">索引</a></li>

<a href="../py-modindex.html" title="Python 模組索引"

>模組</a> |</li>

<a href="number.html" title="Number Protocol"

accesskey="N">下一頁</a> |</li>

<a href="abstract.html" title="抽象物件層"

accesskey="P">上一頁</a> |</li>

<li><img src="../_static/py.png" alt=""

style="vertical-align: middle; margin-top: -1px"/></li>

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

<li>

zh_TW

3.7.0

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

</li>

<li class="nav-item nav-item-1"><a href="index.html" >Python / C API 參考手冊</a> »</li>

<li class="nav-item nav-item-2"><a href="abstract.html" accesskey="U">抽象物件層</a> »</li>

</form>

</div>

</li>

</ul>

</div>

<h1>Object Protocol<a class="headerlink" href="#object-protocol" title="本標題的永久連結">¶</a></h1>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">Py_NotImplemented</code><a class="headerlink" href="#c.Py_NotImplemented" title="本定義的永久連結">¶</a></dt>

<dd>The <code class="docutils literal notranslate">NotImplemented</code> singleton, used to signal that an operation is

not implemented for the given type combination.

</dd></dl>

<code class="descname">Py_RETURN_NOTIMPLEMENTED</code><a class="headerlink" href="#c.Py_RETURN_NOTIMPLEMENTED" title="本定義的永久連結">¶</a></dt>

<dd>Properly handle returning <a class="reference internal" href="#c.Py_NotImplemented" title="Py_NotImplemented"><code class="xref c c-data docutils literal notranslate">Py_NotImplemented</code></a> from within a C

function (that is, increment the reference count of NotImplemented and

return it).

</dd></dl>

int <code class="descname">PyObject_Print</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, FILE *fp, int flags)<a class="headerlink" href="#c.PyObject_Print" title="本定義的永久連結">¶</a></dt>

<dd>Print an object o, on file fp. Returns <code class="docutils literal notranslate">-1</code> on error. The flags argument

is used to enable certain printing options. The only option currently supported

is <code class="xref py py-const docutils literal notranslate">Py_PRINT_RAW</code>; if given, the <a class="reference internal" href="../library/stdtypes.html#str" title="str"><code class="xref py py-func docutils literal notranslate">str()</code></a> of the object is written

instead of the <a class="reference internal" href="../library/functions.html#repr" title="repr"><code class="xref py py-func docutils literal notranslate">repr()</code></a>.

</dd></dl>

int <code class="descname">PyObject_HasAttr</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *attr_name)<a class="headerlink" href="#c.PyObject_HasAttr" title="本定義的永久連結">¶</a></dt>

<dd>Returns <code class="docutils literal notranslate">1</code> if o has the attribute attr_name, and <code class="docutils literal notranslate">0</code> otherwise. This

is equivalent to the Python expression <code class="docutils literal notranslate">hasattr(o, attr_name)</code>. This function

always succeeds.

</dd></dl>

int <code class="descname">PyObject_HasAttrString</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, const char *attr_name)<a class="headerlink" href="#c.PyObject_HasAttrString" title="本定義的永久連結">¶</a></dt>

is equivalent to the Python expression <code class="docutils literal notranslate">hasattr(o, attr_name)</code>. This function

always succeeds.

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_GetAttr</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *attr_name)<a class="headerlink" href="#c.PyObject_GetAttr" title="本定義的永久連結">¶</a></dt>

<dd>Return value: New reference.Retrieve an attribute named attr_name from object o. Returns the attribute

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

expression <code class="docutils literal notranslate">o.attr_name</code>.

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_GetAttrString</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, const char *attr_name)<a class="headerlink" href="#c.PyObject_GetAttrString" title="本定義的永久連結">¶</a></dt>

<dd>Return value: New reference.Retrieve an attribute named attr_name from object o. Returns the attribute

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

expression <code class="docutils literal notranslate">o.attr_name</code>.

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_GenericGetAttr</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *name)<a class="headerlink" href="#c.PyObject_GenericGetAttr" title="本定義的永久連結">¶</a></dt>

<dd>Generic attribute getter function that is meant to be put into a type

object’s <code class="docutils literal notranslate">tp_getattro</code> slot. It looks for a descriptor in the dictionary

of classes in the object’s MRO as well as an attribute in the object’s

<a class="reference internal" href="../library/stdtypes.html#object.__dict__" title="object.__dict__"><code class="xref py py-attr docutils literal notranslate">__dict__</code></a> (if present). As outlined in <a class="reference internal" href="../reference/datamodel.html#descriptors">Implementing Descriptors</a>,

data descriptors take preference over instance attributes, while non-data

descriptors don’t. Otherwise, an <a class="reference internal" href="../library/exceptions.html#AttributeError" title="AttributeError"><code class="xref py py-exc docutils literal notranslate">AttributeError</code></a> is raised.

</dd></dl>

int <code class="descname">PyObject_SetAttr</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *attr_name, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *v)<a class="headerlink" href="#c.PyObject_SetAttr" title="本定義的永久連結">¶</a></dt>

<dd>Set the value of the attribute named attr_name, for object o, to the value

v. Raise an exception and return <code class="docutils literal notranslate">-1</code> on failure;

return <code class="docutils literal notranslate">0</code> on success. This is the equivalent of the Python statement

<code class="docutils literal notranslate">o.attr_name = v</code>.

If v is NULL, the attribute is deleted, however this feature is

deprecated in favour of using <a class="reference internal" href="#c.PyObject_DelAttr" title="PyObject_DelAttr"><code class="xref c c-func docutils literal notranslate">PyObject_DelAttr()</code></a>.

</dd></dl>

int <code class="descname">PyObject_SetAttrString</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, const char *attr_name, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *v)<a class="headerlink" href="#c.PyObject_SetAttrString" title="本定義的永久連結">¶</a></dt>

<dd>Set the value of the attribute named attr_name, for object o, to the value

v. Raise an exception and return <code class="docutils literal notranslate">-1</code> on failure;

return <code class="docutils literal notranslate">0</code> on success. This is the equivalent of the Python statement

<code class="docutils literal notranslate">o.attr_name = v</code>.

If v is NULL, the attribute is deleted, however this feature is

deprecated in favour of using <a class="reference internal" href="#c.PyObject_DelAttrString" title="PyObject_DelAttrString"><code class="xref c c-func docutils literal notranslate">PyObject_DelAttrString()</code></a>.

</dd></dl>

int <code class="descname">PyObject_GenericSetAttr</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *name, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *value)<a class="headerlink" href="#c.PyObject_GenericSetAttr" title="本定義的永久連結">¶</a></dt>

<dd>Generic attribute setter and deleter function that is meant

to be put into a type object’s <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_setattro" title="PyTypeObject.tp_setattro"><code class="xref c c-member docutils literal notranslate">tp_setattro</code></a>

slot. It looks for a data descriptor in the

dictionary of classes in the object’s MRO, and if found it takes preference

over setting or deleting the attribute in the instance dictionary. Otherwise, the

attribute is set or deleted in the object’s <a class="reference internal" href="../library/stdtypes.html#object.__dict__" title="object.__dict__"><code class="xref py py-attr docutils literal notranslate">__dict__</code></a> (if present).

On success, <code class="docutils literal notranslate">0</code> is returned, otherwise an <a class="reference internal" href="../library/exceptions.html#AttributeError" title="AttributeError"><code class="xref py py-exc docutils literal notranslate">AttributeError</code></a>

is raised and <code class="docutils literal notranslate">-1</code> is returned.

</dd></dl>

int <code class="descname">PyObject_DelAttr</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *attr_name)<a class="headerlink" href="#c.PyObject_DelAttr" title="本定義的永久連結">¶</a></dt>

<dd>Delete attribute named attr_name, for object o. Returns <code class="docutils literal notranslate">-1</code> on failure.

This is the equivalent of the Python statement <code class="docutils literal notranslate">del o.attr_name</code>.

</dd></dl>

int <code class="descname">PyObject_DelAttrString</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, const char *attr_name)<a class="headerlink" href="#c.PyObject_DelAttrString" title="本定義的永久連結">¶</a></dt>

<dd>Delete attribute named attr_name, for object o. Returns <code class="docutils literal notranslate">-1</code> on failure.

This is the equivalent of the Python statement <code class="docutils literal notranslate">del o.attr_name</code>.

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_GenericGetDict</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, void *context)<a class="headerlink" href="#c.PyObject_GenericGetDict" title="本定義的永久連結">¶</a></dt>

<dd>A generic implementation for the getter of a <code class="docutils literal notranslate">__dict__</code> descriptor. It

creates the dictionary if necessary.

3.3 版新加入.

</div>

</dd></dl>

int <code class="descname">PyObject_GenericSetDict</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, void *context)<a class="headerlink" href="#c.PyObject_GenericSetDict" title="本定義的永久連結">¶</a></dt>

<dd>A generic implementation for the setter of a <code class="docutils literal notranslate">__dict__</code> descriptor. This

implementation does not allow the dictionary to be deleted.

3.3 版新加入.

</div>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_RichCompare</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o1, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o2, int opid)<a class="headerlink" href="#c.PyObject_RichCompare" title="本定義的永久連結">¶</a></dt>

<dd>Return value: New reference.Compare the values of o1 and o2 using the operation specified by opid,

which must be one of <code class="xref py py-const docutils literal notranslate">Py_LT</code>, <code class="xref py py-const docutils literal notranslate">Py_LE</code>, <code class="xref py py-const docutils literal notranslate">Py_EQ</code>,

<code class="xref py py-const docutils literal notranslate">Py_NE</code>, <code class="xref py py-const docutils literal notranslate">Py_GT</code>, or <code class="xref py py-const docutils literal notranslate">Py_GE</code>, corresponding to <code class="docutils literal notranslate"><</code>,

<code class="docutils literal notranslate"><=</code>, <code class="docutils literal notranslate">==</code>, <code class="docutils literal notranslate">!=</code>, <code class="docutils literal notranslate">></code>, or <code class="docutils literal notranslate">>=</code> respectively. This is the equivalent of

the Python expression <code class="docutils literal notranslate">o1 op o2</code>, where <code class="docutils literal notranslate">op</code> is the operator corresponding

to opid. Returns the value of the comparison on success, or NULL on failure.

</dd></dl>

int <code class="descname">PyObject_RichCompareBool</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o1, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o2, int opid)<a class="headerlink" href="#c.PyObject_RichCompareBool" title="本定義的永久連結">¶</a></dt>

<dd>Compare the values of o1 and o2 using the operation specified by opid,

<code class="docutils literal notranslate">0</code> if the result is false, <code class="docutils literal notranslate">1</code> otherwise. This is the equivalent of the

Python expression <code class="docutils literal notranslate">o1 op o2</code>, where <code class="docutils literal notranslate">op</code> is the operator corresponding to

opid.

</dd></dl>

備註

If o1 and o2 are the same object, <a class="reference internal" href="#c.PyObject_RichCompareBool" title="PyObject_RichCompareBool"><code class="xref c c-func docutils literal notranslate">PyObject_RichCompareBool()</code></a>

will always return <code class="docutils literal notranslate">1</code> for <code class="xref py py-const docutils literal notranslate">Py_EQ</code> and <code class="docutils literal notranslate">0</code> for <code class="xref py py-const docutils literal notranslate">Py_NE</code>.

</div>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_Repr</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyObject_Repr" title="本定義的永久連結">¶</a></dt>

<dd>Return value: New reference.Compute a string representation of object o. Returns the string

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

Python expression <code class="docutils literal notranslate">repr(o)</code>. Called by the <a class="reference internal" href="../library/functions.html#repr" title="repr"><code class="xref py py-func docutils literal notranslate">repr()</code></a> built-in function.

3.4 版更變: This function now includes a debug assertion to help ensure that it

does not silently discard an active exception.

</div>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_ASCII</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyObject_ASCII" title="本定義的永久連結">¶</a></dt>

<dd>As <a class="reference internal" href="#c.PyObject_Repr" title="PyObject_Repr"><code class="xref c c-func docutils literal notranslate">PyObject_Repr()</code></a>, compute a string representation of object o, but

escape the non-ASCII characters in the string returned by

<a class="reference internal" href="#c.PyObject_Repr" title="PyObject_Repr"><code class="xref c c-func docutils literal notranslate">PyObject_Repr()</code></a> with <code class="docutils literal notranslate">\x</code>, <code class="docutils literal notranslate">\u</code> or <code class="docutils literal notranslate">\U</code> escapes. This generates

a string similar to that returned by <a class="reference internal" href="#c.PyObject_Repr" title="PyObject_Repr"><code class="xref c c-func docutils literal notranslate">PyObject_Repr()</code></a> in Python 2.

Called by the <a class="reference internal" href="../library/functions.html#ascii" title="ascii"><code class="xref py py-func docutils literal notranslate">ascii()</code></a> built-in function.

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_Str</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyObject_Str" title="本定義的永久連結">¶</a></dt>

<dd>Return value: New reference.Compute a string representation of object o. Returns the string

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

Python expression <code class="docutils literal notranslate">str(o)</code>. Called by the <a class="reference internal" href="../library/stdtypes.html#str" title="str"><code class="xref py py-func docutils literal notranslate">str()</code></a> built-in function

and, therefore, by the <a class="reference internal" href="../library/functions.html#print" title="print"><code class="xref py py-func docutils literal notranslate">print()</code></a> function.

3.4 版更變: This function now includes a debug assertion to help ensure that it

does not silently discard an active exception.

</div>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_Bytes</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyObject_Bytes" title="本定義的永久連結">¶</a></dt>

<dd>Compute a bytes representation of object o. NULL is returned on

failure and a bytes object on success. This is equivalent to the Python

expression <code class="docutils literal notranslate">bytes(o)</code>, when o is not an integer. Unlike <code class="docutils literal notranslate">bytes(o)</code>,

a TypeError is raised when o is an integer instead of a zero-initialized

bytes object.

</dd></dl>

int <code class="descname">PyObject_IsSubclass</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *derived, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *cls)<a class="headerlink" href="#c.PyObject_IsSubclass" title="本定義的永久連結">¶</a></dt>

<dd>Return <code class="docutils literal notranslate">1</code> if the class derived is identical to or derived from the class

cls, otherwise return <code class="docutils literal notranslate">0</code>. In case of an error, return <code class="docutils literal notranslate">-1</code>.

If cls is a tuple, the check will be done against every entry in cls.

The result will be <code class="docutils literal notranslate">1</code> when at least one of the checks returns <code class="docutils literal notranslate">1</code>,

otherwise it will be <code class="docutils literal notranslate">0</code>.

If cls has a <a class="reference internal" href="../reference/datamodel.html#class.__subclasscheck__" title="class.__subclasscheck__"><code class="xref py py-meth docutils literal notranslate">__subclasscheck__()</code></a> method, it will be called to

determine the subclass status as described in <a class="pep reference external" href="https://www.python.org/dev/peps/pep-3119">PEP 3119</a>. Otherwise,

derived is a subclass of cls if it is a direct or indirect subclass,

i.e. contained in <code class="docutils literal notranslate">cls.__mro__</code>.

Normally only class objects, i.e. instances of <a class="reference internal" href="../library/functions.html#type" title="type"><code class="xref py py-class docutils literal notranslate">type</code></a> or a derived

class, are considered classes. However, objects can override this by having

a <code class="xref py py-attr docutils literal notranslate">__bases__</code> attribute (which must be a tuple of base classes).

</dd></dl>

int <code class="descname">PyObject_IsInstance</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *inst, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *cls)<a class="headerlink" href="#c.PyObject_IsInstance" title="本定義的永久連結">¶</a></dt>

<dd>Return <code class="docutils literal notranslate">1</code> if inst is an instance of the class cls or a subclass of

cls, or <code class="docutils literal notranslate">0</code> if not. On error, returns <code class="docutils literal notranslate">-1</code> and sets an exception.

If cls is a tuple, the check will be done against every entry in cls.

otherwise it will be <code class="docutils literal notranslate">0</code>.

If cls has a <a class="reference internal" href="../reference/datamodel.html#class.__instancecheck__" title="class.__instancecheck__"><code class="xref py py-meth docutils literal notranslate">__instancecheck__()</code></a> method, it will be called to

determine the subclass status as described in <a class="pep reference external" href="https://www.python.org/dev/peps/pep-3119">PEP 3119</a>. Otherwise, inst

is an instance of cls if its class is a subclass of cls.

An instance inst can override what is considered its class by having a

<code class="xref py py-attr docutils literal notranslate">__class__</code> attribute.

An object cls can override if it is considered a class, and what its base

classes are, by having a <code class="xref py py-attr docutils literal notranslate">__bases__</code> attribute (which must be a tuple

of base classes).

</dd></dl>

int <code class="descname">PyCallable_Check</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyCallable_Check" title="本定義的永久連結">¶</a></dt>

<dd>Determine if the object o is callable. Return <code class="docutils literal notranslate">1</code> if the object is callable

and <code class="docutils literal notranslate">0</code> otherwise. This function always succeeds.

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_Call</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *callable, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *args, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *kwargs)<a class="headerlink" href="#c.PyObject_Call" title="本定義的永久連結">¶</a></dt>

<dd>Return value: New reference.Call a callable Python object callable, with arguments given by the

tuple args, and named arguments given by the dictionary kwargs.

args must not be NULL, use an empty tuple if no arguments are needed.

If no named arguments are needed, kwargs can be NULL.

Returns the result of the call on success, or NULL on failure.

This is the equivalent of the Python expression:

<code class="docutils literal notranslate">callable(*args, **kwargs)</code>.

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_CallObject</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *callable, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *args)<a class="headerlink" href="#c.PyObject_CallObject" title="本定義的永久連結">¶</a></dt>

<dd>Return value: New reference.Call a callable Python object callable, with arguments given by the

tuple args. If no arguments are needed, then args can be NULL.

Returns the result of the call on success, or NULL on failure.

This is the equivalent of the Python expression: <code class="docutils literal notranslate">callable(*args)</code>.

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_CallFunction</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *callable, const char *format, ...)<a class="headerlink" href="#c.PyObject_CallFunction" title="本定義的永久連結">¶</a></dt>

<dd>Return value: New reference.Call a callable Python object callable, with a variable number of C arguments.

The C arguments are described using a <a class="reference internal" href="arg.html#c.Py_BuildValue" title="Py_BuildValue"><code class="xref c c-func docutils literal notranslate">Py_BuildValue()</code></a> style format

string. The format can 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: <code class="docutils literal notranslate">callable(*args)</code>.

Note that if you only pass <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><code class="xref c c-type docutils literal notranslate">PyObject *</code></a> args,

<a class="reference internal" href="#c.PyObject_CallFunctionObjArgs" title="PyObject_CallFunctionObjArgs"><code class="xref c c-func docutils literal notranslate">PyObject_CallFunctionObjArgs()</code></a> is a faster alternative.

3.4 版更變: The type of format was changed from <code class="docutils literal notranslate">char *</code>.

</div>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_CallMethod</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *obj, const char *name, const char *format, ...)<a class="headerlink" href="#c.PyObject_CallMethod" title="本定義的永久連結">¶</a></dt>

<dd>Return value: New reference.Call the method named name of object obj with a variable number of C

arguments. The C arguments are described by a <a class="reference internal" href="arg.html#c.Py_BuildValue" title="Py_BuildValue"><code class="xref c c-func docutils literal notranslate">Py_BuildValue()</code></a> format

string that should produce a tuple.

The format can 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:

<code class="docutils literal notranslate">obj.name(arg1, arg2, ...)</code>.

<a class="reference internal" href="#c.PyObject_CallMethodObjArgs" title="PyObject_CallMethodObjArgs"><code class="xref c c-func docutils literal notranslate">PyObject_CallMethodObjArgs()</code></a> is a faster alternative.

3.4 版更變: The types of name and format were changed from <code class="docutils literal notranslate">char *</code>.

</div>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_CallFunctionObjArgs</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *callable, ..., NULL)<a class="headerlink" href="#c.PyObject_CallFunctionObjArgs" title="本定義的永久連結">¶</a></dt>

<dd>Return value: New reference.Call a callable Python object callable, with a variable number of

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><code class="xref c c-type docutils literal notranslate">PyObject*</code></a> arguments. The arguments are provided as a variable number

of parameters followed by NULL.

Returns the result of the call on success, or NULL on failure.

This is the equivalent of the Python expression:

<code class="docutils literal notranslate">callable(arg1, arg2, ...)</code>.

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_CallMethodObjArgs</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *obj, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *name, ..., NULL)<a class="headerlink" href="#c.PyObject_CallMethodObjArgs" title="本定義的永久連結">¶</a></dt>

<dd>Return value: New reference.Calls a method of the Python object obj, where the name of the method is given as a

Python string object in name. It is called with a variable number of

of parameters followed by NULL. Returns the result of the call on success, or

NULL on failure.

</dd></dl>

Py_hash_t <code class="descname">PyObject_Hash</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyObject_Hash" title="本定義的永久連結">¶</a></dt>

<dd>Compute and return the hash value of an object o. On failure, return <code class="docutils literal notranslate">-1</code>.

This is the equivalent of the Python expression <code class="docutils literal notranslate">hash(o)</code>.

3.2 版更變: The return type is now Py_hash_t. This is a signed integer the same size

as Py_ssize_t.

</div>

</dd></dl>

Py_hash_t <code class="descname">PyObject_HashNotImplemented</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyObject_HashNotImplemented" title="本定義的永久連結">¶</a></dt>

<dd>Set a <a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a> indicating that <code class="docutils literal notranslate">type(o)</code> is not hashable and return <code class="docutils literal notranslate">-1</code>.

This function receives special treatment when stored in a <code class="docutils literal notranslate">tp_hash</code> slot,

allowing a type to explicitly indicate to the interpreter that it is not

hashable.

</dd></dl>

int <code class="descname">PyObject_IsTrue</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyObject_IsTrue" title="本定義的永久連結">¶</a></dt>

<dd>Returns <code class="docutils literal notranslate">1</code> if the object o is considered to be true, and <code class="docutils literal notranslate">0</code> otherwise.

This is equivalent to the Python expression <code class="docutils literal notranslate">not not o</code>. On failure, return

<code class="docutils literal notranslate">-1</code>.

</dd></dl>

int <code class="descname">PyObject_Not</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyObject_Not" title="本定義的永久連結">¶</a></dt>

<dd>Returns <code class="docutils literal notranslate">0</code> if the object o is considered to be true, and <code class="docutils literal notranslate">1</code> otherwise.

This is equivalent to the Python expression <code class="docutils literal notranslate">not o</code>. On failure, return

<code class="docutils literal notranslate">-1</code>.

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_Type</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyObject_Type" title="本定義的永久連結">¶</a></dt>

<dd>Return value: New reference.When o is non-NULL, returns a type object corresponding to the object type

of object o. On failure, raises <a class="reference internal" href="../library/exceptions.html#SystemError" title="SystemError"><code class="xref py py-exc docutils literal notranslate">SystemError</code></a> and returns NULL. This

is equivalent to the Python expression <code class="docutils literal notranslate">type(o)</code>. This function increments the

reference count of the return value. There’s really no reason to use this

function instead of the common expression <code class="docutils literal notranslate">o->ob_type</code>, which returns a

pointer of type <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject"><code class="xref c c-type docutils literal notranslate">PyTypeObject*</code></a>, except when the incremented reference

count is needed.

</dd></dl>

int <code class="descname">PyObject_TypeCheck</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyObject_TypeCheck" title="本定義的永久連結">¶</a></dt>

<dd>Return true if the object o is of type type or a subtype of type. Both

parameters must be non-NULL.

</dd></dl>

Py_ssize_t <code class="descname">PyObject_Size</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyObject_Size" title="本定義的永久連結">¶</a></dt>

Py_ssize_t <code class="descname">PyObject_Length</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyObject_Length" title="本定義的永久連結">¶</a></dt>

<dd>Return the length of object o. If the object o provides either the sequence

and mapping protocols, the sequence length is returned. On error, <code class="docutils literal notranslate">-1</code> is

returned. This is the equivalent to the Python expression <code class="docutils literal notranslate">len(o)</code>.

</dd></dl>

Py_ssize_t <code class="descname">PyObject_LengthHint</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, Py_ssize_t default)<a class="headerlink" href="#c.PyObject_LengthHint" title="本定義的永久連結">¶</a></dt>

<dd>Return an estimated length for the object o. First try to return its

actual length, then an estimate using <a class="reference internal" href="../reference/datamodel.html#object.__length_hint__" title="object.__length_hint__"><code class="xref py py-meth docutils literal notranslate">__length_hint__()</code></a>, and

finally return the default value. On error return <code class="docutils literal notranslate">-1</code>. This is the

equivalent to the Python expression <code class="docutils literal notranslate">operator.length_hint(o, default)</code>.

3.4 版新加入.

</div>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_GetItem</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *key)<a class="headerlink" href="#c.PyObject_GetItem" title="本定義的永久連結">¶</a></dt>

<dd>Return value: New reference.Return element of o corresponding to the object key or NULL on failure.

This is the equivalent of the Python expression <code class="docutils literal notranslate">o[key]</code>.

</dd></dl>

int <code class="descname">PyObject_SetItem</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *key, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *v)<a class="headerlink" href="#c.PyObject_SetItem" title="本定義的永久連結">¶</a></dt>

<dd>Map the object key to the value v. Raise an exception and

return <code class="docutils literal notranslate">-1</code> on failure; return <code class="docutils literal notranslate">0</code> on success. This is the

equivalent of the Python statement <code class="docutils literal notranslate">o[key] = v</code>.

</dd></dl>

int <code class="descname">PyObject_DelItem</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *key)<a class="headerlink" href="#c.PyObject_DelItem" title="本定義的永久連結">¶</a></dt>

<dd>Remove the mapping for the object key from the object o. Return <code class="docutils literal notranslate">-1</code>

on failure. This is equivalent to the Python statement <code class="docutils literal notranslate">del o[key]</code>.

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_Dir</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyObject_Dir" title="本定義的永久連結">¶</a></dt>

<dd>Return value: New reference.This is equivalent to the Python expression <code class="docutils literal notranslate">dir(o)</code>, returning a (possibly

empty) list of strings appropriate for the object argument, or NULL if there

was an error. If the argument is NULL, this is like the Python <code class="docutils literal notranslate">dir()</code>,

returning the names of the current locals; in this case, if no execution frame

is active then NULL is returned but <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> will return false.

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyObject_GetIter</code>(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyObject_GetIter" title="本定義的永久連結">¶</a></dt>

iterator for the object argument, or the object itself if the object is already

an iterator. Raises <a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a> and returns NULL if the object cannot be

iterated.

</dd></dl>

</div>

<a href="abstract.html"

title="上一章">抽象物件層</a>

<a href="number.html"

title="下一章">Number Protocol</a>

<li><a href="../bugs.html">Report a Bug</a></li>

<li>

<a href="https://github.com/python/cpython/blob/3.7/Doc/c-api/object.rst"

rel="nofollow">Show Source

</a>

</li>

</ul>

</div>

</div>

<ul>

<a href="../genindex.html" title="General Index"

>索引</a></li>

<a href="../py-modindex.html" title="Python 模組索引"

>模組</a> |</li>

<a href="number.html" title="Number Protocol"

>下一頁</a> |</li>

<a href="abstract.html" title="抽象物件層"

>上一頁</a> |</li>

<li><img src="../_static/py.png" alt=""

style="vertical-align: middle; margin-top: -1px"/></li>

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

<li>

zh_TW

3.7.0

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

</li>

<li class="nav-item nav-item-1"><a href="index.html" >Python / C API 參考手冊</a> »</li>

<li class="nav-item nav-item-2"><a href="abstract.html" >抽象物件層</a> »</li>

</form>

</div>

</li>

</ul>

</div>

The Python Software Foundation is a non-profit corporation.

<a href="https://www.python.org/psf/donations/">Please donate.</a>

Last updated on 8月 22, 2018.

<a href="../bugs.html">Found a bug</a>?

Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.7.7.

</div>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

object.html

Latest commit

History

object.html

File metadata and controls