This repository has been archived by the owner on Sep 26, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
teos.cleaner.html
401 lines (273 loc) · 26.6 KB
/
teos.cleaner.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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>teos.cleaner — pyton-teos documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="teos.extended_appointment" href="teos.extended_appointment.html" />
<link rel="prev" title="teos.chain_monitor" href="teos.chain_monitor.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" alt="Documentation Home"> pyton-teos
</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">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="teos.html">teos package</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="teos.html#subpackages">Subpackages</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="teos.html#submodules">Submodules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="teos.api.html">teos.api</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.appointments_dbm.html">teos.appointments_dbm</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.block_processor.html">teos.block_processor</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.builder.html">teos.builder</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.carrier.html">teos.carrier</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.chain_monitor.html">teos.chain_monitor</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">teos.cleaner</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.extended_appointment.html">teos.extended_appointment</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.gatekeeper.html">teos.gatekeeper</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.inspector.html">teos.inspector</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.internal_api.html">teos.internal_api</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.lightning_server.html">teos.lightning_server</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.logger.html">teos.logger</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.responder.html">teos.responder</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.rpc.html">teos.rpc</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.teosd.html">teos.teosd</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.tools.html">teos.tools</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.users_dbm.html">teos.users_dbm</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.watcher.html">teos.watcher</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="common.html">common package</a></li>
<li class="toctree-l1"><a class="reference internal" href="contrib.html">contrib package</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">pyton-teos</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" class="icon icon-home"></a> »</li>
<li><a href="teos.html">teos package</a> »</li>
<li>teos.cleaner</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/teos.cleaner.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="module-teos.cleaner">
<span id="teos-cleaner"></span><h1>teos.cleaner<a class="headerlink" href="#module-teos.cleaner" title="Permalink to this headline">¶</a></h1>
<dl class="py class">
<dt id="teos.cleaner.Cleaner">
<em class="property">class </em><code class="sig-name descname">Cleaner</code><a class="reference internal" href="_modules/teos/cleaner.html#Cleaner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.cleaner.Cleaner" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>The <a class="reference internal" href="#teos.cleaner.Cleaner" title="teos.cleaner.Cleaner"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cleaner</span></code></a> is in charge of removing expired/completed data from the tower.</p>
<p>Mutable objects (like dicts) are passed-by-reference in Python, so no return is needed for the Cleaner.</p>
<dl class="py method">
<dt id="teos.cleaner.Cleaner.delete_appointment_from_db">
<em class="property">static </em><code class="sig-name descname">delete_appointment_from_db</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">uuid</span></em>, <em class="sig-param"><span class="n">db_manager</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/cleaner.html#Cleaner.delete_appointment_from_db"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.cleaner.Cleaner.delete_appointment_from_db" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes an appointment from the appointments database.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>uuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the identifier of the appointment to be deleted.</p></li>
<li><p><strong>db_manager</strong> (<a class="reference internal" href="teos.appointments_dbm.html#teos.appointments_dbm.AppointmentsDBM" title="teos.appointments_dbm.AppointmentsDBM"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AppointmentsDBM</span></code></a>) – an instance of the appointment
database manager to interact with the database.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.cleaner.Cleaner.delete_appointment_from_memory">
<em class="property">static </em><code class="sig-name descname">delete_appointment_from_memory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">uuid</span></em>, <em class="sig-param"><span class="n">appointments</span></em>, <em class="sig-param"><span class="n">locator_uuid_map</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/cleaner.html#Cleaner.delete_appointment_from_memory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.cleaner.Cleaner.delete_appointment_from_memory" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes an appointment from memory (<code class="docutils literal notranslate"><span class="pre">appointments</span></code> and <code class="docutils literal notranslate"><span class="pre">locator_uuid_map</span></code> dictionaries). If the given
appointment does not share locator with any other, the map will completely removed, otherwise, the uuid will be
removed from the map.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>uuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the identifier of the appointment to be deleted.</p></li>
<li><p><strong>appointments</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – the appointments dictionary from where the appointment should be removed.</p></li>
<li><p><strong>locator_uuid_map</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – the <code class="docutils literal notranslate"><span class="pre">locator:uuid</span></code> map from where the appointment should also be removed.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.cleaner.Cleaner.delete_completed_appointments">
<em class="property">static </em><code class="sig-name descname">delete_completed_appointments</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">completed_appointments</span></em>, <em class="sig-param"><span class="n">appointments</span></em>, <em class="sig-param"><span class="n">locator_uuid_map</span></em>, <em class="sig-param"><span class="n">db_manager</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/cleaner.html#Cleaner.delete_completed_appointments"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.cleaner.Cleaner.delete_completed_appointments" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes a completed appointment from memory (<a class="reference internal" href="teos.watcher.html#teos.watcher.Watcher" title="teos.watcher.Watcher"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Watcher</span></code></a>) and disk.</p>
<p>Currently, an appointment is only completed if it cannot make it to the
(<a class="reference internal" href="teos.responder.html#teos.responder.Responder" title="teos.responder.Responder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Responder</span></code></a>), otherwise, it will be flagged as triggered and removed once the
tracker is completed.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>completed_appointments</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code>) – a list of appointments to be deleted.</p></li>
<li><p><strong>appointments</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – a dictionary containing all the <a class="reference internal" href="teos.watcher.html#teos.watcher.Watcher" title="teos.watcher.Watcher"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Watcher</span></code></a>
appointments.</p></li>
<li><p><strong>locator_uuid_map</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – a <code class="docutils literal notranslate"><span class="pre">locator:uuid</span></code> map for the <a class="reference internal" href="teos.watcher.html#teos.watcher.Watcher" title="teos.watcher.Watcher"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Watcher</span></code></a>
appointments.</p></li>
<li><p><strong>db_manager</strong> (<a class="reference internal" href="teos.appointments_dbm.html#teos.appointments_dbm.AppointmentsDBM" title="teos.appointments_dbm.AppointmentsDBM"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AppointmentsDBM</span></code></a>) – an instance of the appointment
database manager to interact with the database.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.cleaner.Cleaner.delete_expired_appointments">
<em class="property">static </em><code class="sig-name descname">delete_expired_appointments</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">expired_appointments</span></em>, <em class="sig-param"><span class="n">appointments</span></em>, <em class="sig-param"><span class="n">locator_uuid_map</span></em>, <em class="sig-param"><span class="n">db_manager</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/cleaner.html#Cleaner.delete_expired_appointments"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.cleaner.Cleaner.delete_expired_appointments" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes appointments which <code class="docutils literal notranslate"><span class="pre">expiry</span></code> has been reached (with no trigger) both from memory
(<a class="reference internal" href="teos.watcher.html#teos.watcher.Watcher" title="teos.watcher.Watcher"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Watcher</span></code></a>) and disk.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>expired_appointments</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code>) – a list of appointments to be deleted.</p></li>
<li><p><strong>appointments</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – a dictionary containing all the <a class="reference internal" href="teos.watcher.html#teos.watcher.Watcher" title="teos.watcher.Watcher"><code class="xref py py-mod docutils literal notranslate"><span class="pre">Watcher</span></code></a>
appointments.</p></li>
<li><p><strong>locator_uuid_map</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – a <code class="docutils literal notranslate"><span class="pre">locator:uuid</span></code> map for the <a class="reference internal" href="teos.watcher.html#teos.watcher.Watcher" title="teos.watcher.Watcher"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Watcher</span></code></a>
appointments.</p></li>
<li><p><strong>db_manager</strong> (<a class="reference internal" href="teos.appointments_dbm.html#teos.appointments_dbm.AppointmentsDBM" title="teos.appointments_dbm.AppointmentsDBM"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AppointmentsDBM</span></code></a>) – an instance of the appointment
database manager to interact with the database.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.cleaner.Cleaner.delete_gatekeeper_appointments">
<em class="property">static </em><code class="sig-name descname">delete_gatekeeper_appointments</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">gatekeeper</span></em>, <em class="sig-param"><span class="n">appointment_to_delete</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/cleaner.html#Cleaner.delete_gatekeeper_appointments"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.cleaner.Cleaner.delete_gatekeeper_appointments" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes a list of expired / completed appointments of a given user both from memory and the UserDB.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>gatekeeper</strong> (<a class="reference internal" href="teos.gatekeeper.html#teos.gatekeeper.Gatekeeper" title="teos.gatekeeper.Gatekeeper"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Gatekeeper</span></code></a>) – a <cite>Gatekeeper</cite> instance in charge to control
the user access and subscription expiry.</p></li>
<li><p><strong>appointment_to_delete</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – <code class="docutils literal notranslate"><span class="pre">uuid:user_id</span></code> dict containing the appointments to delete
(expired + completed)</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.cleaner.Cleaner.delete_trackers">
<em class="property">static </em><code class="sig-name descname">delete_trackers</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">completed_trackers</span></em>, <em class="sig-param"><span class="n">height</span></em>, <em class="sig-param"><span class="n">trackers</span></em>, <em class="sig-param"><span class="n">tx_tracker_map</span></em>, <em class="sig-param"><span class="n">db_manager</span></em>, <em class="sig-param"><span class="n">expired</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/cleaner.html#Cleaner.delete_trackers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.cleaner.Cleaner.delete_trackers" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes completed/expired trackers both from memory (<a class="reference internal" href="teos.responder.html#teos.responder.Responder" title="teos.responder.Responder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Responder</span></code></a>) and disk
(from the <code class="xref py py-obj docutils literal notranslate"><span class="pre">Responder</span></code>’s and <code class="xref py py-obj docutils literal notranslate"><span class="pre">Watcher</span></code>’s databases).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>trackers</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – a dictionary containing all the <a class="reference internal" href="teos.responder.html#teos.responder.Responder" title="teos.responder.Responder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Responder</span></code></a>
trackers.</p></li>
<li><p><strong>height</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code>) – the block height at which the trackers were completed.</p></li>
<li><p><strong>tx_tracker_map</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – a <code class="docutils literal notranslate"><span class="pre">penalty_txid:uuid</span></code> map for the <a class="reference internal" href="teos.responder.html#teos.responder.Responder" title="teos.responder.Responder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Responder</span></code></a> trackers.</p></li>
<li><p><strong>completed_trackers</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – a dict of completed/expired trackers to be deleted
(<code class="docutils literal notranslate"><span class="pre">uuid:confirmations</span></code>).</p></li>
<li><p><strong>db_manager</strong> (<a class="reference internal" href="teos.appointments_dbm.html#teos.appointments_dbm.AppointmentsDBM" title="teos.appointments_dbm.AppointmentsDBM"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AppointmentsDBM</span></code></a>) – an instance of the appointment
database manager to interact with the database.</p></li>
<li><p><strong>expired</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code>) – whether the trackers have expired or not. Defaults to False.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.cleaner.Cleaner.flag_triggered_appointments">
<em class="property">static </em><code class="sig-name descname">flag_triggered_appointments</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">triggered_appointments</span></em>, <em class="sig-param"><span class="n">appointments</span></em>, <em class="sig-param"><span class="n">locator_uuid_map</span></em>, <em class="sig-param"><span class="n">db_manager</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/cleaner.html#Cleaner.flag_triggered_appointments"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.cleaner.Cleaner.flag_triggered_appointments" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes a list of triggered appointment from memory (<a class="reference internal" href="teos.watcher.html#teos.watcher.Watcher" title="teos.watcher.Watcher"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Watcher</span></code></a>) and flags them as
triggered on disk.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>triggered_appointments</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code>) – a list of appointments to be flagged as triggered on the database.</p></li>
<li><p><strong>appointments</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – a dictionary containing all the <a class="reference internal" href="teos.watcher.html#teos.watcher.Watcher" title="teos.watcher.Watcher"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Watcher</span></code></a>
appointments.</p></li>
<li><p><strong>locator_uuid_map</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – a <code class="docutils literal notranslate"><span class="pre">locator:uuid</span></code> map for the <a class="reference internal" href="teos.watcher.html#teos.watcher.Watcher" title="teos.watcher.Watcher"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Watcher</span></code></a>
appointments.</p></li>
<li><p><strong>db_manager</strong> (<a class="reference internal" href="teos.appointments_dbm.html#teos.appointments_dbm.AppointmentsDBM" title="teos.appointments_dbm.AppointmentsDBM"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AppointmentsDBM</span></code></a>) – an instance of the appointment
database manager to interact with the database.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.cleaner.Cleaner.update_delete_db_locator_map">
<em class="property">static </em><code class="sig-name descname">update_delete_db_locator_map</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">uuids</span></em>, <em class="sig-param"><span class="n">locator</span></em>, <em class="sig-param"><span class="n">db_manager</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/cleaner.html#Cleaner.update_delete_db_locator_map"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.cleaner.Cleaner.update_delete_db_locator_map" title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the <code class="docutils literal notranslate"><span class="pre">locator:uuid</span></code> map of a given locator from the database by removing a given uuid. If the uuid is
the only element of the map, the map is deleted, otherwise the uuid is simply removed and the database is
updated.</p>
<p>If either the uuid of the locator are not found, the data is not modified.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>uuids</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code>) – a list of identifiers to be removed from the map.</p></li>
<li><p><strong>locator</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the identifier of the map to be either updated or deleted.</p></li>
<li><p><strong>db_manager</strong> (<a class="reference internal" href="teos.appointments_dbm.html#teos.appointments_dbm.AppointmentsDBM" title="teos.appointments_dbm.AppointmentsDBM"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AppointmentsDBM</span></code></a>) – an instance of the appointment
database manager to interact with the database.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="teos.extended_appointment.html" class="btn btn-neutral float-right" title="teos.extended_appointment" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="teos.chain_monitor.html" class="btn btn-neutral float-left" title="teos.chain_monitor" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2019, Talaia Labs
</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>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>