diff options
Diffstat (limited to 'coverage-report/d_64287305fe0c6642_spec_py.html')
| -rw-r--r-- | coverage-report/d_64287305fe0c6642_spec_py.html | 1842 |
1 files changed, 0 insertions, 1842 deletions
diff --git a/coverage-report/d_64287305fe0c6642_spec_py.html b/coverage-report/d_64287305fe0c6642_spec_py.html deleted file mode 100644 index 700a493..0000000 --- a/coverage-report/d_64287305fe0c6642_spec_py.html +++ /dev/null @@ -1,1842 +0,0 @@ -<!DOCTYPE html> -<html> -<head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> - <title>Coverage for src/debputy/plugin/api/spec.py: 87%</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/api/spec.py</b>: - <span class="pc_cov">87%</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">282 statements </span> - <button type="button" class="run button_toggle_run" value="run" data-shortcut="r" title="Toggle lines run">246<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">36<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">66<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">7<span class="text"> partial</span></button> - </h2> - <p class="text"> - <a id="prevFileLink" class="nav" href="d_64287305fe0c6642_plugin_parser_py.html">« prev</a> - <a id="indexLink" class="nav" href="index.html">^ index</a> - <a id="nextFileLink" class="nav" href="d_4b9be07fb6071cd2___init___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">contextlib</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">dataclasses</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">os</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">import</span> <span class="nam">tempfile</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t5" href="#t5">5</a></span><span class="t"><span class="key">import</span> <span class="nam">textwrap</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t6" href="#t6">6</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="t7" href="#t7">7</a></span><span class="t"> <span class="nam">Iterable</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">Optional</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">Callable</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">Literal</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">Union</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">Iterator</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">overload</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">FrozenSet</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">Sequence</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="nam">TypeVar</span><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 class="nam">Any</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t18" href="#t18">18</a></span><span class="t"> <span class="nam">TYPE_CHECKING</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t19" href="#t19">19</a></span><span class="t"> <span class="nam">TextIO</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t20" href="#t20">20</a></span><span class="t"> <span class="nam">BinaryIO</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">Generic</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">ContextManager</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="nam">List</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t24" href="#t24">24</a></span><span class="t"> <span class="nam">Type</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">Tuple</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="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><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">debian</span><span class="op">.</span><span class="nam">substvars</span> <span class="key">import</span> <span class="nam">Substvars</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t29" href="#t29">29</a></span><span class="t"> </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="key">import</span> <span class="nam">util</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">exceptions</span> <span class="key">import</span> <span class="nam">TestPathWithNonExistentFSPathError</span><span class="op">,</span> <span class="nam">PureVirtualPathError</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">interpreter</span> <span class="key">import</span> <span class="nam">Interpreter</span><span class="op">,</span> <span class="nam">extract_shebang_interpreter_from_file</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">manifest_parser</span><span class="op">.</span><span class="nam">util</span> <span class="key">import</span> <span class="nam">parse_symbolic_mode</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t34" href="#t34">34</a></span><span class="t"><span class="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">packages</span> <span class="key">import</span> <span class="nam">BinaryPackage</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t35" href="#t35">35</a></span><span class="t"><span class="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">types</span> <span class="key">import</span> <span class="nam">S</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><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t37" href="#t37">37</a></span><span class="t"><span class="key">if</span> <span class="nam">TYPE_CHECKING</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="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">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="t39" href="#t39">39</a></span><span class="t"> <span class="nam">StaticFileSystemOwner</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">StaticFileSystemGroup</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="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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t43" href="#t43">43</a></span><span class="t"> </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="nam">PluginInitializationEntryPoint</span> <span class="op">=</span> <span class="nam">Callable</span><span class="op">[</span><span class="op">[</span><span class="str">"DebputyPluginInitializer"</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="t45" href="#t45">45</a></span><span class="t"><span class="nam">MetadataAutoDetector</span> <span class="op">=</span> <span class="nam">Callable</span><span class="op">[</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t46" href="#t46">46</a></span><span class="t"> <span class="op">[</span><span class="str">"VirtualPath"</span><span class="op">,</span> <span class="str">"BinaryCtrlAccessor"</span><span class="op">,</span> <span class="str">"PackageProcessingContext"</span><span class="op">]</span><span class="op">,</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t47" href="#t47">47</a></span><span class="t"><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t48" href="#t48">48</a></span><span class="t"><span class="nam">PackageProcessor</span> <span class="op">=</span> <span class="nam">Callable</span><span class="op">[</span><span class="op">[</span><span class="str">"VirtualPath"</span><span class="op">,</span> <span class="key">None</span><span class="op">,</span> <span class="str">"PackageProcessingContext"</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="t49" href="#t49">49</a></span><span class="t"><span class="nam">DpkgTriggerType</span> <span class="op">=</span> <span class="nam">Literal</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="str">"activate"</span><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="str">"activate-await"</span><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 class="str">"activate-noawait"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t53" href="#t53">53</a></span><span class="t"> <span class="str">"interest"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t54" href="#t54">54</a></span><span class="t"> <span class="str">"interest-await"</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="str">"interest-noawait"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t56" href="#t56">56</a></span><span class="t"><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t57" href="#t57">57</a></span><span class="t"><span class="nam">Maintscript</span> <span class="op">=</span> <span class="nam">Literal</span><span class="op">[</span><span class="str">"postinst"</span><span class="op">,</span> <span class="str">"preinst"</span><span class="op">,</span> <span class="str">"prerm"</span><span class="op">,</span> <span class="str">"postrm"</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t58" href="#t58">58</a></span><span class="t"><span class="nam">PackageTypeSelector</span> <span class="op">=</span> <span class="nam">Union</span><span class="op">[</span><span class="nam">Literal</span><span class="op">[</span><span class="str">"deb"</span><span class="op">,</span> <span class="str">"udeb"</span><span class="op">]</span><span class="op">,</span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">Literal</span><span class="op">[</span><span class="str">"deb"</span><span class="op">,</span> <span class="str">"udeb"</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="t59" href="#t59">59</a></span><span class="t"><span class="nam">ServiceUpgradeRule</span> <span class="op">=</span> <span class="nam">Literal</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">"do-nothing"</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">"reload"</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="str">"restart"</span><span class="op">,</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">"stop-then-start"</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="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t65" href="#t65">65</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t66" href="#t66">66</a></span><span class="t"><span class="nam">DSD</span> <span class="op">=</span> <span class="nam">TypeVar</span><span class="op">(</span><span class="str">"DSD"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t67" href="#t67">67</a></span><span class="t"><span class="nam">ServiceDetector</span> <span class="op">=</span> <span class="nam">Callable</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="op">[</span><span class="str">"VirtualPath"</span><span class="op">,</span> <span class="str">"ServiceRegistry[DSD]"</span><span class="op">,</span> <span class="str">"PackageProcessingContext"</span><span class="op">]</span><span class="op">,</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="key">None</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="run"><span class="n"><a id="t71" href="#t71">71</a></span><span class="t"><span class="nam">ServiceIntegrator</span> <span class="op">=</span> <span class="nam">Callable</span><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 class="op">[</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t73" href="#t73">73</a></span><span class="t"> <span class="nam">Sequence</span><span class="op">[</span><span class="str">"ServiceDefinition[DSD]"</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t74" href="#t74">74</a></span><span class="t"> <span class="str">"BinaryCtrlAccessor"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t75" href="#t75">75</a></span><span class="t"> <span class="str">"PackageProcessingContext"</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="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t77" href="#t77">77</a></span><span class="t"> <span class="key">None</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="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><span class="r"></span></p> - <p class="run"><span class="n"><a id="t80" href="#t80">80</a></span><span class="t"><span class="nam">PMT</span> <span class="op">=</span> <span class="nam">TypeVar</span><span class="op">(</span><span class="str">"PMT"</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t82" href="#t82">82</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t83" href="#t83">83</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="t84" href="#t84">84</a></span><span class="t"><span class="key">class</span> <span class="nam">PackagerProvidedFileReferenceDocumentation</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t85" href="#t85">85</a></span><span class="t"> <span class="nam">description</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t86" href="#t86">86</a></span><span class="t"> <span class="nam">format_documentation_uris</span><span class="op">:</span> <span class="nam">Sequence</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> <span class="op">=</span> <span class="nam">tuple</span><span class="op">(</span><span class="op">)</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="run"><span class="n"><a id="t88" href="#t88">88</a></span><span class="t"> <span class="key">def</span> <span class="nam">replace</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="op">**</span><span class="nam">changes</span><span class="op">:</span> <span class="nam">Any</span><span class="op">)</span> <span class="op">-></span> <span class="str">"PackagerProvidedFileReferenceDocumentation"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t89" href="#t89">89</a></span><span class="t"> <span class="key">return</span> <span class="nam">dataclasses</span><span class="op">.</span><span class="nam">replace</span><span class="op">(</span><span class="nam">self</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="t90" href="#t90">90</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t91" href="#t91">91</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t92" href="#t92">92</a></span><span class="t"><span class="key">def</span> <span class="nam">packager_provided_file_reference_documentation</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t93" href="#t93">93</a></span><span class="t"> <span class="op">*</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t94" href="#t94">94</a></span><span class="t"> <span class="nam">description</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</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="pln"><span class="n"><a id="t95" href="#t95">95</a></span><span class="t"> <span class="nam">format_documentation_uris</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">Sequence</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">]</span> <span class="op">=</span> <span class="nam">tuple</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="t96" href="#t96">96</a></span><span class="t"><span class="op">)</span> <span class="op">-></span> <span class="nam">PackagerProvidedFileReferenceDocumentation</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t97" href="#t97">97</a></span><span class="t"> <span class="str">"""Provide documentation for a given packager provided file.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t98" href="#t98">98</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t99" href="#t99">99</a></span><span class="t"><span class="str"> :param description: Textual description presented to the user.</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"> :param format_documentation_uris: A sequence of URIs to documentation that describes</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"> the format of the file. Most relevant first.</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"> :return:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t103" href="#t103">103</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t104" href="#t104">104</a></span><span class="t"> <span class="nam">uris</span> <span class="op">=</span> <span class="nam">tuple</span><span class="op">(</span><span class="nam">format_documentation_uris</span><span class="op">)</span> <span class="key">if</span> <span class="nam">format_documentation_uris</span> <span class="key">else</span> <span class="nam">tuple</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t105" href="#t105">105</a></span><span class="t"> <span class="key">return</span> <span class="nam">PackagerProvidedFileReferenceDocumentation</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="nam">description</span><span class="op">=</span><span class="nam">description</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="nam">format_documentation_uris</span><span class="op">=</span><span class="nam">uris</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t108" href="#t108">108</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t109" href="#t109">109</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t110" href="#t110">110</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t111" href="#t111">111</a></span><span class="t"><span class="key">class</span> <span class="nam">PathMetadataReference</span><span class="op">(</span><span class="nam">Generic</span><span class="op">[</span><span class="nam">PMT</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="t112" href="#t112">112</a></span><span class="t"> <span class="str">"""An accessor to plugin provided metadata</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t113" href="#t113">113</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t114" href="#t114">114</a></span><span class="t"><span class="str"> This is a *short-lived* reference to a piece of metadata. It should *not* be stored beyond</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t115" href="#t115">115</a></span><span class="t"><span class="str"> the boundaries of the current plugin execution context as it can be become invalid (as an</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t116" href="#t116">116</a></span><span class="t"><span class="str"> example, if the path associated with this path is removed, then this reference become invalid)</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><span class="r"></span></p> - <p class="run"><span class="n"><a id="t119" href="#t119">119</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t120" href="#t120">120</a></span><span class="t"> <span class="key">def</span> <span class="nam">is_present</span><span class="op">(</span><span class="nam">self</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="pln"><span class="n"><a id="t121" href="#t121">121</a></span><span class="t"> <span class="str">"""Determine whether the value has been set</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t122" href="#t122">122</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t123" href="#t123">123</a></span><span class="t"><span class="str"> If the current plugin cannot access the value, then this method unconditionally returns</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"> `False` regardless of whether the value is there.</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><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"> :return: `True` if the value has been set to a not None value (and not been deleted).</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"> Otherwise, this property is `False`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t128" href="#t128">128</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t129" href="#t129">129</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t130" href="#t130">130</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t131" href="#t131">131</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t132" href="#t132">132</a></span><span class="t"> <span class="key">def</span> <span class="nam">can_read</span><span class="op">(</span><span class="nam">self</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="pln"><span class="n"><a id="t133" href="#t133">133</a></span><span class="t"> <span class="str">"""Test whether it is possible to read the metadata</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t134" href="#t134">134</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t135" href="#t135">135</a></span><span class="t"><span class="str"> Note: That the metadata being readable does *not* imply that the metadata is present.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t136" href="#t136">136</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t137" href="#t137">137</a></span><span class="t"><span class="str"> :return: True if it is possible to read the metadata. This is always True for the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t138" href="#t138">138</a></span><span class="t"><span class="str"> owning plugin.</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"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t140" href="#t140">140</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t141" href="#t141">141</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t142" href="#t142">142</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t143" href="#t143">143</a></span><span class="t"> <span class="key">def</span> <span class="nam">can_write</span><span class="op">(</span><span class="nam">self</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="pln"><span class="n"><a id="t144" href="#t144">144</a></span><span class="t"> <span class="str">"""Test whether it is possible to update the metadata</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t145" href="#t145">145</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t146" href="#t146">146</a></span><span class="t"><span class="str"> :return: True if it is possible to update the metadata.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t147" href="#t147">147</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t148" href="#t148">148</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t149" href="#t149">149</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t150" href="#t150">150</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t151" href="#t151">151</a></span><span class="t"> <span class="key">def</span> <span class="nam">value</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">PMT</span><span class="op">]</span><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 class="str">"""Fetch the currently stored value if present.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t153" href="#t153">153</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t154" href="#t154">154</a></span><span class="t"><span class="str"> :return: The value previously stored if any. Returns `None` if the value was never</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"> stored, explicitly set to `None` or was deleted.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t156" href="#t156">156</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t157" href="#t157">157</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t158" href="#t158">158</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t159" href="#t159">159</a></span><span class="t"> <span class="op">@</span><span class="nam">value</span><span class="op">.</span><span class="nam">setter</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t160" href="#t160">160</a></span><span class="t"> <span class="key">def</span> <span class="nam">value</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">value</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">PMT</span><span class="op">]</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="pln"><span class="n"><a id="t161" href="#t161">161</a></span><span class="t"> <span class="str">"""Replace any current value with the provided value</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t162" href="#t162">162</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t163" href="#t163">163</a></span><span class="t"><span class="str"> This operation is only possible if the path is writable *and* the caller is from</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 owning plugin OR the owning plugin made the reference read-write.</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 class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t166" href="#t166">166</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t167" href="#t167">167</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t168" href="#t168">168</a></span><span class="t"> <span class="op">@</span><span class="nam">value</span><span class="op">.</span><span class="nam">deleter</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t169" href="#t169">169</a></span><span class="t"> <span class="key">def</span> <span class="nam">value</span><span class="op">(</span><span class="nam">self</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="pln"><span class="n"><a id="t170" href="#t170">170</a></span><span class="t"> <span class="str">"""Delete any current value.</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><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"> This has the same effect as setting the value to `None`. It has the same restrictions</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"> as the value setter.</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="str"> """</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t175" href="#t175">175</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">value</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t176" href="#t176">176</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t177" href="#t177">177</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t178" href="#t178">178</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><span class="r"></span></p> - <p class="run"><span class="n"><a id="t179" href="#t179">179</a></span><span class="t"><span class="key">class</span> <span class="nam">PathDef</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t180" href="#t180">180</a></span><span class="t"> <span class="nam">path_name</span><span class="op">:</span> <span class="nam">str</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t181" href="#t181">181</a></span><span class="t"> <span class="nam">mode</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">int</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t182" href="#t182">182</a></span><span class="t"> <span class="nam">mtime</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">int</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t183" href="#t183">183</a></span><span class="t"> <span class="nam">has_fs_path</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">bool</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t184" href="#t184">184</a></span><span class="t"> <span class="nam">fs_path</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t185" href="#t185">185</a></span><span class="t"> <span class="nam">link_target</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t186" href="#t186">186</a></span><span class="t"> <span class="nam">content</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t187" href="#t187">187</a></span><span class="t"> <span class="nam">materialized_content</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t189" href="#t189">189</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t190" href="#t190">190</a></span><span class="t"><span class="key">def</span> <span class="nam">virtual_path_def</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">path_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="t192" href="#t192">192</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="t193" href="#t193">193</a></span><span class="t"> <span class="nam">mode</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">int</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="pln"><span class="n"><a id="t194" href="#t194">194</a></span><span class="t"> <span class="nam">mtime</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">int</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="pln"><span class="n"><a id="t195" href="#t195">195</a></span><span class="t"> <span class="nam">fs_path</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</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="pln"><span class="n"><a id="t196" href="#t196">196</a></span><span class="t"> <span class="nam">link_target</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</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="pln"><span class="n"><a id="t197" href="#t197">197</a></span><span class="t"> <span class="nam">content</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</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="pln"><span class="n"><a id="t198" href="#t198">198</a></span><span class="t"> <span class="nam">materialized_content</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</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="pln"><span class="n"><a id="t199" href="#t199">199</a></span><span class="t"><span class="op">)</span> <span class="op">-></span> <span class="nam">PathDef</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="str">"""Define a virtual path for use with examples or, in tests, `build_virtual_file_system`</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><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"> :param path_name: The full path. Must start with "./". If it ends with "/", the path will be interpreted</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="str"> as a directory (the `is_dir` attribute will be True). Otherwise, it will be a symlink or file depending</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"> on whether a `link_target` is provided.</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"> :param mode: The mode to use for this path. Defaults to 0644 for files and 0755 for directories. The mode</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"> should be None for symlinks.</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"> :param mtime: Define the last modified time for this path. If not provided, debputy will provide a default</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"> if the mtime attribute is accessed.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t209" href="#t209">209</a></span><span class="t"><span class="str"> :param fs_path: Define a file system path for this path. This causes `has_fs_path` to return True and the</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="str"> `fs_path` attribute will return this value. The test is required to make this path available to the extent</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="str"> required. Note that the virtual file system will *not* examine the provided path in any way nor attempt</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t212" href="#t212">212</a></span><span class="t"><span class="str"> to resolve defaults from the path.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t213" href="#t213">213</a></span><span class="t"><span class="str"> :param link_target: A target for the symlink. Providing a not None value for this parameter will make the</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"> path a symlink.</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"> :param content: The content of the path (if opened). The path must be a file.</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"> :param materialized_content: Same as `content` except `debputy` will put the contents into a physical file</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"> as needed. Cannot be used with `content` or `fs_path`.</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"> :return: An *opaque* object to be passed to `build_virtual_file_system`. While the exact type is provided</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"> to aid with typing, the type name and its behaviour is not part of the API.</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"> """</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><span class="r"></span></p> - <p class="run"><span class="n"><a id="t222" href="#t222">222</a></span><span class="t"> <span class="nam">is_dir</span> <span class="op">=</span> <span class="nam">path_name</span><span class="op">.</span><span class="nam">endswith</span><span class="op">(</span><span class="str">"/"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t223" href="#t223">223</a></span><span class="t"> <span class="nam">is_symlink</span> <span class="op">=</span> <span class="nam">link_target</span> <span class="key">is</span> <span class="key">not</span> <span class="key">None</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><span class="r"></span></p> - <p class="run"><span class="n"><a id="t225" href="#t225">225</a></span><span class="t"> <span class="key">if</span> <span class="nam">is_symlink</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t226" href="#t226">226</a></span><span class="t"> <span class="key">if</span> <span class="nam">mode</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="run"><span class="n"><a id="t227" href="#t227">227</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t228" href="#t228">228</a></span><span class="t"> <span class="str">f'Please do not provide mode for symlinks. Triggered by "{path_name}"'</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="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t230" href="#t230">230</a></span><span class="t"> <span class="key">if</span> <span class="nam">is_dir</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t231" href="#t231">231</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t232" href="#t232">232</a></span><span class="t"> <span class="str">"Path name looks like a directory, but a symlink target was also provided."</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">f' Please remove the trailing slash OR the symlink_target. Triggered by "{path_name}"'</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t235" href="#t235">235</a></span><span class="t"> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t236" href="#t236">236</a></span><span class="t"> <span class="key">if</span> <span class="nam">content</span> <span class="key">and</span> <span class="op">(</span><span class="nam">is_dir</span> <span class="key">or</span> <span class="nam">is_symlink</span><span class="op">)</span><span class="op">:</span> </span><span class="r"><span class="annotate short">236 ↛ 237</span><span class="annotate long">line 236 didn't jump to line 237, because the condition on line 236 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t237" href="#t237">237</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t238" href="#t238">238</a></span><span class="t"> <span class="str">"Content was defined however, the path appears to be a directory a or a symlink"</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">f' Please remove the content, the trailing slash OR the symlink_target. Triggered by "{path_name}"'</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="op">)</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><span class="r"></span></p> - <p class="run"><span class="n"><a id="t242" href="#t242">242</a></span><span class="t"> <span class="key">if</span> <span class="nam">materialized_content</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="par run show_par"><span class="n"><a id="t243" href="#t243">243</a></span><span class="t"> <span class="key">if</span> <span class="nam">content</span> <span class="key">is</span> <span class="key">not</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"><span class="annotate short">243 ↛ 244</span><span class="annotate long">line 243 didn't jump to line 244, because the condition on line 243 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t244" href="#t244">244</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t245" href="#t245">245</a></span><span class="t"> <span class="str">"The materialized_content keyword is mutually exclusive with the content keyword."</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="str">f' Triggered by "{path_name}"'</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="op">)</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t248" href="#t248">248</a></span><span class="t"> <span class="key">if</span> <span class="nam">fs_path</span> <span class="key">is</span> <span class="key">not</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"><span class="annotate short">248 ↛ 249</span><span class="annotate long">line 248 didn't jump to line 249, because the condition on line 248 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t249" href="#t249">249</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t250" href="#t250">250</a></span><span class="t"> <span class="str">"The materialized_content keyword is mutually exclusive with the fs_path keyword."</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">f' Triggered by "{path_name}"'</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t252" href="#t252">252</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t253" href="#t253">253</a></span><span class="t"> <span class="key">return</span> <span class="nam">PathDef</span><span class="op">(</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="nam">path_name</span><span class="op">,</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="nam">mode</span><span class="op">=</span><span class="nam">mode</span><span class="op">,</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="nam">mtime</span><span class="op">=</span><span class="nam">mtime</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t257" href="#t257">257</a></span><span class="t"> <span class="nam">has_fs_path</span><span class="op">=</span><span class="nam">bool</span><span class="op">(</span><span class="nam">fs_path</span><span class="op">)</span> <span class="key">or</span> <span class="nam">materialized_content</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="pln"><span class="n"><a id="t258" href="#t258">258</a></span><span class="t"> <span class="nam">fs_path</span><span class="op">=</span><span class="nam">fs_path</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t259" href="#t259">259</a></span><span class="t"> <span class="nam">link_target</span><span class="op">=</span><span class="nam">link_target</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t260" href="#t260">260</a></span><span class="t"> <span class="nam">content</span><span class="op">=</span><span class="nam">content</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t261" href="#t261">261</a></span><span class="t"> <span class="nam">materialized_content</span><span class="op">=</span><span class="nam">materialized_content</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t262" href="#t262">262</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t263" href="#t263">263</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t264" href="#t264">264</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t265" href="#t265">265</a></span><span class="t"><span class="key">class</span> <span class="nam">PackageProcessingContext</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="str">"""Context for auto-detectors of metadata and package processors (no instantiation)</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t268" href="#t268">268</a></span><span class="t"><span class="str"> This object holds some context related data for the metadata detector or/and package</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t269" href="#t269">269</a></span><span class="t"><span class="str"> processors. It may receive new attributes in the future.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t270" href="#t270">270</a></span><span class="t"><span class="str"> """</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><span class="r"></span></p> - <p class="run"><span class="n"><a id="t272" href="#t272">272</a></span><span class="t"> <span class="nam">__slots__</span> <span class="op">=</span> <span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t273" href="#t273">273</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t274" href="#t274">274</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t275" href="#t275">275</a></span><span class="t"> <span class="key">def</span> <span class="nam">binary_package</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">BinaryPackage</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="str">"""The binary package stanza from `debian/control`"""</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t277" href="#t277">277</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t278" href="#t278">278</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t279" href="#t279">279</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t280" href="#t280">280</a></span><span class="t"> <span class="key">def</span> <span class="nam">binary_package_version</span><span class="op">(</span><span class="nam">self</span><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="pln"><span class="n"><a id="t281" href="#t281">281</a></span><span class="t"> <span class="str">"""The version of the binary package</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><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"> Note this never includes the binNMU version for arch:all packages, but it may for arch:any.</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 class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t285" href="#t285">285</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t286" href="#t286">286</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t287" href="#t287">287</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t288" href="#t288">288</a></span><span class="t"> <span class="key">def</span> <span class="nam">related_udeb_package</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">BinaryPackage</span><span class="op">]</span><span class="op">:</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">"""An udeb related to this binary package (if any)"""</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t290" href="#t290">290</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t291" href="#t291">291</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t292" href="#t292">292</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t293" href="#t293">293</a></span><span class="t"> <span class="key">def</span> <span class="nam">related_udeb_package_version</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Optional</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="t294" href="#t294">294</a></span><span class="t"> <span class="str">"""The version of the related udeb package (if present)</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"> Note this never includes the binNMU version for arch:all packages, but it may for arch:any.</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"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t298" href="#t298">298</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t299" href="#t299">299</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t300" href="#t300">300</a></span><span class="t"> <span class="key">def</span> <span class="nam">accessible_package_roots</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">Tuple</span><span class="op">[</span><span class="nam">BinaryPackage</span><span class="op">,</span> <span class="str">"VirtualPath"</span><span class="op">]</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t301" href="#t301">301</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t302" href="#t302">302</a></span><span class="t"> </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="com"># """The source package stanza from `debian/control`"""</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="com"># source_package: SourcePackage</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t305" href="#t305">305</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t306" href="#t306">306</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t307" href="#t307">307</a></span><span class="t"><span class="key">class</span> <span class="nam">DebputyPluginInitializer</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t308" href="#t308">308</a></span><span class="t"> <span class="nam">__slots__</span> <span class="op">=</span> <span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t309" href="#t309">309</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t310" href="#t310">310</a></span><span class="t"> <span class="key">def</span> <span class="nam">packager_provided_file</span><span class="op">(</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="nam">self</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t312" href="#t312">312</a></span><span class="t"> <span class="nam">stem</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="t313" href="#t313">313</a></span><span class="t"> <span class="nam">installed_path</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="t314" href="#t314">314</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="t315" href="#t315">315</a></span><span class="t"> <span class="nam">default_mode</span><span class="op">:</span> <span class="nam">int</span> <span class="op">=</span> <span class="num">0o0644</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t316" href="#t316">316</a></span><span class="t"> <span class="nam">default_priority</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">int</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="pln"><span class="n"><a id="t317" href="#t317">317</a></span><span class="t"> <span class="nam">allow_name_segment</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">True</span><span class="op">,</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="nam">allow_architecture_segment</span><span class="op">:</span> <span class="nam">bool</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="t319" href="#t319">319</a></span><span class="t"> <span class="nam">post_formatting_rewrite</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">Callable</span><span class="op">[</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">,</span> <span class="nam">str</span><span class="op">]</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="pln"><span class="n"><a id="t320" href="#t320">320</a></span><span class="t"> <span class="nam">packageless_is_fallback_for_all_packages</span><span class="op">:</span> <span class="nam">bool</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="t321" href="#t321">321</a></span><span class="t"> <span class="nam">reservation_only</span><span class="op">:</span> <span class="nam">bool</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="t322" href="#t322">322</a></span><span class="t"> <span class="nam">reference_documentation</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</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="nam">PackagerProvidedFileReferenceDocumentation</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="op">]</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="t325" href="#t325">325</a></span><span class="t"> <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="pln"><span class="n"><a id="t326" href="#t326">326</a></span><span class="t"> <span class="str">"""Register a packager provided file (debian/<pkg>.foo)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t327" href="#t327">327</a></span><span class="t"> </span><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"> Register a packager provided file that debputy should automatically detect and install for the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t329" href="#t329">329</a></span><span class="t"><span class="str"> packager (example `debian/foo.tmpfiles` -> `debian/foo/usr/lib/tmpfiles.d/foo.conf`). A packager</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t330" href="#t330">330</a></span><span class="t"><span class="str"> provided file typically identified by a package prefix and a "stem" and by convention placed</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t331" href="#t331">331</a></span><span class="t"><span class="str"> in the `debian/` directory.</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t333" href="#t333">333</a></span><span class="t"><span class="str"> Like debhelper, debputy also supports the `foo.bar.tmpfiles` variant where the file is to be</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t334" href="#t334">334</a></span><span class="t"><span class="str"> installed into the `foo` package but be named after the `bar` segment rather than the package name.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t335" href="#t335">335</a></span><span class="t"><span class="str"> This feature can be controlled via the `allow_name_segment` parameter.</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t337" href="#t337">337</a></span><span class="t"><span class="str"> :param stem: The "stem" of the file. This would be the `tmpfiles` part of `debian/foo.tmpfiles`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t338" href="#t338">338</a></span><span class="t"><span class="str"> Note that this value must be unique across all registered packager provided files.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t339" href="#t339">339</a></span><span class="t"><span class="str"> :param installed_path: A format string describing where the file should be installed. Would be</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="str"> `/usr/lib/tmpfiles.d/{name}.conf` from the example above.</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t342" href="#t342">342</a></span><span class="t"><span class="str"> The caller should provide a string with one or more of the placeholders listed below (usually `{name}`</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"> should be one of them). The format affect the entire path.</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><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"> The following placeholders are supported:</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"> * `{name}` - The name in the name segment (defaulting the package name if no name segment is given)</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"> * `{priority}` / `{priority:02}` - The priority of the file. Only provided priorities are used (that</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"> is, default_priority is not None). The latter variant ensuring that the priority takes at least</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t349" href="#t349">349</a></span><span class="t"><span class="str"> two characters and the `0` character is left-padded for priorities that takes less than two</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t350" href="#t350">350</a></span><span class="t"><span class="str"> characters.</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"> * `{owning_package}` - The name of the package. Should only be used when `{name}` alone is insufficient.</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"> If you do not want the "name" segment in the first place, use `allow_name_segment=False` instead.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t353" href="#t353">353</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t354" href="#t354">354</a></span><span class="t"><span class="str"> The path is always interpreted as relative to the binary package root.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t355" href="#t355">355</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t356" href="#t356">356</a></span><span class="t"><span class="str"> :param default_mode: The mode the installed file should have by default. Common options are 0o0644 (the default)</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"> or 0o0755 (for files that must be executable).</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"> :param allow_architecture_segment: If True, the file may have an optional "architecture" segment at the end</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.tmpfiles.amd64`), which marks it architecture specific. When False, debputy will detect the</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"> "architecture" segment and report the use as an error. Note the architecture segment is only allowed for</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"> arch:any packages. If a file targeting an arch:all package uses an architecture specific file it will</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"> always result in an error.</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"> :param allow_name_segment: If True, the file may have an optional "name" segment after the package name prefix.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t364" href="#t364">364</a></span><span class="t"><span class="str"> (`foo.<name-here>.tmpfiles`). When False, debputy will detect the "name" segment and report the use as an</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t365" href="#t365">365</a></span><span class="t"><span class="str"> error.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t366" href="#t366">366</a></span><span class="t"><span class="str"> :param default_priority: Special-case option for packager files that are installed into directories that have</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"> "parse ordering" or "priority". These files will generally be installed as something like `20-foo.conf`</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"> where the `20-` denotes their "priority". If the plugin is registering such a file type, then it should</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"> provide a default priority.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t370" href="#t370">370</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t371" href="#t371">371</a></span><span class="t"><span class="str"> The following placeholders are supported:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t372" href="#t372">372</a></span><span class="t"><span class="str"> * `{name}` - The name in the name segment (defaulting the package name if no name segment is given)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t373" href="#t373">373</a></span><span class="t"><span class="str"> * `{priority}` - The priority of the file. Only provided priorities are used (that is, default_priority</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"> is not None)</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"> * `{owning_package}` - The name of the package. Should only be used when `{name}` alone is insufficient.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t376" href="#t376">376</a></span><span class="t"><span class="str"> If you do not want the "name" segment in the first place, use `allow_name_segment=False` instead.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t377" href="#t377">377</a></span><span class="t"><span class="str"> :param post_formatting_rewrite: An optional "name correcting" callback. It receives the formatted name and can</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t378" href="#t378">378</a></span><span class="t"><span class="str"> do any transformation required. The primary use-case for this is to replace "forbidden" characters. The most</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t379" href="#t379">379</a></span><span class="t"><span class="str"> common case for debputy itself is to replace "." with "_" for tools that refuse to work with files containing</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t380" href="#t380">380</a></span><span class="t"><span class="str"> "." (`lambda x: x.replace(".", "_")`). The callback operates on basename of formatted version of the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t381" href="#t381">381</a></span><span class="t"><span class="str"> `installed_path` and the callback should return the basename.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t382" href="#t382">382</a></span><span class="t"><span class="str"> :param packageless_is_fallback_for_all_packages: If True, the packageless variant (such as, `debian/changelog`)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t383" href="#t383">383</a></span><span class="t"><span class="str"> is a fallback for every package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t384" href="#t384">384</a></span><span class="t"><span class="str"> :param reference_documentation: Reference documentation for the packager provided file. Use the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t385" href="#t385">385</a></span><span class="t"><span class="str"> packager_provided_file_reference_documentation function to provide the value for this parameter.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t386" href="#t386">386</a></span><span class="t"><span class="str"> :param reservation_only: When True, tell debputy that the plugin reserves this packager provided file, but that</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t387" href="#t387">387</a></span><span class="t"><span class="str"> debputy should not actually install it automatically. This is useful in the cases, where the plugin</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t388" href="#t388">388</a></span><span class="t"><span class="str"> needs to process the file before installing it. The file will be marked as provided by this plugin. This</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t389" href="#t389">389</a></span><span class="t"><span class="str"> enables introspection and detects conflicts if other plugins attempts to claim the file.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t390" href="#t390">390</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t391" href="#t391">391</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t392" href="#t392">392</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t393" href="#t393">393</a></span><span class="t"> <span class="key">def</span> <span class="nam">metadata_or_maintscript_detector</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t394" href="#t394">394</a></span><span class="t"> <span class="nam">self</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t395" href="#t395">395</a></span><span class="t"> <span class="nam">auto_detector_id</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="t396" href="#t396">396</a></span><span class="t"> <span class="nam">auto_detector</span><span class="op">:</span> <span class="nam">MetadataAutoDetector</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t397" href="#t397">397</a></span><span class="t"> <span class="op">*</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t398" href="#t398">398</a></span><span class="t"> <span class="nam">package_type</span><span class="op">:</span> <span class="nam">PackageTypeSelector</span> <span class="op">=</span> <span class="str">"deb"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t399" href="#t399">399</a></span><span class="t"> <span class="op">)</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="t400" href="#t400">400</a></span><span class="t"> <span class="str">"""Provide a pre-assembly hook that can affect the metadata/maintscript of binary ("deb") packages</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t401" href="#t401">401</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t402" href="#t402">402</a></span><span class="t"><span class="str"> The provided hook will be run once per binary package to be assembled, and it can see all the content</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t403" href="#t403">403</a></span><span class="t"><span class="str"> ("data.tar") planned to be included in the deb. The hook may do any *read-only* analysis of this content</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t404" href="#t404">404</a></span><span class="t"><span class="str"> and provide metadata, alter substvars or inject maintscript snippets. However, the hook must *not*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t405" href="#t405">405</a></span><span class="t"><span class="str"> change the content ("data.tar") part of the deb.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t406" href="#t406">406</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t407" href="#t407">407</a></span><span class="t"><span class="str"> The hook will be run unconditionally for all binary packages built. When the hook does not apply to all</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t408" href="#t408">408</a></span><span class="t"><span class="str"> packages, it must provide its own (internal) logic for detecting whether it is relevant and reduced itself</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t409" href="#t409">409</a></span><span class="t"><span class="str"> to a no-op if it should not apply to the current package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t410" href="#t410">410</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t411" href="#t411">411</a></span><span class="t"><span class="str"> Hooks are run in "some implementation defined order" and should not rely on being run before or after</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t412" href="#t412">412</a></span><span class="t"><span class="str"> any other hook.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t413" href="#t413">413</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t414" href="#t414">414</a></span><span class="t"><span class="str"> The hooks are only applied to packages defined in `debian/control`. Notably, the metadata detector will</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t415" href="#t415">415</a></span><span class="t"><span class="str"> not apply to auto-generated `-dbgsym` packages (as those are not listed explicitly in `debian/control`).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t416" href="#t416">416</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t417" href="#t417">417</a></span><span class="t"><span class="str"> :param auto_detector_id: A plugin-wide unique ID for this detector. Packagers may use this ID for disabling</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t418" href="#t418">418</a></span><span class="t"><span class="str"> the detector and accordingly the ID is part of the plugin's API toward the packager.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t419" href="#t419">419</a></span><span class="t"><span class="str"> :param auto_detector: The code to be called that will be run at the metadata generation state (once for each</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t420" href="#t420">420</a></span><span class="t"><span class="str"> binary package).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t421" href="#t421">421</a></span><span class="t"><span class="str"> :param package_type: Which kind of packages this metadata detector applies to. The package type is generally</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t422" href="#t422">422</a></span><span class="t"><span class="str"> defined by `Package-Type` field in the binary package. The default is to only run for regular `deb` packages</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t423" href="#t423">423</a></span><span class="t"><span class="str"> and ignore `udeb` packages.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t424" href="#t424">424</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t425" href="#t425">425</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t426" href="#t426">426</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t427" href="#t427">427</a></span><span class="t"> <span class="key">def</span> <span class="nam">manifest_variable</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">self</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">variable_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="t430" href="#t430">430</a></span><span class="t"> <span class="nam">value</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="t431" href="#t431">431</a></span><span class="t"> <span class="nam">variable_reference_documentation</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</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="pln"><span class="n"><a id="t432" href="#t432">432</a></span><span class="t"> <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="pln"><span class="n"><a id="t433" href="#t433">433</a></span><span class="t"> <span class="str">"""Provide a variable that can be used in the package manifest</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t434" href="#t434">434</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t435" href="#t435">435</a></span><span class="t"><span class="str"> >>> # Enable users to use "{{path:BASH_COMPLETION_DIR}}/foo" in their manifest.</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 class="str"> >>> api.manifest_variable( # doctest: +SKIP</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t437" href="#t437">437</a></span><span class="t"><span class="str"> ... "path:BASH_COMPLETION_DIR",</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="str"> ... "/usr/share/bash-completion/completions",</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="str"> ... variable_reference_documentation="Directory to install bash completions into",</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="str"> ... )</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t441" href="#t441">441</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t442" href="#t442">442</a></span><span class="t"><span class="str"> :param variable_name: The variable name.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t443" href="#t443">443</a></span><span class="t"><span class="str"> :param value: The value the variable should resolve to.</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"> :param variable_reference_documentation: A short snippet of reference documentation that explains</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"> the purpose of the variable.</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"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t447" href="#t447">447</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t448" href="#t448">448</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t449" href="#t449">449</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t450" href="#t450">450</a></span><span class="t"><span class="key">class</span> <span class="nam">MaintscriptAccessor</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t451" href="#t451">451</a></span><span class="t"> <span class="nam">__slots__</span> <span class="op">=</span> <span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t452" href="#t452">452</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t453" href="#t453">453</a></span><span class="t"> <span class="key">def</span> <span class="nam">on_configure</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t454" href="#t454">454</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="t455" href="#t455">455</a></span><span class="t"> <span class="nam">run_snippet</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="t456" href="#t456">456</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="t457" href="#t457">457</a></span><span class="t"> <span class="nam">indent</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">bool</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="pln"><span class="n"><a id="t458" href="#t458">458</a></span><span class="t"> <span class="nam">perform_substitution</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t459" href="#t459">459</a></span><span class="t"> <span class="nam">skip_on_rollback</span><span class="op">:</span> <span class="nam">bool</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="t460" href="#t460">460</a></span><span class="t"> <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="pln"><span class="n"><a id="t461" href="#t461">461</a></span><span class="t"> <span class="str">"""Provide a snippet to be run when the package is about to be "configured"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t462" href="#t462">462</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t463" href="#t463">463</a></span><span class="t"><span class="str"> This condition is the most common "post install" condition and covers the two</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t464" href="#t464">464</a></span><span class="t"><span class="str"> common cases:</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 class="str"> * On initial install, OR</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t466" href="#t466">466</a></span><span class="t"><span class="str"> * On upgrade</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 class="str"> In dpkg maintscript terms, this method roughly corresponds to postinst containing</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t469" href="#t469">469</a></span><span class="t"><span class="str"> `if [ "$1" = configure ]; then <snippet>; fi`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t470" href="#t470">470</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t471" href="#t471">471</a></span><span class="t"><span class="str"> Additionally, the condition will by default also include rollback/abort scenarios such as "above-remove",</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t472" href="#t472">472</a></span><span class="t"><span class="str"> which is normally what you want but most people forget about.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t473" href="#t473">473</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t474" href="#t474">474</a></span><span class="t"><span class="str"> :param run_snippet: The actual shell snippet to be run in the given condition. The snippet must be idempotent.</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 class="str"> The snippet may contain newlines as necessary, which will make the result more readable. Additionally, the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t476" href="#t476">476</a></span><span class="t"><span class="str"> snippet may contain '{{FOO}}' substitutions by default.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t477" href="#t477">477</a></span><span class="t"><span class="str"> :param skip_on_rollback: By default, this condition will also cover common rollback scenarios. This</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t478" href="#t478">478</a></span><span class="t"><span class="str"> is normally what you want (or benign in most cases due to the idempotence requirement for maintscripts).</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 class="str"> However, you can disable the rollback cases, leaving only "On initial install OR On upgrade".</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t480" href="#t480">480</a></span><span class="t"><span class="str"> :param indent: If True, the provided snippet will be indented to fit the condition provided by debputy.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t481" href="#t481">481</a></span><span class="t"><span class="str"> In most cases, this is safe to do and provides more readable scripts. However, it may cause issues</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t482" href="#t482">482</a></span><span class="t"><span class="str"> with some special shell syntax (such as "Heredocs"). When False, the snippet will *not* be re-indented.</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 class="str"> You are recommended to do 4 spaces of indentation when indent is False for readability.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t484" href="#t484">484</a></span><span class="t"><span class="str"> :param perform_substitution: When True, `{{FOO}}` will be substituted in the snippet. When False, no</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t485" href="#t485">485</a></span><span class="t"><span class="str"> substitution is provided.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t486" href="#t486">486</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t487" href="#t487">487</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="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">on_initial_install</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">self</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">run_snippet</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="t492" href="#t492">492</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="t493" href="#t493">493</a></span><span class="t"> <span class="nam">indent</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">bool</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="pln"><span class="n"><a id="t494" href="#t494">494</a></span><span class="t"> <span class="nam">perform_substitution</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t495" href="#t495">495</a></span><span class="t"> <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="pln"><span class="n"><a id="t496" href="#t496">496</a></span><span class="t"> <span class="str">"""Provide a snippet to be run when the package is about to be "configured" for the first time</span> </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="pln"><span class="n"><a id="t498" href="#t498">498</a></span><span class="t"><span class="str"> The snippet will only be run on the first time the package is installed (ever or since last purge).</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="str"> Note that "first" does not mean "exactly once" as dpkg does *not* provide such semantics. There are two</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="str"> common cases where this can snippet can be run multiple times for the same system (and why the snippet</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="str"> must still be idempotent):</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t503" href="#t503">503</a></span><span class="t"><span class="str"> 1) The package is installed (1), then purged and then installed again (2). This can partly be mitigated</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t504" href="#t504">504</a></span><span class="t"><span class="str"> by having an `on_purge` script to do clean up.</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 class="str"> 2) As the package is installed, the `postinst` script terminates prematurely (Disk full, power loss, etc.).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t507" href="#t507">507</a></span><span class="t"><span class="str"> The user resolves the problem and runs `dpkg --configure <pkg>`, which in turn restarts the script</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="str"> from the beginning. This is why scripts must be idempotent in general.</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t510" href="#t510">510</a></span><span class="t"><span class="str"> In dpkg maintscript terms, this method roughly corresponds to postinst containing</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="str"> `if [ "$1" = configure ] && [ -z "$2" ]; then <snippet>; fi`</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t513" href="#t513">513</a></span><span class="t"><span class="str"> :param run_snippet: The actual shell snippet to be run in the given condition. The snippet must be idempotent.</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="str"> The snippet may contain newlines as necessary, which will make the result more readable. Additionally, the</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="str"> snippet may contain '{{FOO}}' substitutions by default.</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="str"> :param indent: If True, the provided snippet will be indented to fit the condition provided by debputy.</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 class="str"> In most cases, this is safe to do and provides more readable scripts. However, it may cause issues</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t518" href="#t518">518</a></span><span class="t"><span class="str"> with some special shell syntax (such as "Heredocs"). When False, the snippet will *not* be re-indented.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t519" href="#t519">519</a></span><span class="t"><span class="str"> You are recommended to do 4 spaces of indentation when indent is False for readability.</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="str"> :param perform_substitution: When True, `{{FOO}}` will be substituted in the snippet. When False, no</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="str"> substitution is provided.</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="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t523" href="#t523">523</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t524" href="#t524">524</a></span><span class="t"> </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">def</span> <span class="nam">on_upgrade</span><span class="op">(</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 class="nam">self</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t527" href="#t527">527</a></span><span class="t"> <span class="nam">run_snippet</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="t528" href="#t528">528</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="t529" href="#t529">529</a></span><span class="t"> <span class="nam">indent</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">bool</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="pln"><span class="n"><a id="t530" href="#t530">530</a></span><span class="t"> <span class="nam">perform_substitution</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t531" href="#t531">531</a></span><span class="t"> <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="pln"><span class="n"><a id="t532" href="#t532">532</a></span><span class="t"> <span class="str">"""Provide a snippet to be run when the package is about to be "configured" after an upgrade</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t533" href="#t533">533</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t534" href="#t534">534</a></span><span class="t"><span class="str"> The snippet will only be run on any upgrade (that is, it will be skipped on the initial install).</span> </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="pln"><span class="n"><a id="t536" href="#t536">536</a></span><span class="t"><span class="str"> In dpkg maintscript terms, this method roughly corresponds to postinst containing</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t537" href="#t537">537</a></span><span class="t"><span class="str"> `if [ "$1" = configure ] && [ -n "$2" ]; then <snippet>; fi`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t538" href="#t538">538</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t539" href="#t539">539</a></span><span class="t"><span class="str"> :param run_snippet: The actual shell snippet to be run in the given condition. The snippet must be idempotent.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t540" href="#t540">540</a></span><span class="t"><span class="str"> The snippet may contain newlines as necessary, which will make the result more readable. Additionally, the</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 class="str"> snippet may contain '{{FOO}}' substitutions by default.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t542" href="#t542">542</a></span><span class="t"><span class="str"> :param indent: If True, the provided snippet will be indented to fit the condition provided by debputy.</span> </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="str"> In most cases, this is safe to do and provides more readable scripts. However, it may cause issues</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="str"> with some special shell syntax (such as "Heredocs"). When False, the snippet will *not* be re-indented.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t545" href="#t545">545</a></span><span class="t"><span class="str"> You are recommended to do 4 spaces of indentation when indent is False for readability.</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="str"> :param perform_substitution: When True, `{{FOO}}` will be substituted in the snippet. When False, no</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="str"> substitution is provided.</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="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t549" href="#t549">549</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t550" href="#t550">550</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t551" href="#t551">551</a></span><span class="t"> <span class="key">def</span> <span class="nam">on_upgrade_from</span><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 class="nam">self</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t553" href="#t553">553</a></span><span class="t"> <span class="nam">version</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="t554" href="#t554">554</a></span><span class="t"> <span class="nam">run_snippet</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="t555" href="#t555">555</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="t556" href="#t556">556</a></span><span class="t"> <span class="nam">indent</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">bool</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="pln"><span class="n"><a id="t557" href="#t557">557</a></span><span class="t"> <span class="nam">perform_substitution</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">True</span><span class="op">,</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="op">)</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="t559" href="#t559">559</a></span><span class="t"> <span class="str">"""Provide a snippet to be run when the package is about to be "configured" after an upgrade from a given version</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t561" href="#t561">561</a></span><span class="t"><span class="str"> The snippet will only be run on any upgrade (that is, it will be skipped on the initial install).</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t563" href="#t563">563</a></span><span class="t"><span class="str"> In dpkg maintscript terms, this method roughly corresponds to postinst containing</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="str"> `if [ "$1" = configure ] && dpkg --compare-versions le-nl "$2" ; then <snippet>; fi`</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t566" href="#t566">566</a></span><span class="t"><span class="str"> :param version: The version to upgrade from</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="str"> :param run_snippet: The actual shell snippet to be run in the given condition. The snippet must be idempotent.</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="str"> The snippet may contain newlines as necessary, which will make the result more readable. Additionally, the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t569" href="#t569">569</a></span><span class="t"><span class="str"> snippet may contain '{{FOO}}' substitutions by default.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t570" href="#t570">570</a></span><span class="t"><span class="str"> :param indent: If True, the provided snippet will be indented to fit the condition provided by debputy.</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 class="str"> In most cases, this is safe to do and provides more readable scripts. However, it may cause issues</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t572" href="#t572">572</a></span><span class="t"><span class="str"> with some special shell syntax (such as "Heredocs"). When False, the snippet will *not* be re-indented.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t573" href="#t573">573</a></span><span class="t"><span class="str"> You are recommended to do 4 spaces of indentation when indent is False for readability.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t574" href="#t574">574</a></span><span class="t"><span class="str"> :param perform_substitution: When True, `{{FOO}}` will be substituted in the snippet. When False, no</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="str"> substitution is provided.</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="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t577" href="#t577">577</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t578" href="#t578">578</a></span><span class="t"> </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="key">def</span> <span class="nam">on_before_removal</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t580" href="#t580">580</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="t581" href="#t581">581</a></span><span class="t"> <span class="nam">run_snippet</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="t582" href="#t582">582</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="t583" href="#t583">583</a></span><span class="t"> <span class="nam">indent</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">bool</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="pln"><span class="n"><a id="t584" href="#t584">584</a></span><span class="t"> <span class="nam">perform_substitution</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">True</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="op">)</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="t586" href="#t586">586</a></span><span class="t"> <span class="str">"""Provide a snippet to be run when the package is about to be removed</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t587" href="#t587">587</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t588" href="#t588">588</a></span><span class="t"><span class="str"> The snippet will be run before dpkg removes any files.</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t590" href="#t590">590</a></span><span class="t"><span class="str"> In dpkg maintscript terms, this method roughly corresponds to prerm containing</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 class="str"> `if [ "$1" = remove ] ; then <snippet>; fi`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t592" href="#t592">592</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t593" href="#t593">593</a></span><span class="t"><span class="str"> :param run_snippet: The actual shell snippet to be run in the given condition. The snippet must be idempotent.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t594" href="#t594">594</a></span><span class="t"><span class="str"> The snippet may contain newlines as necessary, which will make the result more readable. Additionally, the</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"> snippet may contain '{{FOO}}' substitutions by default.</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"> :param indent: If True, the provided snippet will be indented to fit the condition provided by debputy.</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="str"> In most cases, this is safe to do and provides more readable scripts. However, it may cause issues</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t598" href="#t598">598</a></span><span class="t"><span class="str"> with some special shell syntax (such as "Heredocs"). When False, the snippet will *not* be re-indented.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t599" href="#t599">599</a></span><span class="t"><span class="str"> You are recommended to do 4 spaces of indentation when indent is False for readability.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t600" href="#t600">600</a></span><span class="t"><span class="str"> :param perform_substitution: When True, `{{FOO}}` will be substituted in the snippet. When False, no</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"> substitution is provided.</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"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t603" href="#t603">603</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t604" href="#t604">604</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t605" href="#t605">605</a></span><span class="t"> <span class="key">def</span> <span class="nam">on_removed</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t606" href="#t606">606</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="t607" href="#t607">607</a></span><span class="t"> <span class="nam">run_snippet</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="t608" href="#t608">608</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="t609" href="#t609">609</a></span><span class="t"> <span class="nam">indent</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">bool</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="pln"><span class="n"><a id="t610" href="#t610">610</a></span><span class="t"> <span class="nam">perform_substitution</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">True</span><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="op">)</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="t612" href="#t612">612</a></span><span class="t"> <span class="str">"""Provide a snippet to be run when the package has been removed</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t613" href="#t613">613</a></span><span class="t"> </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"> The snippet will be run after dpkg removes the package content from the file system.</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t616" href="#t616">616</a></span><span class="t"><span class="str"> **WARNING**: The snippet *cannot* rely on dependencies and must rely on `Essential: yes` packages.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t617" href="#t617">617</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t618" href="#t618">618</a></span><span class="t"><span class="str"> In dpkg maintscript terms, this method roughly corresponds to postrm containing</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t619" href="#t619">619</a></span><span class="t"><span class="str"> `if [ "$1" = remove ] ; then <snippet>; fi`</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><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"> :param run_snippet: The actual shell snippet to be run in the given condition. The snippet must be idempotent.</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="str"> The snippet may contain newlines as necessary, which will make the result more readable. Additionally, the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t623" href="#t623">623</a></span><span class="t"><span class="str"> snippet may contain '{{FOO}}' substitutions by default.</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="str"> :param indent: If True, the provided snippet will be indented to fit the condition provided by debputy.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t625" href="#t625">625</a></span><span class="t"><span class="str"> In most cases, this is safe to do and provides more readable scripts. However, it may cause issues</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t626" href="#t626">626</a></span><span class="t"><span class="str"> with some special shell syntax (such as "Heredocs"). When False, the snippet will *not* be re-indented.</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="str"> You are recommended to do 4 spaces of indentation when indent is False for readability.</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="str"> :param perform_substitution: When True, `{{FOO}}` will be substituted in the snippet. When False, no</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="str"> substitution is provided.</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="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t631" href="#t631">631</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t632" href="#t632">632</a></span><span class="t"> </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="key">def</span> <span class="nam">on_purge</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 class="nam">self</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t635" href="#t635">635</a></span><span class="t"> <span class="nam">run_snippet</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="t636" href="#t636">636</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="t637" href="#t637">637</a></span><span class="t"> <span class="nam">indent</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">bool</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="pln"><span class="n"><a id="t638" href="#t638">638</a></span><span class="t"> <span class="nam">perform_substitution</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">True</span><span class="op">,</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="op">)</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="t640" href="#t640">640</a></span><span class="t"> <span class="str">"""Provide a snippet to be run when the package is being purged.</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t642" href="#t642">642</a></span><span class="t"><span class="str"> The snippet will when the package is purged from the system.</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><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"> **WARNING**: The snippet *cannot* rely on dependencies and must rely on `Essential: yes` packages.</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t646" href="#t646">646</a></span><span class="t"><span class="str"> In dpkg maintscript terms, this method roughly corresponds to postrm containing</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t647" href="#t647">647</a></span><span class="t"><span class="str"> `if [ "$1" = purge ] ; then <snippet>; fi`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t648" href="#t648">648</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t649" href="#t649">649</a></span><span class="t"><span class="str"> :param run_snippet: The actual shell snippet to be run in the given condition. The snippet must be idempotent.</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="str"> The snippet may contain newlines as necessary, which will make the result more readable. Additionally, 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="str"> snippet may contain '{{FOO}}' substitutions by default.</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="str"> :param indent: If True, the provided snippet will be indented to fit the condition provided by debputy.</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="str"> In most cases, this is safe to do and provides more readable scripts. However, it may cause issues</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="str"> with some special shell syntax (such as "Heredocs"). When False, the snippet will *not* be re-indented.</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="str"> You are recommended to do 4 spaces of indentation when indent is False for readability.</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="str"> :param perform_substitution: When True, `{{FOO}}` will be substituted in the snippet. When False, no</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="str"> substitution is provided.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t658" href="#t658">658</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t659" href="#t659">659</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t660" href="#t660">660</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t661" href="#t661">661</a></span><span class="t"> <span class="key">def</span> <span class="nam">unconditionally_in_script</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t662" href="#t662">662</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="t663" href="#t663">663</a></span><span class="t"> <span class="nam">maintscript</span><span class="op">:</span> <span class="nam">Maintscript</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t664" href="#t664">664</a></span><span class="t"> <span class="nam">run_snippet</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="t665" href="#t665">665</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="t666" href="#t666">666</a></span><span class="t"> <span class="nam">perform_substitution</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">True</span><span class="op">,</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 class="key">None</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="str">"""Provide a snippet to be run in a given script</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t670" href="#t670">670</a></span><span class="t"><span class="str"> Run a given snippet unconditionally from a given script. The snippet must contain its own conditional</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t671" href="#t671">671</a></span><span class="t"><span class="str"> for when it should be run.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t672" href="#t672">672</a></span><span class="t"> </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="str"> :param maintscript: The maintscript to insert the snippet into.</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="str"> :param run_snippet: The actual shell snippet to be run. The snippet will be run unconditionally and should</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="str"> contain its own conditions as necessary. The snippet must be idempotent. The snippet may contain newlines</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t676" href="#t676">676</a></span><span class="t"><span class="str"> as necessary, which will make the result more readable. Additionally, the snippet may contain '{{FOO}}'</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t677" href="#t677">677</a></span><span class="t"><span class="str"> substitutions by default.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t678" href="#t678">678</a></span><span class="t"><span class="str"> :param perform_substitution: When True, `{{FOO}}` will be substituted in the snippet. When False, no</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t679" href="#t679">679</a></span><span class="t"><span class="str"> substitution is provided.</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 class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t681" href="#t681">681</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t682" href="#t682">682</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t683" href="#t683">683</a></span><span class="t"> <span class="key">def</span> <span class="nam">escape_shell_words</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="op">*</span><span class="nam">args</span><span class="op">:</span> <span class="nam">str</span><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="pln"><span class="n"><a id="t684" href="#t684">684</a></span><span class="t"> <span class="str">"""Provide sh-shell escape of strings</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t686" href="#t686">686</a></span><span class="t"><span class="str"> `assert escape_shell("foo", "fu bar", "baz") == 'foo "fu bar" baz'`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t687" href="#t687">687</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t688" href="#t688">688</a></span><span class="t"><span class="str"> This is useful for ensuring file names and other "input" are considered one parameter even when they</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"> contain spaces or shell meta-characters.</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t691" href="#t691">691</a></span><span class="t"><span class="str"> :param args: The string(s) to be escaped.</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 class="str"> :return: Each argument escaped such that each argument becomes a single "word" and then all these words are</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t693" href="#t693">693</a></span><span class="t"><span class="str"> joined by a single space.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t694" href="#t694">694</a></span><span class="t"><span class="str"> """</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">return</span> <span class="nam">util</span><span class="op">.</span><span class="nam">escape_shell</span><span class="op">(</span><span class="op">*</span><span class="nam">args</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t696" href="#t696">696</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t697" href="#t697">697</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t698" href="#t698">698</a></span><span class="t"><span class="key">class</span> <span class="nam">BinaryCtrlAccessor</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t699" href="#t699">699</a></span><span class="t"> <span class="nam">__slots__</span> <span class="op">=</span> <span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t700" href="#t700">700</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t701" href="#t701">701</a></span><span class="t"> <span class="key">def</span> <span class="nam">dpkg_trigger</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">trigger_type</span><span class="op">:</span> <span class="nam">DpkgTriggerType</span><span class="op">,</span> <span class="nam">trigger_target</span><span class="op">:</span> <span class="nam">str</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="pln"><span class="n"><a id="t702" href="#t702">702</a></span><span class="t"> <span class="str">"""Register a declarative dpkg level trigger</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><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t704" href="#t704">704</a></span><span class="t"><span class="str"> The provided trigger will be added to the package's metadata (the triggers file of the control.tar).</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="pln"><span class="n"><a id="t706" href="#t706">706</a></span><span class="t"><span class="str"> If the trigger has already been added previously, a second call with the same trigger data will be ignored.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t707" href="#t707">707</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t708" href="#t708">708</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t709" href="#t709">709</a></span><span class="t"> </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="op">@</span><span class="nam">property</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="key">def</span> <span class="nam">maintscript</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">MaintscriptAccessor</span><span class="op">:</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="str">"""Attribute for manipulating maintscripts"""</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t713" href="#t713">713</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t714" href="#t714">714</a></span><span class="t"> </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="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t716" href="#t716">716</a></span><span class="t"> <span class="key">def</span> <span class="nam">substvars</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="str">"FlushableSubstvars"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t717" href="#t717">717</a></span><span class="t"> <span class="str">"""Attribute for manipulating dpkg substvars (deb-substvars)"""</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t718" href="#t718">718</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t719" href="#t719">719</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t720" href="#t720">720</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t721" href="#t721">721</a></span><span class="t"><span class="key">class</span> <span class="nam">VirtualPath</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t722" href="#t722">722</a></span><span class="t"> <span class="nam">__slots__</span> <span class="op">=</span> <span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t723" href="#t723">723</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t724" href="#t724">724</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t725" href="#t725">725</a></span><span class="t"> <span class="key">def</span> <span class="nam">name</span><span class="op">(</span><span class="nam">self</span><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="pln"><span class="n"><a id="t726" href="#t726">726</a></span><span class="t"> <span class="str">"""Basename of the path a.k.a. last segment of the path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t727" href="#t727">727</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t728" href="#t728">728</a></span><span class="t"><span class="str"> In a path "usr/share/doc/pkg/changelog.gz" the basename is "changelog.gz".</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t729" href="#t729">729</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t730" href="#t730">730</a></span><span class="t"><span class="str"> For a directory, the basename *never* ends with a `/`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t731" href="#t731">731</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t732" href="#t732">732</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t733" href="#t733">733</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t734" href="#t734">734</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t735" href="#t735">735</a></span><span class="t"> <span class="key">def</span> <span class="nam">iterdir</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="str">"VirtualPath"</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t736" href="#t736">736</a></span><span class="t"> <span class="str">"""Returns an iterable that iterates over all children of this path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t737" href="#t737">737</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t738" href="#t738">738</a></span><span class="t"><span class="str"> For directories, this returns an iterable of all children. For non-directories,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t739" href="#t739">739</a></span><span class="t"><span class="str"> the iterable is always empty.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t740" href="#t740">740</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t741" href="#t741">741</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t742" href="#t742">742</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t743" href="#t743">743</a></span><span class="t"> <span class="key">def</span> <span class="nam">lookup</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">path</span><span class="op">:</span> <span class="nam">str</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Optional</span><span class="op">[</span><span class="str">"VirtualPath"</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t744" href="#t744">744</a></span><span class="t"> <span class="str">"""Perform a path lookup relative to this path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t745" href="#t745">745</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t746" href="#t746">746</a></span><span class="t"><span class="str"> As an example `doc_dir = fs_root.lookup('./usr/share/doc')`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t747" href="#t747">747</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t748" href="#t748">748</a></span><span class="t"><span class="str"> If the provided path starts with `/`, then the lookup is performed relative to the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t749" href="#t749">749</a></span><span class="t"><span class="str"> file system root. That is, you can assume the following to always be True:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t750" href="#t750">750</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t751" href="#t751">751</a></span><span class="t"><span class="str"> `fs_root.lookup("usr") == any_path_beneath_fs_root.lookup('/usr')`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t752" href="#t752">752</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t753" href="#t753">753</a></span><span class="t"><span class="str"> Note: This method requires the path to be attached (see `is_detached`) regardless of</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t754" href="#t754">754</a></span><span class="t"><span class="str"> whether the lookup is relative or absolute.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t755" href="#t755">755</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t756" href="#t756">756</a></span><span class="t"><span class="str"> If the path traverse a symlink, the symlink will be resolved.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t757" href="#t757">757</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t758" href="#t758">758</a></span><span class="t"><span class="str"> :param path: The path to look. Can contain "." and ".." segments. If starting with `/`,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t759" href="#t759">759</a></span><span class="t"><span class="str"> look up is performed relative to the file system root, otherwise the lookup is relative</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t760" href="#t760">760</a></span><span class="t"><span class="str"> to this path.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t761" href="#t761">761</a></span><span class="t"><span class="str"> :return: The path object for the desired path if it can be found. Otherwise, None.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t762" href="#t762">762</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t763" href="#t763">763</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t764" href="#t764">764</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t765" href="#t765">765</a></span><span class="t"> <span class="key">def</span> <span class="nam">all_paths</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="str">"VirtualPath"</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t766" href="#t766">766</a></span><span class="t"> <span class="str">"""Iterate over this path and all of its descendants (if any)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t767" href="#t767">767</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t768" href="#t768">768</a></span><span class="t"><span class="str"> If used on the root path, then every path in the package is returned.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t769" href="#t769">769</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t770" href="#t770">770</a></span><span class="t"><span class="str"> The iterable is ordered, so using the order in output will be produce</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t771" href="#t771">771</a></span><span class="t"><span class="str"> bit-for-bit reproducible output. Additionally, a directory will always</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t772" href="#t772">772</a></span><span class="t"><span class="str"> be seen before its descendants. Otherwise, the order is implementation</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t773" href="#t773">773</a></span><span class="t"><span class="str"> defined.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t774" href="#t774">774</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t775" href="#t775">775</a></span><span class="t"><span class="str"> The iteration is lazy and as a side effect do account for some obvious</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t776" href="#t776">776</a></span><span class="t"><span class="str"> mutation. Like if the current path is removed, then none of its children</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t777" href="#t777">777</a></span><span class="t"><span class="str"> will be returned (provided mutation happens before the lazy iteration</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t778" href="#t778">778</a></span><span class="t"><span class="str"> was required to resolve it). Likewise, mutation of the directory will</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t779" href="#t779">779</a></span><span class="t"><span class="str"> also work (again, provided mutation happens before the lazy iteration order).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t780" href="#t780">780</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t781" href="#t781">781</a></span><span class="t"><span class="str"> :return: An ordered iterable of this path followed by its descendants.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t782" href="#t782">782</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t783" href="#t783">783</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t784" href="#t784">784</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t785" href="#t785">785</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t786" href="#t786">786</a></span><span class="t"> <span class="key">def</span> <span class="nam">is_detached</span><span class="op">(</span><span class="nam">self</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="pln"><span class="n"><a id="t787" href="#t787">787</a></span><span class="t"> <span class="str">"""Returns True if this path is detached</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t788" href="#t788">788</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t789" href="#t789">789</a></span><span class="t"><span class="str"> Paths that are detached from the file system will not be present in the package and</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t790" href="#t790">790</a></span><span class="t"><span class="str"> most operations are unsafe on them. This usually only happens if the path or one of</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t791" href="#t791">791</a></span><span class="t"><span class="str"> its parent directories are unlinked (rm'ed) from the file system tree.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t792" href="#t792">792</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t793" href="#t793">793</a></span><span class="t"><span class="str"> All paths are attached by default and will only become detached as a result of</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t794" href="#t794">794</a></span><span class="t"><span class="str"> an action to mutate the virtual file system. Note that the file system may not</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t795" href="#t795">795</a></span><span class="t"><span class="str"> always be manipulated.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t796" href="#t796">796</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t797" href="#t797">797</a></span><span class="t"><span class="str"> :return: True if the entry is detached. Detached entries should be discarded, so they</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t798" href="#t798">798</a></span><span class="t"><span class="str"> can be garbage collected.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t799" href="#t799">799</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t800" href="#t800">800</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t801" href="#t801">801</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t802" href="#t802">802</a></span><span class="t"> <span class="com"># The __getitem__ behaves like __getitem__ from Dict but __iter__ would ideally work like a Sequence.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t803" href="#t803">803</a></span><span class="t"> <span class="com"># However, that does not feel compatible, so lets force people to use .children instead for the Sequence</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t804" href="#t804">804</a></span><span class="t"> <span class="com"># behaviour to avoid surprises for now.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t805" href="#t805">805</a></span><span class="t"> <span class="com"># (Maybe it is a non-issue, but it is easier to add the API later than to remove it once we have committed</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t806" href="#t806">806</a></span><span class="t"> <span class="com"># to using it)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t807" href="#t807">807</a></span><span class="t"> <span class="nam">__iter__</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t808" href="#t808">808</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t809" href="#t809">809</a></span><span class="t"> <span class="key">def</span> <span class="nam">__getitem__</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">key</span><span class="op">:</span> <span class="nam">object</span><span class="op">)</span> <span class="op">-></span> <span class="str">"VirtualPath"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t810" href="#t810">810</a></span><span class="t"> <span class="str">"""Lookup a (direct) child by name</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t811" href="#t811">811</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t812" href="#t812">812</a></span><span class="t"><span class="str"> Ignoring the possible `KeyError`, then the following are the same:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t813" href="#t813">813</a></span><span class="t"><span class="str"> `fs_root["usr"] == fs_root.lookup('usr')`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t814" href="#t814">814</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t815" href="#t815">815</a></span><span class="t"><span class="str"> Note that unlike `.lookup` this can only locate direct children.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t816" href="#t816">816</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t817" href="#t817">817</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t818" href="#t818">818</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t819" href="#t819">819</a></span><span class="t"> <span class="key">def</span> <span class="nam">__delitem__</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">key</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="pln"><span class="n"><a id="t820" href="#t820">820</a></span><span class="t"> <span class="str">"""Remove a child from this node if it exists</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t821" href="#t821">821</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t822" href="#t822">822</a></span><span class="t"><span class="str"> If that child is a directory, then the entire tree is removed (like `rm -fr`).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t823" href="#t823">823</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t824" href="#t824">824</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t825" href="#t825">825</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t826" href="#t826">826</a></span><span class="t"> <span class="key">def</span> <span class="nam">get</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">key</span><span class="op">:</span> <span class="nam">str</span><span class="op">)</span> <span class="op">-></span> <span class="str">"Optional[VirtualPath]"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t827" href="#t827">827</a></span><span class="t"> <span class="str">"""Lookup a (direct) child by name</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t828" href="#t828">828</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t829" href="#t829">829</a></span><span class="t"><span class="str"> The following are the same:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t830" href="#t830">830</a></span><span class="t"><span class="str"> `fs_root.get("usr") == fs_root.lookup('usr')`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t831" href="#t831">831</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t832" href="#t832">832</a></span><span class="t"><span class="str"> Note that unlike `.lookup` this can only locate direct children.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t833" href="#t833">833</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t834" href="#t834">834</a></span><span class="t"> <span class="key">try</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t835" href="#t835">835</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">[</span><span class="nam">key</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t836" href="#t836">836</a></span><span class="t"> <span class="key">except</span> <span class="nam">KeyError</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t837" href="#t837">837</a></span><span class="t"> <span class="key">return</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t838" href="#t838">838</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t839" href="#t839">839</a></span><span class="t"> <span class="key">def</span> <span class="nam">__contains__</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">item</span><span class="op">:</span> <span class="nam">object</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="pln"><span class="n"><a id="t840" href="#t840">840</a></span><span class="t"> <span class="str">"""Determine if this path includes a given child (either by object or string)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t841" href="#t841">841</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t842" href="#t842">842</a></span><span class="t"><span class="str"> Examples:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t843" href="#t843">843</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t844" href="#t844">844</a></span><span class="t"><span class="str"> if 'foo' in dir: ...</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t845" href="#t845">845</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t846" href="#t846">846</a></span><span class="t"> <span class="key">if</span> <span class="nam">isinstance</span><span class="op">(</span><span class="nam">item</span><span class="op">,</span> <span class="nam">VirtualPath</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="t847" href="#t847">847</a></span><span class="t"> <span class="key">return</span> <span class="nam">item</span><span class="op">.</span><span class="nam">parent_dir</span> <span class="key">is</span> <span class="nam">self</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t848" href="#t848">848</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">isinstance</span><span class="op">(</span><span class="nam">item</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="mis show_mis"><span class="n"><a id="t849" href="#t849">849</a></span><span class="t"> <span class="key">return</span> <span class="key">False</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t850" href="#t850">850</a></span><span class="t"> <span class="nam">m</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="nam">item</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t851" href="#t851">851</a></span><span class="t"> <span class="key">return</span> <span class="nam">m</span> <span class="key">is</span> <span class="key">not</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t852" href="#t852">852</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t853" href="#t853">853</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t854" href="#t854">854</a></span><span class="t"> <span class="key">def</span> <span class="nam">path</span><span class="op">(</span><span class="nam">self</span><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="pln"><span class="n"><a id="t855" href="#t855">855</a></span><span class="t"> <span class="str">"""Returns the "full" path for this file system entry</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t856" href="#t856">856</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t857" href="#t857">857</a></span><span class="t"><span class="str"> This is the path that debputy uses to refer to this file system entry. It is always</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t858" href="#t858">858</a></span><span class="t"><span class="str"> normalized. Use the `absolute` attribute for how the path looks</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t859" href="#t859">859</a></span><span class="t"><span class="str"> when the package is installed. Alternatively, there is also `fs_path`, which is the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t860" href="#t860">860</a></span><span class="t"><span class="str"> path to the underlying file system object (assuming there is one). That is the one</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t861" href="#t861">861</a></span><span class="t"><span class="str"> you need if you want to read the file.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t862" href="#t862">862</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t863" href="#t863">863</a></span><span class="t"><span class="str"> This is attribute is mostly useful for debugging or for looking up the path relative</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t864" href="#t864">864</a></span><span class="t"><span class="str"> to the "root" of the virtual file system that debputy maintains.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t865" href="#t865">865</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t866" href="#t866">866</a></span><span class="t"><span class="str"> If the path is detached (see `is_detached`), then this method returns the path as it</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t867" href="#t867">867</a></span><span class="t"><span class="str"> was known prior to being detached.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t868" href="#t868">868</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t869" href="#t869">869</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t870" href="#t870">870</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t871" href="#t871">871</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t872" href="#t872">872</a></span><span class="t"> <span class="key">def</span> <span class="nam">absolute</span><span class="op">(</span><span class="nam">self</span><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="pln"><span class="n"><a id="t873" href="#t873">873</a></span><span class="t"> <span class="str">"""Returns the absolute version of this path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t874" href="#t874">874</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t875" href="#t875">875</a></span><span class="t"><span class="str"> This is how to refer to this path when the package is installed.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t876" href="#t876">876</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t877" href="#t877">877</a></span><span class="t"><span class="str"> If the path is detached (see `is_detached`), then this method returns the last known location</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t878" href="#t878">878</a></span><span class="t"><span class="str"> of installation (prior to being detached).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t879" href="#t879">879</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t880" href="#t880">880</a></span><span class="t"><span class="str"> :return: The absolute path of this file as it would be on the installed system.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t881" href="#t881">881</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t882" href="#t882">882</a></span><span class="t"> <span class="nam">p</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">path</span><span class="op">.</span><span class="nam">lstrip</span><span class="op">(</span><span class="str">"."</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t883" href="#t883">883</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">p</span><span class="op">.</span><span class="nam">startswith</span><span class="op">(</span><span class="str">"/"</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t884" href="#t884">884</a></span><span class="t"> <span class="key">return</span> <span class="str">f"/{p}"</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t885" href="#t885">885</a></span><span class="t"> <span class="key">return</span> <span class="nam">p</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t886" href="#t886">886</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t887" href="#t887">887</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t888" href="#t888">888</a></span><span class="t"> <span class="key">def</span> <span class="nam">parent_dir</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Optional</span><span class="op">[</span><span class="str">"VirtualPath"</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t889" href="#t889">889</a></span><span class="t"> <span class="str">"""The parent directory of this path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t890" href="#t890">890</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t891" href="#t891">891</a></span><span class="t"><span class="str"> Note this operation requires the path is "attached" (see `is_detached`). All paths are attached</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t892" href="#t892">892</a></span><span class="t"><span class="str"> by default but unlinking paths will cause them to become detached.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t893" href="#t893">893</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t894" href="#t894">894</a></span><span class="t"><span class="str"> :return: The parent path or None for the root.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t895" href="#t895">895</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t896" href="#t896">896</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t897" href="#t897">897</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t898" href="#t898">898</a></span><span class="t"> <span class="key">def</span> <span class="nam">stat</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">os</span><span class="op">.</span><span class="nam">stat_result</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t899" href="#t899">899</a></span><span class="t"> <span class="str">"""Attempt to do stat of the underlying path (if it exists)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t900" href="#t900">900</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t901" href="#t901">901</a></span><span class="t"><span class="str"> *Avoid* using `stat()` whenever possible where a more specialized attribute exist. The</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t902" href="#t902">902</a></span><span class="t"><span class="str"> `stat()` call returns the data from the file system and often, `debputy` does *not* track</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t903" href="#t903">903</a></span><span class="t"><span class="str"> its state in the file system. As an example, if you want to know the file system mode of</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t904" href="#t904">904</a></span><span class="t"><span class="str"> a path, please use the `mode` attribute instead.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t905" href="#t905">905</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t906" href="#t906">906</a></span><span class="t"><span class="str"> This never follow symlinks (it behaves like `os.lstat`). It will raise an error</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t907" href="#t907">907</a></span><span class="t"><span class="str"> if the path is not backed by a file system object (that is, `has_fs_path` is False).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t908" href="#t908">908</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t909" href="#t909">909</a></span><span class="t"><span class="str"> :return: The stat result or an error.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t910" href="#t910">910</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t911" href="#t911">911</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t912" href="#t912">912</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t913" href="#t913">913</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t914" href="#t914">914</a></span><span class="t"> <span class="key">def</span> <span class="nam">size</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">int</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t915" href="#t915">915</a></span><span class="t"> <span class="str">"""Resolve the file size (`st_size`)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t916" href="#t916">916</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t917" href="#t917">917</a></span><span class="t"><span class="str"> This may be using `stat()` and therefore `fs_path`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t918" href="#t918">918</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t919" href="#t919">919</a></span><span class="t"><span class="str"> :return: The size of the file in bytes</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t920" href="#t920">920</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t921" href="#t921">921</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">stat</span><span class="op">(</span><span class="op">)</span><span class="op">.</span><span class="nam">st_size</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t922" href="#t922">922</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t923" href="#t923">923</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t924" href="#t924">924</a></span><span class="t"> <span class="key">def</span> <span class="nam">mode</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">int</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t925" href="#t925">925</a></span><span class="t"> <span class="str">"""Determine the mode bits of this path object</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t926" href="#t926">926</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t927" href="#t927">927</a></span><span class="t"><span class="str"> Note that:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t928" href="#t928">928</a></span><span class="t"><span class="str"> * like with `stat` above, this never follows symlinks.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t929" href="#t929">929</a></span><span class="t"><span class="str"> * the mode returned by this method is not always a 1:1 with the mode in the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t930" href="#t930">930</a></span><span class="t"><span class="str"> physical file system. As an optimization, `debputy` skips unnecessary writes</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t931" href="#t931">931</a></span><span class="t"><span class="str"> to the underlying file system in many cases.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t932" href="#t932">932</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t933" href="#t933">933</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t934" href="#t934">934</a></span><span class="t"><span class="str"> :return: The mode bits for the path.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t935" href="#t935">935</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t936" href="#t936">936</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t937" href="#t937">937</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t938" href="#t938">938</a></span><span class="t"> <span class="op">@</span><span class="nam">mode</span><span class="op">.</span><span class="nam">setter</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t939" href="#t939">939</a></span><span class="t"> <span class="key">def</span> <span class="nam">mode</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">new_mode</span><span class="op">:</span> <span class="nam">int</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="pln"><span class="n"><a id="t940" href="#t940">940</a></span><span class="t"> <span class="str">"""Set the octal file mode of this path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t941" href="#t941">941</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t942" href="#t942">942</a></span><span class="t"><span class="str"> Note that:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t943" href="#t943">943</a></span><span class="t"><span class="str"> * this operation will fail if `path.is_read_write` returns False.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t944" href="#t944">944</a></span><span class="t"><span class="str"> * this operation is generally *not* synced to the physical file system (as</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t945" href="#t945">945</a></span><span class="t"><span class="str"> an optimization).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t946" href="#t946">946</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t947" href="#t947">947</a></span><span class="t"><span class="str"> :param new_mode: The new octal mode for this path. Note that `debputy` insists</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t948" href="#t948">948</a></span><span class="t"><span class="str"> that all paths have the `user read bit` and, for directories also, the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t949" href="#t949">949</a></span><span class="t"><span class="str"> `user execute bit`. The absence of these minimal mode bits causes hard to</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t950" href="#t950">950</a></span><span class="t"><span class="str"> debug errors.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t951" href="#t951">951</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t952" href="#t952">952</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t953" href="#t953">953</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t954" href="#t954">954</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t955" href="#t955">955</a></span><span class="t"> <span class="key">def</span> <span class="nam">is_executable</span><span class="op">(</span><span class="nam">self</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="pln"><span class="n"><a id="t956" href="#t956">956</a></span><span class="t"> <span class="str">"""Determine whether a path is considered executable</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t957" href="#t957">957</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t958" href="#t958">958</a></span><span class="t"><span class="str"> Generally, this means that at least one executable bit is set. This will</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t959" href="#t959">959</a></span><span class="t"><span class="str"> basically always be true for directories as directories need the execute</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t960" href="#t960">960</a></span><span class="t"><span class="str"> parameter to be traversable.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t961" href="#t961">961</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t962" href="#t962">962</a></span><span class="t"><span class="str"> :return: True if the path is considered executable with its current mode</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t963" href="#t963">963</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t964" href="#t964">964</a></span><span class="t"> <span class="key">return</span> <span class="nam">bool</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">mode</span> <span class="op">&</span> <span class="num">0o0111</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t965" href="#t965">965</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t966" href="#t966">966</a></span><span class="t"> <span class="key">def</span> <span class="nam">chmod</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">new_mode</span><span class="op">:</span> <span class="nam">Union</span><span class="op">[</span><span class="nam">int</span><span class="op">,</span> <span class="nam">str</span><span class="op">]</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="pln"><span class="n"><a id="t967" href="#t967">967</a></span><span class="t"> <span class="str">"""Set the file mode of this path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t968" href="#t968">968</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t969" href="#t969">969</a></span><span class="t"><span class="str"> This is similar to setting the `mode` attribute. However, this method accepts</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t970" href="#t970">970</a></span><span class="t"><span class="str"> a string argument, which will be parsed as a symbolic mode (example: `u+rX,go=rX`).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t971" href="#t971">971</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t972" href="#t972">972</a></span><span class="t"><span class="str"> Note that:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t973" href="#t973">973</a></span><span class="t"><span class="str"> * this operation will fail if `path.is_read_write` returns False.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t974" href="#t974">974</a></span><span class="t"><span class="str"> * this operation is generally *not* synced to the physical file system (as</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t975" href="#t975">975</a></span><span class="t"><span class="str"> an optimization).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t976" href="#t976">976</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t977" href="#t977">977</a></span><span class="t"><span class="str"> :param new_mode: The new mode for this path.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t978" href="#t978">978</a></span><span class="t"><span class="str"> Note that `debputy` insists that all paths have the `user read bit` and, for</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t979" href="#t979">979</a></span><span class="t"><span class="str"> directories also, the `user execute bit`. The absence of these minimal mode</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t980" href="#t980">980</a></span><span class="t"><span class="str"> bits causes hard to debug errors.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t981" href="#t981">981</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t982" href="#t982">982</a></span><span class="t"> <span class="key">if</span> <span class="nam">isinstance</span><span class="op">(</span><span class="nam">new_mode</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="mis show_mis"><span class="n"><a id="t983" href="#t983">983</a></span><span class="t"> <span class="nam">segments</span> <span class="op">=</span> <span class="nam">parse_symbolic_mode</span><span class="op">(</span><span class="nam">new_mode</span><span class="op">,</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="t984" href="#t984">984</a></span><span class="t"> <span class="nam">final_mode</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">mode</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t985" href="#t985">985</a></span><span class="t"> <span class="nam">is_dir</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">is_dir</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t986" href="#t986">986</a></span><span class="t"> <span class="key">for</span> <span class="nam">segment</span> <span class="key">in</span> <span class="nam">segments</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t987" href="#t987">987</a></span><span class="t"> <span class="nam">final_mode</span> <span class="op">=</span> <span class="nam">segment</span><span class="op">.</span><span class="nam">apply</span><span class="op">(</span><span class="nam">final_mode</span><span class="op">,</span> <span class="nam">is_dir</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t988" href="#t988">988</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">mode</span> <span class="op">=</span> <span class="nam">final_mode</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t989" href="#t989">989</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="t990" href="#t990">990</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">mode</span> <span class="op">=</span> <span class="nam">new_mode</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t991" href="#t991">991</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t992" href="#t992">992</a></span><span class="t"> <span class="key">def</span> <span class="nam">chown</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t993" href="#t993">993</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="t994" href="#t994">994</a></span><span class="t"> <span class="nam">owner</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="str">"StaticFileSystemOwner"</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t995" href="#t995">995</a></span><span class="t"> <span class="nam">group</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="str">"StaticFileSystemGroup"</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t996" href="#t996">996</a></span><span class="t"> <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="pln"><span class="n"><a id="t997" href="#t997">997</a></span><span class="t"> <span class="str">"""Change the owner/group of this path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t998" href="#t998">998</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t999" href="#t999">999</a></span><span class="t"><span class="str"> :param owner: The desired owner definition for this path. If None, then no change of owner is performed.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1000" href="#t1000">1000</a></span><span class="t"><span class="str"> :param group: The desired group definition for this path. If None, then no change of group is performed.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1001" href="#t1001">1001</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1002" href="#t1002">1002</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1003" href="#t1003">1003</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1004" href="#t1004">1004</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1005" href="#t1005">1005</a></span><span class="t"> <span class="key">def</span> <span class="nam">mtime</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">float</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1006" href="#t1006">1006</a></span><span class="t"> <span class="str">"""Determine the mtime of this path object</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1007" href="#t1007">1007</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1008" href="#t1008">1008</a></span><span class="t"><span class="str"> Note that:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1009" href="#t1009">1009</a></span><span class="t"><span class="str"> * like with `stat` above, this never follows symlinks.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1010" href="#t1010">1010</a></span><span class="t"><span class="str"> * the mtime returned has *not* been clamped against ´SOURCE_DATE_EPOCH`. Timestamp</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1011" href="#t1011">1011</a></span><span class="t"><span class="str"> normalization is handled later by `debputy`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1012" href="#t1012">1012</a></span><span class="t"><span class="str"> * the mtime returned by this method is not always a 1:1 with the mtime in the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1013" href="#t1013">1013</a></span><span class="t"><span class="str"> physical file system. As an optimization, `debputy` skips unnecessary writes</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1014" href="#t1014">1014</a></span><span class="t"><span class="str"> to the underlying file system in many cases.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1015" href="#t1015">1015</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1016" href="#t1016">1016</a></span><span class="t"><span class="str"> :return: The mtime for the path.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1017" href="#t1017">1017</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1018" href="#t1018">1018</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1019" href="#t1019">1019</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1020" href="#t1020">1020</a></span><span class="t"> <span class="op">@</span><span class="nam">mtime</span><span class="op">.</span><span class="nam">setter</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1021" href="#t1021">1021</a></span><span class="t"> <span class="key">def</span> <span class="nam">mtime</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">new_mtime</span><span class="op">:</span> <span class="nam">float</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="pln"><span class="n"><a id="t1022" href="#t1022">1022</a></span><span class="t"> <span class="str">"""Set the mtime of this path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1023" href="#t1023">1023</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1024" href="#t1024">1024</a></span><span class="t"><span class="str"> Note that:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1025" href="#t1025">1025</a></span><span class="t"><span class="str"> * this operation will fail if `path.is_read_write` returns False.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1026" href="#t1026">1026</a></span><span class="t"><span class="str"> * this operation is generally *not* synced to the physical file system (as</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1027" href="#t1027">1027</a></span><span class="t"><span class="str"> an optimization).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1028" href="#t1028">1028</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1029" href="#t1029">1029</a></span><span class="t"><span class="str"> :param new_mtime: The new mtime of this path. Note that the caller does not need to</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1030" href="#t1030">1030</a></span><span class="t"><span class="str"> account for `SOURCE_DATE_EPOCH`. Timestamp normalization is handled later.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1031" href="#t1031">1031</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1032" href="#t1032">1032</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1033" href="#t1033">1033</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1034" href="#t1034">1034</a></span><span class="t"> <span class="key">def</span> <span class="nam">readlink</span><span class="op">(</span><span class="nam">self</span><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="pln"><span class="n"><a id="t1035" href="#t1035">1035</a></span><span class="t"> <span class="str">"""Determine the link target of this path assuming it is a symlink</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1036" href="#t1036">1036</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1037" href="#t1037">1037</a></span><span class="t"><span class="str"> For paths where `is_symlink` is True, this already returns a link target even when</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1038" href="#t1038">1038</a></span><span class="t"><span class="str"> `has_fs_path` is False.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1039" href="#t1039">1039</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1040" href="#t1040">1040</a></span><span class="t"><span class="str"> :return: The link target of the path or an error is this is not a symlink</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1041" href="#t1041">1041</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1042" href="#t1042">1042</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1043" href="#t1043">1043</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1044" href="#t1044">1044</a></span><span class="t"> <span class="op">@</span><span class="nam">overload</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t1045" href="#t1045">1045</a></span><span class="t"> <span class="key">def</span> <span class="nam">open</span><span class="op">(</span> </span><span class="r"><span class="annotate short">1045 ↛ exit</span><span class="annotate long">line 1045 didn't jump to the function exit</span></span></p> - <p class="pln"><span class="n"><a id="t1046" href="#t1046">1046</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="t1047" href="#t1047">1047</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="t1048" href="#t1048">1048</a></span><span class="t"> <span class="nam">byte_io</span><span class="op">:</span> <span class="nam">Literal</span><span class="op">[</span><span class="key">False</span><span class="op">]</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="t1049" href="#t1049">1049</a></span><span class="t"> <span class="nam">buffering</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">int</span><span class="op">]</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="t1050" href="#t1050">1050</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="nam">TextIO</span><span class="op">:</span> <span class="op">...</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1051" href="#t1051">1051</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1052" href="#t1052">1052</a></span><span class="t"> <span class="op">@</span><span class="nam">overload</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t1053" href="#t1053">1053</a></span><span class="t"> <span class="key">def</span> <span class="nam">open</span><span class="op">(</span> </span><span class="r"><span class="annotate short">1053 ↛ exit</span><span class="annotate long">line 1053 didn't jump to the function exit</span></span></p> - <p class="pln"><span class="n"><a id="t1054" href="#t1054">1054</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="t1055" href="#t1055">1055</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="t1056" href="#t1056">1056</a></span><span class="t"> <span class="nam">byte_io</span><span class="op">:</span> <span class="nam">Literal</span><span class="op">[</span><span class="key">True</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1057" href="#t1057">1057</a></span><span class="t"> <span class="nam">buffering</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">int</span><span class="op">]</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="t1058" href="#t1058">1058</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="nam">BinaryIO</span><span class="op">:</span> <span class="op">...</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1059" href="#t1059">1059</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1060" href="#t1060">1060</a></span><span class="t"> <span class="op">@</span><span class="nam">overload</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t1061" href="#t1061">1061</a></span><span class="t"> <span class="key">def</span> <span class="nam">open</span><span class="op">(</span> </span><span class="r"><span class="annotate short">1061 ↛ exit</span><span class="annotate long">line 1061 didn't jump to the function exit</span></span></p> - <p class="pln"><span class="n"><a id="t1062" href="#t1062">1062</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="t1063" href="#t1063">1063</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="t1064" href="#t1064">1064</a></span><span class="t"> <span class="nam">byte_io</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="t1065" href="#t1065">1065</a></span><span class="t"> <span class="nam">buffering</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">int</span><span class="op">]</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="t1066" href="#t1066">1066</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="nam">Union</span><span class="op">[</span><span class="nam">TextIO</span><span class="op">,</span> <span class="nam">BinaryIO</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="t1067" href="#t1067">1067</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1068" href="#t1068">1068</a></span><span class="t"> <span class="key">def</span> <span class="nam">open</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1069" href="#t1069">1069</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="t1070" href="#t1070">1070</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="t1071" href="#t1071">1071</a></span><span class="t"> <span class="nam">byte_io</span><span class="op">:</span> <span class="nam">bool</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="t1072" href="#t1072">1072</a></span><span class="t"> <span class="nam">buffering</span><span class="op">:</span> <span class="nam">int</span> <span class="op">=</span> <span class="op">-</span><span class="num">1</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1073" href="#t1073">1073</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="nam">Union</span><span class="op">[</span><span class="nam">TextIO</span><span class="op">,</span> <span class="nam">BinaryIO</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1074" href="#t1074">1074</a></span><span class="t"> <span class="str">"""Open the file for reading. Usually used with a context manager</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1075" href="#t1075">1075</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1076" href="#t1076">1076</a></span><span class="t"><span class="str"> By default, the file is opened in text mode (utf-8). Binary mode can be requested</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1077" href="#t1077">1077</a></span><span class="t"><span class="str"> via the `byte_io` parameter. This operation is only valid for files (`is_file` returns</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1078" href="#t1078">1078</a></span><span class="t"><span class="str"> `True`). Usage on symlinks and directories will raise exceptions.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1079" href="#t1079">1079</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1080" href="#t1080">1080</a></span><span class="t"><span class="str"> This method *often* requires the `fs_path` to be present. However, tests as a notable</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1081" href="#t1081">1081</a></span><span class="t"><span class="str"> case can inject content without having the `fs_path` point to a real file. (To be clear,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1082" href="#t1082">1082</a></span><span class="t"><span class="str"> such tests are generally expected to ensure `has_fs_path` returns `True`).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1083" href="#t1083">1083</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1084" href="#t1084">1084</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1085" href="#t1085">1085</a></span><span class="t"><span class="str"> :param byte_io: If True, open the file in binary mode (like `rb` for `open`)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1086" href="#t1086">1086</a></span><span class="t"><span class="str"> :param buffering: Same as open(..., buffering=...) where supported. Notably during</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1087" href="#t1087">1087</a></span><span class="t"><span class="str"> testing, the content may be purely in memory and use a BytesIO/StringIO</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1088" href="#t1088">1088</a></span><span class="t"><span class="str"> (which does not accept that parameter, but then is buffered in a different way)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1089" href="#t1089">1089</a></span><span class="t"><span class="str"> :return: The file handle.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1090" href="#t1090">1090</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1091" href="#t1091">1091</a></span><span class="t"> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t1092" href="#t1092">1092</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">self</span><span class="op">.</span><span class="nam">is_file</span><span class="op">:</span> </span><span class="r"><span class="annotate short">1092 ↛ 1093</span><span class="annotate long">line 1092 didn't jump to line 1093, because the condition on line 1092 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t1093" href="#t1093">1093</a></span><span class="t"> <span class="key">raise</span> <span class="nam">TypeError</span><span class="op">(</span><span class="str">f"Cannot open {self.path} for reading: It is not a file"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1094" href="#t1094">1094</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1095" href="#t1095">1095</a></span><span class="t"> <span class="key">if</span> <span class="nam">byte_io</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1096" href="#t1096">1096</a></span><span class="t"> <span class="key">return</span> <span class="nam">open</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">fs_path</span><span class="op">,</span> <span class="str">"rb"</span><span class="op">,</span> <span class="nam">buffering</span><span class="op">=</span><span class="nam">buffering</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1097" href="#t1097">1097</a></span><span class="t"> <span class="key">return</span> <span class="nam">open</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">fs_path</span><span class="op">,</span> <span class="str">"rt"</span><span class="op">,</span> <span class="nam">encoding</span><span class="op">=</span><span class="str">"utf-8"</span><span class="op">,</span> <span class="nam">buffering</span><span class="op">=</span><span class="nam">buffering</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1098" href="#t1098">1098</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1099" href="#t1099">1099</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1100" href="#t1100">1100</a></span><span class="t"> <span class="key">def</span> <span class="nam">fs_path</span><span class="op">(</span><span class="nam">self</span><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="pln"><span class="n"><a id="t1101" href="#t1101">1101</a></span><span class="t"> <span class="str">"""Request the underling fs_path of this path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1102" href="#t1102">1102</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1103" href="#t1103">1103</a></span><span class="t"><span class="str"> Only available when `has_fs_path` is True. Generally this should only be used for files to read</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1104" href="#t1104">1104</a></span><span class="t"><span class="str"> the contents of the file and do some action based on the parsed result.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1105" href="#t1105">1105</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1106" href="#t1106">1106</a></span><span class="t"><span class="str"> The path should only be used for read-only purposes as debputy may assume that it is safe to have</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1107" href="#t1107">1107</a></span><span class="t"><span class="str"> multiple paths pointing to the same file system path.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1108" href="#t1108">1108</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1109" href="#t1109">1109</a></span><span class="t"><span class="str"> Note that:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1110" href="#t1110">1110</a></span><span class="t"><span class="str"> * This is often *not* available for directories and symlinks.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1111" href="#t1111">1111</a></span><span class="t"><span class="str"> * The debputy in-memory file system overrules the physical file system. Attempting to "fix" things</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1112" href="#t1112">1112</a></span><span class="t"><span class="str"> by using `os.chmod` or `os.unlink`'ing files, etc. will generally not do as you expect. Best case,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1113" href="#t1113">1113</a></span><span class="t"><span class="str"> your actions are ignored and worst case it will cause the build to fail as it violates debputy's</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1114" href="#t1114">1114</a></span><span class="t"><span class="str"> internal invariants.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1115" href="#t1115">1115</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1116" href="#t1116">1116</a></span><span class="t"><span class="str"> :return: The path to the underlying file system object on the build system or an error if no such</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1117" href="#t1117">1117</a></span><span class="t"><span class="str"> file exist (see `has_fs_path`).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1118" href="#t1118">1118</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1119" href="#t1119">1119</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1120" href="#t1120">1120</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1121" href="#t1121">1121</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1122" href="#t1122">1122</a></span><span class="t"> <span class="key">def</span> <span class="nam">is_dir</span><span class="op">(</span><span class="nam">self</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="pln"><span class="n"><a id="t1123" href="#t1123">1123</a></span><span class="t"> <span class="str">"""Determine if this path is a directory</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1124" href="#t1124">1124</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1125" href="#t1125">1125</a></span><span class="t"><span class="str"> Never follows symlinks.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1126" href="#t1126">1126</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1127" href="#t1127">1127</a></span><span class="t"><span class="str"> :return: True if this path is a directory. False otherwise.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1128" href="#t1128">1128</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1129" href="#t1129">1129</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1130" href="#t1130">1130</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1131" href="#t1131">1131</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1132" href="#t1132">1132</a></span><span class="t"> <span class="key">def</span> <span class="nam">is_file</span><span class="op">(</span><span class="nam">self</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="pln"><span class="n"><a id="t1133" href="#t1133">1133</a></span><span class="t"> <span class="str">"""Determine if this path is a directory</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1134" href="#t1134">1134</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1135" href="#t1135">1135</a></span><span class="t"><span class="str"> Never follows symlinks.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1136" href="#t1136">1136</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1137" href="#t1137">1137</a></span><span class="t"><span class="str"> :return: True if this path is a regular file. False otherwise.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1138" href="#t1138">1138</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1139" href="#t1139">1139</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1140" href="#t1140">1140</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1141" href="#t1141">1141</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1142" href="#t1142">1142</a></span><span class="t"> <span class="key">def</span> <span class="nam">is_symlink</span><span class="op">(</span><span class="nam">self</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="pln"><span class="n"><a id="t1143" href="#t1143">1143</a></span><span class="t"> <span class="str">"""Determine if this path is a symlink</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1144" href="#t1144">1144</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1145" href="#t1145">1145</a></span><span class="t"><span class="str"> :return: True if this path is a symlink. False otherwise.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1146" href="#t1146">1146</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1147" href="#t1147">1147</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1148" href="#t1148">1148</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1149" href="#t1149">1149</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1150" href="#t1150">1150</a></span><span class="t"> <span class="key">def</span> <span class="nam">has_fs_path</span><span class="op">(</span><span class="nam">self</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="pln"><span class="n"><a id="t1151" href="#t1151">1151</a></span><span class="t"> <span class="str">"""Determine whether this path is backed by a file system path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1152" href="#t1152">1152</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1153" href="#t1153">1153</a></span><span class="t"><span class="str"> :return: True if this path is backed by a file system object on the build system.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1154" href="#t1154">1154</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1155" href="#t1155">1155</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1156" href="#t1156">1156</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1157" href="#t1157">1157</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1158" href="#t1158">1158</a></span><span class="t"> <span class="key">def</span> <span class="nam">is_read_write</span><span class="op">(</span><span class="nam">self</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="pln"><span class="n"><a id="t1159" href="#t1159">1159</a></span><span class="t"> <span class="str">"""When true, the file system entry may be mutated</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1160" href="#t1160">1160</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1161" href="#t1161">1161</a></span><span class="t"><span class="str"> Read-write rules are:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1162" href="#t1162">1162</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1163" href="#t1163">1163</a></span><span class="t"><span class="str"> +--------------------------+-------------------+------------------------+</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1164" href="#t1164">1164</a></span><span class="t"><span class="str"> | File system | From / Inside | Read-Only / Read-Write |</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1165" href="#t1165">1165</a></span><span class="t"><span class="str"> +--------------------------+-------------------+------------------------+</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1166" href="#t1166">1166</a></span><span class="t"><span class="str"> | Source directory | Any context | Read-Only |</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1167" href="#t1167">1167</a></span><span class="t"><span class="str"> | Binary staging directory | Package Processor | Read-Write |</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1168" href="#t1168">1168</a></span><span class="t"><span class="str"> | Binary staging directory | Metadata Detector | Read-Only |</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1169" href="#t1169">1169</a></span><span class="t"><span class="str"> +--------------------------+-------------------+------------------------+</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1170" href="#t1170">1170</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1171" href="#t1171">1171</a></span><span class="t"><span class="str"> These rules apply to the virtual file system (`debputy` cannot enforce</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1172" href="#t1172">1172</a></span><span class="t"><span class="str"> these rules in the underlying file system). The `debputy` code relies</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1173" href="#t1173">1173</a></span><span class="t"><span class="str"> on these rules for its logic in multiple places to catch bugs and for</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1174" href="#t1174">1174</a></span><span class="t"><span class="str"> optimizations.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1175" href="#t1175">1175</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1176" href="#t1176">1176</a></span><span class="t"><span class="str"> As an example, the reason why the file system is read-only when Metadata</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1177" href="#t1177">1177</a></span><span class="t"><span class="str"> Detectors are run is based the contents of the file system has already</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1178" href="#t1178">1178</a></span><span class="t"><span class="str"> been committed. New files will not be included, removals of existing</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1179" href="#t1179">1179</a></span><span class="t"><span class="str"> files will trigger a hard error when the package is assembled, etc.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1180" href="#t1180">1180</a></span><span class="t"><span class="str"> To avoid people spending hours debugging why their code does not work</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1181" href="#t1181">1181</a></span><span class="t"><span class="str"> as intended, `debputy` instead throws a hard error if you try to mutate</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1182" href="#t1182">1182</a></span><span class="t"><span class="str"> the file system when it is read-only mode to "fail fast".</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1183" href="#t1183">1183</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1184" href="#t1184">1184</a></span><span class="t"><span class="str"> :return: Whether file system mutations are permitted.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1185" href="#t1185">1185</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t1186" href="#t1186">1186</a></span><span class="t"> <span class="key">return</span> <span class="key">False</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1187" href="#t1187">1187</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1188" href="#t1188">1188</a></span><span class="t"> <span class="key">def</span> <span class="nam">mkdir</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">name</span><span class="op">:</span> <span class="nam">str</span><span class="op">)</span> <span class="op">-></span> <span class="str">"VirtualPath"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1189" href="#t1189">1189</a></span><span class="t"> <span class="str">"""Create a new subdirectory of the current path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1190" href="#t1190">1190</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1191" href="#t1191">1191</a></span><span class="t"><span class="str"> :param name: Basename of the new directory. The directory must not contain a path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1192" href="#t1192">1192</a></span><span class="t"><span class="str"> with this basename.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1193" href="#t1193">1193</a></span><span class="t"><span class="str"> :return: The new subdirectory</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1194" href="#t1194">1194</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1195" href="#t1195">1195</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1196" href="#t1196">1196</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1197" href="#t1197">1197</a></span><span class="t"> <span class="key">def</span> <span class="nam">mkdirs</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">path</span><span class="op">:</span> <span class="nam">str</span><span class="op">)</span> <span class="op">-></span> <span class="str">"VirtualPath"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1198" href="#t1198">1198</a></span><span class="t"> <span class="str">"""Ensure a given path exists and is a directory.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1199" href="#t1199">1199</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1200" href="#t1200">1200</a></span><span class="t"><span class="str"> :param path: Path to the directory to create. Any parent directories will be</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1201" href="#t1201">1201</a></span><span class="t"><span class="str"> created as needed. If the path already exists and is a directory, then it</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1202" href="#t1202">1202</a></span><span class="t"><span class="str"> is returned. If any part of the path exists and that is not a directory,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1203" href="#t1203">1203</a></span><span class="t"><span class="str"> then the `mkdirs` call will raise an error.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1204" href="#t1204">1204</a></span><span class="t"><span class="str"> :return: The directory denoted by the given path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1205" href="#t1205">1205</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1206" href="#t1206">1206</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1207" href="#t1207">1207</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1208" href="#t1208">1208</a></span><span class="t"> <span class="key">def</span> <span class="nam">add_file</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1209" href="#t1209">1209</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="t1210" href="#t1210">1210</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="t1211" href="#t1211">1211</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="t1212" href="#t1212">1212</a></span><span class="t"> <span class="nam">unlink_if_exists</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1213" href="#t1213">1213</a></span><span class="t"> <span class="nam">use_fs_path_mode</span><span class="op">:</span> <span class="nam">bool</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="t1214" href="#t1214">1214</a></span><span class="t"> <span class="nam">mode</span><span class="op">:</span> <span class="nam">int</span> <span class="op">=</span> <span class="num">0o0644</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1215" href="#t1215">1215</a></span><span class="t"> <span class="nam">mtime</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">float</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="pln"><span class="n"><a id="t1216" href="#t1216">1216</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="nam">ContextManager</span><span class="op">[</span><span class="str">"VirtualPath"</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1217" href="#t1217">1217</a></span><span class="t"> <span class="str">"""Add a new regular file as a child of this path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1218" href="#t1218">1218</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1219" href="#t1219">1219</a></span><span class="t"><span class="str"> This method will insert a new file into the virtual file system as a child</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1220" href="#t1220">1220</a></span><span class="t"><span class="str"> of the current path (which must be a directory). The caller must use the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1221" href="#t1221">1221</a></span><span class="t"><span class="str"> return value as a context manager (see example). During the life-cycle of</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1222" href="#t1222">1222</a></span><span class="t"><span class="str"> the managed context, the caller can fill out the contents of the file</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1223" href="#t1223">1223</a></span><span class="t"><span class="str"> from the new path's `fs_path` attribute. The `fs_path` will exist as an</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1224" href="#t1224">1224</a></span><span class="t"><span class="str"> empty file when the context manager is entered.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1225" href="#t1225">1225</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1226" href="#t1226">1226</a></span><span class="t"><span class="str"> Once the context manager exits, mutation of the `fs_path` is no longer permitted.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1227" href="#t1227">1227</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1228" href="#t1228">1228</a></span><span class="t"><span class="str"> >>> import subprocess</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1229" href="#t1229">1229</a></span><span class="t"><span class="str"> >>> path = ... # doctest: +SKIP</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1230" href="#t1230">1230</a></span><span class="t"><span class="str"> >>> with path.add_file("foo") as new_file, open(new_file.fs_path, "w") as fd: # doctest: +SKIP</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1231" href="#t1231">1231</a></span><span class="t"><span class="str"> ... fd.writelines(["Some", "Content", "Here"])</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1232" href="#t1232">1232</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1233" href="#t1233">1233</a></span><span class="t"><span class="str"> The caller can replace the provided `fs_path` entirely provided at the end result</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1234" href="#t1234">1234</a></span><span class="t"><span class="str"> (when the context manager exits) is a regular file with no hard links.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1235" href="#t1235">1235</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1236" href="#t1236">1236</a></span><span class="t"><span class="str"> Note that this operation will fail if `path.is_read_write` returns False.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1237" href="#t1237">1237</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1238" href="#t1238">1238</a></span><span class="t"><span class="str"> :param name: Basename of the new file</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1239" href="#t1239">1239</a></span><span class="t"><span class="str"> :param unlink_if_exists: If the name was already in use, then either an exception is thrown</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1240" href="#t1240">1240</a></span><span class="t"><span class="str"> (when `unlink_if_exists` is False) or the path will be removed via ´unlink(recursive=False)`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1241" href="#t1241">1241</a></span><span class="t"><span class="str"> (when `unlink_if_exists` is True)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1242" href="#t1242">1242</a></span><span class="t"><span class="str"> :param use_fs_path_mode: When True, the file created will have this mode in the physical file</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1243" href="#t1243">1243</a></span><span class="t"><span class="str"> system. When the context manager exists, `debputy` will refresh its mode to match the mode</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1244" href="#t1244">1244</a></span><span class="t"><span class="str"> in the physical file system. This is primarily useful if the caller uses a subprocess to</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1245" href="#t1245">1245</a></span><span class="t"><span class="str"> mutate the path and the file mode is relevant for this tool (either as input or output).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1246" href="#t1246">1246</a></span><span class="t"><span class="str"> When the parameter is false, the new file is guaranteed to be readable and writable for</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1247" href="#t1247">1247</a></span><span class="t"><span class="str"> the current user. However, no other guarantees are given (not even that it matches the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1248" href="#t1248">1248</a></span><span class="t"><span class="str"> `mode` parameter and any changes to the mode in the physical file system will be ignored.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1249" href="#t1249">1249</a></span><span class="t"><span class="str"> :param mode: This is the initial file mode. Note the `use_fs_path_mode` parameter for how</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1250" href="#t1250">1250</a></span><span class="t"><span class="str"> this interacts with the physical file system.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1251" href="#t1251">1251</a></span><span class="t"><span class="str"> :param mtime: If the caller has a more accurate mtime than the mtime of the generated file,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1252" href="#t1252">1252</a></span><span class="t"><span class="str"> then it can be provided here. Note that all mtimes will later be clamped based on</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1253" href="#t1253">1253</a></span><span class="t"><span class="str"> `SOURCE_DATE_EPOCH`. This parameter is only for when the conceptual mtime of this path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1254" href="#t1254">1254</a></span><span class="t"><span class="str"> should be earlier than `SOURCE_DATE_EPOCH`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1255" href="#t1255">1255</a></span><span class="t"><span class="str"> :return: A Context manager that upon entering provides a `VirtualPath` instance for the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1256" href="#t1256">1256</a></span><span class="t"><span class="str"> new file. The instance remains valid after the context manager exits (assuming it exits</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1257" href="#t1257">1257</a></span><span class="t"><span class="str"> successfully), but the file denoted by `fs_path` must not be changed after the context</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1258" href="#t1258">1258</a></span><span class="t"><span class="str"> manager exits</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1259" href="#t1259">1259</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1260" href="#t1260">1260</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1261" href="#t1261">1261</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1262" href="#t1262">1262</a></span><span class="t"> <span class="key">def</span> <span class="nam">replace_fs_path_content</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1263" href="#t1263">1263</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="t1264" href="#t1264">1264</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="t1265" href="#t1265">1265</a></span><span class="t"> <span class="nam">use_fs_path_mode</span><span class="op">:</span> <span class="nam">bool</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="t1266" href="#t1266">1266</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="nam">ContextManager</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="t1267" href="#t1267">1267</a></span><span class="t"> <span class="str">"""Replace the contents of this file via inline manipulation</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1268" href="#t1268">1268</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1269" href="#t1269">1269</a></span><span class="t"><span class="str"> Used as a context manager to provide the fs path for manipulation.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1270" href="#t1270">1270</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1271" href="#t1271">1271</a></span><span class="t"><span class="str"> Example:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1272" href="#t1272">1272</a></span><span class="t"><span class="str"> >>> import subprocess</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1273" href="#t1273">1273</a></span><span class="t"><span class="str"> >>> path = ... # doctest: +SKIP</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1274" href="#t1274">1274</a></span><span class="t"><span class="str"> >>> with path.replace_fs_path_content() as fs_path: # doctest: +SKIP</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1275" href="#t1275">1275</a></span><span class="t"><span class="str"> ... subprocess.check_call(['strip', fs_path]) # doctest: +SKIP</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1276" href="#t1276">1276</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1277" href="#t1277">1277</a></span><span class="t"><span class="str"> The provided file system path should be manipulated inline. The debputy framework may</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1278" href="#t1278">1278</a></span><span class="t"><span class="str"> copy it first as necessary and therefore the provided fs_path may be different from</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1279" href="#t1279">1279</a></span><span class="t"><span class="str"> `path.fs_path` prior to entering the context manager.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1280" href="#t1280">1280</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1281" href="#t1281">1281</a></span><span class="t"><span class="str"> Note that this operation will fail if `path.is_read_write` returns False.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1282" href="#t1282">1282</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1283" href="#t1283">1283</a></span><span class="t"><span class="str"> If the mutation causes the returned `fs_path` to be a non-file or a hard-linked file</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1284" href="#t1284">1284</a></span><span class="t"><span class="str"> when the context manager exits, `debputy` will raise an error at that point. To preserve</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1285" href="#t1285">1285</a></span><span class="t"><span class="str"> the internal invariants of `debputy`, the path will be unlinked as `debputy` cannot</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1286" href="#t1286">1286</a></span><span class="t"><span class="str"> reliably restore the path.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1287" href="#t1287">1287</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1288" href="#t1288">1288</a></span><span class="t"><span class="str"> :param use_fs_path_mode: If True, any changes to the mode on the physical FS path will be</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1289" href="#t1289">1289</a></span><span class="t"><span class="str"> recorded as the desired mode of the file when the contextmanager ends. The provided FS path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1290" href="#t1290">1290</a></span><span class="t"><span class="str"> with start with the current mode when `use_fs_path_mode` is True. Otherwise, `debputy` will</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1291" href="#t1291">1291</a></span><span class="t"><span class="str"> ignore the mode of the file system entry and reuse its own current mode</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1292" href="#t1292">1292</a></span><span class="t"><span class="str"> definition.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1293" href="#t1293">1293</a></span><span class="t"><span class="str"> :return: A Context manager that upon entering provides the path to a muable (copy) of</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1294" href="#t1294">1294</a></span><span class="t"><span class="str"> this path's `fs_path` attribute. The file on the underlying path may be mutated however</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1295" href="#t1295">1295</a></span><span class="t"><span class="str"> the caller wishes until the context manager exits.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1296" href="#t1296">1296</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1297" href="#t1297">1297</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1298" href="#t1298">1298</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1299" href="#t1299">1299</a></span><span class="t"> <span class="key">def</span> <span class="nam">add_symlink</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">link_name</span><span class="op">:</span> <span class="nam">str</span><span class="op">,</span> <span class="nam">link_target</span><span class="op">:</span> <span class="nam">str</span><span class="op">)</span> <span class="op">-></span> <span class="str">"VirtualPath"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1300" href="#t1300">1300</a></span><span class="t"> <span class="str">"""Add a new regular file as a child of this path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1301" href="#t1301">1301</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1302" href="#t1302">1302</a></span><span class="t"><span class="str"> This will create a new symlink inside the current path. If the path already exists,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1303" href="#t1303">1303</a></span><span class="t"><span class="str"> the existing path will be unlinked via `unlink(recursive=False)`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1304" href="#t1304">1304</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1305" href="#t1305">1305</a></span><span class="t"><span class="str"> Note that this operation will fail if `path.is_read_write` returns False.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1306" href="#t1306">1306</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1307" href="#t1307">1307</a></span><span class="t"><span class="str"> :param link_name: The basename of the link file entry.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1308" href="#t1308">1308</a></span><span class="t"><span class="str"> :param link_target: The target of the link. Link target normalization will</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1309" href="#t1309">1309</a></span><span class="t"><span class="str"> be handled by `debputy`, so the caller can use relative or absolute paths.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1310" href="#t1310">1310</a></span><span class="t"><span class="str"> (At the time of writing, symlink target normalization happens late)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1311" href="#t1311">1311</a></span><span class="t"><span class="str"> :return: The newly created symlink.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1312" href="#t1312">1312</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1313" href="#t1313">1313</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1314" href="#t1314">1314</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1315" href="#t1315">1315</a></span><span class="t"> <span class="key">def</span> <span class="nam">unlink</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="op">*</span><span class="op">,</span> <span class="nam">recursive</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">False</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="pln"><span class="n"><a id="t1316" href="#t1316">1316</a></span><span class="t"> <span class="str">"""Unlink a file or a directory</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1317" href="#t1317">1317</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1318" href="#t1318">1318</a></span><span class="t"><span class="str"> This operation will remove the path from the file system (causing `is_detached` to return True).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1319" href="#t1319">1319</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1320" href="#t1320">1320</a></span><span class="t"><span class="str"> When the path is a:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1321" href="#t1321">1321</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1322" href="#t1322">1322</a></span><span class="t"><span class="str"> * symlink, then the symlink itself is removed. The target (if present) is not affected.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1323" href="#t1323">1323</a></span><span class="t"><span class="str"> * *non-empty* directory, then the `recursive` parameter decides the outcome. An empty</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1324" href="#t1324">1324</a></span><span class="t"><span class="str"> directory will be removed regardless of the value of `recursive`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1325" href="#t1325">1325</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1326" href="#t1326">1326</a></span><span class="t"><span class="str"> Note that:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1327" href="#t1327">1327</a></span><span class="t"><span class="str"> * the root directory cannot be deleted.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1328" href="#t1328">1328</a></span><span class="t"><span class="str"> * this operation will fail if `path.is_read_write` returns False.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1329" href="#t1329">1329</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1330" href="#t1330">1330</a></span><span class="t"><span class="str"> :param recursive: If True, then non-empty directories will be unlinked as well removing everything inside them</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1331" href="#t1331">1331</a></span><span class="t"><span class="str"> as well. When False, an error is raised if the path is a non-empty directory</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1332" href="#t1332">1332</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1333" href="#t1333">1333</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1334" href="#t1334">1334</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1335" href="#t1335">1335</a></span><span class="t"> <span class="key">def</span> <span class="nam">interpreter</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">Interpreter</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1336" href="#t1336">1336</a></span><span class="t"> <span class="str">"""Determine the interpreter of the file (`#!`-line details)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1337" href="#t1337">1337</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1338" href="#t1338">1338</a></span><span class="t"><span class="str"> Note: this method is only applicable for files (`is_file` is True).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1339" href="#t1339">1339</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1340" href="#t1340">1340</a></span><span class="t"><span class="str"> :return: The detected interpreter if present or None if no interpreter can be detected.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1341" href="#t1341">1341</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t1342" href="#t1342">1342</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">self</span><span class="op">.</span><span class="nam">is_file</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t1343" href="#t1343">1343</a></span><span class="t"> <span class="key">raise</span> <span class="nam">TypeError</span><span class="op">(</span><span class="str">"Only files can have interpreters"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t1344" href="#t1344">1344</a></span><span class="t"> <span class="key">try</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t1345" href="#t1345">1345</a></span><span class="t"> <span class="key">with</span> <span class="nam">self</span><span class="op">.</span><span class="nam">open</span><span class="op">(</span><span class="nam">byte_io</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> <span class="nam">buffering</span><span class="op">=</span><span class="num">4096</span><span class="op">)</span> <span class="key">as</span> <span class="nam">fd</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t1346" href="#t1346">1346</a></span><span class="t"> <span class="key">return</span> <span class="nam">extract_shebang_interpreter_from_file</span><span class="op">(</span><span class="nam">fd</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t1347" href="#t1347">1347</a></span><span class="t"> <span class="key">except</span> <span class="op">(</span><span class="nam">PureVirtualPathError</span><span class="op">,</span> <span class="nam">TestPathWithNonExistentFSPathError</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="t1348" href="#t1348">1348</a></span><span class="t"> <span class="key">return</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1349" href="#t1349">1349</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1350" href="#t1350">1350</a></span><span class="t"> <span class="key">def</span> <span class="nam">metadata</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1351" href="#t1351">1351</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="t1352" href="#t1352">1352</a></span><span class="t"> <span class="nam">metadata_type</span><span class="op">:</span> <span class="nam">Type</span><span class="op">[</span><span class="nam">PMT</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1353" href="#t1353">1353</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="nam">PathMetadataReference</span><span class="op">[</span><span class="nam">PMT</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1354" href="#t1354">1354</a></span><span class="t"> <span class="str">"""Fetch the path metadata reference to access the underlying metadata</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1355" href="#t1355">1355</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1356" href="#t1356">1356</a></span><span class="t"><span class="str"> Calling this method returns a reference to an arbitrary piece of metadata associated</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1357" href="#t1357">1357</a></span><span class="t"><span class="str"> with this path. Plugins can store any arbitrary data associated with a given path.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1358" href="#t1358">1358</a></span><span class="t"><span class="str"> Keep in mind that the metadata is stored in memory, so keep the size in moderation.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1359" href="#t1359">1359</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1360" href="#t1360">1360</a></span><span class="t"><span class="str"> To store / update the metadata, the path must be in read-write mode. However,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1361" href="#t1361">1361</a></span><span class="t"><span class="str"> already stored metadata remains accessible even if the path becomes read-only.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1362" href="#t1362">1362</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1363" href="#t1363">1363</a></span><span class="t"><span class="str"> Note this method is not applicable if the path is detached</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1364" href="#t1364">1364</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1365" href="#t1365">1365</a></span><span class="t"><span class="str"> :param metadata_type: Type of the metadata being stored.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1366" href="#t1366">1366</a></span><span class="t"><span class="str"> :return: A reference to the metadata.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1367" href="#t1367">1367</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1368" href="#t1368">1368</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1369" href="#t1369">1369</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1370" href="#t1370">1370</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1371" href="#t1371">1371</a></span><span class="t"><span class="key">class</span> <span class="nam">FlushableSubstvars</span><span class="op">(</span><span class="nam">Substvars</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1372" href="#t1372">1372</a></span><span class="t"> <span class="nam">__slots__</span> <span class="op">=</span> <span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1373" href="#t1373">1373</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1374" href="#t1374">1374</a></span><span class="t"> <span class="op">@</span><span class="nam">contextlib</span><span class="op">.</span><span class="nam">contextmanager</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1375" href="#t1375">1375</a></span><span class="t"> <span class="key">def</span> <span class="nam">flush</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Iterator</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="t1376" href="#t1376">1376</a></span><span class="t"> <span class="str">"""Temporarily write the substvars to a file and then re-read it again</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1377" href="#t1377">1377</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1378" href="#t1378">1378</a></span><span class="t"><span class="str"> >>> s = FlushableSubstvars()</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1379" href="#t1379">1379</a></span><span class="t"><span class="str"> >>> 'Test:Var' in s</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1380" href="#t1380">1380</a></span><span class="t"><span class="str"> False</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1381" href="#t1381">1381</a></span><span class="t"><span class="str"> >>> with s.flush() as name, open(name, 'wt', encoding='utf-8') as fobj:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1382" href="#t1382">1382</a></span><span class="t"><span class="str"> ... _ = fobj.write('Test:Var=bar\\n') # "_ = " is to ignore the return value of write</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1383" href="#t1383">1383</a></span><span class="t"><span class="str"> >>> 'Test:Var' in s</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1384" href="#t1384">1384</a></span><span class="t"><span class="str"> True</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1385" href="#t1385">1385</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1386" href="#t1386">1386</a></span><span class="t"><span class="str"> Used as a context manager to define when the file is flushed and can be</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1387" href="#t1387">1387</a></span><span class="t"><span class="str"> accessed via the file system. If the context terminates successfully, the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1388" href="#t1388">1388</a></span><span class="t"><span class="str"> file is read and its content replaces the current substvars.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1389" href="#t1389">1389</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1390" href="#t1390">1390</a></span><span class="t"><span class="str"> This is mostly useful if the plugin needs to interface with a third-party</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1391" href="#t1391">1391</a></span><span class="t"><span class="str"> tool that requires a file as interprocess communication (IPC) for sharing</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1392" href="#t1392">1392</a></span><span class="t"><span class="str"> the substvars.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1393" href="#t1393">1393</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1394" href="#t1394">1394</a></span><span class="t"><span class="str"> The file may be truncated or completed replaced (change inode) as long as</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1395" href="#t1395">1395</a></span><span class="t"><span class="str"> the provided path points to a regular file when the context manager</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1396" href="#t1396">1396</a></span><span class="t"><span class="str"> terminates successfully.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1397" href="#t1397">1397</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1398" href="#t1398">1398</a></span><span class="t"><span class="str"> Note that any manipulation of the substvars via the `Substvars` API while</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1399" href="#t1399">1399</a></span><span class="t"><span class="str"> the file is flushed will silently be discarded if the context manager completes</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1400" href="#t1400">1400</a></span><span class="t"><span class="str"> successfully.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1401" href="#t1401">1401</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1402" href="#t1402">1402</a></span><span class="t"> <span class="key">with</span> <span class="nam">tempfile</span><span class="op">.</span><span class="nam">NamedTemporaryFile</span><span class="op">(</span><span class="nam">mode</span><span class="op">=</span><span class="str">"w+t"</span><span class="op">,</span> <span class="nam">encoding</span><span class="op">=</span><span class="str">"utf-8"</span><span class="op">)</span> <span class="key">as</span> <span class="nam">tmp</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1403" href="#t1403">1403</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">write_substvars</span><span class="op">(</span><span class="nam">tmp</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1404" href="#t1404">1404</a></span><span class="t"> <span class="nam">tmp</span><span class="op">.</span><span class="nam">flush</span><span class="op">(</span><span class="op">)</span> <span class="com"># Temping to use close, but then we have to manually delete the file.</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1405" href="#t1405">1405</a></span><span class="t"> <span class="key">yield</span> <span class="nam">tmp</span><span class="op">.</span><span class="nam">name</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1406" href="#t1406">1406</a></span><span class="t"> <span class="com"># Re-open; seek did not work when I last tried (if I did it work, feel free to</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1407" href="#t1407">1407</a></span><span class="t"> <span class="com"># convert back to seek - as long as it works!)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1408" href="#t1408">1408</a></span><span class="t"> <span class="key">with</span> <span class="nam">open</span><span class="op">(</span><span class="nam">tmp</span><span class="op">.</span><span class="nam">name</span><span class="op">,</span> <span class="str">"rt"</span><span class="op">,</span> <span class="nam">encoding</span><span class="op">=</span><span class="str">"utf-8"</span><span class="op">)</span> <span class="key">as</span> <span class="nam">fd</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1409" href="#t1409">1409</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">read_substvars</span><span class="op">(</span><span class="nam">fd</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1410" href="#t1410">1410</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1411" href="#t1411">1411</a></span><span class="t"> <span class="key">def</span> <span class="nam">save</span><span class="op">(</span><span class="nam">self</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="pln"><span class="n"><a id="t1412" href="#t1412">1412</a></span><span class="t"> <span class="com"># Promote the debputy extension over `save()` for the plugins.</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t1413" href="#t1413">1413</a></span><span class="t"> <span class="key">if</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_substvars_path</span> <span class="key">is</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="t1414" href="#t1414">1414</a></span><span class="t"> <span class="key">raise</span> <span class="nam">TypeError</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1415" href="#t1415">1415</a></span><span class="t"> <span class="str">"Please use `flush()` extension to temporarily write the substvars to the file system"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1416" href="#t1416">1416</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="t1417" href="#t1417">1417</a></span><span class="t"> <span class="nam">super</span><span class="op">(</span><span class="op">)</span><span class="op">.</span><span class="nam">save</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1418" href="#t1418">1418</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1419" href="#t1419">1419</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1420" href="#t1420">1420</a></span><span class="t"><span class="key">class</span> <span class="nam">ServiceRegistry</span><span class="op">(</span><span class="nam">Generic</span><span class="op">[</span><span class="nam">DSD</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="t1421" href="#t1421">1421</a></span><span class="t"> <span class="nam">__slots__</span> <span class="op">=</span> <span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1422" href="#t1422">1422</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1423" href="#t1423">1423</a></span><span class="t"> <span class="key">def</span> <span class="nam">register_service</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1424" href="#t1424">1424</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="t1425" href="#t1425">1425</a></span><span class="t"> <span class="nam">path</span><span class="op">:</span> <span class="nam">VirtualPath</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1426" href="#t1426">1426</a></span><span class="t"> <span class="nam">name</span><span class="op">:</span> <span class="nam">Union</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="t1427" href="#t1427">1427</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="t1428" href="#t1428">1428</a></span><span class="t"> <span class="nam">type_of_service</span><span class="op">:</span> <span class="nam">str</span> <span class="op">=</span> <span class="str">"service"</span><span class="op">,</span> <span class="com"># "timer", etc.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1429" href="#t1429">1429</a></span><span class="t"> <span class="nam">service_scope</span><span class="op">:</span> <span class="nam">str</span> <span class="op">=</span> <span class="str">"system"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1430" href="#t1430">1430</a></span><span class="t"> <span class="nam">enable_by_default</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1431" href="#t1431">1431</a></span><span class="t"> <span class="nam">start_by_default</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1432" href="#t1432">1432</a></span><span class="t"> <span class="nam">default_upgrade_rule</span><span class="op">:</span> <span class="nam">ServiceUpgradeRule</span> <span class="op">=</span> <span class="str">"restart"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1433" href="#t1433">1433</a></span><span class="t"> <span class="nam">service_context</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">DSD</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="pln"><span class="n"><a id="t1434" href="#t1434">1434</a></span><span class="t"> <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="pln"><span class="n"><a id="t1435" href="#t1435">1435</a></span><span class="t"> <span class="str">"""Register a service detected in the package</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1436" href="#t1436">1436</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1437" href="#t1437">1437</a></span><span class="t"><span class="str"> All the details will either be provided as-is or used as default when the plugin provided</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1438" href="#t1438">1438</a></span><span class="t"><span class="str"> integration code is called.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1439" href="#t1439">1439</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1440" href="#t1440">1440</a></span><span class="t"><span class="str"> Two services from different service managers are considered related when:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1441" href="#t1441">1441</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1442" href="#t1442">1442</a></span><span class="t"><span class="str"> 1) They are of the same type (`type_of_service`) and has the same scope (`service_scope`), AND</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1443" href="#t1443">1443</a></span><span class="t"><span class="str"> 2) Their plugin provided names has an overlap</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1444" href="#t1444">1444</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1445" href="#t1445">1445</a></span><span class="t"><span class="str"> Related services can be covered by the same service definition in the manifest.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1446" href="#t1446">1446</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1447" href="#t1447">1447</a></span><span class="t"><span class="str"> :param path: The path defining this service.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1448" href="#t1448">1448</a></span><span class="t"><span class="str"> :param name: The name of the service. Multiple ones can be provided if the service has aliases.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1449" href="#t1449">1449</a></span><span class="t"><span class="str"> Note that when providing multiple names, `debputy` will use the first name in the list as the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1450" href="#t1450">1450</a></span><span class="t"><span class="str"> default name if it has to choose. Any alternative name provided can be used by the packager</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1451" href="#t1451">1451</a></span><span class="t"><span class="str"> to identify this service.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1452" href="#t1452">1452</a></span><span class="t"><span class="str"> :param type_of_service: The type of service. By default, this is "service", but plugins can</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1453" href="#t1453">1453</a></span><span class="t"><span class="str"> provide other types (such as "timer" for the systemd timer unit).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1454" href="#t1454">1454</a></span><span class="t"><span class="str"> :param service_scope: The scope for this service. By default, this is "system" meaning the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1455" href="#t1455">1455</a></span><span class="t"><span class="str"> service is a system-wide service. Service managers can define their own scopes such as</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1456" href="#t1456">1456</a></span><span class="t"><span class="str"> "user" (which is used by systemd for "per-user" services).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1457" href="#t1457">1457</a></span><span class="t"><span class="str"> :param enable_by_default: Whether the service should be enabled by default, assuming the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1458" href="#t1458">1458</a></span><span class="t"><span class="str"> packager does not explicitly override this setting.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1459" href="#t1459">1459</a></span><span class="t"><span class="str"> :param start_by_default: Whether the service should be started by default on install, assuming</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1460" href="#t1460">1460</a></span><span class="t"><span class="str"> the packager does not explicitly override this setting.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1461" href="#t1461">1461</a></span><span class="t"><span class="str"> :param default_upgrade_rule: The default value for how the service should be processed during</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1462" href="#t1462">1462</a></span><span class="t"><span class="str"> upgrades. Options are:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1463" href="#t1463">1463</a></span><span class="t"><span class="str"> * `do-nothing`: The plugin should not interact with the running service (if any)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1464" href="#t1464">1464</a></span><span class="t"><span class="str"> (maintenance of the enabled start, start on install, etc. are still applicable)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1465" href="#t1465">1465</a></span><span class="t"><span class="str"> * `reload`: The plugin should attempt to reload the running service (if any).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1466" href="#t1466">1466</a></span><span class="t"><span class="str"> Note: In combination with `auto_start_in_install == False`, be careful to not</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1467" href="#t1467">1467</a></span><span class="t"><span class="str"> start the service if not is not already running.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1468" href="#t1468">1468</a></span><span class="t"><span class="str"> * `restart`: The plugin should attempt to restart the running service (if any).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1469" href="#t1469">1469</a></span><span class="t"><span class="str"> Note: In combination with `auto_start_in_install == False`, be careful to not</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1470" href="#t1470">1470</a></span><span class="t"><span class="str"> start the service if not is not already running.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1471" href="#t1471">1471</a></span><span class="t"><span class="str"> * `stop-then-start`: The plugin should stop the service during `prerm upgrade`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1472" href="#t1472">1472</a></span><span class="t"><span class="str"> and start it against in the `postinst` script.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1473" href="#t1473">1473</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1474" href="#t1474">1474</a></span><span class="t"><span class="str"> :param service_context: Any custom data that the detector want to pass along to the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1475" href="#t1475">1475</a></span><span class="t"><span class="str"> integrator for this service.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1476" href="#t1476">1476</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1477" href="#t1477">1477</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1478" href="#t1478">1478</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1479" href="#t1479">1479</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1480" href="#t1480">1480</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="t1481" href="#t1481">1481</a></span><span class="t"><span class="key">class</span> <span class="nam">ParserAttributeDocumentation</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1482" href="#t1482">1482</a></span><span class="t"> <span class="nam">attributes</span><span class="op">:</span> <span class="nam">FrozenSet</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="t1483" href="#t1483">1483</a></span><span class="t"> <span class="nam">description</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="pln"><span class="n"><a id="t1484" href="#t1484">1484</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1485" href="#t1485">1485</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1486" href="#t1486">1486</a></span><span class="t"><span class="key">def</span> <span class="nam">undocumented_attr</span><span class="op">(</span><span class="nam">attr</span><span class="op">:</span> <span class="nam">str</span><span class="op">)</span> <span class="op">-></span> <span class="nam">ParserAttributeDocumentation</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1487" href="#t1487">1487</a></span><span class="t"> <span class="str">"""Describe an attribute as undocumented</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1488" href="#t1488">1488</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1489" href="#t1489">1489</a></span><span class="t"><span class="str"> If you for some reason do not want to document a particular attribute, you can mark it as</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1490" href="#t1490">1490</a></span><span class="t"><span class="str"> undocumented. This is required if you are only documenting a subset of the attributes,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1491" href="#t1491">1491</a></span><span class="t"><span class="str"> because `debputy` assumes any omission to be a mistake.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1492" href="#t1492">1492</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1493" href="#t1493">1493</a></span><span class="t"> <span class="key">return</span> <span class="nam">ParserAttributeDocumentation</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1494" href="#t1494">1494</a></span><span class="t"> <span class="nam">frozenset</span><span class="op">(</span><span class="op">{</span><span class="nam">attr</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="t1495" href="#t1495">1495</a></span><span class="t"> <span class="key">None</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1496" href="#t1496">1496</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1497" href="#t1497">1497</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1498" href="#t1498">1498</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1499" href="#t1499">1499</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="t1500" href="#t1500">1500</a></span><span class="t"><span class="key">class</span> <span class="nam">ParserDocumentation</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1501" href="#t1501">1501</a></span><span class="t"> <span class="nam">title</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1502" href="#t1502">1502</a></span><span class="t"> <span class="nam">description</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1503" href="#t1503">1503</a></span><span class="t"> <span class="nam">attribute_doc</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">Sequence</span><span class="op">[</span><span class="nam">ParserAttributeDocumentation</span><span class="op">]</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1504" href="#t1504">1504</a></span><span class="t"> <span class="nam">alt_parser_description</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1505" href="#t1505">1505</a></span><span class="t"> <span class="nam">documentation_reference_url</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1506" href="#t1506">1506</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1507" href="#t1507">1507</a></span><span class="t"> <span class="key">def</span> <span class="nam">replace</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="op">**</span><span class="nam">changes</span><span class="op">:</span> <span class="nam">Any</span><span class="op">)</span> <span class="op">-></span> <span class="str">"ParserDocumentation"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1508" href="#t1508">1508</a></span><span class="t"> <span class="key">return</span> <span class="nam">dataclasses</span><span class="op">.</span><span class="nam">replace</span><span class="op">(</span><span class="nam">self</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="t1509" href="#t1509">1509</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1510" href="#t1510">1510</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1511" href="#t1511">1511</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="t1512" href="#t1512">1512</a></span><span class="t"><span class="key">class</span> <span class="nam">TypeMappingExample</span><span class="op">(</span><span class="nam">Generic</span><span class="op">[</span><span class="nam">S</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="t1513" href="#t1513">1513</a></span><span class="t"> <span class="nam">source_input</span><span class="op">:</span> <span class="nam">S</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1514" href="#t1514">1514</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1515" href="#t1515">1515</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1516" href="#t1516">1516</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="t1517" href="#t1517">1517</a></span><span class="t"><span class="key">class</span> <span class="nam">TypeMappingDocumentation</span><span class="op">(</span><span class="nam">Generic</span><span class="op">[</span><span class="nam">S</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="t1518" href="#t1518">1518</a></span><span class="t"> <span class="nam">description</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1519" href="#t1519">1519</a></span><span class="t"> <span class="nam">examples</span><span class="op">:</span> <span class="nam">Sequence</span><span class="op">[</span><span class="nam">TypeMappingExample</span><span class="op">[</span><span class="nam">S</span><span class="op">]</span><span class="op">]</span> <span class="op">=</span> <span class="nam">tuple</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1520" href="#t1520">1520</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1521" href="#t1521">1521</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1522" href="#t1522">1522</a></span><span class="t"><span class="key">def</span> <span class="nam">type_mapping_example</span><span class="op">(</span><span class="nam">source_input</span><span class="op">:</span> <span class="nam">S</span><span class="op">)</span> <span class="op">-></span> <span class="nam">TypeMappingExample</span><span class="op">[</span><span class="nam">S</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1523" href="#t1523">1523</a></span><span class="t"> <span class="key">return</span> <span class="nam">TypeMappingExample</span><span class="op">(</span><span class="nam">source_input</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1524" href="#t1524">1524</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1525" href="#t1525">1525</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1526" href="#t1526">1526</a></span><span class="t"><span class="key">def</span> <span class="nam">type_mapping_reference_documentation</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1527" href="#t1527">1527</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="t1528" href="#t1528">1528</a></span><span class="t"> <span class="nam">description</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</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="pln"><span class="n"><a id="t1529" href="#t1529">1529</a></span><span class="t"> <span class="nam">examples</span><span class="op">:</span> <span class="nam">Union</span><span class="op">[</span><span class="nam">TypeMappingExample</span><span class="op">[</span><span class="nam">S</span><span class="op">]</span><span class="op">,</span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">TypeMappingExample</span><span class="op">[</span><span class="nam">S</span><span class="op">]</span><span class="op">]</span><span class="op">]</span> <span class="op">=</span> <span class="nam">tuple</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="t1530" href="#t1530">1530</a></span><span class="t"><span class="op">)</span> <span class="op">-></span> <span class="nam">TypeMappingDocumentation</span><span class="op">[</span><span class="nam">S</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1531" href="#t1531">1531</a></span><span class="t"> <span class="nam">e</span> <span class="op">=</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1532" href="#t1532">1532</a></span><span class="t"> <span class="nam">tuple</span><span class="op">(</span><span class="op">[</span><span class="nam">examples</span><span class="op">]</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1533" href="#t1533">1533</a></span><span class="t"> <span class="key">if</span> <span class="nam">isinstance</span><span class="op">(</span><span class="nam">examples</span><span class="op">,</span> <span class="nam">TypeMappingExample</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1534" href="#t1534">1534</a></span><span class="t"> <span class="key">else</span> <span class="nam">tuple</span><span class="op">(</span><span class="nam">examples</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1535" href="#t1535">1535</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1536" href="#t1536">1536</a></span><span class="t"> <span class="key">return</span> <span class="nam">TypeMappingDocumentation</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1537" href="#t1537">1537</a></span><span class="t"> <span class="nam">description</span><span class="op">=</span><span class="nam">description</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1538" href="#t1538">1538</a></span><span class="t"> <span class="nam">examples</span><span class="op">=</span><span class="nam">e</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1539" href="#t1539">1539</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1540" href="#t1540">1540</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1541" href="#t1541">1541</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1542" href="#t1542">1542</a></span><span class="t"><span class="key">def</span> <span class="nam">documented_attr</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1543" href="#t1543">1543</a></span><span class="t"> <span class="nam">attr</span><span class="op">:</span> <span class="nam">Union</span><span class="op">[</span><span class="nam">str</span><span class="op">,</span> <span class="nam">Iterable</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="t1544" href="#t1544">1544</a></span><span class="t"> <span class="nam">description</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="t1545" href="#t1545">1545</a></span><span class="t"><span class="op">)</span> <span class="op">-></span> <span class="nam">ParserAttributeDocumentation</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1546" href="#t1546">1546</a></span><span class="t"> <span class="str">"""Describe an attribute or a group of attributes</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1547" href="#t1547">1547</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1548" href="#t1548">1548</a></span><span class="t"><span class="str"> :param attr: A single attribute or a sequence of attributes. The attribute must be the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1549" href="#t1549">1549</a></span><span class="t"><span class="str"> attribute name as used in the source format version of the TypedDict.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1550" href="#t1550">1550</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1551" href="#t1551">1551</a></span><span class="t"><span class="str"> If multiple attributes are provided, they will be documented together. This is often</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1552" href="#t1552">1552</a></span><span class="t"><span class="str"> useful if these attributes are strongly related (such as different names for the same</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1553" href="#t1553">1553</a></span><span class="t"><span class="str"> target attribute).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1554" href="#t1554">1554</a></span><span class="t"><span class="str"> :param description: The description the user should see for this attribute / these</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1555" href="#t1555">1555</a></span><span class="t"><span class="str"> attributes. This parameter can be a Python format string with variables listed in</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1556" href="#t1556">1556</a></span><span class="t"><span class="str"> the description of `reference_documentation`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1557" href="#t1557">1557</a></span><span class="t"><span class="str"> :return: An opaque representation of the documentation,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1558" href="#t1558">1558</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1559" href="#t1559">1559</a></span><span class="t"> <span class="nam">attributes</span> <span class="op">=</span> <span class="op">[</span><span class="nam">attr</span><span class="op">]</span> <span class="key">if</span> <span class="nam">isinstance</span><span class="op">(</span><span class="nam">attr</span><span class="op">,</span> <span class="nam">str</span><span class="op">)</span> <span class="key">else</span> <span class="nam">attr</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1560" href="#t1560">1560</a></span><span class="t"> <span class="key">return</span> <span class="nam">ParserAttributeDocumentation</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1561" href="#t1561">1561</a></span><span class="t"> <span class="nam">frozenset</span><span class="op">(</span><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="t1562" href="#t1562">1562</a></span><span class="t"> <span class="nam">description</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1563" href="#t1563">1563</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1564" href="#t1564">1564</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1565" href="#t1565">1565</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1566" href="#t1566">1566</a></span><span class="t"><span class="key">def</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="t1567" href="#t1567">1567</a></span><span class="t"> <span class="nam">title</span><span class="op">:</span> <span class="nam">str</span> <span class="op">=</span> <span class="str">"Auto-generated reference documentation for {RULE_NAME}"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1568" href="#t1568">1568</a></span><span class="t"> <span class="nam">description</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</span><span class="op">]</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="t1569" href="#t1569">1569</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1570" href="#t1570">1570</a></span><span class="t"><span class="str"> This is an automatically generated reference documentation for {RULE_NAME}. It is generated</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1571" href="#t1571">1571</a></span><span class="t"><span class="str"> from input provided by {PLUGIN_NAME} via the debputy API.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1572" href="#t1572">1572</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1573" href="#t1573">1573</a></span><span class="t"><span class="str"> (If you are the provider of the {PLUGIN_NAME} plugin, you can replace this text with</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1574" href="#t1574">1574</a></span><span class="t"><span class="str"> your own documentation by providing the `inline_reference_documentation` when registering</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1575" href="#t1575">1575</a></span><span class="t"><span class="str"> the manifest rule.)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1576" href="#t1576">1576</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1577" href="#t1577">1577</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="t1578" href="#t1578">1578</a></span><span class="t"> <span class="nam">attributes</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">Sequence</span><span class="op">[</span><span class="nam">ParserAttributeDocumentation</span><span class="op">]</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="pln"><span class="n"><a id="t1579" href="#t1579">1579</a></span><span class="t"> <span class="nam">non_mapping_description</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</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="pln"><span class="n"><a id="t1580" href="#t1580">1580</a></span><span class="t"> <span class="nam">reference_documentation_url</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</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="pln"><span class="n"><a id="t1581" href="#t1581">1581</a></span><span class="t"><span class="op">)</span> <span class="op">-></span> <span class="nam">ParserDocumentation</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1582" href="#t1582">1582</a></span><span class="t"> <span class="str">"""Provide inline reference documentation for the manifest snippet</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1583" href="#t1583">1583</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1584" href="#t1584">1584</a></span><span class="t"><span class="str"> For parameters that mention that they are a Python format, the following format variables</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1585" href="#t1585">1585</a></span><span class="t"><span class="str"> are available:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1586" href="#t1586">1586</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1587" href="#t1587">1587</a></span><span class="t"><span class="str"> * RULE_NAME: Name of the rule. If manifest snippet has aliases, this will be the name of</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1588" href="#t1588">1588</a></span><span class="t"><span class="str"> the alias provided by the user.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1589" href="#t1589">1589</a></span><span class="t"><span class="str"> * MANIFEST_FORMAT_DOC: Path OR URL to the "MANIFEST-FORMAT" reference documentation from</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1590" href="#t1590">1590</a></span><span class="t"><span class="str"> `debputy`. By using the MANIFEST_FORMAT_DOC variable, you ensure that you point to the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1591" href="#t1591">1591</a></span><span class="t"><span class="str"> file that matches the version of `debputy` itself.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1592" href="#t1592">1592</a></span><span class="t"><span class="str"> * PLUGIN_NAME: Name of the plugin providing this rule.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1593" href="#t1593">1593</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1594" href="#t1594">1594</a></span><span class="t"><span class="str"> :param title: The text you want the user to see as for your rule. A placeholder is provided by default.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1595" href="#t1595">1595</a></span><span class="t"><span class="str"> This parameter can be a Python format string with the above listed variables.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1596" href="#t1596">1596</a></span><span class="t"><span class="str"> :param description: The text you want the user to see as a description for the rule. An auto-generated</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1597" href="#t1597">1597</a></span><span class="t"><span class="str"> placeholder is provided by default saying that no human written documentation was provided.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1598" href="#t1598">1598</a></span><span class="t"><span class="str"> This parameter can be a Python format string with the above listed variables.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1599" href="#t1599">1599</a></span><span class="t"><span class="str"> :param attributes: A sequence of attribute-related documentation. Each element of the sequence should</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1600" href="#t1600">1600</a></span><span class="t"><span class="str"> be the result of `documented_attr` or `undocumented_attr`. The sequence must cover all source</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1601" href="#t1601">1601</a></span><span class="t"><span class="str"> attributes exactly once.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1602" href="#t1602">1602</a></span><span class="t"><span class="str"> :param non_mapping_description: The text you want the user to see as the description for your rule when</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1603" href="#t1603">1603</a></span><span class="t"><span class="str"> `debputy` describes its non-mapping format. Must not be provided for rules that do not have an</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1604" href="#t1604">1604</a></span><span class="t"><span class="str"> (optional) non-mapping format as source format. This parameter can be a Python format string with</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1605" href="#t1605">1605</a></span><span class="t"><span class="str"> the above listed variables.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1606" href="#t1606">1606</a></span><span class="t"><span class="str"> :param reference_documentation_url: A URL to the reference documentation.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1607" href="#t1607">1607</a></span><span class="t"><span class="str"> :return: An opaque representation of the documentation,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1608" href="#t1608">1608</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1609" href="#t1609">1609</a></span><span class="t"> <span class="key">return</span> <span class="nam">ParserDocumentation</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1610" href="#t1610">1610</a></span><span class="t"> <span class="nam">title</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1611" href="#t1611">1611</a></span><span class="t"> <span class="nam">description</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1612" href="#t1612">1612</a></span><span class="t"> <span class="nam">attributes</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1613" href="#t1613">1613</a></span><span class="t"> <span class="nam">non_mapping_description</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1614" href="#t1614">1614</a></span><span class="t"> <span class="nam">reference_documentation_url</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1615" href="#t1615">1615</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1616" href="#t1616">1616</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1617" href="#t1617">1617</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1618" href="#t1618">1618</a></span><span class="t"><span class="key">class</span> <span class="nam">ServiceDefinition</span><span class="op">(</span><span class="nam">Generic</span><span class="op">[</span><span class="nam">DSD</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="t1619" href="#t1619">1619</a></span><span class="t"> <span class="nam">__slots__</span> <span class="op">=</span> <span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1620" href="#t1620">1620</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1621" href="#t1621">1621</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1622" href="#t1622">1622</a></span><span class="t"> <span class="key">def</span> <span class="nam">name</span><span class="op">(</span><span class="nam">self</span><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="pln"><span class="n"><a id="t1623" href="#t1623">1623</a></span><span class="t"> <span class="str">"""Name of the service registered by the plugin</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1624" href="#t1624">1624</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1625" href="#t1625">1625</a></span><span class="t"><span class="str"> This is always a plugin provided name for this service (that is, `x.name in x.names`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1626" href="#t1626">1626</a></span><span class="t"><span class="str"> will always be `True`). Where possible, this will be the same as the one that the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1627" href="#t1627">1627</a></span><span class="t"><span class="str"> packager provided when they provided any configuration related to this service.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1628" href="#t1628">1628</a></span><span class="t"><span class="str"> When not possible, this will be the first name provided by the plugin (`x.names[0]`).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1629" href="#t1629">1629</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1630" href="#t1630">1630</a></span><span class="t"><span class="str"> If all the aliases are equal, then using this attribute will provide traceability</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1631" href="#t1631">1631</a></span><span class="t"><span class="str"> between the manifest and the generated maintscript snippets. When the exact name</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1632" href="#t1632">1632</a></span><span class="t"><span class="str"> used is important, the plugin should ignore this attribute and pick the name that</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1633" href="#t1633">1633</a></span><span class="t"><span class="str"> is needed.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1634" href="#t1634">1634</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1635" href="#t1635">1635</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1636" href="#t1636">1636</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1637" href="#t1637">1637</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1638" href="#t1638">1638</a></span><span class="t"> <span class="key">def</span> <span class="nam">names</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Sequence</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="t1639" href="#t1639">1639</a></span><span class="t"> <span class="str">"""All *plugin provided* names and aliases of the service</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1640" href="#t1640">1640</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1641" href="#t1641">1641</a></span><span class="t"><span class="str"> This is the name/sequence of names that the plugin provided when it registered</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1642" href="#t1642">1642</a></span><span class="t"><span class="str"> the service earlier.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1643" href="#t1643">1643</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1644" href="#t1644">1644</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1645" href="#t1645">1645</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1646" href="#t1646">1646</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1647" href="#t1647">1647</a></span><span class="t"> <span class="key">def</span> <span class="nam">path</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">VirtualPath</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1648" href="#t1648">1648</a></span><span class="t"> <span class="str">"""The registered path for this service</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1649" href="#t1649">1649</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1650" href="#t1650">1650</a></span><span class="t"><span class="str"> :return: The path that was associated with this service when it was registered</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1651" href="#t1651">1651</a></span><span class="t"><span class="str"> earlier.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1652" href="#t1652">1652</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1653" href="#t1653">1653</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1654" href="#t1654">1654</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1655" href="#t1655">1655</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1656" href="#t1656">1656</a></span><span class="t"> <span class="key">def</span> <span class="nam">type_of_service</span><span class="op">(</span><span class="nam">self</span><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="pln"><span class="n"><a id="t1657" href="#t1657">1657</a></span><span class="t"> <span class="str">"""Type of the service such as "service" (daemon), "timer", etc.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1658" href="#t1658">1658</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1659" href="#t1659">1659</a></span><span class="t"><span class="str"> :return: The type of service scope. It is the same value as the one as the plugin provided</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1660" href="#t1660">1660</a></span><span class="t"><span class="str"> when registering the service (if not explicitly provided, it defaults to "service").</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1661" href="#t1661">1661</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1662" href="#t1662">1662</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1663" href="#t1663">1663</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1664" href="#t1664">1664</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1665" href="#t1665">1665</a></span><span class="t"> <span class="key">def</span> <span class="nam">service_scope</span><span class="op">(</span><span class="nam">self</span><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="pln"><span class="n"><a id="t1666" href="#t1666">1666</a></span><span class="t"> <span class="str">"""Service scope such as "system" or "user"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1667" href="#t1667">1667</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1668" href="#t1668">1668</a></span><span class="t"><span class="str"> :return: The service scope. It is the same value as the one as the plugin provided</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1669" href="#t1669">1669</a></span><span class="t"><span class="str"> when registering the service (if not explicitly provided, it defaults to "system")</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1670" href="#t1670">1670</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1671" href="#t1671">1671</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1672" href="#t1672">1672</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1673" href="#t1673">1673</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1674" href="#t1674">1674</a></span><span class="t"> <span class="key">def</span> <span class="nam">auto_enable_on_install</span><span class="op">(</span><span class="nam">self</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="pln"><span class="n"><a id="t1675" href="#t1675">1675</a></span><span class="t"> <span class="str">"""Whether the service should be auto-enabled on install</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1676" href="#t1676">1676</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1677" href="#t1677">1677</a></span><span class="t"><span class="str"> :return: True if the service should be enabled automatically, false if not.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1678" href="#t1678">1678</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1679" href="#t1679">1679</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1680" href="#t1680">1680</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1681" href="#t1681">1681</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1682" href="#t1682">1682</a></span><span class="t"> <span class="key">def</span> <span class="nam">auto_start_on_install</span><span class="op">(</span><span class="nam">self</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="pln"><span class="n"><a id="t1683" href="#t1683">1683</a></span><span class="t"> <span class="str">"""Whether the service should be auto-started on install</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1684" href="#t1684">1684</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1685" href="#t1685">1685</a></span><span class="t"><span class="str"> :return: True if the service should be started automatically, false if not.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1686" href="#t1686">1686</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1687" href="#t1687">1687</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1688" href="#t1688">1688</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1689" href="#t1689">1689</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1690" href="#t1690">1690</a></span><span class="t"> <span class="key">def</span> <span class="nam">on_upgrade</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">ServiceUpgradeRule</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1691" href="#t1691">1691</a></span><span class="t"> <span class="str">"""How to handle the service during an upgrade</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1692" href="#t1692">1692</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1693" href="#t1693">1693</a></span><span class="t"><span class="str"> Options are:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1694" href="#t1694">1694</a></span><span class="t"><span class="str"> * `do-nothing`: The plugin should not interact with the running service (if any)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1695" href="#t1695">1695</a></span><span class="t"><span class="str"> (maintenance of the enabled start, start on install, etc. are still applicable)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1696" href="#t1696">1696</a></span><span class="t"><span class="str"> * `reload`: The plugin should attempt to reload the running service (if any).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1697" href="#t1697">1697</a></span><span class="t"><span class="str"> Note: In combination with `auto_start_in_install == False`, be careful to not</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1698" href="#t1698">1698</a></span><span class="t"><span class="str"> start the service if not is not already running.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1699" href="#t1699">1699</a></span><span class="t"><span class="str"> * `restart`: The plugin should attempt to restart the running service (if any).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1700" href="#t1700">1700</a></span><span class="t"><span class="str"> Note: In combination with `auto_start_in_install == False`, be careful to not</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1701" href="#t1701">1701</a></span><span class="t"><span class="str"> start the service if not is not already running.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1702" href="#t1702">1702</a></span><span class="t"><span class="str"> * `stop-then-start`: The plugin should stop the service during `prerm upgrade`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1703" href="#t1703">1703</a></span><span class="t"><span class="str"> and start it against in the `postinst` script.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1704" href="#t1704">1704</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1705" href="#t1705">1705</a></span><span class="t"><span class="str"> Note: In all cases, the plugin should still consider what to do in</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1706" href="#t1706">1706</a></span><span class="t"><span class="str"> `prerm remove`, which is the last point in time where the plugin can rely on the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1707" href="#t1707">1707</a></span><span class="t"><span class="str"> service definitions in the file systems to stop the services when the package is</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1708" href="#t1708">1708</a></span><span class="t"><span class="str"> being uninstalled.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1709" href="#t1709">1709</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1710" href="#t1710">1710</a></span><span class="t"><span class="str"> :return: The service restart rule</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1711" href="#t1711">1711</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1712" href="#t1712">1712</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1713" href="#t1713">1713</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1714" href="#t1714">1714</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1715" href="#t1715">1715</a></span><span class="t"> <span class="key">def</span> <span class="nam">definition_source</span><span class="op">(</span><span class="nam">self</span><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="pln"><span class="n"><a id="t1716" href="#t1716">1716</a></span><span class="t"> <span class="str">"""Describes where this definition came from</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1717" href="#t1717">1717</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1718" href="#t1718">1718</a></span><span class="t"><span class="str"> If the definition is provided by the packager, then this will reference the part</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1719" href="#t1719">1719</a></span><span class="t"><span class="str"> of the manifest that made this definition. Otherwise, this will be a reference</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1720" href="#t1720">1720</a></span><span class="t"><span class="str"> to the plugin providing this definition.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1721" href="#t1721">1721</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1722" href="#t1722">1722</a></span><span class="t"><span class="str"> :return: The source of this definition</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1723" href="#t1723">1723</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1724" href="#t1724">1724</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1725" href="#t1725">1725</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1726" href="#t1726">1726</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1727" href="#t1727">1727</a></span><span class="t"> <span class="key">def</span> <span class="nam">is_plugin_provided_definition</span><span class="op">(</span><span class="nam">self</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="pln"><span class="n"><a id="t1728" href="#t1728">1728</a></span><span class="t"> <span class="str">"""Whether the definition source points to the plugin or a package provided definition</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1729" href="#t1729">1729</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1730" href="#t1730">1730</a></span><span class="t"><span class="str"> :return: True if definition is 100% from the plugin. False if the definition is partially</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1731" href="#t1731">1731</a></span><span class="t"><span class="str"> or fully from another source (usually, the packager via the manifest).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1732" href="#t1732">1732</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1733" href="#t1733">1733</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1734" href="#t1734">1734</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1735" href="#t1735">1735</a></span><span class="t"> <span class="op">@</span><span class="nam">property</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t1736" href="#t1736">1736</a></span><span class="t"> <span class="key">def</span> <span class="nam">service_context</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Optional</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="t1737" href="#t1737">1737</a></span><span class="t"> <span class="str">"""Custom service context (if any) provided by the detector code of the plugin</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1738" href="#t1738">1738</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1739" href="#t1739">1739</a></span><span class="t"><span class="str"> :return: If the detection code provided a custom data when registering the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1740" href="#t1740">1740</a></span><span class="t"><span class="str"> service, this attribute will reference that data. If nothing was provided,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1741" href="#t1741">1741</a></span><span class="t"><span class="str"> then this attribute will be None.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1742" href="#t1742">1742</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1743" href="#t1743">1743</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> -</main> -<footer> - <div class="content"> - <p> - <a id="prevFileLink" class="nav" href="d_64287305fe0c6642_plugin_parser_py.html">« prev</a> - <a id="indexLink" class="nav" href="index.html">^ index</a> - <a id="nextFileLink" class="nav" href="d_4b9be07fb6071cd2___init___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> |