logging.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>flask.logging &#8212; proxypool documentation</title>
  7. <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
  8. <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: '../../',
  12. VERSION: '',
  13. COLLAPSE_INDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="../../_static/jquery.js"></script>
  19. <script type="text/javascript" src="../../_static/underscore.js"></script>
  20. <script type="text/javascript" src="../../_static/doctools.js"></script>
  21. <link rel="index" title="Index" href="../../genindex.html" />
  22. <link rel="search" title="Search" href="../../search.html" />
  23. <link rel="top" title="proxypool documentation" href="../../index.html" />
  24. <link rel="up" title="Module code" href="../index.html" />
  25. <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  26. <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  27. </head>
  28. <body role="document">
  29. <div class="document">
  30. <div class="documentwrapper">
  31. <div class="bodywrapper">
  32. <div class="body" role="main">
  33. <h1>Source code for flask.logging</h1><div class="highlight"><pre>
  34. <span></span><span class="c1"># -*- coding: utf-8 -*-</span>
  35. <span class="sd">&quot;&quot;&quot;</span>
  36. <span class="sd"> flask.logging</span>
  37. <span class="sd"> ~~~~~~~~~~~~~</span>
  38. <span class="sd"> Implements the logging support for Flask.</span>
  39. <span class="sd"> :copyright: (c) 2015 by Armin Ronacher.</span>
  40. <span class="sd"> :license: BSD, see LICENSE for more details.</span>
  41. <span class="sd">&quot;&quot;&quot;</span>
  42. <span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
  43. <span class="kn">import</span> <span class="nn">sys</span>
  44. <span class="kn">from</span> <span class="nn">werkzeug.local</span> <span class="k">import</span> <span class="n">LocalProxy</span>
  45. <span class="kn">from</span> <span class="nn">logging</span> <span class="k">import</span> <span class="n">getLogger</span><span class="p">,</span> <span class="n">StreamHandler</span><span class="p">,</span> <span class="n">Formatter</span><span class="p">,</span> <span class="n">getLoggerClass</span><span class="p">,</span> \
  46. <span class="n">DEBUG</span><span class="p">,</span> <span class="n">ERROR</span>
  47. <span class="kn">from</span> <span class="nn">.globals</span> <span class="k">import</span> <span class="n">_request_ctx_stack</span>
  48. <span class="n">PROD_LOG_FORMAT</span> <span class="o">=</span> <span class="s1">&#39;[</span><span class="si">%(asctime)s</span><span class="s1">] </span><span class="si">%(levelname)s</span><span class="s1"> in </span><span class="si">%(module)s</span><span class="s1">: </span><span class="si">%(message)s</span><span class="s1">&#39;</span>
  49. <span class="n">DEBUG_LOG_FORMAT</span> <span class="o">=</span> <span class="p">(</span>
  50. <span class="s1">&#39;-&#39;</span> <span class="o">*</span> <span class="mi">80</span> <span class="o">+</span> <span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span> <span class="o">+</span>
  51. <span class="s1">&#39;</span><span class="si">%(levelname)s</span><span class="s1"> in </span><span class="si">%(module)s</span><span class="s1"> [</span><span class="si">%(pathname)s</span><span class="s1">:</span><span class="si">%(lineno)d</span><span class="s1">]:</span><span class="se">\n</span><span class="s1">&#39;</span> <span class="o">+</span>
  52. <span class="s1">&#39;</span><span class="si">%(message)s</span><span class="se">\n</span><span class="s1">&#39;</span> <span class="o">+</span>
  53. <span class="s1">&#39;-&#39;</span> <span class="o">*</span> <span class="mi">80</span>
  54. <span class="p">)</span>
  55. <span class="nd">@LocalProxy</span>
  56. <span class="k">def</span> <span class="nf">_proxy_stream</span><span class="p">():</span>
  57. <span class="sd">&quot;&quot;&quot;Finds the most appropriate error stream for the application. If a</span>
  58. <span class="sd"> WSGI request is in flight we log to wsgi.errors, otherwise this resolves</span>
  59. <span class="sd"> to sys.stderr.</span>
  60. <span class="sd"> &quot;&quot;&quot;</span>
  61. <span class="n">ctx</span> <span class="o">=</span> <span class="n">_request_ctx_stack</span><span class="o">.</span><span class="n">top</span>
  62. <span class="k">if</span> <span class="n">ctx</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
  63. <span class="k">return</span> <span class="n">ctx</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;wsgi.errors&#39;</span><span class="p">]</span>
  64. <span class="k">return</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span>
  65. <span class="k">def</span> <span class="nf">_should_log_for</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">mode</span><span class="p">):</span>
  66. <span class="n">policy</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;LOGGER_HANDLER_POLICY&#39;</span><span class="p">]</span>
  67. <span class="k">if</span> <span class="n">policy</span> <span class="o">==</span> <span class="n">mode</span> <span class="ow">or</span> <span class="n">policy</span> <span class="o">==</span> <span class="s1">&#39;always&#39;</span><span class="p">:</span>
  68. <span class="k">return</span> <span class="kc">True</span>
  69. <span class="k">return</span> <span class="kc">False</span>
  70. <div class="viewcode-block" id="create_logger"><a class="viewcode-back" href="../../flask/flask.html#flask.logging.create_logger">[docs]</a><span class="k">def</span> <span class="nf">create_logger</span><span class="p">(</span><span class="n">app</span><span class="p">):</span>
  71. <span class="sd">&quot;&quot;&quot;Creates a logger for the given application. This logger works</span>
  72. <span class="sd"> similar to a regular Python logger but changes the effective logging</span>
  73. <span class="sd"> level based on the application&#39;s debug flag. Furthermore this</span>
  74. <span class="sd"> function also removes all attached handlers in case there was a</span>
  75. <span class="sd"> logger with the log name before.</span>
  76. <span class="sd"> &quot;&quot;&quot;</span>
  77. <span class="n">Logger</span> <span class="o">=</span> <span class="n">getLoggerClass</span><span class="p">()</span>
  78. <span class="k">class</span> <span class="nc">DebugLogger</span><span class="p">(</span><span class="n">Logger</span><span class="p">):</span>
  79. <span class="k">def</span> <span class="nf">getEffectiveLevel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  80. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">level</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">app</span><span class="o">.</span><span class="n">debug</span><span class="p">:</span>
  81. <span class="k">return</span> <span class="n">DEBUG</span>
  82. <span class="k">return</span> <span class="n">Logger</span><span class="o">.</span><span class="n">getEffectiveLevel</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
  83. <span class="k">class</span> <span class="nc">DebugHandler</span><span class="p">(</span><span class="n">StreamHandler</span><span class="p">):</span>
  84. <span class="k">def</span> <span class="nf">emit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">):</span>
  85. <span class="k">if</span> <span class="n">app</span><span class="o">.</span><span class="n">debug</span> <span class="ow">and</span> <span class="n">_should_log_for</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="s1">&#39;debug&#39;</span><span class="p">):</span>
  86. <span class="n">StreamHandler</span><span class="o">.</span><span class="n">emit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">)</span>
  87. <span class="k">class</span> <span class="nc">ProductionHandler</span><span class="p">(</span><span class="n">StreamHandler</span><span class="p">):</span>
  88. <span class="k">def</span> <span class="nf">emit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">):</span>
  89. <span class="k">if</span> <span class="ow">not</span> <span class="n">app</span><span class="o">.</span><span class="n">debug</span> <span class="ow">and</span> <span class="n">_should_log_for</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="s1">&#39;production&#39;</span><span class="p">):</span>
  90. <span class="n">StreamHandler</span><span class="o">.</span><span class="n">emit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">)</span>
  91. <span class="n">debug_handler</span> <span class="o">=</span> <span class="n">DebugHandler</span><span class="p">()</span>
  92. <span class="n">debug_handler</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">DEBUG</span><span class="p">)</span>
  93. <span class="n">debug_handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">Formatter</span><span class="p">(</span><span class="n">DEBUG_LOG_FORMAT</span><span class="p">))</span>
  94. <span class="n">prod_handler</span> <span class="o">=</span> <span class="n">ProductionHandler</span><span class="p">(</span><span class="n">_proxy_stream</span><span class="p">)</span>
  95. <span class="n">prod_handler</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">ERROR</span><span class="p">)</span>
  96. <span class="n">prod_handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">Formatter</span><span class="p">(</span><span class="n">PROD_LOG_FORMAT</span><span class="p">))</span>
  97. <span class="n">logger</span> <span class="o">=</span> <span class="n">getLogger</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">logger_name</span><span class="p">)</span>
  98. <span class="c1"># just in case that was not a new logger, get rid of all the handlers</span>
  99. <span class="c1"># already attached to it.</span>
  100. <span class="k">del</span> <span class="n">logger</span><span class="o">.</span><span class="n">handlers</span><span class="p">[:]</span>
  101. <span class="n">logger</span><span class="o">.</span><span class="n">__class__</span> <span class="o">=</span> <span class="n">DebugLogger</span>
  102. <span class="n">logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">debug_handler</span><span class="p">)</span>
  103. <span class="n">logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">prod_handler</span><span class="p">)</span>
  104. <span class="k">return</span> <span class="n">logger</span></div>
  105. </pre></div>
  106. </div>
  107. </div>
  108. </div>
  109. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  110. <div class="sphinxsidebarwrapper"><div class="relations">
  111. <h3>Related Topics</h3>
  112. <ul>
  113. <li><a href="../../index.html">Documentation overview</a><ul>
  114. <li><a href="../index.html">Module code</a><ul>
  115. </ul></li>
  116. </ul></li>
  117. </ul>
  118. </div>
  119. <div id="searchbox" style="display: none" role="search">
  120. <h3>Quick search</h3>
  121. <form class="search" action="../../search.html" method="get">
  122. <div><input type="text" name="q" /></div>
  123. <div><input type="submit" value="Go" /></div>
  124. <input type="hidden" name="check_keywords" value="yes" />
  125. <input type="hidden" name="area" value="default" />
  126. </form>
  127. </div>
  128. <script type="text/javascript">$('#searchbox').show(0);</script>
  129. </div>
  130. </div>
  131. <div class="clearer"></div>
  132. </div>
  133. <div class="footer">
  134. &copy;2016, Author.
  135. |
  136. Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
  137. &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
  138. </div>
  139. </body>
  140. </html>