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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
|
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Coverage for src/debputy/lsp/vendoring/_deb822_repro/locatable.py: 90%</title>
<link rel="icon" sizes="32x32" href="favicon_32.png">
<link rel="stylesheet" href="style.css" type="text/css">
<script type="text/javascript" src="coverage_html.js" defer></script>
</head>
<body class="pyfile">
<header>
<div class="content">
<h1>
<span class="text">Coverage for </span><b>src/debputy/lsp/vendoring/_deb822_repro/locatable.py</b>:
<span class="pc_cov">90%</span>
</h1>
<aside id="help_panel_wrapper">
<input id="help_panel_state" type="checkbox">
<label for="help_panel_state">
<img id="keyboard_icon" src="keybd_closed.png" alt="Show/hide keyboard shortcuts" />
</label>
<div id="help_panel">
<p class="legend">Shortcuts on this page</p>
<div class="keyhelp">
<p>
<kbd>r</kbd>
<kbd>m</kbd>
<kbd>x</kbd>
<kbd>p</kbd>
toggle line displays
</p>
<p>
<kbd>j</kbd>
<kbd>k</kbd>
next/prev highlighted chunk
</p>
<p>
<kbd>0</kbd> (zero) top of page
</p>
<p>
<kbd>1</kbd> (one) first highlighted chunk
</p>
<p>
<kbd>[</kbd>
<kbd>]</kbd>
prev/next file
</p>
<p>
<kbd>u</kbd> up to the index
</p>
<p>
<kbd>?</kbd> show/hide this help
</p>
</div>
</div>
</aside>
<h2>
<span class="text">122 statements </span>
<button type="button" class="run button_toggle_run" value="run" data-shortcut="r" title="Toggle lines run">111<span class="text"> run</span></button>
<button type="button" class="mis show_mis button_toggle_mis" value="mis" data-shortcut="m" title="Toggle lines missing">11<span class="text"> missing</span></button>
<button type="button" class="exc show_exc button_toggle_exc" value="exc" data-shortcut="x" title="Toggle lines excluded">5<span class="text"> excluded</span></button>
<button type="button" class="par run show_par button_toggle_par" value="par" data-shortcut="p" title="Toggle lines partially run">5<span class="text"> partial</span></button>
</h2>
<p class="text">
<a id="prevFileLink" class="nav" href="d_e9c451f4ae334f76_formatter_py.html">« prev</a>
<a id="indexLink" class="nav" href="index.html">^ index</a>
<a id="nextFileLink" class="nav" href="d_e9c451f4ae334f76_parsing_py.html">» next</a>
<a class="nav" href="https://coverage.readthedocs.io/en/7.2.7">coverage.py v7.2.7</a>,
created at 2024-04-07 12:14 +0200
</p>
<aside class="hidden">
<button type="button" class="button_next_chunk" data-shortcut="j"/>
<button type="button" class="button_prev_chunk" data-shortcut="k"/>
<button type="button" class="button_top_of_page" data-shortcut="0"/>
<button type="button" class="button_first_chunk" data-shortcut="1"/>
<button type="button" class="button_prev_file" data-shortcut="["/>
<button type="button" class="button_next_file" data-shortcut="]"/>
<button type="button" class="button_to_index" data-shortcut="u"/>
<button type="button" class="button_show_hide_help" data-shortcut="?"/>
</aside>
</div>
</header>
<main id="source">
<p class="run"><span class="n"><a id="t1" href="#t1">1</a></span><span class="t"><span class="key">import</span> <span class="nam">dataclasses</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t2" href="#t2">2</a></span><span class="t"><span class="key">import</span> <span class="nam">itertools</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t3" href="#t3">3</a></span><span class="t"><span class="key">import</span> <span class="nam">sys</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t4" href="#t4">4</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t5" href="#t5">5</a></span><span class="t"><span class="key">from</span> <span class="nam">typing</span> <span class="key">import</span> <span class="nam">Optional</span><span class="op">,</span> <span class="nam">TYPE_CHECKING</span><span class="op">,</span> <span class="nam">Iterable</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t6" href="#t6">6</a></span><span class="t"> </span><span class="r"></span></p>
<p class="exc show_exc"><span class="n"><a id="t7" href="#t7">7</a></span><span class="t"><span class="key">if</span> <span class="nam">TYPE_CHECKING</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="exc show_exc"><span class="n"><a id="t8" href="#t8">8</a></span><span class="t"> <span class="key">from</span> <span class="nam">typing</span> <span class="key">import</span> <span class="nam">Self</span> </span><span class="r"></span></p>
<p class="exc show_exc"><span class="n"><a id="t9" href="#t9">9</a></span><span class="t"> <span class="key">from</span> <span class="op">.</span><span class="nam">parsing</span> <span class="key">import</span> <span class="nam">Deb822Element</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t10" href="#t10">10</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t11" href="#t11">11</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t12" href="#t12">12</a></span><span class="t"><span class="nam">_DATA_CLASS_OPTIONAL_ARGS</span> <span class="op">=</span> <span class="op">{</span><span class="op">}</span> </span><span class="r"></span></p>
<p class="par run show_par"><span class="n"><a id="t13" href="#t13">13</a></span><span class="t"><span class="key">if</span> <span class="nam">sys</span><span class="op">.</span><span class="nam">version_info</span> <span class="op">>=</span> <span class="op">(</span><span class="num">3</span><span class="op">,</span> <span class="num">10</span><span class="op">)</span><span class="op">:</span> </span><span class="r"><span class="annotate short">13 ↛ 20</span><span class="annotate long">line 13 didn't jump to line 20, because the condition on line 13 was never false</span></span></p>
<p class="pln"><span class="n"><a id="t14" href="#t14">14</a></span><span class="t"> <span class="com"># The `slots` feature greatly reduces the memory usage by avoiding the `__dict__`</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t15" href="#t15">15</a></span><span class="t"> <span class="com"># instance. But at the end of the day, performance is "nice to have" for this</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t16" href="#t16">16</a></span><span class="t"> <span class="com"># feature and all current consumers are at Python 3.12 (except the CI tests...)</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t17" href="#t17">17</a></span><span class="t"> <span class="nam">_DATA_CLASS_OPTIONAL_ARGS</span><span class="op">[</span><span class="str">"slots"</span><span class="op">]</span> <span class="op">=</span> <span class="key">True</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t18" href="#t18">18</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t19" href="#t19">19</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t20" href="#t20">20</a></span><span class="t"><span class="op">@</span><span class="nam">dataclasses</span><span class="op">.</span><span class="nam">dataclass</span><span class="op">(</span><span class="nam">frozen</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> <span class="op">**</span><span class="nam">_DATA_CLASS_OPTIONAL_ARGS</span><span class="op">)</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t21" href="#t21">21</a></span><span class="t"><span class="key">class</span> <span class="nam">Position</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t22" href="#t22">22</a></span><span class="t"> <span class="str">"""Describes a "cursor" position inside a file</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t23" href="#t23">23</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t24" href="#t24">24</a></span><span class="t"><span class="str"> It consists of a line position (0-based line number) and a cursor position. This is modelled</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t25" href="#t25">25</a></span><span class="t"><span class="str"> after the "Position" in Language Server Protocol (LSP).</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t26" href="#t26">26</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t27" href="#t27">27</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t28" href="#t28">28</a></span><span class="t"> <span class="nam">line_position</span><span class="op">:</span> <span class="nam">int</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t29" href="#t29">29</a></span><span class="t"> <span class="str">"""Describes the line position as a 0-based line number</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t30" href="#t30">30</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t31" href="#t31">31</a></span><span class="t"><span class="str"> See line_number if you want a human-readable line number</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t32" href="#t32">32</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t33" href="#t33">33</a></span><span class="t"> <span class="nam">cursor_position</span><span class="op">:</span> <span class="nam">int</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t34" href="#t34">34</a></span><span class="t"> <span class="str">"""Describes a cursor position ("between two characters") or a character offset.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t35" href="#t35">35</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t36" href="#t36">36</a></span><span class="t"><span class="str"> When this value is 0, the position is at the start of a line. When it is 1, then</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t37" href="#t37">37</a></span><span class="t"><span class="str"> the position is between the first and the second character (etc.).</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t38" href="#t38">38</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t39" href="#t39">39</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t40" href="#t40">40</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t41" href="#t41">41</a></span><span class="t"> <span class="key">def</span> <span class="nam">line_number</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">int</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t42" href="#t42">42</a></span><span class="t"> <span class="str">"""The line number as human would count it"""</span> </span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t43" href="#t43">43</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">line_position</span> <span class="op">+</span> <span class="num">1</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t44" href="#t44">44</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t45" href="#t45">45</a></span><span class="t"> <span class="key">def</span> <span class="nam">relative_to</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">new_base</span><span class="op">:</span> <span class="str">"Position"</span><span class="op">)</span> <span class="op">-></span> <span class="str">"Position"</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t46" href="#t46">46</a></span><span class="t"> <span class="str">"""Offsets the position relative to another position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t47" href="#t47">47</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t48" href="#t48">48</a></span><span class="t"><span class="str"> This is useful to avoid the `position_in_file()` method by caching where</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t49" href="#t49">49</a></span><span class="t"><span class="str"> the parents position and then for its children you use `range_in_parent()`</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t50" href="#t50">50</a></span><span class="t"><span class="str"> plus `relative_to()` to rebase the range.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t51" href="#t51">51</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t52" href="#t52">52</a></span><span class="t"><span class="str"> >>> parent: Locatable = ... # doctest: +SKIP</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t53" href="#t53">53</a></span><span class="t"><span class="str"> >>> children: Iterable[Locatable] = ... # doctest: +SKIP</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t54" href="#t54">54</a></span><span class="t"><span class="str"> >>> # This will expensive</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t55" href="#t55">55</a></span><span class="t"><span class="str"> >>> parent_pos = parent.position_in_file( # doctest: +SKIP</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t56" href="#t56">56</a></span><span class="t"><span class="str"> ... skip_leading_comments=False</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t57" href="#t57">57</a></span><span class="t"><span class="str"> ... )</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t58" href="#t58">58</a></span><span class="t"><span class="str"> >>> for child in children: # doctest: +SKIP</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t59" href="#t59">59</a></span><span class="t"><span class="str"> ... child_pos = child.position_in_parent()</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t60" href="#t60">60</a></span><span class="t"><span class="str"> ... # Avoid a position_in_file() for each child</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t61" href="#t61">61</a></span><span class="t"><span class="str"> ... child_pos_in_file = child_pos.relative_to(parent_pos)</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t62" href="#t62">62</a></span><span class="t"><span class="str"> ... ... # Use the child_pos_in_file for something</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t63" href="#t63">63</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t64" href="#t64">64</a></span><span class="t"><span class="str"> :param new_base: The position that should have been the origin rather than</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t65" href="#t65">65</a></span><span class="t"><span class="str"> (0, 0).</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t66" href="#t66">66</a></span><span class="t"><span class="str"> :returns: The range offset relative to the base position.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t67" href="#t67">67</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t68" href="#t68">68</a></span><span class="t"> <span class="key">if</span> <span class="nam">self</span><span class="op">.</span><span class="nam">line_position</span> <span class="op">==</span> <span class="num">0</span> <span class="key">and</span> <span class="nam">self</span><span class="op">.</span><span class="nam">cursor_position</span> <span class="op">==</span> <span class="num">0</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t69" href="#t69">69</a></span><span class="t"> <span class="key">return</span> <span class="nam">new_base</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t70" href="#t70">70</a></span><span class="t"> <span class="key">if</span> <span class="nam">new_base</span><span class="op">.</span><span class="nam">line_position</span> <span class="op">==</span> <span class="num">0</span> <span class="key">and</span> <span class="nam">new_base</span><span class="op">.</span><span class="nam">cursor_position</span> <span class="op">==</span> <span class="num">0</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t71" href="#t71">71</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t72" href="#t72">72</a></span><span class="t"> <span class="key">if</span> <span class="nam">self</span><span class="op">.</span><span class="nam">line_position</span> <span class="op">==</span> <span class="num">0</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t73" href="#t73">73</a></span><span class="t"> <span class="nam">line_number</span> <span class="op">=</span> <span class="nam">new_base</span><span class="op">.</span><span class="nam">line_position</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t74" href="#t74">74</a></span><span class="t"> <span class="nam">line_char_offset</span> <span class="op">=</span> <span class="nam">new_base</span><span class="op">.</span><span class="nam">cursor_position</span> <span class="op">+</span> <span class="nam">self</span><span class="op">.</span><span class="nam">cursor_position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t75" href="#t75">75</a></span><span class="t"> <span class="key">else</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t76" href="#t76">76</a></span><span class="t"> <span class="nam">line_number</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">line_position</span> <span class="op">+</span> <span class="nam">new_base</span><span class="op">.</span><span class="nam">line_position</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t77" href="#t77">77</a></span><span class="t"> <span class="nam">line_char_offset</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">cursor_position</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t78" href="#t78">78</a></span><span class="t"> <span class="key">return</span> <span class="nam">Position</span><span class="op">(</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t79" href="#t79">79</a></span><span class="t"> <span class="nam">line_number</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t80" href="#t80">80</a></span><span class="t"> <span class="nam">line_char_offset</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t81" href="#t81">81</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t82" href="#t82">82</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t83" href="#t83">83</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t84" href="#t84">84</a></span><span class="t"><span class="op">@</span><span class="nam">dataclasses</span><span class="op">.</span><span class="nam">dataclass</span><span class="op">(</span><span class="nam">frozen</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> <span class="op">**</span><span class="nam">_DATA_CLASS_OPTIONAL_ARGS</span><span class="op">)</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t85" href="#t85">85</a></span><span class="t"><span class="key">class</span> <span class="nam">Range</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t86" href="#t86">86</a></span><span class="t"> <span class="str">"""Describes a range inside a file</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t87" href="#t87">87</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t88" href="#t88">88</a></span><span class="t"><span class="str"> This can be useful to describe things like "from line 4, cursor position 2</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t89" href="#t89">89</a></span><span class="t"><span class="str"> to line 7 to cursor position 10". When describing a full line including the</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t90" href="#t90">90</a></span><span class="t"><span class="str"> newline, use line N, cursor position 0 to line N+1. cursor position 0.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t91" href="#t91">91</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t92" href="#t92">92</a></span><span class="t"><span class="str"> It is also used to denote the size of objects (in that case, the start position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t93" href="#t93">93</a></span><span class="t"><span class="str"> is set to START_POSITION as a convention if the precise location is not</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t94" href="#t94">94</a></span><span class="t"><span class="str"> specified).</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t95" href="#t95">95</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t96" href="#t96">96</a></span><span class="t"><span class="str"> This is modelled after the "Range" in Language Server Protocol (LSP).</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t97" href="#t97">97</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t98" href="#t98">98</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t99" href="#t99">99</a></span><span class="t"> <span class="nam">start_pos</span><span class="op">:</span> <span class="nam">Position</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t100" href="#t100">100</a></span><span class="t"> <span class="nam">end_pos</span><span class="op">:</span> <span class="nam">Position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t101" href="#t101">101</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t102" href="#t102">102</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t103" href="#t103">103</a></span><span class="t"> <span class="key">def</span> <span class="nam">start_line_position</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">int</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t104" href="#t104">104</a></span><span class="t"> <span class="str">"""Describes the start line position as a 0-based line number</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t105" href="#t105">105</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t106" href="#t106">106</a></span><span class="t"><span class="str"> See start_line_number if you want a human-readable line number</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t107" href="#t107">107</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t108" href="#t108">108</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">start_pos</span><span class="op">.</span><span class="nam">line_position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t109" href="#t109">109</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t110" href="#t110">110</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t111" href="#t111">111</a></span><span class="t"> <span class="key">def</span> <span class="nam">start_cursor_position</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">int</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t112" href="#t112">112</a></span><span class="t"> <span class="str">"""Describes the starting cursor position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t113" href="#t113">113</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t114" href="#t114">114</a></span><span class="t"><span class="str"> When this value is 0, the position is at the start of a line. When it is 1, then</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t115" href="#t115">115</a></span><span class="t"><span class="str"> the position is between the first and the second character (etc.).</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t116" href="#t116">116</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t117" href="#t117">117</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">start_pos</span><span class="op">.</span><span class="nam">cursor_position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t118" href="#t118">118</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t119" href="#t119">119</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t120" href="#t120">120</a></span><span class="t"> <span class="key">def</span> <span class="nam">start_line_number</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">int</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t121" href="#t121">121</a></span><span class="t"> <span class="str">"""The start line number as human would count it"""</span> </span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t122" href="#t122">122</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">start_pos</span><span class="op">.</span><span class="nam">line_number</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t123" href="#t123">123</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t124" href="#t124">124</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t125" href="#t125">125</a></span><span class="t"> <span class="key">def</span> <span class="nam">end_line_position</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">int</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t126" href="#t126">126</a></span><span class="t"> <span class="str">"""Describes the end line position as a 0-based line number</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t127" href="#t127">127</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t128" href="#t128">128</a></span><span class="t"><span class="str"> See end_line_number if you want a human-readable line number</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t129" href="#t129">129</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t130" href="#t130">130</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">end_pos</span><span class="op">.</span><span class="nam">line_position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t131" href="#t131">131</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t132" href="#t132">132</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t133" href="#t133">133</a></span><span class="t"> <span class="key">def</span> <span class="nam">end_line_number</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">int</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t134" href="#t134">134</a></span><span class="t"> <span class="str">"""The end line number as human would count it"""</span> </span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t135" href="#t135">135</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">end_pos</span><span class="op">.</span><span class="nam">line_number</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t136" href="#t136">136</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t137" href="#t137">137</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t138" href="#t138">138</a></span><span class="t"> <span class="key">def</span> <span class="nam">end_cursor_position</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">int</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t139" href="#t139">139</a></span><span class="t"> <span class="str">"""Describes the end cursor position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t140" href="#t140">140</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t141" href="#t141">141</a></span><span class="t"><span class="str"> When this value is 0, the position is at the start of a line. When it is 1, then</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t142" href="#t142">142</a></span><span class="t"><span class="str"> the position is between the first and the second character (etc.).</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t143" href="#t143">143</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t144" href="#t144">144</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">end_pos</span><span class="op">.</span><span class="nam">cursor_position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t145" href="#t145">145</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t146" href="#t146">146</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t147" href="#t147">147</a></span><span class="t"> <span class="key">def</span> <span class="nam">line_count</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">int</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t148" href="#t148">148</a></span><span class="t"> <span class="str">"""The number of lines (newlines) spanned by this range.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t149" href="#t149">149</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t150" href="#t150">150</a></span><span class="t"><span class="str"> Will be zero when the range fits inside one line.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t151" href="#t151">151</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t152" href="#t152">152</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">end_line_position</span> <span class="op">-</span> <span class="nam">self</span><span class="op">.</span><span class="nam">start_line_position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t153" href="#t153">153</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t154" href="#t154">154</a></span><span class="t"> <span class="op">@</span><span class="nam">classmethod</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t155" href="#t155">155</a></span><span class="t"> <span class="key">def</span> <span class="nam">between</span><span class="op">(</span><span class="nam">cls</span><span class="op">,</span> <span class="nam">a</span><span class="op">:</span> <span class="nam">Position</span><span class="op">,</span> <span class="nam">b</span><span class="op">:</span> <span class="nam">Position</span><span class="op">)</span> <span class="op">-></span> <span class="str">"Self"</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t156" href="#t156">156</a></span><span class="t"> <span class="str">"""Computes the range between two positions</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t157" href="#t157">157</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t158" href="#t158">158</a></span><span class="t"><span class="str"> Unlike the constructor, this will always create a "positive" range.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t159" href="#t159">159</a></span><span class="t"><span class="str"> That is, the "earliest" position will always be the start position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t160" href="#t160">160</a></span><span class="t"><span class="str"> regardless of the order they were passed to `between`. When using</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t161" href="#t161">161</a></span><span class="t"><span class="str"> the Range constructor, you have freedom to do "inverse" ranges</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t162" href="#t162">162</a></span><span class="t"><span class="str"> in case that is ever useful</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t163" href="#t163">163</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="par run show_par"><span class="n"><a id="t164" href="#t164">164</a></span><span class="t"> <span class="key">if</span> <span class="nam">a</span><span class="op">.</span><span class="nam">line_position</span> <span class="op">></span> <span class="nam">b</span><span class="op">.</span><span class="nam">line_position</span> <span class="key">or</span> <span class="op">(</span> </span><span class="r"><span class="annotate short">164 ↛ 168</span><span class="annotate long">line 164 didn't jump to line 168, because the condition on line 164 was never true</span></span></p>
<p class="pln"><span class="n"><a id="t165" href="#t165">165</a></span><span class="t"> <span class="nam">a</span><span class="op">.</span><span class="nam">line_position</span> <span class="op">==</span> <span class="nam">b</span><span class="op">.</span><span class="nam">line_position</span> <span class="key">and</span> <span class="nam">a</span><span class="op">.</span><span class="nam">cursor_position</span> <span class="op">></span> <span class="nam">b</span><span class="op">.</span><span class="nam">cursor_position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t166" href="#t166">166</a></span><span class="t"> <span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t167" href="#t167">167</a></span><span class="t"> <span class="com"># Order swap, so `a` is always the earliest position</span> </span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t168" href="#t168">168</a></span><span class="t"> <span class="nam">a</span><span class="op">,</span> <span class="nam">b</span> <span class="op">=</span> <span class="nam">b</span><span class="op">,</span> <span class="nam">a</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t169" href="#t169">169</a></span><span class="t"> <span class="key">return</span> <span class="nam">cls</span><span class="op">(</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t170" href="#t170">170</a></span><span class="t"> <span class="nam">a</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t171" href="#t171">171</a></span><span class="t"> <span class="nam">b</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t172" href="#t172">172</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t173" href="#t173">173</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t174" href="#t174">174</a></span><span class="t"> <span class="key">def</span> <span class="nam">relative_to</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">new_base</span><span class="op">:</span> <span class="nam">Position</span><span class="op">)</span> <span class="op">-></span> <span class="str">"Range"</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t175" href="#t175">175</a></span><span class="t"> <span class="str">"""Offsets the range relative to another position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t176" href="#t176">176</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t177" href="#t177">177</a></span><span class="t"><span class="str"> This is useful to avoid the `position_in_file()` method by caching where</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t178" href="#t178">178</a></span><span class="t"><span class="str"> the parents position and then for its children you use `range_in_parent()`</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t179" href="#t179">179</a></span><span class="t"><span class="str"> plus `relative_to()` to rebase the range.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t180" href="#t180">180</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t181" href="#t181">181</a></span><span class="t"><span class="str"> >>> parent: Locatable = ... # doctest: +SKIP</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t182" href="#t182">182</a></span><span class="t"><span class="str"> >>> children: Iterable[Locatable] = ... # doctest: +SKIP</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t183" href="#t183">183</a></span><span class="t"><span class="str"> >>> # This will expensive</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t184" href="#t184">184</a></span><span class="t"><span class="str"> >>> parent_pos = parent.position_in_file( # doctest: +SKIP</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t185" href="#t185">185</a></span><span class="t"><span class="str"> ... skip_leading_comments=False</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t186" href="#t186">186</a></span><span class="t"><span class="str"> ... )</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t187" href="#t187">187</a></span><span class="t"><span class="str"> >>> for child in children: # doctest: +SKIP</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t188" href="#t188">188</a></span><span class="t"><span class="str"> ... child_range = child.range_in_parent()</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t189" href="#t189">189</a></span><span class="t"><span class="str"> ... # Avoid a position_in_file() for each child</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t190" href="#t190">190</a></span><span class="t"><span class="str"> ... child_range_in_file = child_range.relative_to(parent_pos)</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t191" href="#t191">191</a></span><span class="t"><span class="str"> ... ... # Use the child_range_in_file for something</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t192" href="#t192">192</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t193" href="#t193">193</a></span><span class="t"><span class="str"> :param new_base: The position that should have been the origin rather than</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t194" href="#t194">194</a></span><span class="t"><span class="str"> (0, 0).</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t195" href="#t195">195</a></span><span class="t"><span class="str"> :returns: The range offset relative to the base position.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t196" href="#t196">196</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t197" href="#t197">197</a></span><span class="t"> <span class="key">if</span> <span class="nam">new_base</span> <span class="op">==</span> <span class="nam">START_POSITION</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t198" href="#t198">198</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t199" href="#t199">199</a></span><span class="t"> <span class="key">return</span> <span class="nam">Range</span><span class="op">(</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t200" href="#t200">200</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">start_pos</span><span class="op">.</span><span class="nam">relative_to</span><span class="op">(</span><span class="nam">new_base</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t201" href="#t201">201</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">end_pos</span><span class="op">.</span><span class="nam">relative_to</span><span class="op">(</span><span class="nam">new_base</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t202" href="#t202">202</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t203" href="#t203">203</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t204" href="#t204">204</a></span><span class="t"> <span class="key">def</span> <span class="nam">as_size</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="str">"Range"</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t205" href="#t205">205</a></span><span class="t"> <span class="str">"""Reduces the range to a "size"</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t206" href="#t206">206</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t207" href="#t207">207</a></span><span class="t"><span class="str"> The returned range will always have its start position to (0, 0) and</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t208" href="#t208">208</a></span><span class="t"><span class="str"> its end position shifted accordingly if it was not already based at</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t209" href="#t209">209</a></span><span class="t"><span class="str"> (0, 0).</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t210" href="#t210">210</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t211" href="#t211">211</a></span><span class="t"><span class="str"> The original range is not mutated and, if it is already at (0, 0), the</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t212" href="#t212">212</a></span><span class="t"><span class="str"> method will just return it as-is.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t213" href="#t213">213</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="par run show_par"><span class="n"><a id="t214" href="#t214">214</a></span><span class="t"> <span class="key">if</span> <span class="nam">self</span><span class="op">.</span><span class="nam">start_pos</span> <span class="op">==</span> <span class="nam">START_POSITION</span><span class="op">:</span> </span><span class="r"><span class="annotate short">214 ↛ 216</span><span class="annotate long">line 214 didn't jump to line 216, because the condition on line 214 was never false</span></span></p>
<p class="run"><span class="n"><a id="t215" href="#t215">215</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span> </span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t216" href="#t216">216</a></span><span class="t"> <span class="nam">line_count</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">line_count</span> </span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t217" href="#t217">217</a></span><span class="t"> <span class="key">if</span> <span class="nam">line_count</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t218" href="#t218">218</a></span><span class="t"> <span class="nam">new_end_cursor_position</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">end_cursor_position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t219" href="#t219">219</a></span><span class="t"> <span class="key">else</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t220" href="#t220">220</a></span><span class="t"> <span class="nam">delta</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">end_cursor_position</span> <span class="op">-</span> <span class="nam">self</span><span class="op">.</span><span class="nam">start_cursor_position</span> </span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t221" href="#t221">221</a></span><span class="t"> <span class="nam">new_end_cursor_position</span> <span class="op">=</span> <span class="nam">delta</span> </span><span class="r"></span></p>
<p class="mis show_mis"><span class="n"><a id="t222" href="#t222">222</a></span><span class="t"> <span class="key">return</span> <span class="nam">Range</span><span class="op">(</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t223" href="#t223">223</a></span><span class="t"> <span class="nam">START_POSITION</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t224" href="#t224">224</a></span><span class="t"> <span class="nam">Position</span><span class="op">(</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t225" href="#t225">225</a></span><span class="t"> <span class="nam">line_count</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t226" href="#t226">226</a></span><span class="t"> <span class="nam">new_end_cursor_position</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t227" href="#t227">227</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t228" href="#t228">228</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t229" href="#t229">229</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t230" href="#t230">230</a></span><span class="t"> <span class="op">@</span><span class="nam">classmethod</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t231" href="#t231">231</a></span><span class="t"> <span class="key">def</span> <span class="nam">from_position_and_size</span><span class="op">(</span><span class="nam">cls</span><span class="op">,</span> <span class="nam">base</span><span class="op">:</span> <span class="nam">Position</span><span class="op">,</span> <span class="nam">size</span><span class="op">:</span> <span class="str">"Range"</span><span class="op">)</span> <span class="op">-></span> <span class="str">"Self"</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t232" href="#t232">232</a></span><span class="t"> <span class="str">"""Compute a range from a position and the size of another range</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t233" href="#t233">233</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t234" href="#t234">234</a></span><span class="t"><span class="str"> This provides you with a range starting at the base position that has</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t235" href="#t235">235</a></span><span class="t"><span class="str"> the same effective span as the size parameter.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t236" href="#t236">236</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t237" href="#t237">237</a></span><span class="t"><span class="str"> :param base: The desired starting position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t238" href="#t238">238</a></span><span class="t"><span class="str"> :param size: A range, which will be used as a size (that is, it will</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t239" href="#t239">239</a></span><span class="t"><span class="str"> be reduced to a size via the `as_size()` method) for the resulting</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t240" href="#t240">240</a></span><span class="t"><span class="str"> range</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t241" href="#t241">241</a></span><span class="t"><span class="str"> :returns: A range at the provided base position that has the size of</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t242" href="#t242">242</a></span><span class="t"><span class="str"> the provided range.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t243" href="#t243">243</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t244" href="#t244">244</a></span><span class="t"> <span class="nam">line_position</span> <span class="op">=</span> <span class="nam">base</span><span class="op">.</span><span class="nam">line_position</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t245" href="#t245">245</a></span><span class="t"> <span class="nam">cursor_position</span> <span class="op">=</span> <span class="nam">base</span><span class="op">.</span><span class="nam">cursor_position</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t246" href="#t246">246</a></span><span class="t"> <span class="nam">size_rebased</span> <span class="op">=</span> <span class="nam">size</span><span class="op">.</span><span class="nam">as_size</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t247" href="#t247">247</a></span><span class="t"> <span class="nam">lines</span> <span class="op">=</span> <span class="nam">size_rebased</span><span class="op">.</span><span class="nam">line_count</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t248" href="#t248">248</a></span><span class="t"> <span class="key">if</span> <span class="nam">lines</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t249" href="#t249">249</a></span><span class="t"> <span class="nam">line_position</span> <span class="op">+=</span> <span class="nam">lines</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t250" href="#t250">250</a></span><span class="t"> <span class="nam">cursor_position</span> <span class="op">=</span> <span class="nam">size_rebased</span><span class="op">.</span><span class="nam">end_cursor_position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t251" href="#t251">251</a></span><span class="t"> <span class="key">else</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t252" href="#t252">252</a></span><span class="t"> <span class="nam">delta</span> <span class="op">=</span> <span class="op">(</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t253" href="#t253">253</a></span><span class="t"> <span class="nam">size_rebased</span><span class="op">.</span><span class="nam">end_cursor_position</span> <span class="op">-</span> <span class="nam">size_rebased</span><span class="op">.</span><span class="nam">start_cursor_position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t254" href="#t254">254</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t255" href="#t255">255</a></span><span class="t"> <span class="nam">cursor_position</span> <span class="op">+=</span> <span class="nam">delta</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t256" href="#t256">256</a></span><span class="t"> <span class="key">return</span> <span class="nam">cls</span><span class="op">(</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t257" href="#t257">257</a></span><span class="t"> <span class="nam">base</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t258" href="#t258">258</a></span><span class="t"> <span class="nam">Position</span><span class="op">(</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t259" href="#t259">259</a></span><span class="t"> <span class="nam">line_position</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t260" href="#t260">260</a></span><span class="t"> <span class="nam">cursor_position</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t261" href="#t261">261</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t262" href="#t262">262</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t263" href="#t263">263</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t264" href="#t264">264</a></span><span class="t"> <span class="op">@</span><span class="nam">classmethod</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t265" href="#t265">265</a></span><span class="t"> <span class="key">def</span> <span class="nam">from_position_and_sizes</span><span class="op">(</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t266" href="#t266">266</a></span><span class="t"> <span class="nam">cls</span><span class="op">,</span> <span class="nam">base</span><span class="op">:</span> <span class="nam">Position</span><span class="op">,</span> <span class="nam">sizes</span><span class="op">:</span> <span class="nam">Iterable</span><span class="op">[</span><span class="str">"Range"</span><span class="op">]</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t267" href="#t267">267</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="str">"Self"</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t268" href="#t268">268</a></span><span class="t"> <span class="str">"""Compute a range from a position and the size of number of ranges</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t269" href="#t269">269</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t270" href="#t270">270</a></span><span class="t"><span class="str"> :param base: The desired starting position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t271" href="#t271">271</a></span><span class="t"><span class="str"> :param sizes: All the ranges that combined makes up the size of the</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t272" href="#t272">272</a></span><span class="t"><span class="str"> desired position. Note that order can affect the end result. Particularly</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t273" href="#t273">273</a></span><span class="t"><span class="str"> the end character offset gets reset every time a size spans a line.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t274" href="#t274">274</a></span><span class="t"><span class="str"> :returns: A range at the provided base position that has the size of</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t275" href="#t275">275</a></span><span class="t"><span class="str"> the provided range.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t276" href="#t276">276</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t277" href="#t277">277</a></span><span class="t"> <span class="nam">line_position</span> <span class="op">=</span> <span class="nam">base</span><span class="op">.</span><span class="nam">line_position</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t278" href="#t278">278</a></span><span class="t"> <span class="nam">cursor_position</span> <span class="op">=</span> <span class="nam">base</span><span class="op">.</span><span class="nam">cursor_position</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t279" href="#t279">279</a></span><span class="t"> <span class="key">for</span> <span class="nam">size</span> <span class="key">in</span> <span class="nam">sizes</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t280" href="#t280">280</a></span><span class="t"> <span class="nam">size_rebased</span> <span class="op">=</span> <span class="nam">size</span><span class="op">.</span><span class="nam">as_size</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t281" href="#t281">281</a></span><span class="t"> <span class="nam">lines</span> <span class="op">=</span> <span class="nam">size_rebased</span><span class="op">.</span><span class="nam">line_count</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t282" href="#t282">282</a></span><span class="t"> <span class="key">if</span> <span class="nam">lines</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t283" href="#t283">283</a></span><span class="t"> <span class="nam">line_position</span> <span class="op">+=</span> <span class="nam">lines</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t284" href="#t284">284</a></span><span class="t"> <span class="nam">cursor_position</span> <span class="op">=</span> <span class="nam">size_rebased</span><span class="op">.</span><span class="nam">end_cursor_position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t285" href="#t285">285</a></span><span class="t"> <span class="key">else</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t286" href="#t286">286</a></span><span class="t"> <span class="nam">delta</span> <span class="op">=</span> <span class="op">(</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t287" href="#t287">287</a></span><span class="t"> <span class="nam">size_rebased</span><span class="op">.</span><span class="nam">end_cursor_position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t288" href="#t288">288</a></span><span class="t"> <span class="op">-</span> <span class="nam">size_rebased</span><span class="op">.</span><span class="nam">start_cursor_position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t289" href="#t289">289</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t290" href="#t290">290</a></span><span class="t"> <span class="nam">cursor_position</span> <span class="op">+=</span> <span class="nam">delta</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t291" href="#t291">291</a></span><span class="t"> <span class="key">return</span> <span class="nam">cls</span><span class="op">(</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t292" href="#t292">292</a></span><span class="t"> <span class="nam">base</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t293" href="#t293">293</a></span><span class="t"> <span class="nam">Position</span><span class="op">(</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t294" href="#t294">294</a></span><span class="t"> <span class="nam">line_position</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t295" href="#t295">295</a></span><span class="t"> <span class="nam">cursor_position</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t296" href="#t296">296</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t297" href="#t297">297</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t298" href="#t298">298</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t299" href="#t299">299</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t300" href="#t300">300</a></span><span class="t"><span class="nam">START_POSITION</span> <span class="op">=</span> <span class="nam">Position</span><span class="op">(</span><span class="num">0</span><span class="op">,</span> <span class="num">0</span><span class="op">)</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t301" href="#t301">301</a></span><span class="t"><span class="nam">SECOND_CHAR_POS</span> <span class="op">=</span> <span class="nam">Position</span><span class="op">(</span><span class="num">0</span><span class="op">,</span> <span class="num">1</span><span class="op">)</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t302" href="#t302">302</a></span><span class="t"><span class="nam">SECOND_LINE_POS</span> <span class="op">=</span> <span class="nam">Position</span><span class="op">(</span><span class="num">1</span><span class="op">,</span> <span class="num">0</span><span class="op">)</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t303" href="#t303">303</a></span><span class="t"><span class="nam">ONE_CHAR_RANGE</span> <span class="op">=</span> <span class="nam">Range</span><span class="op">.</span><span class="nam">between</span><span class="op">(</span><span class="nam">START_POSITION</span><span class="op">,</span> <span class="nam">SECOND_CHAR_POS</span><span class="op">)</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t304" href="#t304">304</a></span><span class="t"><span class="nam">ONE_LINE_RANGE</span> <span class="op">=</span> <span class="nam">Range</span><span class="op">.</span><span class="nam">between</span><span class="op">(</span><span class="nam">START_POSITION</span><span class="op">,</span> <span class="nam">SECOND_LINE_POS</span><span class="op">)</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t305" href="#t305">305</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t306" href="#t306">306</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t307" href="#t307">307</a></span><span class="t"><span class="key">class</span> <span class="nam">Locatable</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t308" href="#t308">308</a></span><span class="t"> <span class="nam">__slots__</span> <span class="op">=</span> <span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t309" href="#t309">309</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t310" href="#t310">310</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t311" href="#t311">311</a></span><span class="t"> <span class="key">def</span> <span class="nam">parent_element</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t312" href="#t312">312</a></span><span class="t"> <span class="com"># type: () -> Optional[Deb822Element]</span> </span><span class="r"></span></p>
<p class="exc show_exc"><span class="n"><a id="t313" href="#t313">313</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t314" href="#t314">314</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t315" href="#t315">315</a></span><span class="t"> <span class="key">def</span> <span class="nam">position_in_parent</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="op">*</span><span class="op">,</span> <span class="nam">skip_leading_comments</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">True</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Position</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t316" href="#t316">316</a></span><span class="t"> <span class="str">"""The start position of this token/element inside its parent</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t317" href="#t317">317</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t318" href="#t318">318</a></span><span class="t"><span class="str"> This is operation is generally linear to the number of "parts" (elements/tokens)</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t319" href="#t319">319</a></span><span class="t"><span class="str"> inside the parent.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t320" href="#t320">320</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t321" href="#t321">321</a></span><span class="t"><span class="str"> :param skip_leading_comments: If True, then if any leading comment that</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t322" href="#t322">322</a></span><span class="t"><span class="str"> that can be skipped will be excluded in the position of this locatable.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t323" href="#t323">323</a></span><span class="t"><span class="str"> This is useful if you want the position "semantic" content of a field</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t324" href="#t324">324</a></span><span class="t"><span class="str"> without also highlighting a leading comment. Remember to align this</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t325" href="#t325">325</a></span><span class="t"><span class="str"> parameter with the `size` call, so the range does not "overshoot"</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t326" href="#t326">326</a></span><span class="t"><span class="str"> into the next element (or falls short and only covers part of an</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t327" href="#t327">327</a></span><span class="t"><span class="str"> element). Note that this option can only be used to filter out leading</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t328" href="#t328">328</a></span><span class="t"><span class="str"> comments when the comments are a subset of the element. It has no</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t329" href="#t329">329</a></span><span class="t"><span class="str"> effect on elements that are entirely made of comments.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t330" href="#t330">330</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t331" href="#t331">331</a></span><span class="t"> <span class="com"># pylint: disable=unused-argument</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t332" href="#t332">332</a></span><span class="t"> <span class="com"># Note: The base class makes no assumptions about what tokens can be skipped,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t333" href="#t333">333</a></span><span class="t"> <span class="com"># therefore, skip_leading_comments is unused here. However, I do not want the</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t334" href="#t334">334</a></span><span class="t"> <span class="com"># API to differ between elements and tokens.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t335" href="#t335">335</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t336" href="#t336">336</a></span><span class="t"> <span class="nam">parent</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">parent_element</span> </span><span class="r"></span></p>
<p class="par run show_par"><span class="n"><a id="t337" href="#t337">337</a></span><span class="t"> <span class="key">if</span> <span class="nam">parent</span> <span class="key">is</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"><span class="annotate short">337 ↛ 338</span><span class="annotate long">line 337 didn't jump to line 338, because the condition on line 337 was never true</span></span></p>
<p class="mis show_mis"><span class="n"><a id="t338" href="#t338">338</a></span><span class="t"> <span class="key">raise</span> <span class="nam">TypeError</span><span class="op">(</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t339" href="#t339">339</a></span><span class="t"> <span class="str">"Cannot determine the position since the object is detached"</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t340" href="#t340">340</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t341" href="#t341">341</a></span><span class="t"> <span class="nam">relevant_parts</span> <span class="op">=</span> <span class="nam">itertools</span><span class="op">.</span><span class="nam">takewhile</span><span class="op">(</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t342" href="#t342">342</a></span><span class="t"> <span class="key">lambda</span> <span class="nam">x</span><span class="op">:</span> <span class="nam">x</span> <span class="key">is</span> <span class="key">not</span> <span class="nam">self</span><span class="op">,</span> <span class="nam">parent</span><span class="op">.</span><span class="nam">iter_parts</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t343" href="#t343">343</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t344" href="#t344">344</a></span><span class="t"> <span class="nam">span</span> <span class="op">=</span> <span class="nam">Range</span><span class="op">.</span><span class="nam">from_position_and_sizes</span><span class="op">(</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t345" href="#t345">345</a></span><span class="t"> <span class="nam">START_POSITION</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t346" href="#t346">346</a></span><span class="t"> <span class="op">(</span><span class="nam">x</span><span class="op">.</span><span class="nam">size</span><span class="op">(</span><span class="nam">skip_leading_comments</span><span class="op">=</span><span class="key">False</span><span class="op">)</span> <span class="key">for</span> <span class="nam">x</span> <span class="key">in</span> <span class="nam">relevant_parts</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t347" href="#t347">347</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t348" href="#t348">348</a></span><span class="t"> <span class="key">return</span> <span class="nam">span</span><span class="op">.</span><span class="nam">end_pos</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t349" href="#t349">349</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t350" href="#t350">350</a></span><span class="t"> <span class="key">def</span> <span class="nam">range_in_parent</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="op">*</span><span class="op">,</span> <span class="nam">skip_leading_comments</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">True</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Range</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t351" href="#t351">351</a></span><span class="t"> <span class="str">"""The range of this token/element inside its parent</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t352" href="#t352">352</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t353" href="#t353">353</a></span><span class="t"><span class="str"> This is operation is generally linear to the number of "parts" (elements/tokens)</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t354" href="#t354">354</a></span><span class="t"><span class="str"> inside the parent.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t355" href="#t355">355</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t356" href="#t356">356</a></span><span class="t"><span class="str"> :param skip_leading_comments: If True, then if any leading comment that</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t357" href="#t357">357</a></span><span class="t"><span class="str"> that can be skipped will be excluded in the position of this locatable.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t358" href="#t358">358</a></span><span class="t"><span class="str"> This is useful if you want the position "semantic" content of a field</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t359" href="#t359">359</a></span><span class="t"><span class="str"> without also highlighting a leading comment. Remember to align this</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t360" href="#t360">360</a></span><span class="t"><span class="str"> parameter with the `size` call, so the range does not "overshoot"</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t361" href="#t361">361</a></span><span class="t"><span class="str"> into the next element (or falls short and only covers part of an</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t362" href="#t362">362</a></span><span class="t"><span class="str"> element). Note that this option can only be used to filter out leading</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t363" href="#t363">363</a></span><span class="t"><span class="str"> comments when the comments are a subset of the element. It has no</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t364" href="#t364">364</a></span><span class="t"><span class="str"> effect on elements that are entirely made of comments.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t365" href="#t365">365</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t366" href="#t366">366</a></span><span class="t"> <span class="nam">pos</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">position_in_parent</span><span class="op">(</span><span class="nam">skip_leading_comments</span><span class="op">=</span><span class="nam">skip_leading_comments</span><span class="op">)</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t367" href="#t367">367</a></span><span class="t"> <span class="key">return</span> <span class="nam">Range</span><span class="op">.</span><span class="nam">from_position_and_size</span><span class="op">(</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t368" href="#t368">368</a></span><span class="t"> <span class="nam">pos</span><span class="op">,</span> <span class="nam">self</span><span class="op">.</span><span class="nam">size</span><span class="op">(</span><span class="nam">skip_leading_comments</span><span class="op">=</span><span class="nam">skip_leading_comments</span><span class="op">)</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t369" href="#t369">369</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t370" href="#t370">370</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t371" href="#t371">371</a></span><span class="t"> <span class="key">def</span> <span class="nam">position_in_file</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="op">*</span><span class="op">,</span> <span class="nam">skip_leading_comments</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">True</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Position</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t372" href="#t372">372</a></span><span class="t"> <span class="str">"""The start position of this token/element in this file</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t373" href="#t373">373</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t374" href="#t374">374</a></span><span class="t"><span class="str"> This is an *expensive* operation and in many cases have to traverse</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t375" href="#t375">375</a></span><span class="t"><span class="str"> the entire file structure to answer the query. Consider whether</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t376" href="#t376">376</a></span><span class="t"><span class="str"> you can maintain the parent's position and then use</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t377" href="#t377">377</a></span><span class="t"><span class="str"> `position_in_parent()` combined with</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t378" href="#t378">378</a></span><span class="t"><span class="str"> `child_position.relative_to(parent_position)`</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t379" href="#t379">379</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t380" href="#t380">380</a></span><span class="t"><span class="str"> :param skip_leading_comments: If True, then if any leading comment that</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t381" href="#t381">381</a></span><span class="t"><span class="str"> that can be skipped will be excluded in the position of this locatable.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t382" href="#t382">382</a></span><span class="t"><span class="str"> This is useful if you want the position "semantic" content of a field</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t383" href="#t383">383</a></span><span class="t"><span class="str"> without also highlighting a leading comment. Remember to align this</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t384" href="#t384">384</a></span><span class="t"><span class="str"> parameter with the `size` call, so the range does not "overshoot"</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t385" href="#t385">385</a></span><span class="t"><span class="str"> into the next element (or falls short and only covers part of an</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t386" href="#t386">386</a></span><span class="t"><span class="str"> element). Note that this option can only be used to filter out leading</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t387" href="#t387">387</a></span><span class="t"><span class="str"> comments when the comments are a subset of the element. It has no</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t388" href="#t388">388</a></span><span class="t"><span class="str"> effect on elements that are entirely made of comments.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t389" href="#t389">389</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t390" href="#t390">390</a></span><span class="t"> <span class="nam">position</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">position_in_parent</span><span class="op">(</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t391" href="#t391">391</a></span><span class="t"> <span class="nam">skip_leading_comments</span><span class="op">=</span><span class="nam">skip_leading_comments</span><span class="op">,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t392" href="#t392">392</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t393" href="#t393">393</a></span><span class="t"> <span class="nam">parent</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">parent_element</span> </span><span class="r"></span></p>
<p class="par run show_par"><span class="n"><a id="t394" href="#t394">394</a></span><span class="t"> <span class="key">if</span> <span class="nam">parent</span> <span class="key">is</span> <span class="key">not</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"><span class="annotate short">394 ↛ 397</span><span class="annotate long">line 394 didn't jump to line 397, because the condition on line 394 was never false</span></span></p>
<p class="run"><span class="n"><a id="t395" href="#t395">395</a></span><span class="t"> <span class="nam">parent_position</span> <span class="op">=</span> <span class="nam">parent</span><span class="op">.</span><span class="nam">position_in_file</span><span class="op">(</span><span class="nam">skip_leading_comments</span><span class="op">=</span><span class="key">False</span><span class="op">)</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t396" href="#t396">396</a></span><span class="t"> <span class="nam">position</span> <span class="op">=</span> <span class="nam">position</span><span class="op">.</span><span class="nam">relative_to</span><span class="op">(</span><span class="nam">parent_position</span><span class="op">)</span> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t397" href="#t397">397</a></span><span class="t"> <span class="key">return</span> <span class="nam">position</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t398" href="#t398">398</a></span><span class="t"> </span><span class="r"></span></p>
<p class="run"><span class="n"><a id="t399" href="#t399">399</a></span><span class="t"> <span class="key">def</span> <span class="nam">size</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="op">*</span><span class="op">,</span> <span class="nam">skip_leading_comments</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">True</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Range</span><span class="op">:</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t400" href="#t400">400</a></span><span class="t"> <span class="str">"""Describe the objects size as a continuous range</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t401" href="#t401">401</a></span><span class="t"> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t402" href="#t402">402</a></span><span class="t"><span class="str"> :param skip_leading_comments: If True, then if any leading comment that</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t403" href="#t403">403</a></span><span class="t"><span class="str"> that can be skipped will be excluded in the position of this locatable.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t404" href="#t404">404</a></span><span class="t"><span class="str"> This is useful if you want the position "semantic" content of a field</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t405" href="#t405">405</a></span><span class="t"><span class="str"> without also highlighting a leading comment. Remember to align this</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t406" href="#t406">406</a></span><span class="t"><span class="str"> parameter with the `position_in_file` or `position_in_parent` call,</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t407" href="#t407">407</a></span><span class="t"><span class="str"> so the range does not "overshoot" into the next element (or falls</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t408" href="#t408">408</a></span><span class="t"><span class="str"> short and only covers part of an element). Note that this option can</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t409" href="#t409">409</a></span><span class="t"><span class="str"> only be used to filter out leading comments when the comments are a</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t410" href="#t410">410</a></span><span class="t"><span class="str"> subset of the element. It has no effect on elements that are entirely</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t411" href="#t411">411</a></span><span class="t"><span class="str"> made of comments.</span> </span><span class="r"></span></p>
<p class="pln"><span class="n"><a id="t412" href="#t412">412</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
<p class="exc show_exc"><span class="n"><a id="t413" href="#t413">413</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p>
</main>
<footer>
<div class="content">
<p>
<a id="prevFileLink" class="nav" href="d_e9c451f4ae334f76_formatter_py.html">« prev</a>
<a id="indexLink" class="nav" href="index.html">^ index</a>
<a id="nextFileLink" class="nav" href="d_e9c451f4ae334f76_parsing_py.html">» next</a>
<a class="nav" href="https://coverage.readthedocs.io/en/7.2.7">coverage.py v7.2.7</a>,
created at 2024-04-07 12:14 +0200
</p>
</div>
</footer>
</body>
</html>
|
