diff options
Diffstat (limited to 'coverage-report/d_e9c451f4ae334f76_formatter_py.html')
| -rw-r--r-- | coverage-report/d_e9c451f4ae334f76_formatter_py.html | 577 |
1 files changed, 0 insertions, 577 deletions
diff --git a/coverage-report/d_e9c451f4ae334f76_formatter_py.html b/coverage-report/d_e9c451f4ae334f76_formatter_py.html deleted file mode 100644 index b80d750..0000000 --- a/coverage-report/d_e9c451f4ae334f76_formatter_py.html +++ /dev/null @@ -1,577 +0,0 @@ -<!DOCTYPE html> -<html> -<head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> - <title>Coverage for src/debputy/lsp/vendoring/_deb822_repro/formatter.py: 80%</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/formatter.py</b>: - <span class="pc_cov">80%</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">128 statements </span> - <button type="button" class="run button_toggle_run" value="run" data-shortcut="r" title="Toggle lines run">104<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">24<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">0<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">12<span class="text"> partial</span></button> - </h2> - <p class="text"> - <a id="prevFileLink" class="nav" href="d_e9c451f4ae334f76__util_py.html">« prev</a> - <a id="indexLink" class="nav" href="index.html">^ index</a> - <a id="nextFileLink" class="nav" href="d_e9c451f4ae334f76_locatable_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">operator</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2" href="#t2">2</a></span><span class="t"> </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">from</span> <span class="op">.</span><span class="nam">_util</span> <span class="key">import</span> <span class="nam">BufferingIterator</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t4" href="#t4">4</a></span><span class="t"><span class="key">from</span> <span class="op">.</span><span class="nam">tokens</span> <span class="key">import</span> <span class="nam">Deb822Token</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t5" href="#t5">5</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t6" href="#t6">6</a></span><span class="t"><span class="com"># Consider these "opaque" enum-like values. The actual value was chosen to</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t7" href="#t7">7</a></span><span class="t"><span class="com"># make repr easier to implement, but they are subject to change.</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t8" href="#t8">8</a></span><span class="t"><span class="nam">_CONTENT_TYPE_VALUE</span> <span class="op">=</span> <span class="str">"is_value"</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t9" href="#t9">9</a></span><span class="t"><span class="nam">_CONTENT_TYPE_COMMENT</span> <span class="op">=</span> <span class="str">"is_comment"</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t10" href="#t10">10</a></span><span class="t"><span class="nam">_CONTENT_TYPE_SEPARATOR</span> <span class="op">=</span> <span class="str">"is_separator"</span> </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="key">try</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t13" href="#t13">13</a></span><span class="t"> <span class="key">from</span> <span class="nam">typing</span> <span class="key">import</span> <span class="nam">Iterator</span><span class="op">,</span> <span class="nam">Union</span><span class="op">,</span> <span class="nam">Literal</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t14" href="#t14">14</a></span><span class="t"> <span class="key">from</span> <span class="op">.</span><span class="nam">types</span> <span class="key">import</span> <span class="nam">TokenOrElement</span><span class="op">,</span> <span class="nam">FormatterCallback</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t15" href="#t15">15</a></span><span class="t"><span class="key">except</span> <span class="nam">ImportError</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t16" href="#t16">16</a></span><span class="t"> <span class="key">pass</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t17" href="#t17">17</a></span><span class="t"> </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="run"><span class="n"><a id="t19" href="#t19">19</a></span><span class="t"><span class="key">class</span> <span class="nam">FormatterContentToken</span><span class="op">(</span><span class="nam">object</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t20" href="#t20">20</a></span><span class="t"> <span class="str">"""Typed, tagged text for use with the formatting API</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t21" href="#t21">21</a></span><span class="t"> </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"> The FormatterContentToken is used by the formatting API and provides the</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 class="str"> formatter callback with context about the textual tokens it is supposed</span> </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"> to format.</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"> """</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><span class="r"></span></p> - <p class="run"><span class="n"><a id="t27" href="#t27">27</a></span><span class="t"> <span class="nam">__slots__</span> <span class="op">=</span> <span class="op">(</span><span class="str">"_text"</span><span class="op">,</span> <span class="str">"_content_type"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t28" href="#t28">28</a></span><span class="t"> </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="key">def</span> <span class="nam">__init__</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">text</span><span class="op">,</span> <span class="nam">content_type</span><span class="op">)</span><span class="op">:</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 class="com"># type: (str, object) -> None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t31" href="#t31">31</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">_text</span> <span class="op">=</span> <span class="nam">text</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t32" href="#t32">32</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">_content_type</span> <span class="op">=</span> <span class="nam">content_type</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t33" href="#t33">33</a></span><span class="t"> </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="op">@</span><span class="nam">classmethod</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t35" href="#t35">35</a></span><span class="t"> <span class="key">def</span> <span class="nam">from_token_or_element</span><span class="op">(</span><span class="nam">cls</span><span class="op">,</span> <span class="nam">token_or_element</span><span class="op">)</span><span class="op">:</span> </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="com"># type: (TokenOrElement) -> FormatterContentToken</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t37" href="#t37">37</a></span><span class="t"> <span class="key">if</span> <span class="nam">isinstance</span><span class="op">(</span><span class="nam">token_or_element</span><span class="op">,</span> <span class="nam">Deb822Token</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t38" href="#t38">38</a></span><span class="t"> <span class="key">if</span> <span class="nam">token_or_element</span><span class="op">.</span><span class="nam">is_comment</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t39" href="#t39">39</a></span><span class="t"> <span class="key">return</span> <span class="nam">cls</span><span class="op">.</span><span class="nam">comment_token</span><span class="op">(</span><span class="nam">token_or_element</span><span class="op">.</span><span class="nam">text</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t40" href="#t40">40</a></span><span class="t"> <span class="key">if</span> <span class="nam">token_or_element</span><span class="op">.</span><span class="nam">is_whitespace</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t41" href="#t41">41</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="str">"FormatterContentType cannot be whitespace"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t42" href="#t42">42</a></span><span class="t"> <span class="key">return</span> <span class="nam">cls</span><span class="op">.</span><span class="nam">value_token</span><span class="op">(</span><span class="nam">token_or_element</span><span class="op">.</span><span class="nam">text</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t43" href="#t43">43</a></span><span class="t"> <span class="com"># Elements are assumed to be content (this is specialized for the</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 class="com"># interpretations where comments are always tokens).</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t45" href="#t45">45</a></span><span class="t"> <span class="key">return</span> <span class="nam">cls</span><span class="op">.</span><span class="nam">value_token</span><span class="op">(</span><span class="nam">token_or_element</span><span class="op">.</span><span class="nam">convert_to_text</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="t46" href="#t46">46</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t47" href="#t47">47</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="t48" href="#t48">48</a></span><span class="t"> <span class="key">def</span> <span class="nam">separator_token</span><span class="op">(</span><span class="nam">cls</span><span class="op">,</span> <span class="nam">text</span><span class="op">)</span><span class="op">:</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="com"># type: (str) -> FormatterContentToken</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="com"># Special-case separators as a minor memory optimization</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t51" href="#t51">51</a></span><span class="t"> <span class="key">if</span> <span class="nam">text</span> <span class="op">==</span> <span class="str">" "</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t52" href="#t52">52</a></span><span class="t"> <span class="key">return</span> <span class="nam">SPACE_SEPARATOR_FT</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t53" href="#t53">53</a></span><span class="t"> <span class="key">if</span> <span class="nam">text</span> <span class="op">==</span> <span class="str">","</span><span class="op">:</span> </span><span class="r"><span class="annotate short">53 ↛ 54</span><span class="annotate long">line 53 didn't jump to line 54, because the condition on line 53 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t54" href="#t54">54</a></span><span class="t"> <span class="key">return</span> <span class="nam">COMMA_SEPARATOR_FT</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t55" href="#t55">55</a></span><span class="t"> <span class="key">return</span> <span class="nam">cls</span><span class="op">(</span><span class="nam">text</span><span class="op">,</span> <span class="nam">_CONTENT_TYPE_SEPARATOR</span><span class="op">)</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><span class="r"></span></p> - <p class="run"><span class="n"><a id="t57" href="#t57">57</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="t58" href="#t58">58</a></span><span class="t"> <span class="key">def</span> <span class="nam">comment_token</span><span class="op">(</span><span class="nam">cls</span><span class="op">,</span> <span class="nam">text</span><span class="op">)</span><span class="op">:</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="com"># type: (str) -> FormatterContentToken</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">"""Generates a single comment token with the provided text</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><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"> Mostly useful for creating test cases</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 class="str"> """</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t64" href="#t64">64</a></span><span class="t"> <span class="key">return</span> <span class="nam">cls</span><span class="op">(</span><span class="nam">text</span><span class="op">,</span> <span class="nam">_CONTENT_TYPE_COMMENT</span><span class="op">)</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><span class="r"></span></p> - <p class="run"><span class="n"><a id="t66" href="#t66">66</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="t67" href="#t67">67</a></span><span class="t"> <span class="key">def</span> <span class="nam">value_token</span><span class="op">(</span><span class="nam">cls</span><span class="op">,</span> <span class="nam">text</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t68" href="#t68">68</a></span><span class="t"> <span class="com"># type: (str) -> FormatterContentToken</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t69" href="#t69">69</a></span><span class="t"> <span class="str">"""Generates a single value token with the provided text</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t70" href="#t70">70</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t71" href="#t71">71</a></span><span class="t"><span class="str"> Mostly useful for creating test cases</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t72" href="#t72">72</a></span><span class="t"><span class="str"> """</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="key">return</span> <span class="nam">cls</span><span class="op">(</span><span class="nam">text</span><span class="op">,</span> <span class="nam">_CONTENT_TYPE_VALUE</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t74" href="#t74">74</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t75" href="#t75">75</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="t76" href="#t76">76</a></span><span class="t"> <span class="key">def</span> <span class="nam">is_comment</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="t77" href="#t77">77</a></span><span class="t"> <span class="com"># type: () -> bool</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t78" href="#t78">78</a></span><span class="t"> <span class="str">"""True if this formatter token represent a comment</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t80" href="#t80">80</a></span><span class="t"><span class="str"> This should be used for determining whether the token is a comment</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="str"> or not. It might be tempting to check whether the text in the token</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 class="str"> starts with a "#" but that is insufficient because a value *can*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t83" href="#t83">83</a></span><span class="t"><span class="str"> start with that as well. Whether it is a comment or a value is</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t84" href="#t84">84</a></span><span class="t"><span class="str"> based on the context (it is a comment if and only if the "#" was</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t85" href="#t85">85</a></span><span class="t"><span class="str"> at the start of a line) but the formatter often do not have the</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"> context available to assert this.</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"> The formatter *should* preserve the order of comments and interleave</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"> between the value tokens in the same order as it see them. Failing</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"> to preserve the order of comments and values can cause confusing</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 class="str"> comments (such as associating the comment with a different value</span> </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"> than it was written for).</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><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"> The formatter *may* discard comment tokens if it does not want to</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 class="str"> preserve them. If so, they would be omitted in the output, which</span> </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"> may be acceptable in some cases. This is a lot better than</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"> re-ordering comments.</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="pln"><span class="n"><a id="t99" href="#t99">99</a></span><span class="t"><span class="str"> Formatters must be aware of the following special cases for comments:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t100" href="#t100">100</a></span><span class="t"><span class="str"> * Comments *MUST* be emitted after a newline. If the very first token</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 class="str"> is a comment, the formatter is expected to emit a newline before it</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t102" href="#t102">102</a></span><span class="t"><span class="str"> as well (Fields cannot start immediately on a comment).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t103" href="#t103">103</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t104" href="#t104">104</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_content_type</span> <span class="key">is</span> <span class="nam">_CONTENT_TYPE_COMMENT</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="run"><span class="n"><a id="t106" href="#t106">106</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="t107" href="#t107">107</a></span><span class="t"> <span class="key">def</span> <span class="nam">is_value</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="t108" href="#t108">108</a></span><span class="t"> <span class="com"># type: () -> bool</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 class="str">"""True if this formatter token represents a semantic value</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t110" href="#t110">110</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t111" href="#t111">111</a></span><span class="t"><span class="str"> The formatter *MUST* preserve values as-in in its output. It may</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"> "unpack" it from the token (as in, return it as a part of a plain</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 class="str"> str) but the value content must not be changed nor re-ordered relative</span> </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"> to other value tokens (as that could change the meaning of the field).</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"> """</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t116" href="#t116">116</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_content_type</span> <span class="key">is</span> <span class="nam">_CONTENT_TYPE_VALUE</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t117" href="#t117">117</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t118" href="#t118">118</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="t119" href="#t119">119</a></span><span class="t"> <span class="key">def</span> <span class="nam">is_separator</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="t120" href="#t120">120</a></span><span class="t"> <span class="com"># type: () -> bool</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">"""True if this formatter token represents a separator token</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t122" href="#t122">122</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t123" href="#t123">123</a></span><span class="t"><span class="str"> The formatter is not required to preserve the provided separators but it</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t124" href="#t124">124</a></span><span class="t"><span class="str"> is required to properly separate values. In fact, often is a lot easier</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t125" href="#t125">125</a></span><span class="t"><span class="str"> to discard existing separator tokens. As an example, in whitespace</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"> separated list of values space, tab and newline all counts as separator.</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 class="str"> However, formatting-wise, there is a world of difference between the</span> </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"> a space, tab and a newline. In particularly, newlines must be followed</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"> by an additional space or tab (to act as a value continuation line) if</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t130" href="#t130">130</a></span><span class="t"><span class="str"> there is a value following it (otherwise, the generated output is</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 class="str"> invalid).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t132" href="#t132">132</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t133" href="#t133">133</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_content_type</span> <span class="key">is</span> <span class="nam">_CONTENT_TYPE_SEPARATOR</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><span class="r"></span></p> - <p class="run"><span class="n"><a id="t135" href="#t135">135</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="t136" href="#t136">136</a></span><span class="t"> <span class="key">def</span> <span class="nam">is_whitespace</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="t137" href="#t137">137</a></span><span class="t"> <span class="com"># type: () -> bool</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t138" href="#t138">138</a></span><span class="t"> <span class="str">"""True if this formatter token represents a whitespace token"""</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t139" href="#t139">139</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_content_type</span> <span class="key">is</span> <span class="nam">_CONTENT_TYPE_SEPARATOR</span> <span class="key">and</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_text</span><span class="op">.</span><span class="nam">isspace</span><span class="op">(</span><span class="op">)</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="run"><span class="n"><a id="t141" href="#t141">141</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="t142" href="#t142">142</a></span><span class="t"> <span class="key">def</span> <span class="nam">text</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="t143" href="#t143">143</a></span><span class="t"> <span class="com"># type: () -> str</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t144" href="#t144">144</a></span><span class="t"> <span class="str">"""The actual context of the token</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="pln"><span class="n"><a id="t146" href="#t146">146</a></span><span class="t"><span class="str"> This field *must not* be used to determine the type of token. The</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t147" href="#t147">147</a></span><span class="t"><span class="str"> formatter cannot reliably tell whether "#..." is a comment or a value</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"> (it can be both). Use is_value and is_comment instead for discriminating</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 class="str"> token types.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t150" href="#t150">150</a></span><span class="t"> </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"> For value tokens, this the concrete value to be omitted.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t152" href="#t152">152</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t153" href="#t153">153</a></span><span class="t"><span class="str"> For comment token, this is the full comment text.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t154" href="#t154">154</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t155" href="#t155">155</a></span><span class="t"><span class="str"> This is the same as str(token).</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"> """</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t157" href="#t157">157</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_text</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t158" href="#t158">158</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t159" href="#t159">159</a></span><span class="t"> <span class="key">def</span> <span class="nam">__str__</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="t160" href="#t160">160</a></span><span class="t"> <span class="com"># type: () -> str</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t161" href="#t161">161</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_text</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><span class="r"></span></p> - <p class="run"><span class="n"><a id="t163" href="#t163">163</a></span><span class="t"> <span class="key">def</span> <span class="nam">__repr__</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="t164" href="#t164">164</a></span><span class="t"> <span class="com"># type: () -> str</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t165" href="#t165">165</a></span><span class="t"> <span class="key">return</span> <span class="str">"{}({!r}, {}=True)"</span><span class="op">.</span><span class="nam">format</span><span class="op">(</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="nam">self</span><span class="op">.</span><span class="nam">__class__</span><span class="op">.</span><span class="nam">__name__</span><span class="op">,</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_text</span><span class="op">,</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_content_type</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="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t168" href="#t168">168</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t169" href="#t169">169</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t170" href="#t170">170</a></span><span class="t"><span class="nam">SPACE_SEPARATOR_FT</span> <span class="op">=</span> <span class="nam">FormatterContentToken</span><span class="op">(</span><span class="str">" "</span><span class="op">,</span> <span class="nam">_CONTENT_TYPE_SEPARATOR</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t171" href="#t171">171</a></span><span class="t"><span class="nam">COMMA_SEPARATOR_FT</span> <span class="op">=</span> <span class="nam">FormatterContentToken</span><span class="op">(</span><span class="str">","</span><span class="op">,</span> <span class="nam">_CONTENT_TYPE_SEPARATOR</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><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">one_value_per_line_formatter</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="nam">indentation</span><span class="op">,</span> <span class="com"># type: Union[int, Literal["FIELD_NAME_LENGTH"]]</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 class="nam">trailing_separator</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> <span class="com"># type: bool</span> </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="nam">immediate_empty_line</span><span class="op">=</span><span class="key">False</span><span class="op">,</span> <span class="com"># type: bool</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="op">)</span><span class="op">:</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="com"># type: (...) -> FormatterCallback</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 class="str">"""Provide a simple formatter that can handle indentation and trailing separators</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t181" href="#t181">181</a></span><span class="t"> </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"> All formatters returned by this function puts exactly one value per line. This</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"> pattern is commonly seen in the "Depends" field and similar fields of</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"> debian/control files.</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><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"> :param indentation: Either the literal string "FIELD_NAME_LENGTH" or a positive</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"> integer, which determines the indentation for fields. If it is an integer,</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"> then a fixed indentation is used (notably the value 1 ensures the shortest</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"> possible indentation). Otherwise, if it is "FIELD_NAME_LENGTH", then the</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"> indentation is set such that it aligns the values based on the field name.</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"> :param trailing_separator: If True, then the last value will have a trailing</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 class="str"> separator token (e.g., ",") after it.</span> </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 immediate_empty_line: Whether the value should always start with an</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"> empty line. If True, then the result becomes something like "Field:\n value".</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><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="par run show_par"><span class="n"><a id="t197" href="#t197">197</a></span><span class="t"> <span class="key">if</span> <span class="nam">indentation</span> <span class="op">!=</span> <span class="str">"FIELD_NAME_LENGTH"</span> <span class="key">and</span> <span class="nam">indentation</span> <span class="op"><</span> <span class="num">1</span><span class="op">:</span> </span><span class="r"><span class="annotate short">197 ↛ 198</span><span class="annotate long">line 197 didn't jump to line 198, because the condition on line 197 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t198" href="#t198">198</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="str">'indentation must be at least 1 (or "FIELD_NAME_LENGTH")'</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t199" href="#t199">199</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t200" href="#t200">200</a></span><span class="t"> <span class="key">def</span> <span class="nam">_formatter</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">name</span><span class="op">,</span> <span class="com"># type: str</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="nam">sep_token</span><span class="op">,</span> <span class="com"># type: FormatterContentToken</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 class="nam">formatter_tokens</span><span class="op">,</span> <span class="com"># type: Iterator[FormatterContentToken]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t204" href="#t204">204</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="t205" href="#t205">205</a></span><span class="t"> <span class="com"># type: (...) -> Iterator[Union[FormatterContentToken, str]]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t206" href="#t206">206</a></span><span class="t"> <span class="key">if</span> <span class="nam">indentation</span> <span class="op">==</span> <span class="str">"FIELD_NAME_LENGTH"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t207" href="#t207">207</a></span><span class="t"> <span class="nam">indent_len</span> <span class="op">=</span> <span class="nam">len</span><span class="op">(</span><span class="nam">name</span><span class="op">)</span> <span class="op">+</span> <span class="num">2</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="key">else</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t209" href="#t209">209</a></span><span class="t"> <span class="nam">indent_len</span> <span class="op">=</span> <span class="nam">indentation</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t210" href="#t210">210</a></span><span class="t"> <span class="nam">indent</span> <span class="op">=</span> <span class="str">" "</span> <span class="op">*</span> <span class="nam">indent_len</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t211" href="#t211">211</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t212" href="#t212">212</a></span><span class="t"> <span class="nam">emitted_first_line</span> <span class="op">=</span> <span class="key">False</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t213" href="#t213">213</a></span><span class="t"> <span class="nam">tok_iter</span> <span class="op">=</span> <span class="nam">BufferingIterator</span><span class="op">(</span><span class="nam">formatter_tokens</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t214" href="#t214">214</a></span><span class="t"> <span class="nam">is_value</span> <span class="op">=</span> <span class="nam">operator</span><span class="op">.</span><span class="nam">attrgetter</span><span class="op">(</span><span class="str">"is_value"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t215" href="#t215">215</a></span><span class="t"> <span class="key">if</span> <span class="nam">immediate_empty_line</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t216" href="#t216">216</a></span><span class="t"> <span class="nam">emitted_first_line</span> <span class="op">=</span> <span class="key">True</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t217" href="#t217">217</a></span><span class="t"> <span class="key">yield</span> <span class="str">"\n"</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t218" href="#t218">218</a></span><span class="t"> <span class="key">for</span> <span class="nam">t</span> <span class="key">in</span> <span class="nam">tok_iter</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t219" href="#t219">219</a></span><span class="t"> <span class="key">if</span> <span class="nam">t</span><span class="op">.</span><span class="nam">is_comment</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t220" href="#t220">220</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">emitted_first_line</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t221" href="#t221">221</a></span><span class="t"> <span class="key">yield</span> <span class="str">"\n"</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t222" href="#t222">222</a></span><span class="t"> <span class="key">yield</span> <span class="nam">t</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t223" href="#t223">223</a></span><span class="t"> <span class="key">elif</span> <span class="nam">t</span><span class="op">.</span><span class="nam">is_value</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t224" href="#t224">224</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">emitted_first_line</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t225" href="#t225">225</a></span><span class="t"> <span class="key">yield</span> <span class="str">" "</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="key">else</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t227" href="#t227">227</a></span><span class="t"> <span class="key">yield</span> <span class="nam">indent</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t228" href="#t228">228</a></span><span class="t"> <span class="key">yield</span> <span class="nam">t</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t229" href="#t229">229</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">sep_token</span><span class="op">.</span><span class="nam">is_whitespace</span> <span class="key">and</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t230" href="#t230">230</a></span><span class="t"> <span class="nam">trailing_separator</span> <span class="key">or</span> <span class="nam">tok_iter</span><span class="op">.</span><span class="nam">peek_find</span><span class="op">(</span><span class="nam">is_value</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t231" href="#t231">231</a></span><span class="t"> <span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t232" href="#t232">232</a></span><span class="t"> <span class="key">yield</span> <span class="nam">sep_token</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t233" href="#t233">233</a></span><span class="t"> <span class="key">yield</span> <span class="str">"\n"</span> </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="key">else</span><span class="op">:</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="com"># Skip existing separators (etc.)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t236" href="#t236">236</a></span><span class="t"> <span class="key">continue</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t237" href="#t237">237</a></span><span class="t"> <span class="nam">emitted_first_line</span> <span class="op">=</span> <span class="key">True</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><span class="r"></span></p> - <p class="run"><span class="n"><a id="t239" href="#t239">239</a></span><span class="t"> <span class="key">return</span> <span class="nam">_formatter</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t241" href="#t241">241</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t242" href="#t242">242</a></span><span class="t"><span class="nam">one_value_per_line_trailing_separator</span> <span class="op">=</span> <span class="nam">one_value_per_line_formatter</span><span class="op">(</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">"FIELD_NAME_LENGTH"</span><span class="op">,</span> <span class="nam">trailing_separator</span><span class="op">=</span><span class="key">True</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t244" href="#t244">244</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t245" href="#t245">245</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t246" href="#t246">246</a></span><span class="t"> </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="key">def</span> <span class="nam">format_field</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t248" href="#t248">248</a></span><span class="t"> <span class="nam">formatter</span><span class="op">,</span> <span class="com"># type: FormatterCallback</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t249" href="#t249">249</a></span><span class="t"> <span class="nam">field_name</span><span class="op">,</span> <span class="com"># type: str</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t250" href="#t250">250</a></span><span class="t"> <span class="nam">separator_token</span><span class="op">,</span> <span class="com"># type: FormatterContentToken</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="nam">token_iter</span><span class="op">,</span> <span class="com"># type: Iterator[FormatterContentToken]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t252" href="#t252">252</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="t253" href="#t253">253</a></span><span class="t"> <span class="com"># type: (...) -> str</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="str">"""Format a field using a provided formatter</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t255" href="#t255">255</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t256" href="#t256">256</a></span><span class="t"><span class="str"> This function formats a series of tokens using the provided formatter.</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="str"> It can be used as a standalone formatter engine and can be used in test</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="str"> suites to validate third-party formatters (enabling them to test for</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="str"> corner cases without involving parsing logic).</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t261" href="#t261">261</a></span><span class="t"><span class="str"> The formatter receives series of FormatterContentTokens (via the</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="str"> token_iter) and is expected to yield one or more str or</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 class="str"> FormatterContentTokens. The calling function will combine all of</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t264" href="#t264">264</a></span><span class="t"><span class="str"> these into a single string, which will be used as the value.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t265" href="#t265">265</a></span><span class="t"> </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="str"> The formatter is recommended to yield the provided value and comment</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="str"> tokens interleaved with text segments of whitespace and separators</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"> as part of its output. If it preserve comment and value tokens, the</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 class="str"> calling function can provide some runtime checks to catch bugs</span> </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"> (like the formatter turning a comment into a value because it forgot</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"> to ensure that the comment was emitted directly after a newline</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"> character).</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><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"> When writing a formatter, please keep the following in mind:</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><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"> * The output of the formatter is appended directly after the ":" separator.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t277" href="#t277">277</a></span><span class="t"><span class="str"> Most formatters will want to emit either a space or a newline as the very</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t278" href="#t278">278</a></span><span class="t"><span class="str"> first character for readability.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t279" href="#t279">279</a></span><span class="t"><span class="str"> (compare "Depends:foo\\n" to "Depends: foo\\n")</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t280" href="#t280">280</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t281" href="#t281">281</a></span><span class="t"><span class="str"> * The formatter must always end its output on a newline. This is a design</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t282" href="#t282">282</a></span><span class="t"><span class="str"> choice of how the round-trip safe parser represent values that is imposed</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t283" href="#t283">283</a></span><span class="t"><span class="str"> on the formatter.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t284" href="#t284">284</a></span><span class="t"> </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="str"> * It is often easier to discard/ignore all separator tokens from the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t286" href="#t286">286</a></span><span class="t"><span class="str"> the provided token sequence and instead just yield separator tokens/str</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="str"> where the formatter wants to place them.</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t289" href="#t289">289</a></span><span class="t"><span class="str"> - The formatter is strongly recommended to special-case formatting</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t290" href="#t290">290</a></span><span class="t"><span class="str"> for whitespace separators (check for `separator_token.is_whitespace`).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t291" href="#t291">291</a></span><span class="t"> </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="str"> This is because space, tab and newline all counts as valid separators</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="str"> and can all appear in the token sequence. If the original field uses</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="str"> a mix of these separators it is likely to completely undermine the</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="str"> desired result. Not to mention the additional complexity of handling</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="str"> when a separator token happens to use the newline character which</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="str"> affects how the formatter is supposed what comes after it</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 class="str"> (see the rules for comments, empty lines and continuation line</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t299" href="#t299">299</a></span><span class="t"><span class="str"> markers).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t300" href="#t300">300</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t301" href="#t301">301</a></span><span class="t"><span class="str"> * The formatter must remember to emit a "continuation line" marker</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t302" href="#t302">302</a></span><span class="t"><span class="str"> (typically a single space or tab) when emitting a value after</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t303" href="#t303">303</a></span><span class="t"><span class="str"> a newline or a comment. A `yield " "` is sufficient.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t304" href="#t304">304</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t305" href="#t305">305</a></span><span class="t"><span class="str"> - The continuation line marker may be embedded inside a str</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t306" href="#t306">306</a></span><span class="t"><span class="str"> with other whitespace (such as the newline coming before it</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t307" href="#t307">307</a></span><span class="t"><span class="str"> or/and whitespace used for indentation purposes following</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t308" href="#t308">308</a></span><span class="t"><span class="str"> the marker).</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="pln"><span class="n"><a id="t310" href="#t310">310</a></span><span class="t"><span class="str"> * The formatter must not cause the output to contain completely</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t311" href="#t311">311</a></span><span class="t"><span class="str"> empty/whitespace lines as these cause syntax errors. The first</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="str"> line never counts as an empty line (as it will be appended after</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t313" href="#t313">313</a></span><span class="t"><span class="str"> the field name).</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="pln"><span class="n"><a id="t315" href="#t315">315</a></span><span class="t"><span class="str"> * Tokens must be discriminated via the `token.is_value` (etc.)</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"> properties. Assuming that `token.text.startswith("#")` implies a</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 class="str"> comment and similar stunts are wrong. As an example, "#foo" is a</span> </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"> perfectly valid value in some contexts.</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t320" href="#t320">320</a></span><span class="t"><span class="str"> * Comment tokens *always* take up exactly one complete line including</span> </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"> the newline character at the end of the line. They must be emitted</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"> directly after a newline character or another comment token.</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><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"> * Special cases that are rare but can happen:</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><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"> - Fields *can* start with comments and requires a formatter provided newline.</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"> (Example: "Depends:\\n# Comment here\\n foo")</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><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"> - Fields *can* start on a separator or have two separators in a row.</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"> This is especially true for whitespace separated fields where every</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="str"> whitespace counts as a separator, but it can also happen with other</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="str"> separators (such as comma).</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t334" href="#t334">334</a></span><span class="t"><span class="str"> - Value tokens can contain whitespace (for non-whitespace separators).</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 class="str"> When they do, the formatter must not attempt change nor "normalize"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t336" href="#t336">336</a></span><span class="t"><span class="str"> the whitespace inside the value token as that might change how the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t337" href="#t337">337</a></span><span class="t"><span class="str"> value is interpreted. (If you want to normalize such whitespace,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t338" href="#t338">338</a></span><span class="t"><span class="str"> the formatter is at the wrong abstraction level. Instead, manipulate</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"> the values directly in the value interpretation layer)</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t341" href="#t341">341</a></span><span class="t"><span class="str"> This function will provide *some* runtime checks of its input and the</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="str"> output from the formatter to detect some errors early and provide</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="str"> helpful diagnostics. If you use the function for testing, you are</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t344" href="#t344">344</a></span><span class="t"><span class="str"> recommended to rely on verifying the output of the function rather than</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="str"> relying on the runtime checks (as these are subject to change).</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t347" href="#t347">347</a></span><span class="t"><span class="str"> :param formatter: A formatter (see FormatterCallback for the type).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t348" href="#t348">348</a></span><span class="t"><span class="str"> Basic formatting is provided via one_value_per_line_trailing_separator</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 class="str"> (a formatter) or one_value_per_line_formatter (a formatter generator).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t350" href="#t350">350</a></span><span class="t"><span class="str"> :param field_name: The name of the field.</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"> :param separator_token: One of SPACE_SEPARATOR and COMMA_SEPARATOR</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 class="str"> :param token_iter: An iterable of tokens to be formatted.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t353" href="#t353">353</a></span><span class="t"> </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"> The following example shows how to define a formatter_callback along with</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 class="str"> a few verifications.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t356" href="#t356">356</a></span><span class="t"> </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"> >>> fmt_field_len_sep = one_value_per_line_trailing_separator</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"> >>> fmt_shortest = one_value_per_line_formatter(</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"> ... 1,</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"> ... trailing_separator=False</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"> ... )</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"> >>> fmt_newline_first = one_value_per_line_formatter(</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"> ... 1,</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"> ... trailing_separator=False,</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"> ... immediate_empty_line=True</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t366" href="#t366">366</a></span><span class="t"><span class="str"> ... )</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t367" href="#t367">367</a></span><span class="t"><span class="str"> >>> # Omit separator tokens for in the token list for simplicity (the formatter does</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="str"> >>> # not use them, and it enables us to keep the example simple by reusing the list)</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="str"> >>> tokens = [</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 class="str"> ... FormatterContentToken.value_token("foo"),</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t371" href="#t371">371</a></span><span class="t"><span class="str"> ... FormatterContentToken.comment_token("# some comment about bar\\n"),</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"> ... FormatterContentToken.value_token("bar"),</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 class="str"> ... ]</span> </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"> >>> # Starting with fmt_dl_ts</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"> >>> print(format_field(fmt_field_len_sep, "Depends", COMMA_SEPARATOR_FT, tokens), end='')</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"> Depends: foo,</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"> # some comment about bar</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"> bar,</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 class="str"> >>> print(format_field(fmt_field_len_sep, "Architecture", SPACE_SEPARATOR_FT, tokens), end='')</span> </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"> Architecture: foo</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"> # some comment about bar</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"> bar</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"> >>> # Control check for the special case where the field starts with a comment</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"> >>> print(format_field(fmt_field_len_sep, "Depends", COMMA_SEPARATOR_FT, tokens[1:]), end='')</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"> Depends:</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"> # some comment about bar</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"> bar,</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"> >>> # Also, check single line values (to ensure it ends on a newline)</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"> >>> print(format_field(fmt_field_len_sep, "Depends", COMMA_SEPARATOR_FT, tokens[2:]), end='')</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t390" href="#t390">390</a></span><span class="t"><span class="str"> Depends: bar,</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="str"> >>> ### Changing format to the shortest length</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="str"> >>> print(format_field(fmt_shortest, "Depends", COMMA_SEPARATOR_FT, tokens), end='')</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t393" href="#t393">393</a></span><span class="t"><span class="str"> Depends: foo,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t394" href="#t394">394</a></span><span class="t"><span class="str"> # some comment about bar</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t395" href="#t395">395</a></span><span class="t"><span class="str"> bar</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t396" href="#t396">396</a></span><span class="t"><span class="str"> >>> print(format_field(fmt_shortest, "Architecture", SPACE_SEPARATOR_FT, tokens), end='')</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t397" href="#t397">397</a></span><span class="t"><span class="str"> Architecture: foo</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 class="str"> # some comment about bar</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t399" href="#t399">399</a></span><span class="t"><span class="str"> bar</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"> >>> # Control check for the special case where the field starts with a comment</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 class="str"> >>> print(format_field(fmt_shortest, "Depends", COMMA_SEPARATOR_FT, tokens[1:]), end='')</span> </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"> Depends:</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"> # some comment about bar</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"> bar</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"> >>> # Also, check single line values (to ensure it ends on a newline)</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"> >>> print(format_field(fmt_shortest, "Depends", COMMA_SEPARATOR_FT, tokens[2:]), end='')</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"> Depends: bar</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"> >>> ### Changing format to the newline first format</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"> >>> print(format_field(fmt_newline_first, "Depends", COMMA_SEPARATOR_FT, tokens), end='')</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"> Depends:</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"> foo,</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"> # some comment about bar</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t413" href="#t413">413</a></span><span class="t"><span class="str"> bar</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t414" href="#t414">414</a></span><span class="t"><span class="str"> >>> print(format_field(fmt_newline_first, "Architecture", SPACE_SEPARATOR_FT, tokens), end='')</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t415" href="#t415">415</a></span><span class="t"><span class="str"> Architecture:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t416" href="#t416">416</a></span><span class="t"><span class="str"> foo</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t417" href="#t417">417</a></span><span class="t"><span class="str"> # some comment about bar</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t418" href="#t418">418</a></span><span class="t"><span class="str"> bar</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t419" href="#t419">419</a></span><span class="t"><span class="str"> >>> # Control check for the special case where the field starts with a comment</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t420" href="#t420">420</a></span><span class="t"><span class="str"> >>> print(format_field(fmt_newline_first, "Depends", COMMA_SEPARATOR_FT, tokens[1:]), end='')</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t421" href="#t421">421</a></span><span class="t"><span class="str"> Depends:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t422" href="#t422">422</a></span><span class="t"><span class="str"> # some comment about bar</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t423" href="#t423">423</a></span><span class="t"><span class="str"> bar</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t424" href="#t424">424</a></span><span class="t"><span class="str"> >>> # Also, check single line values (to ensure it ends on a newline)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t425" href="#t425">425</a></span><span class="t"><span class="str"> >>> print(format_field(fmt_newline_first, "Depends", COMMA_SEPARATOR_FT, tokens[2:]), end='')</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t426" href="#t426">426</a></span><span class="t"><span class="str"> Depends:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t427" href="#t427">427</a></span><span class="t"><span class="str"> bar</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t428" href="#t428">428</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t429" href="#t429">429</a></span><span class="t"> <span class="nam">formatted_tokens</span> <span class="op">=</span> <span class="op">[</span><span class="nam">field_name</span><span class="op">,</span> <span class="str">":"</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t430" href="#t430">430</a></span><span class="t"> <span class="nam">just_after_newline</span> <span class="op">=</span> <span class="key">False</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t431" href="#t431">431</a></span><span class="t"> <span class="nam">last_was_value_token</span> <span class="op">=</span> <span class="key">False</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t432" href="#t432">432</a></span><span class="t"> <span class="key">if</span> <span class="nam">isinstance</span><span class="op">(</span><span class="nam">token_iter</span><span class="op">,</span> <span class="nam">list</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t433" href="#t433">433</a></span><span class="t"> <span class="com"># Stop people from using this to test known "invalid" cases.</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t434" href="#t434">434</a></span><span class="t"> <span class="nam">last_token</span> <span class="op">=</span> <span class="nam">token_iter</span><span class="op">[</span><span class="op">-</span><span class="num">1</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t435" href="#t435">435</a></span><span class="t"> <span class="key">if</span> <span class="nam">last_token</span><span class="op">.</span><span class="nam">is_comment</span><span class="op">:</span> </span><span class="r"><span class="annotate short">435 ↛ 436</span><span class="annotate long">line 435 didn't jump to line 436, because the condition on line 435 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t436" href="#t436">436</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t437" href="#t437">437</a></span><span class="t"> <span class="str">"Invalid token_iter: Field values cannot end with comments"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t438" href="#t438">438</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t439" href="#t439">439</a></span><span class="t"> <span class="key">for</span> <span class="nam">token</span> <span class="key">in</span> <span class="nam">formatter</span><span class="op">(</span><span class="nam">field_name</span><span class="op">,</span> <span class="nam">separator_token</span><span class="op">,</span> <span class="nam">token_iter</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t440" href="#t440">440</a></span><span class="t"> <span class="nam">token_as_text</span> <span class="op">=</span> <span class="nam">str</span><span class="op">(</span><span class="nam">token</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t441" href="#t441">441</a></span><span class="t"> <span class="com"># If we are given formatter tokens, then use them to verify the output.</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t442" href="#t442">442</a></span><span class="t"> <span class="key">if</span> <span class="nam">isinstance</span><span class="op">(</span><span class="nam">token</span><span class="op">,</span> <span class="nam">FormatterContentToken</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t443" href="#t443">443</a></span><span class="t"> <span class="key">if</span> <span class="nam">token</span><span class="op">.</span><span class="nam">is_comment</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t444" href="#t444">444</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">just_after_newline</span><span class="op">:</span> </span><span class="r"><span class="annotate short">444 ↛ 445</span><span class="annotate long">line 444 didn't jump to line 445, because the condition on line 444 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t445" href="#t445">445</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t446" href="#t446">446</a></span><span class="t"> <span class="str">"Bad format: Comments must appear directly after a newline."</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t447" href="#t447">447</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t448" href="#t448">448</a></span><span class="t"> <span class="com"># for the sake of ensuring people use proper test data.</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t449" href="#t449">449</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">token_as_text</span><span class="op">.</span><span class="nam">startswith</span><span class="op">(</span><span class="str">"#"</span><span class="op">)</span><span class="op">:</span> </span><span class="r"><span class="annotate short">449 ↛ 450</span><span class="annotate long">line 449 didn't jump to line 450, because the condition on line 449 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t450" href="#t450">450</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="str">"Invalid Comment token: Must start with #"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t451" href="#t451">451</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">token_as_text</span><span class="op">.</span><span class="nam">endswith</span><span class="op">(</span><span class="str">"\n"</span><span class="op">)</span><span class="op">:</span> </span><span class="r"><span class="annotate short">451 ↛ 452</span><span class="annotate long">line 451 didn't jump to line 452, because the condition on line 451 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t452" href="#t452">452</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="str">"Invalid Comment token: Must end on a newline"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t453" href="#t453">453</a></span><span class="t"> <span class="key">elif</span> <span class="nam">token</span><span class="op">.</span><span class="nam">is_value</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t454" href="#t454">454</a></span><span class="t"> <span class="key">if</span> <span class="nam">token_as_text</span><span class="op">[</span><span class="num">0</span><span class="op">]</span><span class="op">.</span><span class="nam">isspace</span><span class="op">(</span><span class="op">)</span> <span class="key">or</span> <span class="nam">token_as_text</span><span class="op">[</span><span class="op">-</span><span class="num">1</span><span class="op">]</span><span class="op">.</span><span class="nam">isspace</span><span class="op">(</span><span class="op">)</span><span class="op">:</span> </span><span class="r"><span class="annotate short">454 ↛ 455</span><span class="annotate long">line 454 didn't jump to line 455, because the condition on line 454 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t455" href="#t455">455</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t456" href="#t456">456</a></span><span class="t"> <span class="str">"Invalid Value token: It cannot start nor end on whitespace"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t457" href="#t457">457</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t458" href="#t458">458</a></span><span class="t"> <span class="key">if</span> <span class="nam">just_after_newline</span><span class="op">:</span> </span><span class="r"><span class="annotate short">458 ↛ 459</span><span class="annotate long">line 458 didn't jump to line 459, because the condition on line 458 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t459" href="#t459">459</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="str">"Bad format: Missing continuation line marker"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t460" href="#t460">460</a></span><span class="t"> <span class="key">if</span> <span class="nam">last_was_value_token</span><span class="op">:</span> </span><span class="r"><span class="annotate short">460 ↛ 461</span><span class="annotate long">line 460 didn't jump to line 461, because the condition on line 460 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t461" href="#t461">461</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="str">"Bad format: Formatter omitted a separator"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t462" href="#t462">462</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t463" href="#t463">463</a></span><span class="t"> <span class="nam">last_was_value_token</span> <span class="op">=</span> <span class="nam">token</span><span class="op">.</span><span class="nam">is_value</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t464" href="#t464">464</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="t465" href="#t465">465</a></span><span class="t"> <span class="nam">last_was_value_token</span> <span class="op">=</span> <span class="key">False</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t466" href="#t466">466</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t467" href="#t467">467</a></span><span class="t"> <span class="key">if</span> <span class="nam">just_after_newline</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t468" href="#t468">468</a></span><span class="t"> <span class="key">if</span> <span class="nam">token_as_text</span><span class="op">[</span><span class="num">0</span><span class="op">]</span> <span class="key">in</span> <span class="op">(</span><span class="str">"\r"</span><span class="op">,</span> <span class="str">"\n"</span><span class="op">)</span><span class="op">:</span> </span><span class="r"><span class="annotate short">468 ↛ 469</span><span class="annotate long">line 468 didn't jump to line 469, because the condition on line 468 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t469" href="#t469">469</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="str">"Bad format: Saw completely empty line."</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t470" href="#t470">470</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">token_as_text</span><span class="op">[</span><span class="num">0</span><span class="op">]</span><span class="op">.</span><span class="nam">isspace</span><span class="op">(</span><span class="op">)</span> <span class="key">and</span> <span class="key">not</span> <span class="nam">token_as_text</span><span class="op">.</span><span class="nam">startswith</span><span class="op">(</span><span class="str">"#"</span><span class="op">)</span><span class="op">:</span> </span><span class="r"><span class="annotate short">470 ↛ 471</span><span class="annotate long">line 470 didn't jump to line 471, because the condition on line 470 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t471" href="#t471">471</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="str">"Bad format: Saw completely empty line."</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t472" href="#t472">472</a></span><span class="t"> <span class="nam">formatted_tokens</span><span class="op">.</span><span class="nam">append</span><span class="op">(</span><span class="nam">token_as_text</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t473" href="#t473">473</a></span><span class="t"> <span class="nam">just_after_newline</span> <span class="op">=</span> <span class="nam">token_as_text</span><span class="op">.</span><span class="nam">endswith</span><span class="op">(</span><span class="str">"\n"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t474" href="#t474">474</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t475" href="#t475">475</a></span><span class="t"> <span class="nam">formatted_text</span> <span class="op">=</span> <span class="str">""</span><span class="op">.</span><span class="nam">join</span><span class="op">(</span><span class="nam">formatted_tokens</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t476" href="#t476">476</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">formatted_text</span><span class="op">.</span><span class="nam">endswith</span><span class="op">(</span><span class="str">"\n"</span><span class="op">)</span><span class="op">:</span> </span><span class="r"><span class="annotate short">476 ↛ 477</span><span class="annotate long">line 476 didn't jump to line 477, because the condition on line 476 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t477" href="#t477">477</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="str">"Bad format: The field value must end on a newline"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t478" href="#t478">478</a></span><span class="t"> <span class="key">return</span> <span class="nam">formatted_text</span> </span><span class="r"></span></p> -</main> -<footer> - <div class="content"> - <p> - <a id="prevFileLink" class="nav" href="d_e9c451f4ae334f76__util_py.html">« prev</a> - <a id="indexLink" class="nav" href="index.html">^ index</a> - <a id="nextFileLink" class="nav" href="d_e9c451f4ae334f76_locatable_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> |