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

History

353 lines (311 loc) · 28.5 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

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

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

<head>

<title>Sequence 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="mapping.html" title="Mapping Protocol"

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

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

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>Sequence Protocol<a class="headerlink" href="#sequence-protocol" title="本標題的永久連結">¶</a></h1>

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

<dd>Return <code class="docutils literal notranslate">1</code> if the object provides sequence protocol, and <code class="docutils literal notranslate">0</code> otherwise.

Note that it returns <code class="docutils literal notranslate">1</code> for Python classes with a <a class="reference internal" href="../reference/datamodel.html#object.__getitem__" title="object.__getitem__"><code class="xref py py-meth docutils literal notranslate">__getitem__()</code></a>

method unless they are <a class="reference internal" href="../library/stdtypes.html#dict" title="dict"><code class="xref py py-class docutils literal notranslate">dict</code></a> subclasses since in general case it

is impossible to determine what the type of keys it supports. This

function always succeeds.

</dd></dl>

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

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

<dd>Returns the number of objects in sequence o on success, and <code class="docutils literal notranslate">-1</code> on

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

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PySequence_Concat</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)<a class="headerlink" href="#c.PySequence_Concat" title="本定義的永久連結">¶</a></dt>

<dd>Return value: New reference.Return the concatenation of o1 and o2 on success, and NULL on failure.

This is the equivalent of the Python expression <code class="docutils literal notranslate">o1 + o2</code>.

</dd></dl>

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

<dd>Return value: New reference.Return the result of repeating sequence object o count times, or NULL on

failure. This is the equivalent of the Python expression <code class="docutils literal notranslate">o * count</code>.

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PySequence_InPlaceConcat</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)<a class="headerlink" href="#c.PySequence_InPlaceConcat" title="本定義的永久連結">¶</a></dt>

<dd>Return value: New reference.Return the concatenation of o1 and o2 on success, and NULL on failure.

The operation is done in-place when o1 supports it. This is the equivalent

of the Python expression <code class="docutils literal notranslate">o1 += o2</code>.

</dd></dl>

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

<dd>Return value: New reference.Return the result of repeating sequence object o count times, or NULL on

failure. The operation is done in-place when o supports it. This is the

equivalent of the Python expression <code class="docutils literal notranslate">o *= count</code>.

</dd></dl>

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

<dd>Return value: New reference.Return the ith element of o, or NULL on failure. This is the equivalent of

the Python expression <code class="docutils literal notranslate">o[i]</code>.

</dd></dl>

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

<dd>Return value: New reference.Return the slice of sequence object o between i1 and i2, or NULL on

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

</dd></dl>

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

<dd>Assign object v to the ith element of o. 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[i] = v</code>. This function does

not steal a reference to v.

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

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

</dd></dl>

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

<dd>Delete the ith element of 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[i]</code>.

</dd></dl>

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

<dd>Assign the sequence object v to the slice in sequence object o from i1 to

i2. This is the equivalent of the Python statement <code class="docutils literal notranslate">o[i1:i2] = v</code>.

</dd></dl>

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

<dd>Delete the slice in sequence object o from i1 to i2. 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[i1:i2]</code>.

</dd></dl>

Py_ssize_t <code class="descname">PySequence_Count</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> *value)<a class="headerlink" href="#c.PySequence_Count" title="本定義的永久連結">¶</a></dt>

<dd>Return the number of occurrences of value in o, that is, return the number

of keys for which <code class="docutils literal notranslate">o[key] == value</code>. On failure, return <code class="docutils literal notranslate">-1</code>. This is

equivalent to the Python expression <code class="docutils literal notranslate">o.count(value)</code>.

</dd></dl>

int <code class="descname">PySequence_Contains</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> *value)<a class="headerlink" href="#c.PySequence_Contains" title="本定義的永久連結">¶</a></dt>

<dd>Determine if o contains value. If an item in o is equal to value,

return <code class="docutils literal notranslate">1</code>, otherwise return <code class="docutils literal notranslate">0</code>. On error, return <code class="docutils literal notranslate">-1</code>. This is

