<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Module: utils.warn — IPython 2.3.0 documentation</title> <link rel="stylesheet" href="../../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../../', VERSION: '2.3.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </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> <link rel="top" title="IPython 2.3.0 documentation" href="../../index.html" /> <link rel="up" title="The IPython API" href="../index.html" /> <link rel="next" title="Module: utils.wildcard" href="IPython.utils.wildcard.html" /> <link rel="prev" title="Module: utils.version" href="IPython.utils.version.html" /> </head> <body> <div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px"> <a href="http://ipython.org/"><img src="../../_static/logo.png" border="0" alt="IPython Documentation"/></a> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="IPython.utils.wildcard.html" title="Module: utils.wildcard" accesskey="N">next</a> |</li> <li class="right" > <a href="IPython.utils.version.html" title="Module: utils.version" accesskey="P">previous</a> |</li> <li><a href="http://ipython.org">home</a>| </li> <li><a href="../../search.html">search</a>| </li> <li><a href="../../index.html">documentation </a> »</li> <li><a href="../index.html" accesskey="U">The IPython API</a> »</li> </ul> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="../../index.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">Module: <tt class="docutils literal"><span class="pre">utils.warn</span></tt></a><ul> <li><a class="reference internal" href="#functions">4 Functions</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="IPython.utils.version.html" title="previous chapter">Module: <tt class="docutils literal"><span class="pre">utils.version</span></tt></a></p> <h4>Next topic</h4> <p class="topless"><a href="IPython.utils.wildcard.html" title="next chapter">Module: <tt class="docutils literal"><span class="pre">utils.wildcard</span></tt></a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../../_sources/api/generated/IPython.utils.warn.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="module-IPython.utils.warn"> <span id="module-utils-warn"></span><h1>Module: <tt class="xref py py-mod docutils literal"><span class="pre">utils.warn</span></tt><a class="headerlink" href="#module-IPython.utils.warn" title="Permalink to this headline">¶</a></h1> <p>Utilities for warnings. Shoudn’t we just use the built in warnings module.</p> <div class="section" id="functions"> <h2>4 Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h2> <dl class="function"> <dt id="IPython.utils.warn.warn"> <tt class="descclassname">IPython.utils.warn.</tt><tt class="descname">warn</tt><big>(</big><em>msg</em>, <em>level=2</em>, <em>exit_val=1</em><big>)</big><a class="headerlink" href="#IPython.utils.warn.warn" title="Permalink to this definition">¶</a></dt> <dd><p>Standard warning printer. Gives formatting consistency.</p> <p>Output is sent to io.stderr (sys.stderr by default).</p> <p>Options:</p> <dl class="docutils"> <dt>-level(2): allows finer control:</dt> <dd>0 -> Do nothing, dummy function. 1 -> Print message. 2 -> Print ‘WARNING:’ + message. (Default level). 3 -> Print ‘ERROR:’ + message. 4 -> Print ‘FATAL ERROR:’ + message and trigger a sys.exit(exit_val).</dd> </dl> <p>-exit_val (1): exit value returned by sys.exit() for a level 4 warning. Ignored for all other levels.</p> </dd></dl> <dl class="function"> <dt id="IPython.utils.warn.info"> <tt class="descclassname">IPython.utils.warn.</tt><tt class="descname">info</tt><big>(</big><em>msg</em><big>)</big><a class="headerlink" href="#IPython.utils.warn.info" title="Permalink to this definition">¶</a></dt> <dd><p>Equivalent to warn(msg,level=1).</p> </dd></dl> <dl class="function"> <dt id="IPython.utils.warn.error"> <tt class="descclassname">IPython.utils.warn.</tt><tt class="descname">error</tt><big>(</big><em>msg</em><big>)</big><a class="headerlink" href="#IPython.utils.warn.error" title="Permalink to this definition">¶</a></dt> <dd><p>Equivalent to warn(msg,level=3).</p> </dd></dl> <dl class="function"> <dt id="IPython.utils.warn.fatal"> <tt class="descclassname">IPython.utils.warn.</tt><tt class="descname">fatal</tt><big>(</big><em>msg</em>, <em>exit_val=1</em><big>)</big><a class="headerlink" href="#IPython.utils.warn.fatal" title="Permalink to this definition">¶</a></dt> <dd><p>Equivalent to warn(msg,exit_val=exit_val,level=4).</p> </dd></dl> </div> </div> </div> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="IPython.utils.wildcard.html" title="Module: utils.wildcard" >next</a> |</li> <li class="right" > <a href="IPython.utils.version.html" title="Module: utils.version" >previous</a> |</li> <li><a href="http://ipython.org">home</a>| </li> <li><a href="../../search.html">search</a>| </li> <li><a href="../../index.html">documentation </a> »</li> <li><a href="../index.html" >The IPython API</a> »</li> </ul> </div> <div class="footer"> © Copyright The IPython Development Team. Last updated on Sep 02, 2015. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. </div> </body> </html>