py36/c-api/function.html at master · python-doc-ja/py36 · GitHub

Repository navigation

History

281 lines (247 loc) · 19.8 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

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

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

<head>

<title>Function オブジェクト — Python 3.6.5 ドキュメント</title>

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '3.6.5',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Python 3.6.5 ドキュメント内を検索"

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

$(document).ready(function() {

var base = 'https://docs.python.org/3.6/c-api/function.html';

$('a.headerlink').each(function() {

var html = '<a href="' + base + $(this).attr('href') +

'" title="原文へのリンク"><small>(原文)</small></a>';

$(this).after(html);

})

});

</script>

</head>

<body>

<h3>ナビゲーション</h3>

<ul>

<a href="../genindex.html" title="総索引"

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

<a href="../py-modindex.html" title="Pythonモジュール索引"

>モジュール</a> |</li>

<a href="method.html" title="インスタンスメソッドオブジェクト(Instance Method Objects)"

accesskey="N">次へ</a> |</li>

<a href="set.html" title="Set オブジェクト"

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>

<a href="../index.html">ドキュメント</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="concrete.html" accesskey="U">具象オブジェクト (concrete object) レイヤ</a> »</li>

</form>

</div>

</li>

</ul>

</div>

<span id="id1"></span><h1>Function オブジェクト<a class="headerlink" href="#function-objects" title="このヘッドラインへのパーマリンク">¶</a></h1>

<p id="index-0">Functionオブジェクト固有の関数はわずかです。</p>

<code class="descname">PyFunctionObject</code><a class="headerlink" href="#c.PyFunctionObject" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>関数に使われるCの構造体。</p>

</dd></dl>

<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> <code class="descname">PyFunction_Type</code><a class="headerlink" href="#c.PyFunction_Type" title="この定義へのパーマリンク">¶</a></dt>

<dd><p id="index-1"><a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject"><code class="xref c c-type docutils literal"><span class="pre">PyTypeObject</span></code></a> 型のインスタンスで、 Python の関数型を表します。これは Python プログラムに <code class="docutils literal"><span class="pre">types.FunctionType</span></code> として公開されています。</p>

</dd></dl>

int <code class="descname">PyFunction_Check</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *o</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyFunction_Check" title="この定義へのパーマリンク">¶</a></dt>

<dd><p><em>o</em> が関数オブジェクト (<a class="reference internal" href="#c.PyFunction_Type" title="PyFunction_Type"><code class="xref c c-data docutils literal"><span class="pre">PyFunction_Type</span></code></a> 型なら) なら true を返します。引数は <em>NULL</em> であってはいけません。</p>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyFunction_New</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *code</em>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *globals</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyFunction_New" title="この定義へのパーマリンク">¶</a></dt>

<dd><em class="refcount">Return value: New reference.</em><p>コードオブジェクト <em>code</em> に関連付けられた新しい関数オブジェクトを返します。<em>globals</em> はこの関数からアクセスできるグローバル変数の辞書でなければなりません。</p>

<p>関数のドキュメント文字列と名前はコードオブジェクトから取得されます。 <em>__module__</em> は <em>globals</em> から取得されます。引数のデフォルト値やアノテーション、クロージャは <em>NULL</em> に設定されます。 <em>__qualname__</em> は関数名と同じ値に設定されます。</p>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyFunction_NewWithQualName</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *code</em>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *globals</em>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *qualname</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyFunction_NewWithQualName" title="この定義へのパーマリンク">¶</a></dt>

<dd><em class="refcount">Return value: New reference.</em><p><a class="reference internal" href="#c.PyFunction_New" title="PyFunction_New"><code class="xref c c-func docutils literal"><span class="pre">PyFunction_New()</span></code></a> に似ていますが、関数オブジェクトの <code class="docutils literal"><span class="pre">__qualname__</span></code> 属性に値をセットすることができます。 <em>qualname</em> はユニコードオブジェクトか NULL でなくてはなりません; NULL だった場合、 <code class="docutils literal"><span class="pre">__qualname__</span></code> 属性には <code class="docutils literal"><span class="pre">__name__</span></code> 属性と同じ値がセットされます。</p>

<p><span class="versionmodified">バージョン 3.3 で追加.</span></p>

</div>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyFunction_GetCode</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *op</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyFunction_GetCode" title="この定義へのパーマリンク">¶</a></dt>

