-
Notifications
You must be signed in to change notification settings - Fork 10
/
python_api.html
309 lines (189 loc) · 14.7 KB
/
python_api.html
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
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Language API - Python — Digdag 0.10.5 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<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/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Language API - Ruby" href="ruby_api.html" />
<link rel="prev" title="Command reference" href="command_reference.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Digdag
</a>
<div class="version">
0.10
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="architecture.html">Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="concepts.html">Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="workflow_definition.html">Workflow definition</a></li>
<li class="toctree-l1"><a class="reference internal" href="scheduling_workflow.html">Scheduling workflow</a></li>
<li class="toctree-l1"><a class="reference internal" href="operators.html">Operators</a></li>
<li class="toctree-l1"><a class="reference internal" href="command_reference.html">Command reference</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Language API - Python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#programmable-workflow-in-python">Programmable workflow in Python</a></li>
<li class="toctree-l2"><a class="reference internal" href="#defining-variables">Defining variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="#method-argument-mapping">Method argument mapping</a></li>
<li class="toctree-l2"><a class="reference internal" href="#generating-child-tasks">Generating child tasks</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="ruby_api.html">Language API - Ruby</a></li>
<li class="toctree-l1"><a class="reference internal" href="rest_api.html">REST API</a></li>
<li class="toctree-l1"><a class="reference internal" href="command_executor.html">Command Executor</a></li>
<li class="toctree-l1"><a class="reference internal" href="internal.html">Internal architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="metrics.html">Digdag metrics (experimental)</a></li>
<li class="toctree-l1"><a class="reference internal" href="community_contributions.html">Community Contributions</a></li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="logo.html">Logo</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Digdag</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Language API - Python</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/python_api.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="language-api-python">
<h1>Language API - Python<a class="headerlink" href="#language-api-python" title="Permalink to this headline">¶</a></h1>
<div class="section" id="programmable-workflow-in-python">
<h2>Programmable workflow in Python<a class="headerlink" href="#programmable-workflow-in-python" title="Permalink to this headline">¶</a></h2>
<p>workflow.dig:</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">+step1</span><span class="p">:</span>
<span class="nt">py></span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">tasks.MyWorkflow.step1</span>
<span class="nt">+step2</span><span class="p">:</span>
<span class="nt">py></span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">tasks.MyWorkflow.step2</span>
</pre></div>
</div>
<p>tasks/__init__.py:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyWorkflow</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">step1</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">print</span><span class="p">(</span><span class="s2">"step1"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">step2</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">print</span><span class="p">(</span><span class="s2">"step2"</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="defining-variables">
<h2>Defining variables<a class="headerlink" href="#defining-variables" title="Permalink to this headline">¶</a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">digdag</span>
<span class="k">class</span> <span class="nc">MyWorkflow</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">step1</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">digdag</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">store</span><span class="p">({</span><span class="s1">'my_value'</span><span class="p">:</span> <span class="mi">1</span><span class="p">})</span>
<span class="k">def</span> <span class="nf">step2</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">print</span><span class="p">(</span><span class="s2">"step2: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">digdag</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s2">"my_value"</span><span class="p">])</span>
</pre></div>
</div>
</div>
<div class="section" id="method-argument-mapping">
<h2>Method argument mapping<a class="headerlink" href="#method-argument-mapping" title="Permalink to this headline">¶</a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">digdag</span>
<span class="k">class</span> <span class="nc">MyWorkflow</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">step1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">session_time</span><span class="p">):</span>
<span class="n">digdag</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">store</span><span class="p">({</span><span class="s1">'my_value'</span><span class="p">:</span> <span class="mi">1</span><span class="p">})</span>
<span class="k">def</span> <span class="nf">step2</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">my_value</span><span class="o">=</span><span class="s2">"default"</span><span class="p">):</span>
<span class="k">print</span><span class="p">(</span><span class="s2">"step2: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">my_value</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="generating-child-tasks">
<h2>Generating child tasks<a class="headerlink" href="#generating-child-tasks" title="Permalink to this headline">¶</a></h2>
<p>Generating Python child tasks:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">digdag</span>
<span class="k">class</span> <span class="nc">MyWorkflow</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">step1</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">digdag</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">add_subtask</span><span class="p">(</span><span class="n">MyWorkflow</span><span class="o">.</span><span class="n">step3</span><span class="p">,</span> <span class="n">arg1</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">step2</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">my_value</span><span class="o">=</span><span class="s2">"default"</span><span class="p">):</span>
<span class="k">print</span><span class="p">(</span><span class="s2">"step2: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">my_value</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">step3</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">arg1</span><span class="p">):</span>
<span class="k">print</span><span class="p">(</span><span class="s2">"step3: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">arg1</span><span class="p">)</span>
</pre></div>
</div>
<p>Generating other child tasks:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">digdag</span>
<span class="k">class</span> <span class="nc">MyWorkflow</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">step1</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">digdag</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">add_subtask</span><span class="p">({</span>
<span class="s1">'_type'</span><span class="p">:</span> <span class="s1">'mail'</span><span class="p">,</span>
<span class="s1">'body'</span><span class="p">:</span> <span class="s1">'this is email body in string'</span><span class="p">,</span>
<span class="s1">'subject'</span><span class="p">:</span> <span class="s1">'workflow started'</span><span class="p">,</span>
<span class="s1">'to'</span><span class="p">:</span> <span class="p">[</span><span class="s1">'[email protected]'</span><span class="p">],</span>
<span class="p">})</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Arguments need to be serializable using JSON. If arguments include non-serializable objects such as function, add_subtask throws TypeError.</p>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="ruby_api.html" class="btn btn-neutral float-right" title="Language API - Ruby" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="command_reference.html" class="btn btn-neutral float-left" title="Command reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2016-2024, Digdag Project
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
<br/>
<br/>
<p><a href="https://digdag.io/">Digdag</a> is an open source project, invented and sponsored by <a href="https://www.treasuredata.com/">Treasure Data, Inc.</a> under the Apache 2.0 Licence.</p>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>