diff options
Diffstat (limited to 'coverage-report/d_d5d6843b45eec01e_binary_package_rules_py.html')
| -rw-r--r-- | coverage-report/d_d5d6843b45eec01e_binary_package_rules_py.html | 817 |
1 files changed, 0 insertions, 817 deletions
diff --git a/coverage-report/d_d5d6843b45eec01e_binary_package_rules_py.html b/coverage-report/d_d5d6843b45eec01e_binary_package_rules_py.html deleted file mode 100644 index c98b3fb..0000000 --- a/coverage-report/d_d5d6843b45eec01e_binary_package_rules_py.html +++ /dev/null @@ -1,817 +0,0 @@ -<!DOCTYPE html> -<html> -<head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> - <title>Coverage for src/debputy/plugin/debputy/binary_package_rules.py: 82%</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/plugin/debputy/binary_package_rules.py</b>: - <span class="pc_cov">82%</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">173 statements </span> - <button type="button" class="run button_toggle_run" value="run" data-shortcut="r" title="Toggle lines run">150<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">23<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">6<span class="text"> partial</span></button> - </h2> - <p class="text"> - <a id="prevFileLink" class="nav" href="d_d5d6843b45eec01e___init___py.html">« prev</a> - <a id="indexLink" class="nav" href="index.html">^ index</a> - <a id="nextFileLink" class="nav" href="d_d5d6843b45eec01e_debputy_plugin_py.html">» next</a> - - <a class="nav" href="https://coverage.readthedocs.io/en/7.2.7">coverage.py v7.2.7</a>, - created at 2024-04-07 12:14 +0200 - </p> - <aside class="hidden"> - <button type="button" class="button_next_chunk" data-shortcut="j"/> - <button type="button" class="button_prev_chunk" data-shortcut="k"/> - <button type="button" class="button_top_of_page" data-shortcut="0"/> - <button type="button" class="button_first_chunk" data-shortcut="1"/> - <button type="button" class="button_prev_file" data-shortcut="["/> - <button type="button" class="button_next_file" data-shortcut="]"/> - <button type="button" class="button_to_index" data-shortcut="u"/> - <button type="button" class="button_show_hide_help" data-shortcut="?"/> - </aside> - </div> -</header> -<main id="source"> - <p class="run"><span class="n"><a id="t1" href="#t1">1</a></span><span class="t"><span class="key">import</span> <span class="nam">dataclasses</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2" href="#t2">2</a></span><span class="t"><span class="key">import</span> <span class="nam">os</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t3" href="#t3">3</a></span><span class="t"><span class="key">import</span> <span class="nam">textwrap</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="nam">typing</span> <span class="key">import</span> <span class="op">(</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 class="nam">Any</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t6" href="#t6">6</a></span><span class="t"> <span class="nam">List</span><span class="op">,</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="nam">NotRequired</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t8" href="#t8">8</a></span><span class="t"> <span class="nam">Union</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t9" href="#t9">9</a></span><span class="t"> <span class="nam">Literal</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t10" href="#t10">10</a></span><span class="t"> <span class="nam">TypedDict</span><span class="op">,</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 class="nam">Annotated</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t12" href="#t12">12</a></span><span class="t"> <span class="nam">Optional</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t13" href="#t13">13</a></span><span class="t"> <span class="nam">FrozenSet</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t14" href="#t14">14</a></span><span class="t"> <span class="nam">Self</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t15" href="#t15">15</a></span><span class="t"> <span class="nam">cast</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t16" href="#t16">16</a></span><span class="t"><span class="op">)</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="run"><span class="n"><a id="t18" href="#t18">18</a></span><span class="t"><span class="key">from</span> <span class="nam">debputy</span> <span class="key">import</span> <span class="nam">DEBPUTY_DOC_ROOT_DIR</span> </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">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">maintscript_snippet</span> <span class="key">import</span> <span class="nam">DpkgMaintscriptHelperCommand</span><span class="op">,</span> <span class="nam">MaintscriptSnippet</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t20" href="#t20">20</a></span><span class="t"><span class="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">manifest_parser</span><span class="op">.</span><span class="nam">base_types</span> <span class="key">import</span> <span class="op">(</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 class="nam">DebputyParsedContent</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t22" href="#t22">22</a></span><span class="t"> <span class="nam">FileSystemExactMatchRule</span><span class="op">,</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="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t24" href="#t24">24</a></span><span class="t"><span class="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">manifest_parser</span><span class="op">.</span><span class="nam">declarative_parser</span> <span class="key">import</span> <span class="op">(</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="nam">DebputyParseHint</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t26" href="#t26">26</a></span><span class="t"> <span class="nam">ParserGenerator</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t27" href="#t27">27</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t28" href="#t28">28</a></span><span class="t"><span class="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">manifest_parser</span><span class="op">.</span><span class="nam">exceptions</span> <span class="key">import</span> <span class="nam">ManifestParseException</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t29" href="#t29">29</a></span><span class="t"><span class="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">manifest_parser</span><span class="op">.</span><span class="nam">parser_data</span> <span class="key">import</span> <span class="nam">ParserContextData</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t30" href="#t30">30</a></span><span class="t"><span class="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">manifest_parser</span><span class="op">.</span><span class="nam">util</span> <span class="key">import</span> <span class="nam">AttributePath</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="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">path_matcher</span> <span class="key">import</span> <span class="nam">MatchRule</span><span class="op">,</span> <span class="nam">MATCH_ANYTHING</span><span class="op">,</span> <span class="nam">ExactFileSystemPath</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="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">plugin</span><span class="op">.</span><span class="nam">api</span> <span class="key">import</span> <span class="nam">reference_documentation</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t33" href="#t33">33</a></span><span class="t"><span class="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">plugin</span><span class="op">.</span><span class="nam">api</span><span class="op">.</span><span class="nam">impl</span> <span class="key">import</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t34" href="#t34">34</a></span><span class="t"> <span class="nam">DebputyPluginInitializerProvider</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t35" href="#t35">35</a></span><span class="t"> <span class="nam">ServiceDefinitionImpl</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="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t37" href="#t37">37</a></span><span class="t"><span class="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">plugin</span><span class="op">.</span><span class="nam">api</span><span class="op">.</span><span class="nam">impl_types</span> <span class="key">import</span> <span class="nam">OPARSER_PACKAGES</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t38" href="#t38">38</a></span><span class="t"><span class="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">plugin</span><span class="op">.</span><span class="nam">api</span><span class="op">.</span><span class="nam">spec</span> <span class="key">import</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t39" href="#t39">39</a></span><span class="t"> <span class="nam">ServiceUpgradeRule</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t40" href="#t40">40</a></span><span class="t"> <span class="nam">ServiceDefinition</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t41" href="#t41">41</a></span><span class="t"> <span class="nam">DSD</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t42" href="#t42">42</a></span><span class="t"> <span class="nam">documented_attr</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="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t44" href="#t44">44</a></span><span class="t"><span class="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">transformation_rules</span> <span class="key">import</span> <span class="nam">TransformationRule</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t45" href="#t45">45</a></span><span class="t"><span class="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">util</span> <span class="key">import</span> <span class="nam">_error</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="nam">ACCEPTABLE_CLEAN_ON_REMOVAL_FOR_GLOBS_AND_EXACT_MATCHES</span> <span class="op">=</span> <span class="nam">frozenset</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t48" href="#t48">48</a></span><span class="t"> <span class="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="str">"./var/log"</span><span class="op">,</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="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t51" href="#t51">51</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t52" href="#t52">52</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t53" href="#t53">53</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t54" href="#t54">54</a></span><span class="t"><span class="nam">ACCEPTABLE_CLEAN_ON_REMOVAL_IF_EXACT_MATCH_OR_SUBDIR_OF</span> <span class="op">=</span> <span class="nam">frozenset</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t55" href="#t55">55</a></span><span class="t"> <span class="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 class="str">"./etc"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t57" href="#t57">57</a></span><span class="t"> <span class="str">"./run"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t58" href="#t58">58</a></span><span class="t"> <span class="str">"./var/lib"</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="str">"./var/cache"</span><span class="op">,</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">"./var/backups"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t61" href="#t61">61</a></span><span class="t"> <span class="str">"./var/spool"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t62" href="#t62">62</a></span><span class="t"> <span class="com"># linux-image uses these paths with some `rm -f`</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">"./usr/lib/modules"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t64" href="#t64">64</a></span><span class="t"> <span class="str">"./lib/modules"</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 class="com"># udev special case</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t66" href="#t66">66</a></span><span class="t"> <span class="str">"./lib/udev"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t67" href="#t67">67</a></span><span class="t"> <span class="str">"./usr/lib/udev"</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"># pciutils deletes /usr/share/misc/pci.ids.<ext></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">"./usr/share/misc"</span><span class="op">,</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 class="op">]</span> </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="op">)</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t73" href="#t73">73</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t74" href="#t74">74</a></span><span class="t"><span class="key">def</span> <span class="nam">register_binary_package_rules</span><span class="op">(</span><span class="nam">api</span><span class="op">:</span> <span class="nam">DebputyPluginInitializerProvider</span><span class="op">)</span> <span class="op">-></span> <span class="key">None</span><span class="op">:</span> </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="nam">api</span><span class="op">.</span><span class="nam">pluggable_manifest_rule</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t76" href="#t76">76</a></span><span class="t"> <span class="nam">OPARSER_PACKAGES</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="str">"binary-version"</span><span class="op">,</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="nam">BinaryVersionParsedFormat</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t79" href="#t79">79</a></span><span class="t"> <span class="nam">_parse_binary_version</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t80" href="#t80">80</a></span><span class="t"> <span class="nam">source_format</span><span class="op">=</span><span class="nam">str</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t81" href="#t81">81</a></span><span class="t"> <span class="nam">inline_reference_documentation</span><span class="op">=</span><span class="nam">reference_documentation</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t82" href="#t82">82</a></span><span class="t"> <span class="nam">title</span><span class="op">=</span><span class="str">"Custom binary version (`binary-version`)"</span><span class="op">,</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="nam">description</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</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">"""\</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"> In the *rare* case that you need a binary package to have a custom version, you can use</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"> the `binary-version:` key to describe the desired package version. An example being:</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"> packages:</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"> foo:</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"> # The foo package needs a different epoch because we took it over from a different</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"> # source package with higher epoch version</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"> binary-version: '1:{{DEB_VERSION_UPSTREAM_REVISION}}'</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"> Use this feature sparingly as it is generally not possible to undo as each version must be</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"> monotonously higher than the previous one. This feature translates into `-v` option for</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"> `dpkg-gencontrol`.</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t98" href="#t98">98</a></span><span class="t"><span class="str"> The value for the `binary-version` key is a string that defines the binary version. Generally,</span> </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"> you will want it to contain one of the versioned related substitution variables such as</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"> `{{DEB_VERSION_UPSTREAM_REVISION}}`. Otherwise, you will have to remember to bump the version</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"> manually with each upload as versions cannot be reused and the package would not support binNMUs</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"> either.</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="pln"><span class="n"><a id="t104" href="#t104">104</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="t105" href="#t105">105</a></span><span class="t"> <span class="nam">reference_documentation_url</span><span class="op">=</span><span class="str">f"{DEBPUTY_DOC_ROOT_DIR}/MANIFEST-FORMAT.md#custom-binary-version-binary-version"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t106" href="#t106">106</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t107" href="#t107">107</a></span><span class="t"> <span class="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><span class="r"></span></p> - <p class="run"><span class="n"><a id="t109" href="#t109">109</a></span><span class="t"> <span class="nam">api</span><span class="op">.</span><span class="nam">pluggable_manifest_rule</span><span class="op">(</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 class="nam">OPARSER_PACKAGES</span><span class="op">,</span> </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">"transformations"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t112" href="#t112">112</a></span><span class="t"> <span class="nam">List</span><span class="op">[</span><span class="nam">TransformationRule</span><span class="op">]</span><span class="op">,</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="nam">_unpack_list</span><span class="op">,</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="nam">inline_reference_documentation</span><span class="op">=</span><span class="nam">reference_documentation</span><span class="op">(</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="nam">title</span><span class="op">=</span><span class="str">"Transformations (`transformations`)"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t116" href="#t116">116</a></span><span class="t"> <span class="nam">description</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</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 class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t118" href="#t118">118</a></span><span class="t"><span class="str"> You can define a `transformations` under the package definition, which is a list a transformation</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t119" href="#t119">119</a></span><span class="t"><span class="str"> rules. An example:</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><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"> packages:</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 class="str"> foo:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t123" href="#t123">123</a></span><span class="t"><span class="str"> transformations:</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"> - remove: 'usr/share/doc/{{PACKAGE}}/INSTALL.md'</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"> - move:</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"> source: bar/*</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"> target: foo/</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t129" href="#t129">129</a></span><span class="t"> </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"> Transformations are ordered and are applied in the listed order. A path can be matched by multiple</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"> transformations; how that plays out depends on which transformations are applied and in which order.</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"> A quick summary:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t133" href="#t133">133</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t134" href="#t134">134</a></span><span class="t"><span class="str"> - Transformations that modify the file system layout affect how path matches in later transformations.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t135" href="#t135">135</a></span><span class="t"><span class="str"> As an example, `move` and `remove` transformations affects what globs and path matches expand to in</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t136" href="#t136">136</a></span><span class="t"><span class="str"> later transformation rules.</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><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"> - For other transformations generally the latter transformation overrules the earlier one, when they</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t139" href="#t139">139</a></span><span class="t"><span class="str"> overlap or conflict.</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 class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t141" href="#t141">141</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t142" href="#t142">142</a></span><span class="t"> <span class="nam">reference_documentation_url</span><span class="op">=</span><span class="str">f"{DEBPUTY_DOC_ROOT_DIR}/MANIFEST-FORMAT.md#transformations-transformations"</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="op">)</span><span class="op">,</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="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t145" href="#t145">145</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t146" href="#t146">146</a></span><span class="t"> <span class="nam">api</span><span class="op">.</span><span class="nam">pluggable_manifest_rule</span><span class="op">(</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="nam">OPARSER_PACKAGES</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t148" href="#t148">148</a></span><span class="t"> <span class="str">"conffile-management"</span><span class="op">,</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="nam">List</span><span class="op">[</span><span class="nam">DpkgMaintscriptHelperCommand</span><span class="op">]</span><span class="op">,</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 class="nam">_unpack_list</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t151" href="#t151">151</a></span><span class="t"> <span class="op">)</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="run"><span class="n"><a id="t153" href="#t153">153</a></span><span class="t"> <span class="nam">api</span><span class="op">.</span><span class="nam">pluggable_manifest_rule</span><span class="op">(</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 class="nam">OPARSER_PACKAGES</span><span class="op">,</span> </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">"services"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t156" href="#t156">156</a></span><span class="t"> <span class="nam">List</span><span class="op">[</span><span class="nam">ServiceRuleParsedFormat</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t157" href="#t157">157</a></span><span class="t"> <span class="nam">_process_service_rules</span><span class="op">,</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 class="nam">source_format</span><span class="op">=</span><span class="nam">List</span><span class="op">[</span><span class="nam">ServiceRuleSourceFormat</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t159" href="#t159">159</a></span><span class="t"> <span class="nam">inline_reference_documentation</span><span class="op">=</span><span class="nam">reference_documentation</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="nam">title</span><span class="op">=</span><span class="str">"Define how services in the package will be handled (`services`)"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t161" href="#t161">161</a></span><span class="t"> <span class="nam">description</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t162" href="#t162">162</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t163" href="#t163">163</a></span><span class="t"><span class="str"> If you have non-standard requirements for certain services in the package, you can define those via</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="str"> the `services` attribute. The `services` attribute is a list of service rules. Example:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t165" href="#t165">165</a></span><span class="t"> </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="str"> packages:</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="str"> foo:</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 class="str"> services:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t169" href="#t169">169</a></span><span class="t"><span class="str"> - service: "foo"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t170" href="#t170">170</a></span><span class="t"><span class="str"> enable-on-install: false</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t171" href="#t171">171</a></span><span class="t"><span class="str"> - service: "bar"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t172" href="#t172">172</a></span><span class="t"><span class="str"> on-upgrade: stop-then-start</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t173" href="#t173">173</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t174" href="#t174">174</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="t175" href="#t175">175</a></span><span class="t"> <span class="nam">attributes</span><span class="op">=</span><span class="op">[</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">documented_attr</span><span class="op">(</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="str">"service"</span><span class="op">,</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="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</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="str">f"""\</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"> Name of the service to match. The name is usually the basename of the service file.</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 class="str"> However, aliases can also be used for relevant system managers. When aliases **and**</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t182" href="#t182">182</a></span><span class="t"><span class="str"> multiple service managers are involved, then the rule will apply to all matches.</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"> For details on aliases, please see</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"> {DEBPUTY_DOC_ROOT_DIR}/MANIFEST-FORMAT.md#service-managers-and-aliases.</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"> - Note: For systemd, the `.service` suffix can be omitted from name, but other</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"> suffixes such as `.timer` cannot.</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"> """</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="op">)</span><span class="op">,</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="op">)</span><span class="op">,</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="nam">documented_attr</span><span class="op">(</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">"type_of_service"</span><span class="op">,</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="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</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">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t195" href="#t195">195</a></span><span class="t"><span class="str"> The type of service this rule applies to. To act on a `systemd` timer, you would</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t196" href="#t196">196</a></span><span class="t"><span class="str"> set this to `timer` (etc.). Each service manager defines its own set of types</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t197" href="#t197">197</a></span><span class="t"><span class="str"> of services.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t198" href="#t198">198</a></span><span class="t"><span class="str"> """</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 class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t200" href="#t200">200</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t201" href="#t201">201</a></span><span class="t"> <span class="nam">documented_attr</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t202" href="#t202">202</a></span><span class="t"> <span class="str">"service_scope"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t203" href="#t203">203</a></span><span class="t"> <span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</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="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t205" href="#t205">205</a></span><span class="t"><span class="str"> The scope of the service. It must be either `system` and `user`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t206" href="#t206">206</a></span><span class="t"><span class="str"> - Note: The keyword is defined to support `user`, but `debputy` does not support `user`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t207" href="#t207">207</a></span><span class="t"><span class="str"> services at the moment (the detection logic is missing).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t208" href="#t208">208</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t209" href="#t209">209</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t210" href="#t210">210</a></span><span class="t"> <span class="op">)</span><span class="op">,</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 class="nam">documented_attr</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t212" href="#t212">212</a></span><span class="t"> <span class="op">[</span><span class="str">"service_manager"</span><span class="op">,</span> <span class="str">"service_managers"</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t213" href="#t213">213</a></span><span class="t"> <span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t214" href="#t214">214</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t215" href="#t215">215</a></span><span class="t"><span class="str"> Which service managers this rule is for. When omitted, all service managers with this</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t216" href="#t216">216</a></span><span class="t"><span class="str"> service will be affected. This can be used to specify separate rules for the same</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t217" href="#t217">217</a></span><span class="t"><span class="str"> service under different service managers.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t218" href="#t218">218</a></span><span class="t"><span class="str"> - When this attribute is explicitly given, then all the listed service managers must</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t219" href="#t219">219</a></span><span class="t"><span class="str"> provide at least one service matching the definition. In contract, when it is omitted,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t220" href="#t220">220</a></span><span class="t"><span class="str"> then all service manager integrations are consulted but as long as at least one</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t221" href="#t221">221</a></span><span class="t"><span class="str"> service is match from any service manager, the rule is accepted.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t222" href="#t222">222</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t223" href="#t223">223</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t224" href="#t224">224</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t225" href="#t225">225</a></span><span class="t"> <span class="nam">documented_attr</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t226" href="#t226">226</a></span><span class="t"> <span class="str">"enable_on_install"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t227" href="#t227">227</a></span><span class="t"> <span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t228" href="#t228">228</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t229" href="#t229">229</a></span><span class="t"><span class="str"> Whether to automatically enable the service on installation. Note: This does</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="str"> **not** affect whether the service will be started nor how restarts during</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="str"> upgrades will happen.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t232" href="#t232">232</a></span><span class="t"><span class="str"> - If omitted, the plugin detecting the service decides the default.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t233" href="#t233">233</a></span><span class="t"><span class="str"> """</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="op">)</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="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t236" href="#t236">236</a></span><span class="t"> <span class="nam">documented_attr</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t237" href="#t237">237</a></span><span class="t"> <span class="str">"start_on_install"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t238" href="#t238">238</a></span><span class="t"> <span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t239" href="#t239">239</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t240" href="#t240">240</a></span><span class="t"><span class="str"> Whether to automatically start the service on installation. Whether it is</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t241" href="#t241">241</a></span><span class="t"><span class="str"> enabled or how upgrades are handled have separate attributes.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t242" href="#t242">242</a></span><span class="t"><span class="str"> - If omitted, the plugin detecting the service decides the default.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t243" href="#t243">243</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t244" href="#t244">244</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="t245" href="#t245">245</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="t246" href="#t246">246</a></span><span class="t"> <span class="nam">documented_attr</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t247" href="#t247">247</a></span><span class="t"> <span class="str">"on_upgrade"</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">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</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="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="str"> How `debputy` should handle the service during upgrades. The default depends on the</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="str"> plugin detecting the service. Valid values are:</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t253" href="#t253">253</a></span><span class="t"><span class="str"> - `do-nothing`: During an upgrade, the package should not attempt to stop, reload or</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"> restart the service.</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 class="str"> - `reload`: During an upgrade, prefer reloading the service rather than restarting</span> </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"> if possible. Note that the result may become `restart` instead if the service</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"> manager integration determines that `reload` is not supported.</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"> - `restart`: During an upgrade, `restart` the service post upgrade. The service</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"> will be left running during the upgrade process.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t260" href="#t260">260</a></span><span class="t"><span class="str"> - `stop-then-start`: Stop the service before the upgrade, perform the upgrade and</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t261" href="#t261">261</a></span><span class="t"><span class="str"> then start the service.</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"> """</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="op">)</span><span class="op">,</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="op">)</span><span class="op">,</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 class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t266" href="#t266">266</a></span><span class="t"> <span class="nam">reference_documentation_url</span><span class="op">=</span><span class="str">f"{DEBPUTY_DOC_ROOT_DIR}/MANIFEST-FORMAT.md#service-management-services"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t267" href="#t267">267</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t268" href="#t268">268</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t269" href="#t269">269</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t270" href="#t270">270</a></span><span class="t"> <span class="nam">api</span><span class="op">.</span><span class="nam">pluggable_manifest_rule</span><span class="op">(</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="nam">OPARSER_PACKAGES</span><span class="op">,</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">"clean-after-removal"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t273" href="#t273">273</a></span><span class="t"> <span class="nam">ListParsedFormat</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t274" href="#t274">274</a></span><span class="t"> <span class="nam">_parse_clean_after_removal</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t275" href="#t275">275</a></span><span class="t"> <span class="nam">source_format</span><span class="op">=</span><span class="nam">List</span><span class="op">[</span><span class="nam">Any</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t276" href="#t276">276</a></span><span class="t"> <span class="com"># FIXME: debputy won't see the attributes for this one :'(</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="nam">inline_reference_documentation</span><span class="op">=</span><span class="nam">reference_documentation</span><span class="op">(</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="nam">title</span><span class="op">=</span><span class="str">"Remove runtime created paths on purge or post removal (`clean-after-removal`)"</span><span class="op">,</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="nam">description</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</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 class="str">"""\</span> </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"> For some packages, it is necessary to clean up some run-time created paths. Typical use cases are</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"> deleting log files, cache files, or persistent state. This can be done via the `clean-after-removal`.</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"> An example being:</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"> packages:</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"> foo:</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"> clean-after-removal:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t288" href="#t288">288</a></span><span class="t"><span class="str"> - /var/log/foo/*.log</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t289" href="#t289">289</a></span><span class="t"><span class="str"> - /var/log/foo/*.log.gz</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"> - path: /var/log/foo/</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 class="str"> ignore-non-empty-dir: true</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t292" href="#t292">292</a></span><span class="t"><span class="str"> - /etc/non-conffile-configuration.conf</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"> - path: /var/cache/foo</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"> recursive: true</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><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"> The `clean-after-removal` key accepts a list, where each element is either a mapping, a string or a list</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"> of strings. When an element is a mapping, then the following key/value pairs are applicable:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t298" href="#t298">298</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t299" href="#t299">299</a></span><span class="t"><span class="str"> * `path` or `paths` (required): A path match (`path`) or a list of path matches (`paths`) defining the</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 class="str"> path(s) that should be removed after clean. The path match(es) can use globs and manifest variables.</span> </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"> Every path matched will by default be removed via `rm -f` or `rmdir` depending on whether the path</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"> provided ends with a *literal* `/`. Special-rules for matches:</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"> - Glob is interpreted by the shell, so shell (`/bin/sh`) rules apply to globs rather than</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 class="str"> `debputy`'s glob rules. As an example, `foo/*` will **not** match `foo/.hidden-file`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t305" href="#t305">305</a></span><span class="t"><span class="str"> - `debputy` cannot evaluate whether these paths/globs will match the desired paths (or anything at</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"> all). Be sure to test the resulting package.</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"> - When a symlink is matched, it is not followed.</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"> - Directory handling depends on the `recursive` attribute and whether the pattern ends with a literal</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 class="str"> "/".</span> </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"> - `debputy` has restrictions on the globs being used to prevent rules that could cause massive damage</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"> to the system.</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><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"> * `recursive` (optional): When `true`, the removal rule will use `rm -fr` rather than `rm -f` or `rmdir`</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 class="str"> meaning any directory matched will be deleted along with all of its contents.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t315" href="#t315">315</a></span><span class="t"> </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"> * `ignore-non-empty-dir` (optional): When `true`, each path must be or match a directory (and as 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"> consequence each path must with a literal `/`). The affected directories will be deleted only if they</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"> are empty. Non-empty directories will be skipped. This option is mutually exclusive with `recursive`.</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"> * `delete-on` (optional, defaults to `purge`): This attribute defines when the removal happens. It can</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"> be set to one of the following values:</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"> - `purge`: The removal happens with the package is being purged. This is the default. At a technical</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t323" href="#t323">323</a></span><span class="t"><span class="str"> level, the removal occurs at `postrm purge`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t324" href="#t324">324</a></span><span class="t"><span class="str"> - `removal`: The removal happens immediately after the package has been removed. At a technical level,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t325" href="#t325">325</a></span><span class="t"><span class="str"> the removal occurs at `postrm remove`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t326" href="#t326">326</a></span><span class="t"> </span><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"> This feature resembles the concept of `rpm`'s `%ghost` files.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t328" href="#t328">328</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t329" href="#t329">329</a></span><span class="t"> <span class="op">)</span><span class="op">,</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="nam">reference_documentation_url</span><span class="op">=</span><span class="str">f"{DEBPUTY_DOC_ROOT_DIR}/MANIFEST-FORMAT.md#remove-runtime-created-paths-on-purge-or-post-removal-clean-after-removal"</span><span class="op">,</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="op">)</span><span class="op">,</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="op">)</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="run"><span class="n"><a id="t334" href="#t334">334</a></span><span class="t"> <span class="nam">api</span><span class="op">.</span><span class="nam">pluggable_manifest_rule</span><span class="op">(</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="nam">OPARSER_PACKAGES</span><span class="op">,</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">"installation-search-dirs"</span><span class="op">,</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="nam">InstallationSearchDirsParsedFormat</span><span class="op">,</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="nam">_parse_installation_search_dirs</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t339" href="#t339">339</a></span><span class="t"> <span class="nam">source_format</span><span class="op">=</span><span class="nam">List</span><span class="op">[</span><span class="nam">FileSystemExactMatchRule</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t340" href="#t340">340</a></span><span class="t"> <span class="nam">inline_reference_documentation</span><span class="op">=</span><span class="nam">reference_documentation</span><span class="op">(</span> </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="nam">title</span><span class="op">=</span><span class="str">"Custom installation time search directories (`installation-search-dirs`)"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t342" href="#t342">342</a></span><span class="t"> <span class="nam">description</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t343" href="#t343">343</a></span><span class="t"> <span class="str">"""\</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"> For source packages that does multiple build, it can be an advantage to provide a custom list of</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"> installation-time search directories. This can be done via the `installation-search-dirs` key. A common</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t346" href="#t346">346</a></span><span class="t"><span class="str"> example is building the source twice with different optimization and feature settings where the second</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t347" href="#t347">347</a></span><span class="t"><span class="str"> build is for the `debian-installer` (in the form of a `udeb` package). A sample manifest snippet could</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"> look something like:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t349" href="#t349">349</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t350" href="#t350">350</a></span><span class="t"><span class="str"> installations:</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"> - install:</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"> # Because of the search order (see below), `foo` installs `debian/tmp/usr/bin/tool`,</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 class="str"> # while `foo-udeb` installs `debian/tmp-udeb/usr/bin/tool` (assuming both paths are</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t354" href="#t354">354</a></span><span class="t"><span class="str"> # available). Note the rule can be split into two with the same effect if that aids</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"> # readability or understanding.</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 class="str"> source: usr/bin/tool</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t357" href="#t357">357</a></span><span class="t"><span class="str"> into:</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"> - foo</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"> - foo-udeb</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"> packages:</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"> foo-udeb:</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"> installation-search-dirs:</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"> - debian/tmp-udeb</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t365" href="#t365">365</a></span><span class="t"> </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"> The `installation-search-dirs` key accepts a list, where each element is a path (str) relative from the</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"> source root to the directory that should be used as a search directory (absolute paths are still interpreted</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"> as relative to the source root). This list should contain all search directories that should be applicable</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"> for this package (except the source root itself, which is always appended after the provided list). If the</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"> key is omitted, then `debputy` will provide a default search order (In the `dh` integration, the default</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"> is the directory `debian/tmp`).</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><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"> If a non-existing or non-directory path is listed, then it will be skipped (info-level note). If the path</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"> exists and is a directory, it will also be checked for "not-installed" paths.</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"> """</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="op">)</span><span class="op">,</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="nam">reference_documentation_url</span><span class="op">=</span><span class="str">f"{DEBPUTY_DOC_ROOT_DIR}/MANIFEST-FORMAT.md#custom-installation-time-search-directories-installation-search-dirs"</span><span class="op">,</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="op">)</span><span class="op">,</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="op">)</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t381" href="#t381">381</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t382" href="#t382">382</a></span><span class="t"><span class="key">class</span> <span class="nam">ServiceRuleSourceFormat</span><span class="op">(</span><span class="nam">TypedDict</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t383" href="#t383">383</a></span><span class="t"> <span class="nam">service</span><span class="op">:</span> <span class="nam">str</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t384" href="#t384">384</a></span><span class="t"> <span class="nam">type_of_service</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t385" href="#t385">385</a></span><span class="t"> <span class="nam">service_scope</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">Literal</span><span class="op">[</span><span class="str">"system"</span><span class="op">,</span> <span class="str">"user"</span><span class="op">]</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t386" href="#t386">386</a></span><span class="t"> <span class="nam">enable_on_install</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">bool</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t387" href="#t387">387</a></span><span class="t"> <span class="nam">start_on_install</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">bool</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t388" href="#t388">388</a></span><span class="t"> <span class="nam">on_upgrade</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">ServiceUpgradeRule</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t389" href="#t389">389</a></span><span class="t"> <span class="nam">service_manager</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</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="nam">Annotated</span><span class="op">[</span><span class="nam">str</span><span class="op">,</span> <span class="nam">DebputyParseHint</span><span class="op">.</span><span class="nam">target_attribute</span><span class="op">(</span><span class="str">"service_managers"</span><span class="op">)</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t391" href="#t391">391</a></span><span class="t"> <span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t392" href="#t392">392</a></span><span class="t"> <span class="nam">service_managers</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">List</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">]</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t394" href="#t394">394</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t395" href="#t395">395</a></span><span class="t"><span class="key">class</span> <span class="nam">ServiceRuleParsedFormat</span><span class="op">(</span><span class="nam">DebputyParsedContent</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t396" href="#t396">396</a></span><span class="t"> <span class="nam">service</span><span class="op">:</span> <span class="nam">str</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t397" href="#t397">397</a></span><span class="t"> <span class="nam">type_of_service</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t398" href="#t398">398</a></span><span class="t"> <span class="nam">service_scope</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">Literal</span><span class="op">[</span><span class="str">"system"</span><span class="op">,</span> <span class="str">"user"</span><span class="op">]</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t399" href="#t399">399</a></span><span class="t"> <span class="nam">enable_on_install</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">bool</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t400" href="#t400">400</a></span><span class="t"> <span class="nam">start_on_install</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">bool</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t401" href="#t401">401</a></span><span class="t"> <span class="nam">on_upgrade</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">ServiceUpgradeRule</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t402" href="#t402">402</a></span><span class="t"> <span class="nam">service_managers</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">List</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">]</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t404" href="#t404">404</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t405" href="#t405">405</a></span><span class="t"><span class="op">@</span><span class="nam">dataclasses</span><span class="op">.</span><span class="nam">dataclass</span><span class="op">(</span><span class="nam">slots</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> <span class="nam">frozen</span><span class="op">=</span><span class="key">True</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t406" href="#t406">406</a></span><span class="t"><span class="key">class</span> <span class="nam">ServiceRule</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t407" href="#t407">407</a></span><span class="t"> <span class="nam">definition_source</span><span class="op">:</span> <span class="nam">str</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t408" href="#t408">408</a></span><span class="t"> <span class="nam">service</span><span class="op">:</span> <span class="nam">str</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t409" href="#t409">409</a></span><span class="t"> <span class="nam">type_of_service</span><span class="op">:</span> <span class="nam">str</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t410" href="#t410">410</a></span><span class="t"> <span class="nam">service_scope</span><span class="op">:</span> <span class="nam">Literal</span><span class="op">[</span><span class="str">"system"</span><span class="op">,</span> <span class="str">"user"</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t411" href="#t411">411</a></span><span class="t"> <span class="nam">enable_on_install</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">bool</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t412" href="#t412">412</a></span><span class="t"> <span class="nam">start_on_install</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">bool</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t413" href="#t413">413</a></span><span class="t"> <span class="nam">on_upgrade</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">ServiceUpgradeRule</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t414" href="#t414">414</a></span><span class="t"> <span class="nam">service_managers</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">FrozenSet</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">]</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><span class="r"></span></p> - <p class="run"><span class="n"><a id="t416" href="#t416">416</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="t417" href="#t417">417</a></span><span class="t"> <span class="key">def</span> <span class="nam">from_service_rule_parsed_format</span><span class="op">(</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="nam">cls</span><span class="op">,</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="nam">data</span><span class="op">:</span> <span class="nam">ServiceRuleParsedFormat</span><span class="op">,</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="nam">attribute_path</span><span class="op">:</span> <span class="nam">AttributePath</span><span class="op">,</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="op">)</span> <span class="op">-></span> <span class="str">"Self"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t422" href="#t422">422</a></span><span class="t"> <span class="nam">service_managers</span> <span class="op">=</span> <span class="nam">data</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="str">"service_managers"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t423" href="#t423">423</a></span><span class="t"> <span class="key">return</span> <span class="nam">cls</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t424" href="#t424">424</a></span><span class="t"> <span class="nam">attribute_path</span><span class="op">.</span><span class="nam">path</span><span class="op">,</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="nam">data</span><span class="op">[</span><span class="str">"service"</span><span class="op">]</span><span class="op">,</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="nam">data</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="str">"type_of_service"</span><span class="op">,</span> <span class="str">"service"</span><span class="op">)</span><span class="op">,</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="nam">cast</span><span class="op">(</span><span class="str">"Literal['system', 'user']"</span><span class="op">,</span> <span class="nam">data</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="str">"service_scope"</span><span class="op">,</span> <span class="str">"system"</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="t428" href="#t428">428</a></span><span class="t"> <span class="nam">data</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="str">"enable_on_install"</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t429" href="#t429">429</a></span><span class="t"> <span class="nam">data</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="str">"start_on_install"</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t430" href="#t430">430</a></span><span class="t"> <span class="nam">data</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="str">"on_upgrade"</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t431" href="#t431">431</a></span><span class="t"> <span class="nam">frozenset</span><span class="op">(</span><span class="nam">service_managers</span><span class="op">)</span> <span class="key">if</span> <span class="nam">service_managers</span> <span class="key">else</span> <span class="nam">service_managers</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t432" href="#t432">432</a></span><span class="t"> <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><span class="r"></span></p> - <p class="run"><span class="n"><a id="t434" href="#t434">434</a></span><span class="t"> <span class="key">def</span> <span class="nam">applies_to_service_manager</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">service_manager</span><span class="op">:</span> <span class="nam">str</span><span class="op">)</span> <span class="op">-></span> <span class="nam">bool</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t435" href="#t435">435</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">service_managers</span> <span class="key">is</span> <span class="key">None</span> <span class="key">or</span> <span class="nam">service_manager</span> <span class="key">in</span> <span class="nam">self</span><span class="op">.</span><span class="nam">service_managers</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t436" href="#t436">436</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t437" href="#t437">437</a></span><span class="t"> <span class="key">def</span> <span class="nam">apply_to_service_definition</span><span class="op">(</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="nam">self</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t439" href="#t439">439</a></span><span class="t"> <span class="nam">service_definition</span><span class="op">:</span> <span class="nam">ServiceDefinition</span><span class="op">[</span><span class="nam">DSD</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t440" href="#t440">440</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="nam">ServiceDefinition</span><span class="op">[</span><span class="nam">DSD</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="t441" href="#t441">441</a></span><span class="t"> <span class="key">assert</span> <span class="nam">isinstance</span><span class="op">(</span><span class="nam">service_definition</span><span class="op">,</span> <span class="nam">ServiceDefinitionImpl</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t442" href="#t442">442</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">service_definition</span><span class="op">.</span><span class="nam">is_plugin_provided_definition</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t443" href="#t443">443</a></span><span class="t"> <span class="nam">_error</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t444" href="#t444">444</a></span><span class="t"> <span class="str">f"Conflicting definitions related to {self.service} (type: {self.type_of_service},"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t445" href="#t445">445</a></span><span class="t"> <span class="str">f" scope: {self.service_scope}). First definition at {service_definition.definition_source},"</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">f" the second at {self.definition_source}). If they are for different service managers,"</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="str">" you can often avoid this problem by explicitly defining which service managers are applicable"</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="str">' to each rule via the "service-managers" keyword.'</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t449" href="#t449">449</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t450" href="#t450">450</a></span><span class="t"> <span class="nam">changes</span> <span class="op">=</span> <span class="op">{</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t451" href="#t451">451</a></span><span class="t"> <span class="str">"definition_source"</span><span class="op">:</span> <span class="nam">self</span><span class="op">.</span><span class="nam">definition_source</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t452" href="#t452">452</a></span><span class="t"> <span class="str">"is_plugin_provided_definition"</span><span class="op">:</span> <span class="key">False</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t453" href="#t453">453</a></span><span class="t"> <span class="op">}</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t454" href="#t454">454</a></span><span class="t"> <span class="key">if</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t455" href="#t455">455</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">service</span> <span class="op">!=</span> <span class="nam">service_definition</span><span class="op">.</span><span class="nam">name</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="key">and</span> <span class="nam">self</span><span class="op">.</span><span class="nam">service</span> <span class="key">in</span> <span class="nam">service_definition</span><span class="op">.</span><span class="nam">names</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 class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t458" href="#t458">458</a></span><span class="t"> <span class="nam">changes</span><span class="op">[</span><span class="str">"name"</span><span class="op">]</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">service</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t459" href="#t459">459</a></span><span class="t"> <span class="key">if</span> <span class="nam">self</span><span class="op">.</span><span class="nam">enable_on_install</span> <span class="key">is</span> <span class="key">not</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t460" href="#t460">460</a></span><span class="t"> <span class="nam">changes</span><span class="op">[</span><span class="str">"auto_start_on_install"</span><span class="op">]</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">enable_on_install</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t461" href="#t461">461</a></span><span class="t"> <span class="key">if</span> <span class="nam">self</span><span class="op">.</span><span class="nam">start_on_install</span> <span class="key">is</span> <span class="key">not</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t462" href="#t462">462</a></span><span class="t"> <span class="nam">changes</span><span class="op">[</span><span class="str">"auto_start_on_install"</span><span class="op">]</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">start_on_install</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t463" href="#t463">463</a></span><span class="t"> <span class="key">if</span> <span class="nam">self</span><span class="op">.</span><span class="nam">on_upgrade</span> <span class="key">is</span> <span class="key">not</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t464" href="#t464">464</a></span><span class="t"> <span class="nam">changes</span><span class="op">[</span><span class="str">"on_upgrade"</span><span class="op">]</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">on_upgrade</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t465" href="#t465">465</a></span><span class="t"> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t466" href="#t466">466</a></span><span class="t"> <span class="key">return</span> <span class="nam">service_definition</span><span class="op">.</span><span class="nam">replace</span><span class="op">(</span><span class="op">**</span><span class="nam">changes</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t467" href="#t467">467</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t468" href="#t468">468</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t469" href="#t469">469</a></span><span class="t"><span class="key">class</span> <span class="nam">BinaryVersionParsedFormat</span><span class="op">(</span><span class="nam">DebputyParsedContent</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t470" href="#t470">470</a></span><span class="t"> <span class="nam">binary_version</span><span class="op">:</span> <span class="nam">str</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t471" href="#t471">471</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t472" href="#t472">472</a></span><span class="t"> </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="key">class</span> <span class="nam">ListParsedFormat</span><span class="op">(</span><span class="nam">DebputyParsedContent</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t474" href="#t474">474</a></span><span class="t"> <span class="nam">elements</span><span class="op">:</span> <span class="nam">List</span><span class="op">[</span><span class="nam">Any</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t475" href="#t475">475</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t476" href="#t476">476</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t477" href="#t477">477</a></span><span class="t"><span class="key">class</span> <span class="nam">ListOfTransformationRulesFormat</span><span class="op">(</span><span class="nam">DebputyParsedContent</span><span class="op">)</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="nam">elements</span><span class="op">:</span> <span class="nam">List</span><span class="op">[</span><span class="nam">TransformationRule</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t479" href="#t479">479</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t480" href="#t480">480</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t481" href="#t481">481</a></span><span class="t"><span class="key">class</span> <span class="nam">ListOfDpkgMaintscriptHelperCommandFormat</span><span class="op">(</span><span class="nam">DebputyParsedContent</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t482" href="#t482">482</a></span><span class="t"> <span class="nam">elements</span><span class="op">:</span> <span class="nam">List</span><span class="op">[</span><span class="nam">DpkgMaintscriptHelperCommand</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t483" href="#t483">483</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t484" href="#t484">484</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t485" href="#t485">485</a></span><span class="t"><span class="key">class</span> <span class="nam">InstallationSearchDirsParsedFormat</span><span class="op">(</span><span class="nam">DebputyParsedContent</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t486" href="#t486">486</a></span><span class="t"> <span class="nam">installation_search_dirs</span><span class="op">:</span> <span class="nam">List</span><span class="op">[</span><span class="nam">FileSystemExactMatchRule</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t487" href="#t487">487</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t488" href="#t488">488</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t489" href="#t489">489</a></span><span class="t"><span class="key">def</span> <span class="nam">_parse_binary_version</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t490" href="#t490">490</a></span><span class="t"> <span class="nam">_name</span><span class="op">:</span> <span class="nam">str</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t491" href="#t491">491</a></span><span class="t"> <span class="nam">parsed_data</span><span class="op">:</span> <span class="nam">BinaryVersionParsedFormat</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t492" href="#t492">492</a></span><span class="t"> <span class="nam">_attribute_path</span><span class="op">:</span> <span class="nam">AttributePath</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t493" href="#t493">493</a></span><span class="t"> <span class="nam">_parser_context</span><span class="op">:</span> <span class="nam">ParserContextData</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t494" href="#t494">494</a></span><span class="t"><span class="op">)</span> <span class="op">-></span> <span class="nam">str</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t495" href="#t495">495</a></span><span class="t"> <span class="key">return</span> <span class="nam">parsed_data</span><span class="op">[</span><span class="str">"binary_version"</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t496" href="#t496">496</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t497" href="#t497">497</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t498" href="#t498">498</a></span><span class="t"><span class="key">def</span> <span class="nam">_parse_installation_search_dirs</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t499" href="#t499">499</a></span><span class="t"> <span class="nam">_name</span><span class="op">:</span> <span class="nam">str</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t500" href="#t500">500</a></span><span class="t"> <span class="nam">parsed_data</span><span class="op">:</span> <span class="nam">InstallationSearchDirsParsedFormat</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t501" href="#t501">501</a></span><span class="t"> <span class="nam">_attribute_path</span><span class="op">:</span> <span class="nam">AttributePath</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t502" href="#t502">502</a></span><span class="t"> <span class="nam">_parser_context</span><span class="op">:</span> <span class="nam">ParserContextData</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t503" href="#t503">503</a></span><span class="t"><span class="op">)</span> <span class="op">-></span> <span class="nam">List</span><span class="op">[</span><span class="nam">FileSystemExactMatchRule</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="t504" href="#t504">504</a></span><span class="t"> <span class="key">return</span> <span class="nam">parsed_data</span><span class="op">[</span><span class="str">"installation_search_dirs"</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t505" href="#t505">505</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t506" href="#t506">506</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t507" href="#t507">507</a></span><span class="t"><span class="key">def</span> <span class="nam">_process_service_rules</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t508" href="#t508">508</a></span><span class="t"> <span class="nam">_name</span><span class="op">:</span> <span class="nam">str</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t509" href="#t509">509</a></span><span class="t"> <span class="nam">parsed_data</span><span class="op">:</span> <span class="nam">List</span><span class="op">[</span><span class="nam">ServiceRuleParsedFormat</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t510" href="#t510">510</a></span><span class="t"> <span class="nam">attribute_path</span><span class="op">:</span> <span class="nam">AttributePath</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t511" href="#t511">511</a></span><span class="t"> <span class="nam">_parser_context</span><span class="op">:</span> <span class="nam">ParserContextData</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t512" href="#t512">512</a></span><span class="t"><span class="op">)</span> <span class="op">-></span> <span class="nam">List</span><span class="op">[</span><span class="nam">ServiceRule</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="t513" href="#t513">513</a></span><span class="t"> <span class="key">return</span> <span class="op">[</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t514" href="#t514">514</a></span><span class="t"> <span class="nam">ServiceRule</span><span class="op">.</span><span class="nam">from_service_rule_parsed_format</span><span class="op">(</span><span class="nam">x</span><span class="op">,</span> <span class="nam">attribute_path</span><span class="op">[</span><span class="nam">i</span><span class="op">]</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t515" href="#t515">515</a></span><span class="t"> <span class="key">for</span> <span class="nam">i</span><span class="op">,</span> <span class="nam">x</span> <span class="key">in</span> <span class="nam">enumerate</span><span class="op">(</span><span class="nam">parsed_data</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t516" href="#t516">516</a></span><span class="t"> <span class="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t517" href="#t517">517</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t518" href="#t518">518</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t519" href="#t519">519</a></span><span class="t"><span class="key">def</span> <span class="nam">_unpack_list</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t520" href="#t520">520</a></span><span class="t"> <span class="nam">_name</span><span class="op">:</span> <span class="nam">str</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t521" href="#t521">521</a></span><span class="t"> <span class="nam">parsed_data</span><span class="op">:</span> <span class="nam">List</span><span class="op">[</span><span class="nam">Any</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t522" href="#t522">522</a></span><span class="t"> <span class="nam">_attribute_path</span><span class="op">:</span> <span class="nam">AttributePath</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t523" href="#t523">523</a></span><span class="t"> <span class="nam">_parser_context</span><span class="op">:</span> <span class="nam">ParserContextData</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t524" href="#t524">524</a></span><span class="t"><span class="op">)</span> <span class="op">-></span> <span class="nam">List</span><span class="op">[</span><span class="nam">Any</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t525" href="#t525">525</a></span><span class="t"> <span class="key">return</span> <span class="nam">parsed_data</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t526" href="#t526">526</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t527" href="#t527">527</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t528" href="#t528">528</a></span><span class="t"><span class="key">class</span> <span class="nam">CleanAfterRemovalRuleSourceFormat</span><span class="op">(</span><span class="nam">TypedDict</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t529" href="#t529">529</a></span><span class="t"> <span class="nam">path</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">Annotated</span><span class="op">[</span><span class="nam">str</span><span class="op">,</span> <span class="nam">DebputyParseHint</span><span class="op">.</span><span class="nam">target_attribute</span><span class="op">(</span><span class="str">"paths"</span><span class="op">)</span><span class="op">]</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t530" href="#t530">530</a></span><span class="t"> <span class="nam">paths</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">List</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t531" href="#t531">531</a></span><span class="t"> <span class="nam">delete_on</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">Literal</span><span class="op">[</span><span class="str">"purge"</span><span class="op">,</span> <span class="str">"removal"</span><span class="op">]</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t532" href="#t532">532</a></span><span class="t"> <span class="nam">recursive</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">bool</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t533" href="#t533">533</a></span><span class="t"> <span class="nam">ignore_non_empty_dir</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">bool</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t534" href="#t534">534</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t535" href="#t535">535</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t536" href="#t536">536</a></span><span class="t"><span class="key">class</span> <span class="nam">CleanAfterRemovalRule</span><span class="op">(</span><span class="nam">DebputyParsedContent</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t537" href="#t537">537</a></span><span class="t"> <span class="nam">paths</span><span class="op">:</span> <span class="nam">List</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t538" href="#t538">538</a></span><span class="t"> <span class="nam">delete_on</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">Literal</span><span class="op">[</span><span class="str">"purge"</span><span class="op">,</span> <span class="str">"removal"</span><span class="op">]</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t539" href="#t539">539</a></span><span class="t"> <span class="nam">recursive</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">bool</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t540" href="#t540">540</a></span><span class="t"> <span class="nam">ignore_non_empty_dir</span><span class="op">:</span> <span class="nam">NotRequired</span><span class="op">[</span><span class="nam">bool</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t541" href="#t541">541</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t542" href="#t542">542</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t543" href="#t543">543</a></span><span class="t"><span class="com"># FIXME: Not optimal that we are doing an initialization of ParserGenerator here. But the rule is not depending on any</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t544" href="#t544">544</a></span><span class="t"><span class="com"># complex types that is registered by plugins, so it will work for now.</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t545" href="#t545">545</a></span><span class="t"><span class="nam">_CLEAN_AFTER_REMOVAL_RULE_PARSER</span> <span class="op">=</span> <span class="nam">ParserGenerator</span><span class="op">(</span><span class="op">)</span><span class="op">.</span><span class="nam">generate_parser</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t546" href="#t546">546</a></span><span class="t"> <span class="nam">CleanAfterRemovalRule</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t547" href="#t547">547</a></span><span class="t"> <span class="nam">source_content</span><span class="op">=</span><span class="nam">Union</span><span class="op">[</span><span class="nam">CleanAfterRemovalRuleSourceFormat</span><span class="op">,</span> <span class="nam">str</span><span class="op">,</span> <span class="nam">List</span><span class="op">[</span><span class="nam">str</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="t548" href="#t548">548</a></span><span class="t"> <span class="nam">inline_reference_documentation</span><span class="op">=</span><span class="nam">reference_documentation</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t549" href="#t549">549</a></span><span class="t"> <span class="nam">reference_documentation_url</span><span class="op">=</span><span class="str">f"{DEBPUTY_DOC_ROOT_DIR}/MANIFEST-FORMAT.md#remove-runtime-created-paths-on-purge-or-post-removal-clean-after-removal"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t550" href="#t550">550</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="t551" href="#t551">551</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t552" href="#t552">552</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t553" href="#t553">553</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t554" href="#t554">554</a></span><span class="t"><span class="com"># Order between clean_on_removal and conffile_management is</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t555" href="#t555">555</a></span><span class="t"><span class="com"># important. We want the dpkg conffile management rules to happen before the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t556" href="#t556">556</a></span><span class="t"><span class="com"># clean clean_on_removal rules. Since the latter only affects `postrm`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t557" href="#t557">557</a></span><span class="t"><span class="com"># and the order is reversed for `postrm` scripts (among other), we need do</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t558" href="#t558">558</a></span><span class="t"><span class="com"># clean_on_removal first to account for the reversing of order.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t559" href="#t559">559</a></span><span class="t"><span class="com">#</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t560" href="#t560">560</a></span><span class="t"><span class="com"># FIXME: All of this is currently not really possible todo, but it should be.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t561" href="#t561">561</a></span><span class="t"><span class="com"># (I think it is the correct order by "mistake" rather than by "design", which is</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t562" href="#t562">562</a></span><span class="t"><span class="com"># what this note is about)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t563" href="#t563">563</a></span><span class="t"><span class="key">def</span> <span class="nam">_parse_clean_after_removal</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t564" href="#t564">564</a></span><span class="t"> <span class="nam">_name</span><span class="op">:</span> <span class="nam">str</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t565" href="#t565">565</a></span><span class="t"> <span class="nam">parsed_data</span><span class="op">:</span> <span class="nam">ListParsedFormat</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t566" href="#t566">566</a></span><span class="t"> <span class="nam">attribute_path</span><span class="op">:</span> <span class="nam">AttributePath</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t567" href="#t567">567</a></span><span class="t"> <span class="nam">parser_context</span><span class="op">:</span> <span class="nam">ParserContextData</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t568" href="#t568">568</a></span><span class="t"><span class="op">)</span> <span class="op">-></span> <span class="key">None</span><span class="op">:</span> <span class="com"># TODO: Return and pass to a maintscript helper</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t569" href="#t569">569</a></span><span class="t"> <span class="nam">raw_clean_after_removal</span> <span class="op">=</span> <span class="nam">parsed_data</span><span class="op">[</span><span class="str">"elements"</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t570" href="#t570">570</a></span><span class="t"> <span class="nam">package_state</span> <span class="op">=</span> <span class="nam">parser_context</span><span class="op">.</span><span class="nam">current_binary_package_state</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t571" href="#t571">571</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t572" href="#t572">572</a></span><span class="t"> <span class="key">for</span> <span class="nam">no</span><span class="op">,</span> <span class="nam">raw_transformation</span> <span class="key">in</span> <span class="nam">enumerate</span><span class="op">(</span><span class="nam">raw_clean_after_removal</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t573" href="#t573">573</a></span><span class="t"> <span class="nam">definition_source</span> <span class="op">=</span> <span class="nam">attribute_path</span><span class="op">[</span><span class="nam">no</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t574" href="#t574">574</a></span><span class="t"> <span class="nam">clean_after_removal_rules</span> <span class="op">=</span> <span class="nam">_CLEAN_AFTER_REMOVAL_RULE_PARSER</span><span class="op">.</span><span class="nam">parse_input</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t575" href="#t575">575</a></span><span class="t"> <span class="nam">raw_transformation</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t576" href="#t576">576</a></span><span class="t"> <span class="nam">definition_source</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t577" href="#t577">577</a></span><span class="t"> <span class="nam">parser_context</span><span class="op">=</span><span class="nam">parser_context</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t578" href="#t578">578</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t579" href="#t579">579</a></span><span class="t"> <span class="nam">patterns</span> <span class="op">=</span> <span class="nam">clean_after_removal_rules</span><span class="op">[</span><span class="str">"paths"</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t580" href="#t580">580</a></span><span class="t"> <span class="key">if</span> <span class="nam">patterns</span><span class="op">:</span> </span><span class="r"><span class="annotate short">580 ↛ 582</span><span class="annotate long">line 580 didn't jump to line 582, because the condition on line 580 was never false</span></span></p> - <p class="run"><span class="n"><a id="t581" href="#t581">581</a></span><span class="t"> <span class="nam">definition_source</span><span class="op">.</span><span class="nam">path_hint</span> <span class="op">=</span> <span class="nam">patterns</span><span class="op">[</span><span class="num">0</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t582" href="#t582">582</a></span><span class="t"> <span class="nam">delete_on</span> <span class="op">=</span> <span class="nam">clean_after_removal_rules</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="str">"delete_on"</span><span class="op">)</span> <span class="key">or</span> <span class="str">"purge"</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t583" href="#t583">583</a></span><span class="t"> <span class="nam">recurse</span> <span class="op">=</span> <span class="nam">clean_after_removal_rules</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="str">"recursive"</span><span class="op">)</span> <span class="key">or</span> <span class="key">False</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t584" href="#t584">584</a></span><span class="t"> <span class="nam">ignore_non_empty_dir</span> <span class="op">=</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t585" href="#t585">585</a></span><span class="t"> <span class="nam">clean_after_removal_rules</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="str">"ignore_non_empty_dir"</span><span class="op">)</span> <span class="key">or</span> <span class="key">False</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t586" href="#t586">586</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="t587" href="#t587">587</a></span><span class="t"> <span class="key">if</span> <span class="nam">delete_on</span> <span class="op">==</span> <span class="str">"purge"</span><span class="op">:</span> </span><span class="r"><span class="annotate short">587 ↛ 590</span><span class="annotate long">line 587 didn't jump to line 590, because the condition on line 587 was never false</span></span></p> - <p class="run"><span class="n"><a id="t588" href="#t588">588</a></span><span class="t"> <span class="nam">condition</span> <span class="op">=</span> <span class="str">'[ "$1" = "purge" ]'</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t589" href="#t589">589</a></span><span class="t"> <span class="key">else</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t590" href="#t590">590</a></span><span class="t"> <span class="nam">condition</span> <span class="op">=</span> <span class="str">'[ "$1" = "remove" ]'</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t591" href="#t591">591</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t592" href="#t592">592</a></span><span class="t"> <span class="key">if</span> <span class="nam">ignore_non_empty_dir</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t593" href="#t593">593</a></span><span class="t"> <span class="key">if</span> <span class="nam">recurse</span><span class="op">:</span> </span><span class="r"><span class="annotate short">593 ↛ 594</span><span class="annotate long">line 593 didn't jump to line 594, because the condition on line 593 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t594" href="#t594">594</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ManifestParseException</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t595" href="#t595">595</a></span><span class="t"> <span class="str">'The "recursive" and "ignore-non-empty-dir" options are mutually exclusive.'</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t596" href="#t596">596</a></span><span class="t"> <span class="str">f" Both were enabled at the same time in at {definition_source.path}"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t597" href="#t597">597</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t598" href="#t598">598</a></span><span class="t"> <span class="key">for</span> <span class="nam">pattern</span> <span class="key">in</span> <span class="nam">patterns</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t599" href="#t599">599</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">pattern</span><span class="op">.</span><span class="nam">endswith</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">599 ↛ 600</span><span class="annotate long">line 599 didn't jump to line 600, because the condition on line 599 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t600" href="#t600">600</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ManifestParseException</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t601" href="#t601">601</a></span><span class="t"> <span class="str">'When ignore-non-empty-dir is True, then all patterns must end with a literal "/"'</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t602" href="#t602">602</a></span><span class="t"> <span class="str">f' to ensure they only apply to directories. The pattern "{pattern}" at'</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t603" href="#t603">603</a></span><span class="t"> <span class="str">f" {definition_source.path} did not."</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t604" href="#t604">604</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t605" href="#t605">605</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t606" href="#t606">606</a></span><span class="t"> <span class="nam">substitution</span> <span class="op">=</span> <span class="nam">parser_context</span><span class="op">.</span><span class="nam">substitution</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t607" href="#t607">607</a></span><span class="t"> <span class="nam">match_rules</span> <span class="op">=</span> <span class="op">[</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t608" href="#t608">608</a></span><span class="t"> <span class="nam">MatchRule</span><span class="op">.</span><span class="nam">from_path_or_glob</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t609" href="#t609">609</a></span><span class="t"> <span class="nam">p</span><span class="op">,</span> <span class="nam">definition_source</span><span class="op">.</span><span class="nam">path</span><span class="op">,</span> <span class="nam">substitution</span><span class="op">=</span><span class="nam">substitution</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t610" href="#t610">610</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t611" href="#t611">611</a></span><span class="t"> <span class="key">for</span> <span class="nam">p</span> <span class="key">in</span> <span class="nam">patterns</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t612" href="#t612">612</a></span><span class="t"> <span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t613" href="#t613">613</a></span><span class="t"> <span class="nam">content_lines</span> <span class="op">=</span> <span class="op">[</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t614" href="#t614">614</a></span><span class="t"> <span class="str">f"if {condition}; then\n"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t615" href="#t615">615</a></span><span class="t"> <span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t616" href="#t616">616</a></span><span class="t"> <span class="key">for</span> <span class="nam">idx</span><span class="op">,</span> <span class="nam">match_rule</span> <span class="key">in</span> <span class="nam">enumerate</span><span class="op">(</span><span class="nam">match_rules</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t617" href="#t617">617</a></span><span class="t"> <span class="nam">original_pattern</span> <span class="op">=</span> <span class="nam">patterns</span><span class="op">[</span><span class="nam">idx</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t618" href="#t618">618</a></span><span class="t"> <span class="key">if</span> <span class="nam">match_rule</span> <span class="key">is</span> <span class="nam">MATCH_ANYTHING</span><span class="op">:</span> </span><span class="r"><span class="annotate short">618 ↛ 619</span><span class="annotate long">line 618 didn't jump to line 619, because the condition on line 618 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t619" href="#t619">619</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ManifestParseException</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t620" href="#t620">620</a></span><span class="t"> <span class="str">f'Using "{original_pattern}" in a clean rule would trash the system.'</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t621" href="#t621">621</a></span><span class="t"> <span class="str">f" Please restrict this pattern at {definition_source.path} considerably."</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t622" href="#t622">622</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t623" href="#t623">623</a></span><span class="t"> <span class="nam">is_subdir_match</span> <span class="op">=</span> <span class="key">False</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t624" href="#t624">624</a></span><span class="t"> <span class="nam">matched_directory</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t625" href="#t625">625</a></span><span class="t"> <span class="key">if</span> <span class="nam">isinstance</span><span class="op">(</span><span class="nam">match_rule</span><span class="op">,</span> <span class="nam">ExactFileSystemPath</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t626" href="#t626">626</a></span><span class="t"> <span class="nam">matched_directory</span> <span class="op">=</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t627" href="#t627">627</a></span><span class="t"> <span class="nam">os</span><span class="op">.</span><span class="nam">path</span><span class="op">.</span><span class="nam">dirname</span><span class="op">(</span><span class="nam">match_rule</span><span class="op">.</span><span class="nam">path</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t628" href="#t628">628</a></span><span class="t"> <span class="key">if</span> <span class="nam">match_rule</span><span class="op">.</span><span class="nam">path</span> <span class="key">not</span> <span class="key">in</span> <span class="op">(</span><span class="str">"/"</span><span class="op">,</span> <span class="str">"."</span><span class="op">,</span> <span class="str">"./"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t629" href="#t629">629</a></span><span class="t"> <span class="key">else</span> <span class="nam">match_rule</span><span class="op">.</span><span class="nam">path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t630" href="#t630">630</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t631" href="#t631">631</a></span><span class="t"> <span class="nam">is_subdir_match</span> <span class="op">=</span> <span class="key">True</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t632" href="#t632">632</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="t633" href="#t633">633</a></span><span class="t"> <span class="nam">matched_directory</span> <span class="op">=</span> <span class="nam">getattr</span><span class="op">(</span><span class="nam">match_rule</span><span class="op">,</span> <span class="str">"directory"</span><span class="op">,</span> <span class="key">None</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t634" href="#t634">634</a></span><span class="t"> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t635" href="#t635">635</a></span><span class="t"> <span class="key">if</span> <span class="nam">matched_directory</span> <span class="key">is</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"><span class="annotate short">635 ↛ 636</span><span class="annotate long">line 635 didn't jump to line 636, because the condition on line 635 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t636" href="#t636">636</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ManifestParseException</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t637" href="#t637">637</a></span><span class="t"> <span class="str">f'The pattern "{original_pattern}" defined at {definition_source.path} is not'</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t638" href="#t638">638</a></span><span class="t"> <span class="str">f" trivially anchored in a specific directory. Cowardly refusing to use it"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t639" href="#t639">639</a></span><span class="t"> <span class="str">f" in a clean rule as it may trash the system if the pattern is overreaching."</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t640" href="#t640">640</a></span><span class="t"> <span class="str">f" Please avoid glob characters in the top level directories."</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t641" href="#t641">641</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t642" href="#t642">642</a></span><span class="t"> <span class="key">assert</span> <span class="nam">matched_directory</span><span class="op">.</span><span class="nam">startswith</span><span class="op">(</span><span class="str">"./"</span><span class="op">)</span> <span class="key">or</span> <span class="nam">matched_directory</span> <span class="key">in</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t643" href="#t643">643</a></span><span class="t"> <span class="str">"."</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t644" href="#t644">644</a></span><span class="t"> <span class="str">"./"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t645" href="#t645">645</a></span><span class="t"> <span class="str">""</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t646" href="#t646">646</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t647" href="#t647">647</a></span><span class="t"> <span class="nam">acceptable_directory</span> <span class="op">=</span> <span class="key">False</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t648" href="#t648">648</a></span><span class="t"> <span class="nam">would_have_allowed_direct_match</span> <span class="op">=</span> <span class="key">False</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t649" href="#t649">649</a></span><span class="t"> <span class="key">while</span> <span class="nam">matched_directory</span> <span class="key">not</span> <span class="key">in</span> <span class="op">(</span><span class="str">"."</span><span class="op">,</span> <span class="str">"./"</span><span class="op">,</span> <span class="str">""</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t650" href="#t650">650</a></span><span class="t"> <span class="com"># Our acceptable paths set includes "/var/lib" or "/etc". We require that the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t651" href="#t651">651</a></span><span class="t"> <span class="com"># pattern is either an exact match, in which case it may match directly inside</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t652" href="#t652">652</a></span><span class="t"> <span class="com"># the acceptable directory OR it is a pattern against a subdirectory of the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t653" href="#t653">653</a></span><span class="t"> <span class="com"># acceptable path. As an example:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t654" href="#t654">654</a></span><span class="t"> <span class="com">#</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t655" href="#t655">655</a></span><span class="t"> <span class="com"># /etc/inputrc <-- OK, exact match</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t656" href="#t656">656</a></span><span class="t"> <span class="com"># /etc/foo/* <-- OK, subdir match</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t657" href="#t657">657</a></span><span class="t"> <span class="com"># /etc/* <-- ERROR, glob directly in the accepted directory.</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t658" href="#t658">658</a></span><span class="t"> <span class="key">if</span> <span class="nam">is_subdir_match</span> <span class="key">and</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t659" href="#t659">659</a></span><span class="t"> <span class="nam">matched_directory</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t660" href="#t660">660</a></span><span class="t"> <span class="key">in</span> <span class="nam">ACCEPTABLE_CLEAN_ON_REMOVAL_IF_EXACT_MATCH_OR_SUBDIR_OF</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t661" href="#t661">661</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="t662" href="#t662">662</a></span><span class="t"> <span class="nam">acceptable_directory</span> <span class="op">=</span> <span class="key">True</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t663" href="#t663">663</a></span><span class="t"> <span class="key">break</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t664" href="#t664">664</a></span><span class="t"> <span class="key">if</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t665" href="#t665">665</a></span><span class="t"> <span class="nam">matched_directory</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t666" href="#t666">666</a></span><span class="t"> <span class="key">in</span> <span class="nam">ACCEPTABLE_CLEAN_ON_REMOVAL_FOR_GLOBS_AND_EXACT_MATCHES</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t667" href="#t667">667</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="t668" href="#t668">668</a></span><span class="t"> <span class="com"># Special-case: In some directories (such as /var/log), we allow globs directly.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t669" href="#t669">669</a></span><span class="t"> <span class="com"># Notably, X11's log files are /var/log/Xorg.*.log</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t670" href="#t670">670</a></span><span class="t"> <span class="nam">acceptable_directory</span> <span class="op">=</span> <span class="key">True</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t671" href="#t671">671</a></span><span class="t"> <span class="key">break</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t672" href="#t672">672</a></span><span class="t"> <span class="key">if</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t673" href="#t673">673</a></span><span class="t"> <span class="nam">matched_directory</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t674" href="#t674">674</a></span><span class="t"> <span class="key">in</span> <span class="nam">ACCEPTABLE_CLEAN_ON_REMOVAL_IF_EXACT_MATCH_OR_SUBDIR_OF</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t675" href="#t675">675</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="t676" href="#t676">676</a></span><span class="t"> <span class="nam">would_have_allowed_direct_match</span> <span class="op">=</span> <span class="key">True</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t677" href="#t677">677</a></span><span class="t"> <span class="key">break</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t678" href="#t678">678</a></span><span class="t"> <span class="nam">matched_directory</span> <span class="op">=</span> <span class="nam">os</span><span class="op">.</span><span class="nam">path</span><span class="op">.</span><span class="nam">dirname</span><span class="op">(</span><span class="nam">matched_directory</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t679" href="#t679">679</a></span><span class="t"> <span class="nam">is_subdir_match</span> <span class="op">=</span> <span class="key">True</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t680" href="#t680">680</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t681" href="#t681">681</a></span><span class="t"> <span class="key">if</span> <span class="nam">would_have_allowed_direct_match</span> <span class="key">and</span> <span class="key">not</span> <span class="nam">acceptable_directory</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t682" href="#t682">682</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ManifestParseException</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t683" href="#t683">683</a></span><span class="t"> <span class="str">f'The pattern "{original_pattern}" defined at {definition_source.path} seems to'</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t684" href="#t684">684</a></span><span class="t"> <span class="str">" be overreaching. If it has been a path (and not use a glob), the rule would"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t685" href="#t685">685</a></span><span class="t"> <span class="str">" have been permitted."</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t686" href="#t686">686</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t687" href="#t687">687</a></span><span class="t"> <span class="key">elif</span> <span class="key">not</span> <span class="nam">acceptable_directory</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t688" href="#t688">688</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ManifestParseException</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t689" href="#t689">689</a></span><span class="t"> <span class="str">f'The pattern or path "{original_pattern}" defined at {definition_source.path} seems to'</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t690" href="#t690">690</a></span><span class="t"> <span class="str">f' be overreaching or not limited to the set of "known acceptable" directories.'</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t691" href="#t691">691</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t692" href="#t692">692</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t693" href="#t693">693</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="t694" href="#t694">694</a></span><span class="t"> <span class="nam">shell_escaped_pattern</span> <span class="op">=</span> <span class="nam">match_rule</span><span class="op">.</span><span class="nam">shell_escape_pattern</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t695" href="#t695">695</a></span><span class="t"> <span class="key">except</span> <span class="nam">TypeError</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t696" href="#t696">696</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ManifestParseException</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t697" href="#t697">697</a></span><span class="t"> <span class="str">f'Sorry, the pattern "{original_pattern}" defined at {definition_source.path}'</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t698" href="#t698">698</a></span><span class="t"> <span class="str">f" is unfortunately not supported by `debputy` for clean-after-removal rules."</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t699" href="#t699">699</a></span><span class="t"> <span class="str">f" If you can rewrite the rule to something like `/var/log/foo/*.log` or"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t700" href="#t700">700</a></span><span class="t"> <span class="str">f' similar "trivial" patterns. You may have to rewrite the pattern the rule '</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t701" href="#t701">701</a></span><span class="t"> <span class="str">f" into multiple patterns to achieve this. This restriction is to enable "</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t702" href="#t702">702</a></span><span class="t"> <span class="str">f' `debputy` to ensure the pattern is correctly executed plus catch "obvious'</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t703" href="#t703">703</a></span><span class="t"> <span class="str">f' system trashing" patterns. Apologies for the inconvenience.'</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t704" href="#t704">704</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t705" href="#t705">705</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t706" href="#t706">706</a></span><span class="t"> <span class="key">if</span> <span class="nam">ignore_non_empty_dir</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t707" href="#t707">707</a></span><span class="t"> <span class="nam">cmd</span> <span class="op">=</span> <span class="str">f' rmdir --ignore-fail-on-non-empty "${{DPKG_ROOT}}"{shell_escaped_pattern}\n'</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t708" href="#t708">708</a></span><span class="t"> <span class="key">elif</span> <span class="nam">recurse</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t709" href="#t709">709</a></span><span class="t"> <span class="nam">cmd</span> <span class="op">=</span> <span class="str">f' rm -fr "${{DPKG_ROOT}}"{shell_escaped_pattern}\n'</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t710" href="#t710">710</a></span><span class="t"> <span class="key">elif</span> <span class="nam">original_pattern</span><span class="op">.</span><span class="nam">endswith</span><span class="op">(</span><span class="str">"/"</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t711" href="#t711">711</a></span><span class="t"> <span class="nam">cmd</span> <span class="op">=</span> <span class="str">f' rmdir "${{DPKG_ROOT}}"{shell_escaped_pattern}\n'</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t712" href="#t712">712</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="t713" href="#t713">713</a></span><span class="t"> <span class="nam">cmd</span> <span class="op">=</span> <span class="str">f' rm -f "${{DPKG_ROOT}}"{shell_escaped_pattern}\n'</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t714" href="#t714">714</a></span><span class="t"> <span class="nam">content_lines</span><span class="op">.</span><span class="nam">append</span><span class="op">(</span><span class="nam">cmd</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t715" href="#t715">715</a></span><span class="t"> <span class="nam">content_lines</span><span class="op">.</span><span class="nam">append</span><span class="op">(</span><span class="str">"fi\n"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t716" href="#t716">716</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t717" href="#t717">717</a></span><span class="t"> <span class="nam">snippet</span> <span class="op">=</span> <span class="nam">MaintscriptSnippet</span><span class="op">(</span><span class="nam">definition_source</span><span class="op">.</span><span class="nam">path</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">content_lines</span><span class="op">)</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t718" href="#t718">718</a></span><span class="t"> <span class="nam">package_state</span><span class="op">.</span><span class="nam">maintscript_snippets</span><span class="op">[</span><span class="str">"postrm"</span><span class="op">]</span><span class="op">.</span><span class="nam">append</span><span class="op">(</span><span class="nam">snippet</span><span class="op">)</span> </span><span class="r"></span></p> -</main> -<footer> - <div class="content"> - <p> - <a id="prevFileLink" class="nav" href="d_d5d6843b45eec01e___init___py.html">« prev</a> - <a id="indexLink" class="nav" href="index.html">^ index</a> - <a id="nextFileLink" class="nav" href="d_d5d6843b45eec01e_debputy_plugin_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> |