<dd><em class="refcount">Return value: Borrowed reference.</em><p>関数オブジェクト <em>op</em> に関連付けられたコードオブジェクトを返します。</p>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyFunction_GetGlobals</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *op</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyFunction_GetGlobals" title="この定義へのパーマリンク">¶</a></dt>

<dd><em class="refcount">Return value: Borrowed reference.</em><p>関数オブジェクト <em>op</em> に関連付けられたglobals辞書を返します。</p>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyFunction_GetModule</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *op</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyFunction_GetModule" title="この定義へのパーマリンク">¶</a></dt>

<dd><em class="refcount">Return value: Borrowed reference.</em><p>関数オブジェクト <em>op</em> の <em>__module__</em> 属性を返します。これには普通はモジュール名の文字列が入っていますが、Python コードから他のオブジェクトをセットされることもあります。</p>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyFunction_GetDefaults</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *op</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyFunction_GetDefaults" title="この定義へのパーマリンク">¶</a></dt>

<dd><em class="refcount">Return value: Borrowed reference.</em><p>関数オブジェクト <em>op</em> の引数のデフォルト値を返します。引数のタプルか <em>NULL</em> になります。</p>

</dd></dl>

int <code class="descname">PyFunction_SetDefaults</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *op</em>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *defaults</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyFunction_SetDefaults" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>関数オブジェクト <em>op</em> の引数のデフォルト値を設定します。<em>defaults</em> は <em>Py_None</em> かタプルでなければいけません。</p>

<p>失敗した時は、 <a class="reference internal" href="../library/exceptions.html#SystemError" title="SystemError"><code class="xref py py-exc docutils literal"><span class="pre">SystemError</span></code></a> を発生させ、 <code class="docutils literal"><span class="pre">-1</span></code> を返します。</p>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyFunction_GetClosure</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *op</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyFunction_GetClosure" title="この定義へのパーマリンク">¶</a></dt>

<dd><em class="refcount">Return value: Borrowed reference.</em><p>関数オブジェクト <em>op</em> に設定されたクロージャを返します。<em>NULL</em> か cell オブジェクトのタプルです。</p>

</dd></dl>

int <code class="descname">PyFunction_SetClosure</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *op</em>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *closure</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyFunction_SetClosure" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>関数オブジェクト <em>op</em> にクロージャを設定します。<em>closure</em> は、<em>Py_None</em> もしくは cell オブジェクトのタプルでなければなりません。</p>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *<code class="descname">PyFunction_GetAnnotations</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *op</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyFunction_GetAnnotations" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>関数オブジェクト <em>op</em> のアノテーションを返します。返り値は修正可能な辞書か <em>NULL</em> になります。</p>

</dd></dl>

int <code class="descname">PyFunction_SetAnnotations</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *op</em>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *annotations</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyFunction_SetAnnotations" title="この定義へのパーマリンク">¶</a></dt>

<dd><p>関数オブジェクト <em>op</em> のアノテーションを設定します。<em>annotations</em> は辞書か、<em>Py_None</em> でなければなりません。</p>

</dd></dl>

</div>

<h4>前のトピックへ</h4>

<p class="topless"><a href="set.html"

title="前の章へ">Set オブジェクト</a></p>

<h4>次のトピックへ</h4>

<p class="topless"><a href="method.html"

title="次の章へ">インスタンスメソッドオブジェクト(Instance Method Objects)</a></p>

<h3>このページ</h3>

<li>

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

rel="nofollow">ソースの表示

</a>

</li>

</ul>

</div>

</div>

<h3>ナビゲーション</h3>

<ul>

<a href="../genindex.html" title="総索引"

>索引</a></li>

<a href="../py-modindex.html" title="Pythonモジュール索引"

>モジュール</a> |</li>

<a href="method.html" title="インスタンスメソッドオブジェクト(Instance Method Objects)"

>次へ</a> |</li>

<a href="set.html" title="Set オブジェクト"

>前へ</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>

<a href="../index.html">ドキュメント</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="concrete.html" >具象オブジェクト (concrete object) レイヤ</a> »</li>

</form>

</div>

</li>

</ul>

</div>

<br />

Python Software Foundation は非営利団体です。

<br />

最終更新日時: 7月 29, 2018

<a href="../bugs.html">バグを見つけたら</a>?

<br />

このドキュメントは <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.6.5 を使って作成されました。

</div>

</body>

</html>

py36/c-api/function.html at master · python-doc-ja/py36 · GitHub

Repository navigation

Expand file tree

Breadcrumbs

function.html

Latest commit

History

Breadcrumbs

function.html

File metadata and controls