-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcontextvars.html
More file actions
323 lines (284 loc) · 20.1 KB
/
contextvars.html
File metadata and controls
323 lines (284 loc) · 20.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="zh_TW">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Context Variables Objects — Python 3.7.0 說明文件</title>
<link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/translations.js"></script>
<script type="text/javascript" src="../_static/sidebar.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="在 Python 3.7.0 說明文件 中搜尋"
href="../_static/opensearch.xml"/>
<link rel="author" title="關於這些文件" href="../about.html" />
<link rel="index" title="索引" href="../genindex.html" />
<link rel="search" title="搜尋" href="../search.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
<link rel="next" title="DateTime 物件" href="datetime.html" />
<link rel="prev" title="Coroutine Objects" href="coro.html" />
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
<link rel="canonical" href="https://docs.python.org/3/c-api/contextvars.html" />
<script type="text/javascript" src="../_static/copybutton.js"></script>
<script type="text/javascript" src="../_static/switchers.js"></script>
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>瀏覽</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">索引</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python 模組索引"
>模組</a> |</li>
<li class="right" >
<a href="datetime.html" title="DateTime 物件"
accesskey="N">下一頁</a> |</li>
<li class="right" >
<a href="coro.html" title="Coroutine Objects"
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>
<span class="language_switcher_placeholder">zh_TW</span>
<span class="version_switcher_placeholder">3.7.0</span>
<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="concrete.html" accesskey="U">Concrete Objects Layer</a> »</li>
<li class="right">
<div class="inline-search" style="display: none" role="search">
<form class="inline-search" action="../search.html" method="get">
<input placeholder="Quick search" type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('.inline-search').show(0);</script>
|
</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="context-variables-objects">
<span id="contextvarsobjects"></span><h1>Context Variables Objects<a class="headerlink" href="#context-variables-objects" title="本標題的永久連結">¶</a></h1>
<div class="versionadded">
<p><span class="versionmodified">3.7 版新加入.</span></p>
</div>
<p>This section details the public C API for the <a class="reference internal" href="../library/contextvars.html#module-contextvars" title="contextvars: Context Variables"><code class="xref py py-mod docutils literal notranslate"><span class="pre">contextvars</span></code></a> module.</p>
<dl class="type">
<dt id="c.PyContext">
<code class="descname">PyContext</code><a class="headerlink" href="#c.PyContext" title="本定義的永久連結">¶</a></dt>
<dd><p>The C structure used to represent a <a class="reference internal" href="../library/contextvars.html#contextvars.Context" title="contextvars.Context"><code class="xref py py-class docutils literal notranslate"><span class="pre">contextvars.Context</span></code></a>
object.</p>
</dd></dl>
<dl class="type">
<dt id="c.PyContextVar">
<code class="descname">PyContextVar</code><a class="headerlink" href="#c.PyContextVar" title="本定義的永久連結">¶</a></dt>
<dd><p>The C structure used to represent a <a class="reference internal" href="../library/contextvars.html#contextvars.ContextVar" title="contextvars.ContextVar"><code class="xref py py-class docutils literal notranslate"><span class="pre">contextvars.ContextVar</span></code></a>
object.</p>
</dd></dl>
<dl class="type">
<dt id="c.PyContextToken">
<code class="descname">PyContextToken</code><a class="headerlink" href="#c.PyContextToken" title="本定義的永久連結">¶</a></dt>
<dd><p>The C structure used to represent a <code class="xref py py-class docutils literal notranslate"><span class="pre">contextvars.Token</span></code> object.</p>
</dd></dl>
<dl class="var">
<dt id="c.PyContext_Type">
<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> <code class="descname">PyContext_Type</code><a class="headerlink" href="#c.PyContext_Type" title="本定義的永久連結">¶</a></dt>
<dd><p>The type object representing the <em>context</em> type.</p>
</dd></dl>
<dl class="var">
<dt id="c.PyContextVar_Type">
<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> <code class="descname">PyContextVar_Type</code><a class="headerlink" href="#c.PyContextVar_Type" title="本定義的永久連結">¶</a></dt>
<dd><p>The type object representing the <em>context variable</em> type.</p>
</dd></dl>
<dl class="var">
<dt id="c.PyContextToken_Type">
<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> <code class="descname">PyContextToken_Type</code><a class="headerlink" href="#c.PyContextToken_Type" title="本定義的永久連結">¶</a></dt>
<dd><p>The type object representing the <em>context variable token</em> type.</p>
</dd></dl>
<p>Type-check macros:</p>
<dl class="function">
<dt id="c.PyContext_CheckExact">
int <code class="descname">PyContext_CheckExact</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.PyContext_CheckExact" title="本定義的永久連結">¶</a></dt>
<dd><p>Return true if <em>o</em> is of type <a class="reference internal" href="#c.PyContext_Type" title="PyContext_Type"><code class="xref c c-data docutils literal notranslate"><span class="pre">PyContext_Type</span></code></a>. <em>o</em> must not be
<em>NULL</em>. This function always succeeds.</p>
</dd></dl>
<dl class="function">
<dt id="c.PyContextVar_CheckExact">
int <code class="descname">PyContextVar_CheckExact</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.PyContextVar_CheckExact" title="本定義的永久連結">¶</a></dt>
<dd><p>Return true if <em>o</em> is of type <a class="reference internal" href="#c.PyContextVar_Type" title="PyContextVar_Type"><code class="xref c c-data docutils literal notranslate"><span class="pre">PyContextVar_Type</span></code></a>. <em>o</em> must not be
<em>NULL</em>. This function always succeeds.</p>
</dd></dl>
<dl class="function">
<dt id="c.PyContextToken_CheckExact">
int <code class="descname">PyContextToken_CheckExact</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.PyContextToken_CheckExact" title="本定義的永久連結">¶</a></dt>
<dd><p>Return true if <em>o</em> is of type <a class="reference internal" href="#c.PyContextToken_Type" title="PyContextToken_Type"><code class="xref c c-data docutils literal notranslate"><span class="pre">PyContextToken_Type</span></code></a>.
<em>o</em> must not be <em>NULL</em>. This function always succeeds.</p>
</dd></dl>
<p>Context object management functions:</p>
<dl class="function">
<dt id="c.PyContext_New">
<a class="reference internal" href="#c.PyContext" title="PyContext">PyContext</a> *<code class="descname">PyContext_New</code><span class="sig-paren">(</span>void<span class="sig-paren">)</span><a class="headerlink" href="#c.PyContext_New" title="本定義的永久連結">¶</a></dt>
<dd><em class="refcount">Return value: New reference.</em><p>Create a new empty context object. Returns <code class="docutils literal notranslate"><span class="pre">NULL</span></code> if an error
has occurred.</p>
</dd></dl>
<dl class="function">
<dt id="c.PyContext_Copy">
<a class="reference internal" href="#c.PyContext" title="PyContext">PyContext</a> *<code class="descname">PyContext_Copy</code><span class="sig-paren">(</span><a class="reference internal" href="#c.PyContext" title="PyContext">PyContext</a><em> *ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyContext_Copy" title="本定義的永久連結">¶</a></dt>
<dd><em class="refcount">Return value: New reference.</em><p>Create a shallow copy of the passed <em>ctx</em> context object.
Returns <code class="docutils literal notranslate"><span class="pre">NULL</span></code> if an error has occurred.</p>
</dd></dl>
<dl class="function">
<dt id="c.PyContext_CopyCurrent">
<a class="reference internal" href="#c.PyContext" title="PyContext">PyContext</a> *<code class="descname">PyContext_CopyCurrent</code><span class="sig-paren">(</span>void<span class="sig-paren">)</span><a class="headerlink" href="#c.PyContext_CopyCurrent" title="本定義的永久連結">¶</a></dt>
<dd><em class="refcount">Return value: New reference.</em><p>Create a shallow copy of the current thread context.
Returns <code class="docutils literal notranslate"><span class="pre">NULL</span></code> if an error has occurred.</p>
</dd></dl>
<dl class="function">
<dt id="c.PyContext_Enter">
int <code class="descname">PyContext_Enter</code><span class="sig-paren">(</span><a class="reference internal" href="#c.PyContext" title="PyContext">PyContext</a><em> *ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyContext_Enter" title="本定義的永久連結">¶</a></dt>
<dd><p>Set <em>ctx</em> as the current context for the current thread.
Returns <code class="docutils literal notranslate"><span class="pre">0</span></code> on success, and <code class="docutils literal notranslate"><span class="pre">-1</span></code> on error.</p>
</dd></dl>
<dl class="function">
<dt id="c.PyContext_Exit">
int <code class="descname">PyContext_Exit</code><span class="sig-paren">(</span><a class="reference internal" href="#c.PyContext" title="PyContext">PyContext</a><em> *ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyContext_Exit" title="本定義的永久連結">¶</a></dt>
<dd><p>Deactivate the <em>ctx</em> context and restore the previous context as the
current context for the current thread. Returns <code class="docutils literal notranslate"><span class="pre">0</span></code> on success,
and <code class="docutils literal notranslate"><span class="pre">-1</span></code> on error.</p>
</dd></dl>
<dl class="function">
<dt id="c.PyContext_ClearFreeList">
int <code class="descname">PyContext_ClearFreeList</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyContext_ClearFreeList" title="本定義的永久連結">¶</a></dt>
<dd><p>Clear the context variable free list. Return the total number of
freed items. This function always succeeds.</p>
</dd></dl>
<p>Context variable functions:</p>
<dl class="function">
<dt id="c.PyContextVar_New">
<a class="reference internal" href="#c.PyContextVar" title="PyContextVar">PyContextVar</a> *<code class="descname">PyContextVar_New</code><span class="sig-paren">(</span>const char<em> *name</em>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *def</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyContextVar_New" title="本定義的永久連結">¶</a></dt>
<dd><em class="refcount">Return value: New reference.</em><p>Create a new <code class="docutils literal notranslate"><span class="pre">ContextVar</span></code> object. The <em>name</em> parameter is used
for introspection and debug purposes. The <em>def</em> parameter may optionally
specify the default value for the context variable. If an error has
occurred, this function returns <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>
</dd></dl>
<dl class="function">
<dt id="c.PyContextVar_Get">
int <code class="descname">PyContextVar_Get</code><span class="sig-paren">(</span><a class="reference internal" href="#c.PyContextVar" title="PyContextVar">PyContextVar</a><em> *var</em>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *default_value</em>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> **value</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyContextVar_Get" title="本定義的永久連結">¶</a></dt>
<dd><p>Get the value of a context variable. Returns <code class="docutils literal notranslate"><span class="pre">-1</span></code> if an error has
occurred during lookup, and <code class="docutils literal notranslate"><span class="pre">0</span></code> if no error occurred, whether or not
a value was found.</p>
<p>If the context variable was found, <em>value</em> will be a pointer to it.
If the context variable was <em>not</em> found, <em>value</em> will point to:</p>
<ul class="simple">
<li><em>default_value</em>, if not <code class="docutils literal notranslate"><span class="pre">NULL</span></code>;</li>
<li>the default value of <em>var</em>, if not <code class="docutils literal notranslate"><span class="pre">NULL</span></code>;</li>
<li><code class="docutils literal notranslate"><span class="pre">NULL</span></code></li>
</ul>
<p>If the value was found, the function will create a new reference to it.</p>
</dd></dl>
<dl class="function">
<dt id="c.PyContextVar_Set">
<a class="reference internal" href="#c.PyContextToken" title="PyContextToken">PyContextToken</a> *<code class="descname">PyContextVar_Set</code><span class="sig-paren">(</span><a class="reference internal" href="#c.PyContextVar" title="PyContextVar">PyContextVar</a><em> *var</em>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em> *value</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyContextVar_Set" title="本定義的永久連結">¶</a></dt>
<dd><em class="refcount">Return value: New reference.</em><p>Set the value of <em>var</em> to <em>value</em> in the current context. Returns a
pointer to a <a class="reference internal" href="#c.PyContextToken" title="PyContextToken"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyContextToken</span></code></a> object, or <code class="docutils literal notranslate"><span class="pre">NULL</span></code> if an error
has occurred.</p>
</dd></dl>
<dl class="function">
<dt id="c.PyContextVar_Reset">
int <code class="descname">PyContextVar_Reset</code><span class="sig-paren">(</span><a class="reference internal" href="#c.PyContextVar" title="PyContextVar">PyContextVar</a><em> *var</em>, <a class="reference internal" href="#c.PyContextToken" title="PyContextToken">PyContextToken</a><em> *token</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyContextVar_Reset" title="本定義的永久連結">¶</a></dt>
<dd><p>Reset the state of the <em>var</em> context variable to that it was in before
<a class="reference internal" href="#c.PyContextVar_Set" title="PyContextVar_Set"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyContextVar_Set()</span></code></a> that returned the <em>token</em> was called.
This function returns <code class="docutils literal notranslate"><span class="pre">0</span></code> on success and <code class="docutils literal notranslate"><span class="pre">-1</span></code> on error.</p>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>上個主題</h4>
<p class="topless"><a href="coro.html"
title="上一章">Coroutine Objects</a></p>
<h4>下個主題</h4>
<p class="topless"><a href="datetime.html"
title="下一章">DateTime 物件</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../bugs.html">Report a Bug</a></li>
<li>
<a href="https://github.com/python/cpython/blob/3.7/Doc/c-api/contextvars.rst"
rel="nofollow">Show Source
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>瀏覽</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>索引</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python 模組索引"
>模組</a> |</li>
<li class="right" >
<a href="datetime.html" title="DateTime 物件"
>下一頁</a> |</li>
<li class="right" >
<a href="coro.html" title="Coroutine Objects"
>上一頁</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>
<span class="language_switcher_placeholder">zh_TW</span>
<span class="version_switcher_placeholder">3.7.0</span>
<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="concrete.html" >Concrete Objects Layer</a> »</li>
<li class="right">
<div class="inline-search" style="display: none" role="search">
<form class="inline-search" action="../search.html" method="get">
<input placeholder="Quick search" type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('.inline-search').show(0);</script>
|
</li>
</ul>
</div>
<div class="footer">
© <a href="../copyright.html">Copyright</a> 2001-2018, Python Software Foundation.
<br />
The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>
<br />
Last updated on 8月 22, 2018.
<a href="../bugs.html">Found a bug</a>?
<br />
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.7.7.
</div>
</body>
</html>