Deployed b1d6a09 with MkDocs version: 1.3.0

This commit is contained in:
2022-07-12 07:04:59 +00:00
parent 25a66fb86b
commit 0683061983
6 changed files with 369 additions and 101 deletions

View file

@ -3830,6 +3830,7 @@ the system and <code>ignore_missing=False</code>.</p></td>
<div class="doc doc-contents first">
<p>Return a customised logger used throughout the GreatAI codebase.</p>
<p>Uses colors, and only prints timestamps when not running inside notebook.</p>
<details class="quote">
<summary>Source code in <code>great_ai/utilities/logger/get_logger.py</code></summary>
@ -3851,25 +3852,43 @@ the system and <code>ignore_missing=False</code>.</p></td>
<span class="normal"><a href="#__codelineno-0-24">24</a></span>
<span class="normal"><a href="#__codelineno-0-25">25</a></span>
<span class="normal"><a href="#__codelineno-0-26">26</a></span>
<span class="normal"><a href="#__codelineno-0-27">27</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-9" name="__codelineno-0-9"></a><span class="k">def</span> <span class="nf">get_logger</span><span class="p">(</span>
<span class="normal"><a href="#__codelineno-0-27">27</a></span>
<span class="normal"><a href="#__codelineno-0-28">28</a></span>
<span class="normal"><a href="#__codelineno-0-29">29</a></span>
<span class="normal"><a href="#__codelineno-0-30">30</a></span>
<span class="normal"><a href="#__codelineno-0-31">31</a></span>
<span class="normal"><a href="#__codelineno-0-32">32</a></span>
<span class="normal"><a href="#__codelineno-0-33">33</a></span>
<span class="normal"><a href="#__codelineno-0-34">34</a></span>
<span class="normal"><a href="#__codelineno-0-35">35</a></span>
<span class="normal"><a href="#__codelineno-0-36">36</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-9" name="__codelineno-0-9"></a><span class="k">def</span> <span class="nf">get_logger</span><span class="p">(</span>
<a id="__codelineno-0-10" name="__codelineno-0-10"></a> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">level</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">,</span> <span class="n">disable_colors</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
<a id="__codelineno-0-11" name="__codelineno-0-11"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">logging</span><span class="o">.</span><span class="n">Logger</span><span class="p">:</span>
<a id="__codelineno-0-12" name="__codelineno-0-12"></a> <span class="sd">&quot;&quot;&quot;Return a customised logger used throughout the GreatAI codebase.&quot;&quot;&quot;</span>
<a id="__codelineno-0-12" name="__codelineno-0-12"></a> <span class="sd">&quot;&quot;&quot;Return a customised logger used throughout the GreatAI codebase.</span>
<a id="__codelineno-0-13" name="__codelineno-0-13"></a>
<a id="__codelineno-0-14" name="__codelineno-0-14"></a> <span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">loggers</span><span class="p">:</span>
<a id="__codelineno-0-15" name="__codelineno-0-15"></a> <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="n">name</span><span class="p">)</span>
<a id="__codelineno-0-16" name="__codelineno-0-16"></a> <span class="n">logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">level</span><span class="p">)</span>
<a id="__codelineno-0-17" name="__codelineno-0-17"></a>
<a id="__codelineno-0-18" name="__codelineno-0-18"></a> <span class="n">log_format</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">%(asctime)s</span><span class="s2"> | </span><span class="si">%(levelname)8s</span><span class="s2"> | </span><span class="si">%(message)s</span><span class="s2">&quot;</span>
<a id="__codelineno-0-19" name="__codelineno-0-19"></a> <span class="n">stdout_handler</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">()</span>
<a id="__codelineno-0-20" name="__codelineno-0-20"></a> <span class="n">stdout_handler</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">level</span><span class="p">)</span>
<a id="__codelineno-0-21" name="__codelineno-0-21"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">disable_colors</span><span class="p">:</span>
<a id="__codelineno-0-22" name="__codelineno-0-22"></a> <span class="n">stdout_handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">CustomFormatter</span><span class="p">(</span><span class="n">log_format</span><span class="p">))</span>
<a id="__codelineno-0-23" name="__codelineno-0-23"></a>
<a id="__codelineno-0-24" name="__codelineno-0-24"></a> <span class="n">logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">stdout_handler</span><span class="p">)</span>
<a id="__codelineno-0-25" name="__codelineno-0-25"></a> <span class="n">loggers</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">logger</span>
<a id="__codelineno-0-26" name="__codelineno-0-26"></a>
<a id="__codelineno-0-27" name="__codelineno-0-27"></a> <span class="k">return</span> <span class="n">loggers</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<a id="__codelineno-0-14" name="__codelineno-0-14"></a><span class="sd"> Uses colors, and only prints timestamps when not running inside notebook.</span>
<a id="__codelineno-0-15" name="__codelineno-0-15"></a><span class="sd"> &quot;&quot;&quot;</span>
<a id="__codelineno-0-16" name="__codelineno-0-16"></a>
<a id="__codelineno-0-17" name="__codelineno-0-17"></a> <span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">loggers</span><span class="p">:</span>
<a id="__codelineno-0-18" name="__codelineno-0-18"></a> <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="n">name</span><span class="p">)</span>
<a id="__codelineno-0-19" name="__codelineno-0-19"></a> <span class="n">logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">level</span><span class="p">)</span>
<a id="__codelineno-0-20" name="__codelineno-0-20"></a>
<a id="__codelineno-0-21" name="__codelineno-0-21"></a> <span class="k">try</span><span class="p">:</span>
<a id="__codelineno-0-22" name="__codelineno-0-22"></a> <span class="n">get_ipython</span><span class="p">()</span> <span class="c1"># type: ignore</span>
<a id="__codelineno-0-23" name="__codelineno-0-23"></a> <span class="n">log_format</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">%(message)s</span><span class="s2">&quot;</span>
<a id="__codelineno-0-24" name="__codelineno-0-24"></a> <span class="k">except</span> <span class="ne">NameError</span><span class="p">:</span>
<a id="__codelineno-0-25" name="__codelineno-0-25"></a> <span class="c1"># will fail outside of a notebook https://ipython.org/</span>
<a id="__codelineno-0-26" name="__codelineno-0-26"></a> <span class="n">log_format</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">%(asctime)s</span><span class="s2"> | </span><span class="si">%(levelname)8s</span><span class="s2"> | </span><span class="si">%(message)s</span><span class="s2">&quot;</span>
<a id="__codelineno-0-27" name="__codelineno-0-27"></a>
<a id="__codelineno-0-28" name="__codelineno-0-28"></a> <span class="n">stdout_handler</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">()</span>
<a id="__codelineno-0-29" name="__codelineno-0-29"></a> <span class="n">stdout_handler</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">level</span><span class="p">)</span>
<a id="__codelineno-0-30" name="__codelineno-0-30"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">disable_colors</span><span class="p">:</span>
<a id="__codelineno-0-31" name="__codelineno-0-31"></a> <span class="n">stdout_handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">CustomFormatter</span><span class="p">(</span><span class="n">log_format</span><span class="p">))</span>
<a id="__codelineno-0-32" name="__codelineno-0-32"></a>
<a id="__codelineno-0-33" name="__codelineno-0-33"></a> <span class="n">logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">stdout_handler</span><span class="p">)</span>
<a id="__codelineno-0-34" name="__codelineno-0-34"></a> <span class="n">loggers</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">logger</span>
<a id="__codelineno-0-35" name="__codelineno-0-35"></a>
<a id="__codelineno-0-36" name="__codelineno-0-36"></a> <span class="k">return</span> <span class="n">loggers</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
</code></pre></div></td></tr></table></div>
</details>
</div>