equivalent to the Python expression <code class="docutils literal notranslate">value in o</code>.

</dd></dl>

Py_ssize_t <code class="descname">PySequence_Index</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> *value)<a class="headerlink" href="#c.PySequence_Index" title="本定義的永久連結">¶</a></dt>

<dd>Return the first index i for which <code class="docutils literal notranslate">o[i] == value</code>. On error, return

<code class="docutils literal notranslate">-1</code>. This is equivalent to the Python expression <code class="docutils literal notranslate">o.index(value)</code>.

</dd></dl>

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

<dd>Return value: New reference.Return a list object with the same contents as the sequence or iterable o,

or NULL on failure. The returned list is guaranteed to be new. This is

equivalent to the Python expression <code class="docutils literal notranslate">list(o)</code>.

</dd></dl>

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

<dd>Return value: New reference.Return a tuple object with the same contents as the sequence or iterable o,

or NULL on failure. If o is a tuple, a new reference will be returned,

otherwise a tuple will be constructed with the appropriate contents. This is

equivalent to the Python expression <code class="docutils literal notranslate">tuple(o)</code>.

</dd></dl>

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

<dd>Return value: New reference.Return the sequence or iterable o as a list, unless it is already a tuple or list, in

which case o is returned. Use <a class="reference internal" href="#c.PySequence_Fast_GET_ITEM" title="PySequence_Fast_GET_ITEM"><code class="xref c c-func docutils literal notranslate">PySequence_Fast_GET_ITEM()</code></a> to access

the members of the result. Returns NULL on failure. If the object is not

a sequence or iterable, raises <a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a> with m as the message text.

</dd></dl>

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

<dd>Returns the length of o, assuming that o was returned by

<a class="reference internal" href="#c.PySequence_Fast" title="PySequence_Fast"><code class="xref c c-func docutils literal notranslate">PySequence_Fast()</code></a> and that o is not NULL. The size can also be

gotten by calling <a class="reference internal" href="#c.PySequence_Size" title="PySequence_Size"><code class="xref c c-func docutils literal notranslate">PySequence_Size()</code></a> on o, but

<a class="reference internal" href="#c.PySequence_Fast_GET_SIZE" title="PySequence_Fast_GET_SIZE"><code class="xref c c-func docutils literal notranslate">PySequence_Fast_GET_SIZE()</code></a> is faster because it can assume o is a list

or tuple.

</dd></dl>

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

<dd>Return value: Borrowed reference.Return the ith element of o, assuming that o was returned by

<a class="reference internal" href="#c.PySequence_Fast" title="PySequence_Fast"><code class="xref c c-func docutils literal notranslate">PySequence_Fast()</code></a>, o is not NULL, and that i is within bounds.

</dd></dl>

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

<dd>Return the underlying array of PyObject pointers. Assumes that o was returned

by <a class="reference internal" href="#c.PySequence_Fast" title="PySequence_Fast"><code class="xref c c-func docutils literal notranslate">PySequence_Fast()</code></a> and o is not NULL.

Note, if a list gets resized, the reallocation may relocate the items array.

So, only use the underlying array pointer in contexts where the sequence

cannot change.

</dd></dl>

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

<dd>Return value: New reference.Return the ith element of o or NULL on failure. Macro form of

<a class="reference internal" href="#c.PySequence_GetItem" title="PySequence_GetItem"><code class="xref c c-func docutils literal notranslate">PySequence_GetItem()</code></a> but without checking that

<a class="reference internal" href="#c.PySequence_Check" title="PySequence_Check"><code class="xref c c-func docutils literal notranslate">PySequence_Check()</code></a> on o is true and without adjustment for negative

indices.

</dd></dl>

</div>

<a href="number.html"

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

<a href="mapping.html"

title="下一章">Mapping 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/sequence.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="mapping.html" title="Mapping Protocol"

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

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

>上一頁</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

sequence.html

Latest commit

History

sequence.html

File metadata and controls