-
Notifications
You must be signed in to change notification settings - Fork 0
/
api_etl.utils_misc.html
377 lines (260 loc) · 16.6 KB
/
api_etl.utils_misc.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
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
<!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>api_etl.utils_misc module — api_transilien_doc documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="api_transilien_doc documentation" href="index.html"/>
<link rel="next" title="api_etl package" href="api_etl.html"/>
<link rel="prev" title="api_etl.utils_api_client module" href="api_etl.utils_api_client.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<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"> api_transilien_doc
</a>
<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">
<p class="caption"><span class="caption-text">Main modules</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="api_etl.extract_api.html">api_etl.extract_api module</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_etl.extract_schedule.html">api_etl.extract_schedule module</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_etl.query_schedule.html">api_etl.query_schedule module</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_etl.utils_dynamo.html">api_etl.utils_dynamo module</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_etl.utils_api_client.html">api_etl.utils_api_client module</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">api_etl.utils_misc module</a></li>
</ul>
<p class="caption"><span class="caption-text">All modules:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="api_etl.html">api_etl package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="api_etl.html#submodules">Submodules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="api_etl.builder_feature_matrix.html">api_etl.builder_feature_matrix module</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_etl.builder_feature_vector.html">api_etl.builder_feature_vector module</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_etl.data_models.html">api_etl.data_models module</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_etl.extract_api.html">api_etl.extract_api module</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_etl.extract_schedule.html">api_etl.extract_schedule module</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_etl.feature_vector.html">api_etl.feature_vector module</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_etl.querier_realtime.html">api_etl.querier_realtime module</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_etl.querier_schedule.html">api_etl.querier_schedule module</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_etl.regressor_predict.html">api_etl.regressor_predict module</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_etl.regressor_train.html">api_etl.regressor_train module</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_etl.settings.html">api_etl.settings module</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_etl.utils_api_client.html">api_etl.utils_api_client module</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">api_etl.utils_misc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_etl.utils_rdb.html">api_etl.utils_rdb module</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_etl.utils_secrets.html">api_etl.utils_secrets module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_etl.html#module-api_etl">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">api_transilien_doc</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>api_etl.utils_misc module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/api_etl.utils_misc.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="module-api_etl.utils_misc">
<span id="api-etl-utils-misc-module"></span><h1>api_etl.utils_misc module<a class="headerlink" href="#module-api_etl.utils_misc" title="Permalink to this headline">¶</a></h1>
<p>Module containing some useful functions that might be used by all other
modules.</p>
<dl class="class">
<dt id="api_etl.utils_misc.DateConverter">
<em class="property">class </em><code class="descclassname">api_etl.utils_misc.</code><code class="descname">DateConverter</code><span class="sig-paren">(</span><em>dt=None</em>, <em>api_date=None</em>, <em>normal_date=None</em>, <em>normal_time=None</em>, <em>special_date=None</em>, <em>special_time=None</em>, <em>force_regular_date=False</em><span class="sig-paren">)</span><a class="headerlink" href="#api_etl.utils_misc.DateConverter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<dl class="docutils">
<dt>Class to convert dates from and to our special format, from and to api</dt>
<dd>date format, and to and from our regular format:</dd>
</dl>
<ul class="simple">
<li>api_format: “16/02/2017 01:26”</li>
<li>normal date: “20170216”</li>
<li>normal time: “01:26:00”</li>
<li>special date: “20170215”</li>
<li>special time: “25:26:00”</li>
</ul>
<p>This class has also methods to compute delays</p>
<dl class="method">
<dt id="api_etl.utils_misc.DateConverter.compute_delay_from">
<code class="descname">compute_delay_from</code><span class="sig-paren">(</span><em>dc=None</em>, <em>dt=None</em>, <em>api_date=None</em>, <em>normal_date=None</em>, <em>normal_time=None</em>, <em>special_date=None</em>, <em>special_time=None</em>, <em>force_regular_date=False</em><span class="sig-paren">)</span><a class="headerlink" href="#api_etl.utils_misc.DateConverter.compute_delay_from" title="Permalink to this definition">¶</a></dt>
<dd><p>Create another DateConverter and compares datetimes
Return in seconds the delay:
- positive if this one > ‘from’ (delayed)
- negative if this one < ‘from’ (advance)
:param dc:
:param dt:
:param api_date:
:param normal_date:
:param normal_time:
:param special_date:
:param special_time:
:param force_regular_date:</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="api_etl.utils_misc.S3Bucket">
<em class="property">class </em><code class="descclassname">api_etl.utils_misc.</code><code class="descname">S3Bucket</code><span class="sig-paren">(</span><em>name</em>, <em>create_if_absent=False</em><span class="sig-paren">)</span><a class="headerlink" href="#api_etl.utils_misc.S3Bucket" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<dl class="method">
<dt id="api_etl.utils_misc.S3Bucket.list_bucket_objects">
<code class="descname">list_bucket_objects</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api_etl.utils_misc.S3Bucket.list_bucket_objects" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="api_etl.utils_misc.S3Bucket.send_file">
<code class="descname">send_file</code><span class="sig-paren">(</span><em>file_path</em>, <em>file_name=None</em>, <em>delete=False</em>, <em>ignore_hidden=False</em><span class="sig-paren">)</span><a class="headerlink" href="#api_etl.utils_misc.S3Bucket.send_file" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="api_etl.utils_misc.S3Bucket.send_folder">
<code class="descname">send_folder</code><span class="sig-paren">(</span><em>folder_path</em>, <em>folder_name=None</em>, <em>delete=False</em>, <em>ignore_hidden=True</em><span class="sig-paren">)</span><a class="headerlink" href="#api_etl.utils_misc.S3Bucket.send_folder" title="Permalink to this definition">¶</a></dt>
<dd><p>Will keep same names for files inside folder.</p>
<p>Note: in S3, there is no folder, just files with names as path.
:param folder_path:
:param folder_name:
:param delete:
:param ignore_hidden:</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="api_etl.utils_misc.StationProvider">
<em class="property">class </em><code class="descclassname">api_etl.utils_misc.</code><code class="descname">StationProvider</code><a class="headerlink" href="#api_etl.utils_misc.StationProvider" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Class to easily get lists of stations in gtfs format (7 digits) or
transilien’s format (8 digits).</p>
<p>Warning: data sources have to be checked (“all” is ok, “top” is wrong).</p>
<dl class="method">
<dt id="api_etl.utils_misc.StationProvider.get_station_ids">
<code class="descname">get_station_ids</code><span class="sig-paren">(</span><em>stations='all'</em>, <em>gtfs_format=False</em><span class="sig-paren">)</span><a class="headerlink" href="#api_etl.utils_misc.StationProvider.get_station_ids" title="Permalink to this definition">¶</a></dt>
<dd><p>Get stations ids either in API format (8 digits), or in GTFS format
(7 digits).</p>
<p>Beware, this function has to be more tested.
Beware: two formats:
- 8 digits format to query api
- 7 digits format to query gtfs files
:param stations:
:param gtfs_format:</p>
</dd></dl>
<dl class="method">
<dt id="api_etl.utils_misc.StationProvider.get_stations_per_line">
<code class="descname">get_stations_per_line</code><span class="sig-paren">(</span><em>lines=None</em>, <em>uic7=False</em>, <em>full_df=False</em><span class="sig-paren">)</span><a class="headerlink" href="#api_etl.utils_misc.StationProvider.get_stations_per_line" title="Permalink to this definition">¶</a></dt>
<dd><p>Get stations of given line (multiple lines possible)
:param lines:
:param uic7:
:param full_df:</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="api_etl.utils_misc.build_uri">
<code class="descclassname">api_etl.utils_misc.</code><code class="descname">build_uri</code><span class="sig-paren">(</span><em>db_type</em>, <em>host</em>, <em>user=None</em>, <em>password=None</em>, <em>port=None</em>, <em>database=None</em><span class="sig-paren">)</span><a class="headerlink" href="#api_etl.utils_misc.build_uri" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="api_etl.utils_misc.chunks">
<code class="descclassname">api_etl.utils_misc.</code><code class="descname">chunks</code><span class="sig-paren">(</span><em>l</em>, <em>n</em><span class="sig-paren">)</span><a class="headerlink" href="#api_etl.utils_misc.chunks" title="Permalink to this definition">¶</a></dt>
<dd><p>Yield a list in ‘n’ lists of nearly same size (some can be one more than
others).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>l</strong> (<em>list</em>) – list you want to divide in chunks</li>
<li><strong>n</strong> (<em>int</em>) – number of chunks you want to get</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="api_etl.utils_misc.get_paris_local_datetime_now">
<code class="descclassname">api_etl.utils_misc.</code><code class="descname">get_paris_local_datetime_now</code><span class="sig-paren">(</span><em>tz_naive=True</em><span class="sig-paren">)</span><a class="headerlink" href="#api_etl.utils_misc.get_paris_local_datetime_now" title="Permalink to this definition">¶</a></dt>
<dd><p>Return paris local time (necessary for operations operated on other time
zones)
:param tz_naive:</p>
</dd></dl>
<dl class="function">
<dt id="api_etl.utils_misc.get_responding_stations_from_sample">
<code class="descclassname">api_etl.utils_misc.</code><code class="descname">get_responding_stations_from_sample</code><span class="sig-paren">(</span><em>sample_loc=None</em>, <em>write_loc=None</em><span class="sig-paren">)</span><a class="headerlink" href="#api_etl.utils_misc.get_responding_stations_from_sample" title="Permalink to this definition">¶</a></dt>
<dd><p>This function’s purpose is to write down responding stations from a given
“real_departures” sample, and to write it down so it can be used to query
only necessary stations (and avoid to spend API credits on unnecessary
stations)
:param sample_loc:
:param write_loc:</p>
</dd></dl>
<dl class="function">
<dt id="api_etl.utils_misc.s3_ressource">
<code class="descclassname">api_etl.utils_misc.</code><code class="descname">s3_ressource</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api_etl.utils_misc.s3_ressource" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="api_etl.utils_misc.set_logging_conf">
<code class="descclassname">api_etl.utils_misc.</code><code class="descname">set_logging_conf</code><span class="sig-paren">(</span><em>log_name</em>, <em>level='INFO'</em><span class="sig-paren">)</span><a class="headerlink" href="#api_etl.utils_misc.set_logging_conf" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="api_etl.html" class="btn btn-neutral float-right" title="api_etl package" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="api_etl.utils_api_client.html" class="btn btn-neutral" title="api_etl.utils_api_client module" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, Leonard Binet.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</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/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>