/usr/share/doc/python3-certbot/html/_modules/certbot/error_handler.html is in python-certbot-doc 0.23.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 | <!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>certbot.error_handler — Certbot 0.23.0 documentation</title>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="../../genindex.html"/>
<link rel="search" title="Search" href="../../search.html"/>
<link rel="top" title="Certbot 0.23.0 documentation" href="../../index.html"/>
<link rel="up" title="Module code" href="../index.html"/>
<script src="../../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../../index.html" class="icon icon-home"> Certbot
</a>
<div class="version">
0.23
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../what.html">What is a Certificate?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../install.html">Get Certbot</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../using.html">User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Developer Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../packaging.html">Packaging Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../resources.html">Resources</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../api.html">API Documentation</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">Certbot</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html">Docs</a> »</li>
<li><a href="../index.html">Module code</a> »</li>
<li>certbot.error_handler</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for certbot.error_handler</h1><div class="highlight"><pre>
<span></span><span class="sd">"""Registers functions to be called if an exception or signal occurs."""</span>
<span class="kn">import</span> <span class="nn">functools</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">signal</span>
<span class="kn">import</span> <span class="nn">traceback</span>
<span class="kn">from</span> <span class="nn">certbot</span> <span class="k">import</span> <span class="n">errors</span>
<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
<span class="c1"># _SIGNALS stores the signals that will be handled by the ErrorHandler. These</span>
<span class="c1"># signals were chosen as their default handler terminates the process and could</span>
<span class="c1"># potentially occur from inside Python. Signals such as SIGILL were not</span>
<span class="c1"># included as they could be a sign of something devious and we should terminate</span>
<span class="c1"># immediately.</span>
<span class="n">_SIGNALS</span> <span class="o">=</span> <span class="p">[</span><span class="n">signal</span><span class="o">.</span><span class="n">SIGTERM</span><span class="p">]</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">name</span> <span class="o">!=</span> <span class="s2">"nt"</span><span class="p">:</span>
<span class="k">for</span> <span class="n">signal_code</span> <span class="ow">in</span> <span class="p">[</span><span class="n">signal</span><span class="o">.</span><span class="n">SIGHUP</span><span class="p">,</span> <span class="n">signal</span><span class="o">.</span><span class="n">SIGQUIT</span><span class="p">,</span>
<span class="n">signal</span><span class="o">.</span><span class="n">SIGXCPU</span><span class="p">,</span> <span class="n">signal</span><span class="o">.</span><span class="n">SIGXFSZ</span><span class="p">]:</span>
<span class="c1"># Adding only those signals that their default action is not Ignore.</span>
<span class="c1"># This is platform-dependent, so we check it dynamically.</span>
<span class="k">if</span> <span class="n">signal</span><span class="o">.</span><span class="n">getsignal</span><span class="p">(</span><span class="n">signal_code</span><span class="p">)</span> <span class="o">!=</span> <span class="n">signal</span><span class="o">.</span><span class="n">SIG_IGN</span><span class="p">:</span>
<span class="n">_SIGNALS</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">signal_code</span><span class="p">)</span>
<div class="viewcode-block" id="ErrorHandler"><a class="viewcode-back" href="../../api/error_handler.html#certbot.error_handler.ErrorHandler">[docs]</a><span class="k">class</span> <span class="nc">ErrorHandler</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""Context manager for running code that must be cleaned up on failure.</span>
<span class="sd"> The context manager allows you to register functions that will be called</span>
<span class="sd"> when an exception (excluding SystemExit) or signal is encountered.</span>
<span class="sd"> Usage::</span>
<span class="sd"> handler = ErrorHandler(cleanup1_func, *cleanup1_args, **cleanup1_kwargs)</span>
<span class="sd"> handler.register(cleanup2_func, *cleanup2_args, **cleanup2_kwargs)</span>
<span class="sd"> with handler:</span>
<span class="sd"> do_something()</span>
<span class="sd"> Or for one cleanup function::</span>
<span class="sd"> with ErrorHandler(func, args, kwargs):</span>
<span class="sd"> do_something()</span>
<span class="sd"> If an exception is raised out of do_something, the cleanup functions will</span>
<span class="sd"> be called in last in first out order. Then the exception is raised.</span>
<span class="sd"> Similarly, if a signal is encountered, the cleanup functions are called</span>
<span class="sd"> followed by the previously received signal handler.</span>
<span class="sd"> Each registered cleanup function is called exactly once. If a registered</span>
<span class="sd"> function raises an exception, it is logged and the next function is called.</span>
<span class="sd"> Signals received while the registered functions are executing are</span>
<span class="sd"> deferred until they finish.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">func</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">call_on_regular_exit</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">body_executed</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">funcs</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prev_handlers</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">received_signals</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">func</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">func</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">body_executed</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_set_signal_handlers</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exec_type</span><span class="p">,</span> <span class="n">exec_value</span><span class="p">,</span> <span class="n">trace</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">body_executed</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">retval</span> <span class="o">=</span> <span class="kc">False</span>
<span class="c1"># SystemExit is ignored to properly handle forks that don't exec</span>
<span class="k">if</span> <span class="n">exec_type</span> <span class="ow">is</span> <span class="ne">SystemExit</span><span class="p">:</span>
<span class="k">return</span> <span class="n">retval</span>
<span class="k">elif</span> <span class="n">exec_type</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">call_on_regular_exit</span><span class="p">:</span>
<span class="k">return</span> <span class="n">retval</span>
<span class="k">elif</span> <span class="n">exec_type</span> <span class="ow">is</span> <span class="n">errors</span><span class="o">.</span><span class="n">SignalExit</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Encountered signals: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">received_signals</span><span class="p">)</span>
<span class="n">retval</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Encountered exception:</span><span class="se">\n</span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
<span class="n">traceback</span><span class="o">.</span><span class="n">format_exception</span><span class="p">(</span><span class="n">exec_type</span><span class="p">,</span> <span class="n">exec_value</span><span class="p">,</span> <span class="n">trace</span><span class="p">)))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_call_registered</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_reset_signal_handlers</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_call_signals</span><span class="p">()</span>
<span class="k">return</span> <span class="n">retval</span>
<div class="viewcode-block" id="ErrorHandler.register"><a class="viewcode-back" href="../../api/error_handler.html#certbot.error_handler.ErrorHandler.register">[docs]</a> <span class="k">def</span> <span class="nf">register</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">func</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""Sets func to be run with the given arguments during cleanup.</span>
<span class="sd"> :param function func: function to be called in case of an error</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">funcs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">functools</span><span class="o">.</span><span class="n">partial</span><span class="p">(</span><span class="n">func</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">))</span></div>
<div class="viewcode-block" id="ErrorHandler._call_registered"><a class="viewcode-back" href="../../api/error_handler.html#certbot.error_handler.ErrorHandler._call_registered">[docs]</a> <span class="k">def</span> <span class="nf">_call_registered</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Calls all registered functions"""</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Calling registered functions"</span><span class="p">)</span>
<span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">funcs</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">funcs</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]()</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">error</span><span class="p">:</span> <span class="c1"># pylint: disable=broad-except</span>
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"Encountered exception during recovery"</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span><span class="n">error</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">funcs</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span></div>
<div class="viewcode-block" id="ErrorHandler._set_signal_handlers"><a class="viewcode-back" href="../../api/error_handler.html#certbot.error_handler.ErrorHandler._set_signal_handlers">[docs]</a> <span class="k">def</span> <span class="nf">_set_signal_handlers</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Sets signal handlers for signals in _SIGNALS."""</span>
<span class="k">for</span> <span class="n">signum</span> <span class="ow">in</span> <span class="n">_SIGNALS</span><span class="p">:</span>
<span class="n">prev_handler</span> <span class="o">=</span> <span class="n">signal</span><span class="o">.</span><span class="n">getsignal</span><span class="p">(</span><span class="n">signum</span><span class="p">)</span>
<span class="c1"># If prev_handler is None, the handler was set outside of Python</span>
<span class="k">if</span> <span class="n">prev_handler</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prev_handlers</span><span class="p">[</span><span class="n">signum</span><span class="p">]</span> <span class="o">=</span> <span class="n">prev_handler</span>
<span class="n">signal</span><span class="o">.</span><span class="n">signal</span><span class="p">(</span><span class="n">signum</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_signal_handler</span><span class="p">)</span></div>
<div class="viewcode-block" id="ErrorHandler._reset_signal_handlers"><a class="viewcode-back" href="../../api/error_handler.html#certbot.error_handler.ErrorHandler._reset_signal_handlers">[docs]</a> <span class="k">def</span> <span class="nf">_reset_signal_handlers</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Resets signal handlers for signals in _SIGNALS."""</span>
<span class="k">for</span> <span class="n">signum</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">prev_handlers</span><span class="p">:</span>
<span class="n">signal</span><span class="o">.</span><span class="n">signal</span><span class="p">(</span><span class="n">signum</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">prev_handlers</span><span class="p">[</span><span class="n">signum</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prev_handlers</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span></div>
<div class="viewcode-block" id="ErrorHandler._signal_handler"><a class="viewcode-back" href="../../api/error_handler.html#certbot.error_handler.ErrorHandler._signal_handler">[docs]</a> <span class="k">def</span> <span class="nf">_signal_handler</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">signum</span><span class="p">,</span> <span class="n">unused_frame</span><span class="p">):</span>
<span class="sd">"""Replacement function for handling received signals.</span>
<span class="sd"> Store the received signal. If we are executing the code block in</span>
<span class="sd"> the body of the context manager, stop by raising signal exit.</span>
<span class="sd"> :param int signum: number of current signal</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">received_signals</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">signum</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">body_executed</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">SignalExit</span></div>
<div class="viewcode-block" id="ErrorHandler._call_signals"><a class="viewcode-back" href="../../api/error_handler.html#certbot.error_handler.ErrorHandler._call_signals">[docs]</a> <span class="k">def</span> <span class="nf">_call_signals</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Finally call the deferred signals."""</span>
<span class="k">for</span> <span class="n">signum</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">received_signals</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Calling signal </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">signum</span><span class="p">)</span>
<span class="n">os</span><span class="o">.</span><span class="n">kill</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getpid</span><span class="p">(),</span> <span class="n">signum</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="ExitHandler"><a class="viewcode-back" href="../../api/error_handler.html#certbot.error_handler.ExitHandler">[docs]</a><span class="k">class</span> <span class="nc">ExitHandler</span><span class="p">(</span><span class="n">ErrorHandler</span><span class="p">):</span>
<span class="sd">"""Context manager for running code that must be cleaned up.</span>
<span class="sd"> Subclass of ErrorHandler, with the same usage and parameters.</span>
<span class="sd"> In addition to cleaning up on all signals, also cleans up on</span>
<span class="sd"> regular exit.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">func</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">ErrorHandler</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">func</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">call_on_regular_exit</span> <span class="o">=</span> <span class="kc">True</span></div>
</pre></div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
<span class="copyright">
© Copyright 2014-2018 - The Certbot software and documentation are licensed under the Apache 2.0 license as described at <a href="https://eff.org/cb-license">https://eff.org/cb-license</a>.
</span>
<br>
<br>
<span class="status">
<a href="https://letsencrypt.status.io/">Let's Encrypt Status</a>
</span>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'0.23.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|