Edit File: cmdline.html
<!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>1. Command line and environment — Python v2.6.6 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.6.6', COLLAPSE_MODINDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python v2.6.6 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="top" title="Python v2.6.6 documentation" href="../index.html" /> <link rel="up" title="Using Python" href="index.html" /> <link rel="next" title="2. Using Python on Unix platforms" href="unix.html" /> <link rel="prev" title="Using Python" href="index.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> </head> <body> <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="../modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li> <li class="right" > <a href="unix.html" title="2. Using Python on Unix platforms" accesskey="N">next</a> |</li> <li class="right" > <a href="index.html" title="Using Python" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="../index.html">Python v2.6.6 documentation</a> »</li> <li><a href="index.html" accesskey="U">Using Python</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="command-line-and-environment"> <span id="using-on-general"></span><h1>1. Command line and environment<a class="headerlink" href="#command-line-and-environment" title="Permalink to this headline">¶</a></h1> <p>The CPython interpreter scans the command line and the environment for various settings.</p> <div class="impl-detail compound"> <p><strong>CPython implementation detail:</strong> Other implementations’ command line schemes may differ. See <a class="reference external" href="../reference/introduction.html#implementations"><em>Alternate Implementations</em></a> for further resources.</p> </div> <div class="section" id="command-line"> <span id="using-on-cmdline"></span><h2>1.1. Command line<a class="headerlink" href="#command-line" title="Permalink to this headline">¶</a></h2> <p>When invoking Python, you may specify any of these options:</p> <div class="highlight-none"><div class="highlight"><pre>python [-BdEiOQsStuUvVWxX3?] [-c command | -m module-name | script | - ] [args] </pre></div> </div> <p>The most common use case is, of course, a simple invocation of a script:</p> <div class="highlight-none"><div class="highlight"><pre>python myscript.py </pre></div> </div> <div class="section" id="interface-options"> <span id="using-on-interface-options"></span><h3>1.1.1. Interface options<a class="headerlink" href="#interface-options" title="Permalink to this headline">¶</a></h3> <p>The interpreter interface resembles that of the UNIX shell, but provides some additional methods of invocation:</p> <ul class="simple"> <li>When called with standard input connected to a tty device, it prompts for commands and executes them until an EOF (an end-of-file character, you can produce that with <em>Ctrl-D</em> on UNIX or <em>Ctrl-Z, Enter</em> on Windows) is read.</li> <li>When called with a file name argument or with a file as standard input, it reads and executes a script from that file.</li> <li>When called with a directory name argument, it reads and executes an appropriately named script from that directory.</li> <li>When called with <tt class="docutils literal"><span class="pre">-c</span> <span class="pre">command</span></tt>, it executes the Python statement(s) given as <em>command</em>. Here <em>command</em> may contain multiple statements separated by newlines. Leading whitespace is significant in Python statements!</li> <li>When called with <tt class="docutils literal"><span class="pre">-m</span> <span class="pre">module-name</span></tt>, the given module is located on the Python module path and executed as a script.</li> </ul> <p>In non-interactive mode, the entire input is parsed before it is executed.</p> <p>An interface option terminates the list of options consumed by the interpreter, all consecutive arguments will end up in <a title="sys.argv" class="reference external" href="../library/sys.html#sys.argv"><tt class="xref docutils literal"><span class="pre">sys.argv</span></tt></a> – note that the first element, subscript zero (<tt class="docutils literal"><span class="pre">sys.argv[0]</span></tt>), is a string reflecting the program’s source.</p> <dl class="cmdoption"> <dt id="cmdoption-c"> <tt class="descname">-c</tt><tt class="descclassname"> <command></tt><a class="headerlink" href="#cmdoption-c" title="Permalink to this definition">¶</a></dt> <dd><p>Execute the Python code in <em>command</em>. <em>command</em> can be one or more statements separated by newlines, with significant leading whitespace as in normal module code.</p> <p>If this option is given, the first element of <a title="sys.argv" class="reference external" href="../library/sys.html#sys.argv"><tt class="xref docutils literal"><span class="pre">sys.argv</span></tt></a> will be <tt class="docutils literal"><span class="pre">"-c"</span></tt> and the current directory will be added to the start of <a title="sys.path" class="reference external" href="../library/sys.html#sys.path"><tt class="xref docutils literal"><span class="pre">sys.path</span></tt></a> (allowing modules in that directory to be imported as top level modules).</p> </dd></dl> <dl class="cmdoption"> <dt id="cmdoption-m"> <tt class="descname">-m</tt><tt class="descclassname"> <module-name></tt><a class="headerlink" href="#cmdoption-m" title="Permalink to this definition">¶</a></dt> <dd><p>Search <a title="sys.path" class="reference external" href="../library/sys.html#sys.path"><tt class="xref docutils literal"><span class="pre">sys.path</span></tt></a> for the named module and execute its contents as the <a title="The environment where the top-level script is run." class="reference external" href="../library/__main__.html#module-__main__"><tt class="xref docutils literal"><span class="pre">__main__</span></tt></a> module.</p> <p>Since the argument is a <em>module</em> name, you must not give a file extension (<tt class="docutils literal"><span class="pre">.py</span></tt>). The <tt class="docutils literal"><span class="pre">module-name</span></tt> should be a valid Python module name, but the implementation may not always enforce this (e.g. it may allow you to use a name that includes a hyphen).</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">This option cannot be used with built-in modules and extension modules written in C, since they do not have Python module files. However, it can still be used for precompiled modules, even if the original source file is not available.</p> </div> <p>If this option is given, the first element of <a title="sys.argv" class="reference external" href="../library/sys.html#sys.argv"><tt class="xref docutils literal"><span class="pre">sys.argv</span></tt></a> will be the full path to the module file. As with the <a class="reference internal" href="#cmdoption-c"><em class="xref">-c</em></a> option, the current directory will be added to the start of <a title="sys.path" class="reference external" href="../library/sys.html#sys.path"><tt class="xref docutils literal"><span class="pre">sys.path</span></tt></a>.</p> <p>Many standard library modules contain code that is invoked on their execution as a script. An example is the <a title="Measure the execution time of small code snippets." class="reference external" href="../library/timeit.html#module-timeit"><tt class="xref docutils literal"><span class="pre">timeit</span></tt></a> module:</p> <div class="highlight-none"><div class="highlight"><pre>python -mtimeit -s 'setup here' 'benchmarked code here' python -mtimeit -h # for details </pre></div> </div> <div class="admonition-see-also admonition seealso"> <p class="first admonition-title">See also</p> <p><a title="runpy.run_module" class="reference external" href="../library/runpy.html#runpy.run_module"><tt class="xref docutils literal"><span class="pre">runpy.run_module()</span></tt></a> The actual implementation of this feature.</p> <p class="last"><span class="target" id="index-1109"></span><a class="reference external" href="http://www.python.org/dev/peps/pep-0338"><strong>PEP 338</strong></a> – Executing modules as scripts</p> </div> <p class="versionadded"> <span class="versionmodified">New in version 2.4.</span></p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>The named module can now be located inside a package.</p> </dd></dl> <dl class="describe"> <dt> <tt class="descname">-</tt></dt> <dd><p>Read commands from standard input (<a title="sys.stdin" class="reference external" href="../library/sys.html#sys.stdin"><tt class="xref docutils literal"><span class="pre">sys.stdin</span></tt></a>). If standard input is a terminal, <a class="reference internal" href="#cmdoption-i"><em class="xref">-i</em></a> is implied.</p> <p>If this option is given, the first element of <a title="sys.argv" class="reference external" href="../library/sys.html#sys.argv"><tt class="xref docutils literal"><span class="pre">sys.argv</span></tt></a> will be <tt class="docutils literal"><span class="pre">"-"</span></tt> and the current directory will be added to the start of <a title="sys.path" class="reference external" href="../library/sys.html#sys.path"><tt class="xref docutils literal"><span class="pre">sys.path</span></tt></a>.</p> </dd></dl> <dl class="describe"> <dt> <tt class="descname"><script></tt></dt> <dd><p>Execute the Python code contained in <em>script</em>, which must be a filesystem path (absolute or relative) referring to either a Python file, a directory containing a <tt class="docutils literal"><span class="pre">__main__.py</span></tt> file, or a zipfile containing a <tt class="docutils literal"><span class="pre">__main__.py</span></tt> file.</p> <p>If this option is given, the first element of <a title="sys.argv" class="reference external" href="../library/sys.html#sys.argv"><tt class="xref docutils literal"><span class="pre">sys.argv</span></tt></a> will be the script name as given on the command line.</p> <p>If the script name refers directly to a Python file, the directory containing that file is added to the start of <a title="sys.path" class="reference external" href="../library/sys.html#sys.path"><tt class="xref docutils literal"><span class="pre">sys.path</span></tt></a>, and the file is executed as the <a title="The environment where the top-level script is run." class="reference external" href="../library/__main__.html#module-__main__"><tt class="xref docutils literal"><span class="pre">__main__</span></tt></a> module.</p> <p>If the script name refers to a directory or zipfile, the script name is added to the start of <a title="sys.path" class="reference external" href="../library/sys.html#sys.path"><tt class="xref docutils literal"><span class="pre">sys.path</span></tt></a> and the <tt class="docutils literal"><span class="pre">__main__.py</span></tt> file in that location is executed as the <a title="The environment where the top-level script is run." class="reference external" href="../library/__main__.html#module-__main__"><tt class="xref docutils literal"><span class="pre">__main__</span></tt></a> module.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>Directories and zipfiles containing a <tt class="docutils literal"><span class="pre">__main__.py</span></tt> file at the top level are now considered valid Python scripts.</p> </dd></dl> <p>If no interface option is given, <a class="reference internal" href="#cmdoption-i"><em class="xref">-i</em></a> is implied, <tt class="docutils literal"><span class="pre">sys.argv[0]</span></tt> is an empty string (<tt class="docutils literal"><span class="pre">""</span></tt>) and the current directory will be added to the start of <a title="sys.path" class="reference external" href="../library/sys.html#sys.path"><tt class="xref docutils literal"><span class="pre">sys.path</span></tt></a>.</p> <div class="admonition-see-also admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><a class="reference external" href="../tutorial/interpreter.html#tut-invoking"><em>Invoking the Interpreter</em></a></p> </div> </div> <div class="section" id="generic-options"> <h3>1.1.2. Generic options<a class="headerlink" href="#generic-options" title="Permalink to this headline">¶</a></h3> <dl class="cmdoption"> <dt> <tt class="descname">-?</tt></dt> <dt id="cmdoption-h"> <tt class="descname">-h</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-h" title="Permalink to this definition">¶</a></dt> <dt id="cmdoption--help"> <tt class="descname">--help</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption--help" title="Permalink to this definition">¶</a></dt> <dd><p>Print a short description of all command line options.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>The <tt class="docutils literal"><span class="pre">--help</span></tt> variant.</p> </dd></dl> <dl class="cmdoption"> <dt id="cmdoption-V"> <tt class="descname">-V</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-V" title="Permalink to this definition">¶</a></dt> <dt id="cmdoption--version"> <tt class="descname">--version</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption--version" title="Permalink to this definition">¶</a></dt> <dd><p>Print the Python version number and exit. Example output could be:</p> <div class="highlight-none"><div class="highlight"><pre>Python 2.5.1 </pre></div> </div> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>The <tt class="docutils literal"><span class="pre">--version</span></tt> variant.</p> </dd></dl> </div> <div class="section" id="miscellaneous-options"> <h3>1.1.3. Miscellaneous options<a class="headerlink" href="#miscellaneous-options" title="Permalink to this headline">¶</a></h3> <dl class="cmdoption"> <dt id="cmdoption-B"> <tt class="descname">-B</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-B" title="Permalink to this definition">¶</a></dt> <dd><p>If given, Python won’t try to write <tt class="docutils literal"><span class="pre">.pyc</span></tt> or <tt class="docutils literal"><span class="pre">.pyo</span></tt> files on the import of source modules. See also <span class="target" id="index-1110"></span><a class="reference internal" href="#envvar-PYTHONDONTWRITEBYTECODE"><strong class="xref">PYTHONDONTWRITEBYTECODE</strong></a>.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.6.</span></p> </dd></dl> <dl class="cmdoption"> <dt id="cmdoption-d"> <tt class="descname">-d</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-d" title="Permalink to this definition">¶</a></dt> <dd>Turn on parser debugging output (for wizards only, depending on compilation options). See also <span class="target" id="index-1111"></span><a class="reference internal" href="#envvar-PYTHONDEBUG"><strong class="xref">PYTHONDEBUG</strong></a>.</dd></dl> <dl class="cmdoption"> <dt id="cmdoption-E"> <tt class="descname">-E</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-E" title="Permalink to this definition">¶</a></dt> <dd><p>Ignore all <span class="target" id="index-1112"></span><strong class="xref">PYTHON*</strong> environment variables, e.g. <span class="target" id="index-1113"></span><a class="reference internal" href="#envvar-PYTHONPATH"><strong class="xref">PYTHONPATH</strong></a> and <span class="target" id="index-1114"></span><a class="reference internal" href="#envvar-PYTHONHOME"><strong class="xref">PYTHONHOME</strong></a>, that might be set.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.2.</span></p> </dd></dl> <dl class="cmdoption"> <dt id="cmdoption-i"> <tt class="descname">-i</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-i" title="Permalink to this definition">¶</a></dt> <dd><p>When a script is passed as first argument or the <a class="reference internal" href="#cmdoption-c"><em class="xref">-c</em></a> option is used, enter interactive mode after executing the script or the command, even when <a title="sys.stdin" class="reference external" href="../library/sys.html#sys.stdin"><tt class="xref docutils literal"><span class="pre">sys.stdin</span></tt></a> does not appear to be a terminal. The <span class="target" id="index-1115"></span><a class="reference internal" href="#envvar-PYTHONSTARTUP"><strong class="xref">PYTHONSTARTUP</strong></a> file is not read.</p> <p>This can be useful to inspect global variables or a stack trace when a script raises an exception. See also <span class="target" id="index-1116"></span><a class="reference internal" href="#envvar-PYTHONINSPECT"><strong class="xref">PYTHONINSPECT</strong></a>.</p> </dd></dl> <dl class="cmdoption"> <dt id="cmdoption-O"> <tt class="descname">-O</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-O" title="Permalink to this definition">¶</a></dt> <dd>Turn on basic optimizations. This changes the filename extension for compiled (<a class="reference external" href="../glossary.html#term-bytecode"><em class="xref">bytecode</em></a>) files from <tt class="docutils literal"><span class="pre">.pyc</span></tt> to <tt class="docutils literal"><span class="pre">.pyo</span></tt>. See also <span class="target" id="index-1117"></span><a class="reference internal" href="#envvar-PYTHONOPTIMIZE"><strong class="xref">PYTHONOPTIMIZE</strong></a>.</dd></dl> <dl class="cmdoption"> <dt id="cmdoption-OO"> <tt class="descname">-OO</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-OO" title="Permalink to this definition">¶</a></dt> <dd>Discard docstrings in addition to the <a class="reference internal" href="#cmdoption-O"><em class="xref">-O</em></a> optimizations.</dd></dl> <dl class="cmdoption"> <dt id="cmdoption-Q"> <tt class="descname">-Q</tt><tt class="descclassname"> <arg></tt><a class="headerlink" href="#cmdoption-Q" title="Permalink to this definition">¶</a></dt> <dd><p>Division control. The argument must be one of the following:</p> <dl class="docutils"> <dt><tt class="docutils literal"><span class="pre">old</span></tt></dt> <dd>division of int/int and long/long return an int or long (<em>default</em>)</dd> <dt><tt class="docutils literal"><span class="pre">new</span></tt></dt> <dd>new division semantics, i.e. division of int/int and long/long returns a float</dd> <dt><tt class="docutils literal"><span class="pre">warn</span></tt></dt> <dd>old division semantics with a warning for int/int and long/long</dd> <dt><tt class="docutils literal"><span class="pre">warnall</span></tt></dt> <dd>old division semantics with a warning for all uses of the division operator</dd> </dl> <div class="admonition-see-also admonition seealso"> <p class="first admonition-title">See also</p> <p><tt class="docutils literal"><span class="pre">Tools/scripts/fixdiv.py</span></tt> for a use of <tt class="docutils literal"><span class="pre">warnall</span></tt></p> <p class="last"><span class="target" id="index-1118"></span><a class="reference external" href="http://www.python.org/dev/peps/pep-0238"><strong>PEP 238</strong></a> – Changing the division operator</p> </div> </dd></dl> <dl class="cmdoption"> <dt id="cmdoption-s"> <tt class="descname">-s</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-s" title="Permalink to this definition">¶</a></dt> <dd><p>Don’t add user site directory to sys.path</p> <p class="versionadded"> <span class="versionmodified">New in version 2.6.</span></p> <div class="admonition-see-also admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><span class="target" id="index-1119"></span><a class="reference external" href="http://www.python.org/dev/peps/pep-0370"><strong>PEP 370</strong></a> – Per user site-packages directory</p> </div> </dd></dl> <dl class="cmdoption"> <dt id="cmdoption-S"> <tt class="descname">-S</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-S" title="Permalink to this definition">¶</a></dt> <dd>Disable the import of the module <a title="A standard way to reference site-specific modules." class="reference external" href="../library/site.html#module-site"><tt class="xref docutils literal"><span class="pre">site</span></tt></a> and the site-dependent manipulations of <a title="sys.path" class="reference external" href="../library/sys.html#sys.path"><tt class="xref docutils literal"><span class="pre">sys.path</span></tt></a> that it entails.</dd></dl> <dl class="cmdoption"> <dt id="cmdoption-t"> <tt class="descname">-t</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-t" title="Permalink to this definition">¶</a></dt> <dd>Issue a warning when a source file mixes tabs and spaces for indentation in a way that makes it depend on the worth of a tab expressed in spaces. Issue an error when the option is given twice (<em class="xref">-tt</em>).</dd></dl> <dl class="cmdoption"> <dt id="cmdoption-u"> <tt class="descname">-u</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-u" title="Permalink to this definition">¶</a></dt> <dd><p>Force stdin, stdout and stderr to be totally unbuffered. On systems where it matters, also put stdin, stdout and stderr in binary mode.</p> <p>Note that there is internal buffering in <a title="file.readlines" class="reference external" href="../library/stdtypes.html#file.readlines"><tt class="xref docutils literal"><span class="pre">file.readlines()</span></tt></a> and <a class="reference external" href="../library/stdtypes.html#bltin-file-objects"><em>File Objects</em></a> (<tt class="docutils literal"><span class="pre">for</span> <span class="pre">line</span> <span class="pre">in</span> <span class="pre">sys.stdin</span></tt>) which is not influenced by this option. To work around this, you will want to use <a title="file.readline" class="reference external" href="../library/stdtypes.html#file.readline"><tt class="xref docutils literal"><span class="pre">file.readline()</span></tt></a> inside a <tt class="docutils literal"><span class="pre">while</span> <span class="pre">1:</span></tt> loop.</p> <p>See also <span class="target" id="index-1120"></span><a class="reference internal" href="#envvar-PYTHONUNBUFFERED"><strong class="xref">PYTHONUNBUFFERED</strong></a>.</p> </dd></dl> <dl class="cmdoption"> <dt id="cmdoption-v"> <tt class="descname">-v</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-v" title="Permalink to this definition">¶</a></dt> <dd>Print a message each time a module is initialized, showing the place (filename or built-in module) from which it is loaded. When given twice (<em class="xref">-vv</em>), print a message for each file that is checked for when searching for a module. Also provides information on module cleanup at exit. See also <span class="target" id="index-1121"></span><a class="reference internal" href="#envvar-PYTHONVERBOSE"><strong class="xref">PYTHONVERBOSE</strong></a>.</dd></dl> <dl class="cmdoption"> <dt id="cmdoption-W"> <tt class="descname">-W</tt><tt class="descclassname"> arg</tt><a class="headerlink" href="#cmdoption-W" title="Permalink to this definition">¶</a></dt> <dd><p>Warning control. Python’s warning machinery by default prints warning messages to <a title="sys.stderr" class="reference external" href="../library/sys.html#sys.stderr"><tt class="xref docutils literal"><span class="pre">sys.stderr</span></tt></a>. A typical warning message has the following form:</p> <div class="highlight-none"><div class="highlight"><pre>file:line: category: message </pre></div> </div> <p>By default, each warning is printed once for each source line where it occurs. This option controls how often warnings are printed.</p> <p>Multiple <a class="reference internal" href="#cmdoption-W"><em class="xref">-W</em></a> options may be given; when a warning matches more than one option, the action for the last matching option is performed. Invalid <a class="reference internal" href="#cmdoption-W"><em class="xref">-W</em></a> options are ignored (though, a warning message is printed about invalid options when the first warning is issued).</p> <p>Warnings can also be controlled from within a Python program using the <a title="Issue warning messages and control their disposition." class="reference external" href="../library/warnings.html#module-warnings"><tt class="xref docutils literal"><span class="pre">warnings</span></tt></a> module.</p> <p>The simplest form of argument is one of the following action strings (or a unique abbreviation) by themselves:</p> <dl class="docutils"> <dt><tt class="docutils literal"><span class="pre">ignore</span></tt></dt> <dd>Ignore all warnings.</dd> <dt><tt class="docutils literal"><span class="pre">default</span></tt></dt> <dd>Explicitly request the default behavior (printing each warning once per source line).</dd> <dt><tt class="docutils literal"><span class="pre">all</span></tt></dt> <dd>Print a warning each time it occurs (this may generate many messages if a warning is triggered repeatedly for the same source line, such as inside a loop).</dd> <dt><tt class="docutils literal"><span class="pre">module</span></tt></dt> <dd>Print each warning only the first time it occurs in each module.</dd> <dt><tt class="docutils literal"><span class="pre">once</span></tt></dt> <dd>Print each warning only the first time it occurs in the program.</dd> <dt><tt class="docutils literal"><span class="pre">error</span></tt></dt> <dd>Raise an exception instead of printing a warning message.</dd> </dl> <p>The full form of argument is:</p> <div class="highlight-none"><div class="highlight"><pre>action:message:category:module:line </pre></div> </div> <p>Here, <em>action</em> is as explained above but only applies to messages that match the remaining fields. Empty fields match all values; trailing empty fields may be omitted. The <em>message</em> field matches the start of the warning message printed; this match is case-insensitive. The <em>category</em> field matches the warning category. This must be a class name; the match test whether the actual warning category of the message is a subclass of the specified warning category. The full class name must be given. The <em>module</em> field matches the (fully-qualified) module name; this match is case-sensitive. The <em>line</em> field matches the line number, where zero matches all line numbers and is thus equivalent to an omitted line number.</p> <div class="admonition-see-also admonition seealso"> <p class="first admonition-title">See also</p> <p><a title="Issue warning messages and control their disposition." class="reference external" href="../library/warnings.html#module-warnings"><tt class="xref docutils literal"><span class="pre">warnings</span></tt></a> – the warnings module</p> <p class="last"><span class="target" id="index-1122"></span><a class="reference external" href="http://www.python.org/dev/peps/pep-0230"><strong>PEP 230</strong></a> – Warning framework</p> </div> </dd></dl> <dl class="cmdoption"> <dt id="cmdoption-x"> <tt class="descname">-x</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-x" title="Permalink to this definition">¶</a></dt> <dd><p>Skip the first line of the source, allowing use of non-Unix forms of <tt class="docutils literal"><span class="pre">#!cmd</span></tt>. This is intended for a DOS specific hack only.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">The line numbers in error messages will be off by one.</p> </div> </dd></dl> <dl class="cmdoption"> <dt id="cmdoption-3"> <tt class="descname">-3</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-3" title="Permalink to this definition">¶</a></dt> <dd><p>Warn about Python 3.x incompatibilities which cannot be fixed trivially by <a class="reference external" href="../library/2to3.html#to3-reference"><em>2to3</em></a>. Among these are:</p> <ul class="simple"> <li><a title="dict.has_key" class="reference external" href="../library/stdtypes.html#dict.has_key"><tt class="xref docutils literal"><span class="pre">dict.has_key()</span></tt></a></li> <li><a title="apply" class="reference external" href="../library/functions.html#apply"><tt class="xref docutils literal"><span class="pre">apply()</span></tt></a></li> <li><a title="callable" class="reference external" href="../library/functions.html#callable"><tt class="xref docutils literal"><span class="pre">callable()</span></tt></a></li> <li><a title="coerce" class="reference external" href="../library/functions.html#coerce"><tt class="xref docutils literal"><span class="pre">coerce()</span></tt></a></li> <li><a title="execfile" class="reference external" href="../library/functions.html#execfile"><tt class="xref docutils literal"><span class="pre">execfile()</span></tt></a></li> <li><a title="reduce" class="reference external" href="../library/functions.html#reduce"><tt class="xref docutils literal"><span class="pre">reduce()</span></tt></a></li> <li><a title="reload" class="reference external" href="../library/functions.html#reload"><tt class="xref docutils literal"><span class="pre">reload()</span></tt></a></li> </ul> <p>Using these will emit a <a title="exceptions.DeprecationWarning" class="reference external" href="../library/exceptions.html#exceptions.DeprecationWarning"><tt class="xref docutils literal"><span class="pre">DeprecationWarning</span></tt></a>.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.6.</span></p> </dd></dl> </div> <div class="section" id="options-you-shouldn-t-use"> <h3>1.1.4. Options you shouldn’t use<a class="headerlink" href="#options-you-shouldn-t-use" title="Permalink to this headline">¶</a></h3> <dl class="cmdoption"> <dt id="cmdoption-J"> <tt class="descname">-J</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-J" title="Permalink to this definition">¶</a></dt> <dd>Reserved for use by <a class="reference external" href="http://jython.org">Jython</a>.</dd></dl> <dl class="cmdoption"> <dt id="cmdoption-U"> <tt class="descname">-U</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-U" title="Permalink to this definition">¶</a></dt> <dd><p>Turns all string literals into unicodes globally. Do not be tempted to use this option as it will probably break your world. It also produces <tt class="docutils literal"><span class="pre">.pyc</span></tt> files with a different magic number than normal. Instead, you can enable unicode literals on a per-module basis by using:</p> <div class="highlight-none"><div class="highlight"><pre>from __future__ import unicode_literals </pre></div> </div> <p>at the top of the file. See <a title="Future statement definitions" class="reference external" href="../library/__future__.html#module-__future__"><tt class="xref docutils literal"><span class="pre">__future__</span></tt></a> for details.</p> </dd></dl> <dl class="cmdoption"> <dt id="cmdoption-X"> <tt class="descname">-X</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-X" title="Permalink to this definition">¶</a></dt> <dd>Reserved for alternative implementations of Python to use for their own purposes.</dd></dl> </div> </div> <div class="section" id="environment-variables"> <span id="using-on-envvars"></span><h2>1.2. Environment variables<a class="headerlink" href="#environment-variables" title="Permalink to this headline">¶</a></h2> <p>These environment variables influence Python’s behavior.</p> <dl class="envvar"> <dt id="envvar-PYTHONHOME"> <tt class="descname">PYTHONHOME</tt><a class="headerlink" href="#envvar-PYTHONHOME" title="Permalink to this definition">¶</a></dt> <dd><p>Change the location of the standard Python libraries. By default, the libraries are searched in <tt class="docutils literal"><em><span class="pre">prefix</span></em><span class="pre">/lib/python</span><em><span class="pre">version</span></em></tt> and <tt class="docutils literal"><em><span class="pre">exec_prefix</span></em><span class="pre">/lib/python</span><em><span class="pre">version</span></em></tt>, where <tt class="docutils literal"><em><span class="pre">prefix</span></em></tt> and <tt class="docutils literal"><em><span class="pre">exec_prefix</span></em></tt> are installation-dependent directories, both defaulting to <tt class="docutils literal"><span class="pre">/usr/local</span></tt>.</p> <p>When <span class="target" id="index-1123"></span><a class="reference internal" href="#envvar-PYTHONHOME"><strong class="xref">PYTHONHOME</strong></a> is set to a single directory, its value replaces both <tt class="docutils literal"><em><span class="pre">prefix</span></em></tt> and <tt class="docutils literal"><em><span class="pre">exec_prefix</span></em></tt>. To specify different values for these, set <span class="target" id="index-1124"></span><a class="reference internal" href="#envvar-PYTHONHOME"><strong class="xref">PYTHONHOME</strong></a> to <tt class="docutils literal"><em><span class="pre">prefix</span></em><span class="pre">:</span><em><span class="pre">exec_prefix</span></em></tt>.</p> </dd></dl> <dl class="envvar"> <dt id="envvar-PYTHONPATH"> <tt class="descname">PYTHONPATH</tt><a class="headerlink" href="#envvar-PYTHONPATH" title="Permalink to this definition">¶</a></dt> <dd><p>Augment the default search path for module files. The format is the same as the shell’s <span class="target" id="index-1125"></span><strong class="xref">PATH</strong>: one or more directory pathnames separated by <a title="os.pathsep" class="reference external" href="../library/os.html#os.pathsep"><tt class="xref docutils literal"><span class="pre">os.pathsep</span></tt></a> (e.g. colons on Unix or semicolons on Windows). Non-existent directories are silently ignored.</p> <p>In addition to normal directories, individual <span class="target" id="index-1126"></span><a class="reference internal" href="#envvar-PYTHONPATH"><strong class="xref">PYTHONPATH</strong></a> entries may refer to zipfiles containing pure Python modules (in either source or compiled form). Extension modules cannot be imported from zipfiles.</p> <p>The default search path is installation dependent, but generally begins with <tt class="docutils literal"><em><span class="pre">prefix</span></em><span class="pre">/lib/python</span><em><span class="pre">version</span></em></tt> (see <span class="target" id="index-1127"></span><a class="reference internal" href="#envvar-PYTHONHOME"><strong class="xref">PYTHONHOME</strong></a> above). It is <em>always</em> appended to <span class="target" id="index-1128"></span><a class="reference internal" href="#envvar-PYTHONPATH"><strong class="xref">PYTHONPATH</strong></a>.</p> <p>An additional directory will be inserted in the search path in front of <span class="target" id="index-1129"></span><a class="reference internal" href="#envvar-PYTHONPATH"><strong class="xref">PYTHONPATH</strong></a> as described above under <a class="reference internal" href="#using-on-interface-options"><em>Interface options</em></a>. The search path can be manipulated from within a Python program as the variable <a title="sys.path" class="reference external" href="../library/sys.html#sys.path"><tt class="xref docutils literal"><span class="pre">sys.path</span></tt></a>.</p> </dd></dl> <dl class="envvar"> <dt id="envvar-PYTHONSTARTUP"> <tt class="descname">PYTHONSTARTUP</tt><a class="headerlink" href="#envvar-PYTHONSTARTUP" title="Permalink to this definition">¶</a></dt> <dd>If this is the name of a readable file, the Python commands in that file are executed before the first prompt is displayed in interactive mode. The file is executed in the same namespace where interactive commands are executed so that objects defined or imported in it can be used without qualification in the interactive session. You can also change the prompts <a title="sys.ps1" class="reference external" href="../library/sys.html#sys.ps1"><tt class="xref docutils literal"><span class="pre">sys.ps1</span></tt></a> and <a title="sys.ps2" class="reference external" href="../library/sys.html#sys.ps2"><tt class="xref docutils literal"><span class="pre">sys.ps2</span></tt></a> in this file.</dd></dl> <dl class="envvar"> <dt id="envvar-PYTHONY2K"> <tt class="descname">PYTHONY2K</tt><a class="headerlink" href="#envvar-PYTHONY2K" title="Permalink to this definition">¶</a></dt> <dd>Set this to a non-empty string to cause the <a title="Time access and conversions." class="reference external" href="../library/time.html#module-time"><tt class="xref docutils literal"><span class="pre">time</span></tt></a> module to require dates specified as strings to include 4-digit years, otherwise 2-digit years are converted based on rules described in the <a title="Time access and conversions." class="reference external" href="../library/time.html#module-time"><tt class="xref docutils literal"><span class="pre">time</span></tt></a> module documentation.</dd></dl> <dl class="envvar"> <dt id="envvar-PYTHONOPTIMIZE"> <tt class="descname">PYTHONOPTIMIZE</tt><a class="headerlink" href="#envvar-PYTHONOPTIMIZE" title="Permalink to this definition">¶</a></dt> <dd>If this is set to a non-empty string it is equivalent to specifying the <a class="reference internal" href="#cmdoption-O"><em class="xref">-O</em></a> option. If set to an integer, it is equivalent to specifying <a class="reference internal" href="#cmdoption-O"><em class="xref">-O</em></a> multiple times.</dd></dl> <dl class="envvar"> <dt id="envvar-PYTHONDEBUG"> <tt class="descname">PYTHONDEBUG</tt><a class="headerlink" href="#envvar-PYTHONDEBUG" title="Permalink to this definition">¶</a></dt> <dd>If this is set to a non-empty string it is equivalent to specifying the <a class="reference internal" href="#cmdoption-d"><em class="xref">-d</em></a> option. If set to an integer, it is equivalent to specifying <a class="reference internal" href="#cmdoption-d"><em class="xref">-d</em></a> multiple times.</dd></dl> <dl class="envvar"> <dt id="envvar-PYTHONINSPECT"> <tt class="descname">PYTHONINSPECT</tt><a class="headerlink" href="#envvar-PYTHONINSPECT" title="Permalink to this definition">¶</a></dt> <dd><p>If this is set to a non-empty string it is equivalent to specifying the <a class="reference internal" href="#cmdoption-i"><em class="xref">-i</em></a> option.</p> <p>This variable can also be modified by Python code using <a title="os.environ" class="reference external" href="../library/os.html#os.environ"><tt class="xref docutils literal"><span class="pre">os.environ</span></tt></a> to force inspect mode on program termination.</p> </dd></dl> <dl class="envvar"> <dt id="envvar-PYTHONUNBUFFERED"> <tt class="descname">PYTHONUNBUFFERED</tt><a class="headerlink" href="#envvar-PYTHONUNBUFFERED" title="Permalink to this definition">¶</a></dt> <dd>If this is set to a non-empty string it is equivalent to specifying the <a class="reference internal" href="#cmdoption-u"><em class="xref">-u</em></a> option.</dd></dl> <dl class="envvar"> <dt id="envvar-PYTHONVERBOSE"> <tt class="descname">PYTHONVERBOSE</tt><a class="headerlink" href="#envvar-PYTHONVERBOSE" title="Permalink to this definition">¶</a></dt> <dd>If this is set to a non-empty string it is equivalent to specifying the <a class="reference internal" href="#cmdoption-v"><em class="xref">-v</em></a> option. If set to an integer, it is equivalent to specifying <a class="reference internal" href="#cmdoption-v"><em class="xref">-v</em></a> multiple times.</dd></dl> <dl class="envvar"> <dt id="envvar-PYTHONCASEOK"> <tt class="descname">PYTHONCASEOK</tt><a class="headerlink" href="#envvar-PYTHONCASEOK" title="Permalink to this definition">¶</a></dt> <dd>If this is set, Python ignores case in <a class="reference external" href="../reference/simple_stmts.html#import"><tt class="xref docutils literal"><span class="pre">import</span></tt></a> statements. This only works on Windows.</dd></dl> <dl class="envvar"> <dt id="envvar-PYTHONDONTWRITEBYTECODE"> <tt class="descname">PYTHONDONTWRITEBYTECODE</tt><a class="headerlink" href="#envvar-PYTHONDONTWRITEBYTECODE" title="Permalink to this definition">¶</a></dt> <dd><p>If this is set, Python won’t try to write <tt class="docutils literal"><span class="pre">.pyc</span></tt> or <tt class="docutils literal"><span class="pre">.pyo</span></tt> files on the import of source modules.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.6.</span></p> </dd></dl> <dl class="envvar"> <dt id="envvar-PYTHONIOENCODING"> <tt class="descname">PYTHONIOENCODING</tt><a class="headerlink" href="#envvar-PYTHONIOENCODING" title="Permalink to this definition">¶</a></dt> <dd><p>Overrides the encoding used for stdin/stdout/stderr, in the syntax <tt class="docutils literal"><span class="pre">encodingname:errorhandler</span></tt>. The <tt class="docutils literal"><span class="pre">:errorhandler</span></tt> part is optional and has the same meaning as in <a title="str.encode" class="reference external" href="../library/stdtypes.html#str.encode"><tt class="xref docutils literal"><span class="pre">str.encode()</span></tt></a>.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.6.</span></p> </dd></dl> <dl class="envvar"> <dt id="envvar-PYTHONNOUSERSITE"> <tt class="descname">PYTHONNOUSERSITE</tt><a class="headerlink" href="#envvar-PYTHONNOUSERSITE" title="Permalink to this definition">¶</a></dt> <dd><p>If this is set, Python won’t add the user site directory to sys.path</p> <p class="versionadded"> <span class="versionmodified">New in version 2.6.</span></p> <div class="admonition-see-also admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><span class="target" id="index-1130"></span><a class="reference external" href="http://www.python.org/dev/peps/pep-0370"><strong>PEP 370</strong></a> – Per user site-packages directory</p> </div> </dd></dl> <dl class="envvar"> <dt id="envvar-PYTHONUSERBASE"> <tt class="descname">PYTHONUSERBASE</tt><a class="headerlink" href="#envvar-PYTHONUSERBASE" title="Permalink to this definition">¶</a></dt> <dd><p>Sets the base directory for the user site directory</p> <p class="versionadded"> <span class="versionmodified">New in version 2.6.</span></p> <div class="admonition-see-also admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><span class="target" id="index-1131"></span><a class="reference external" href="http://www.python.org/dev/peps/pep-0370"><strong>PEP 370</strong></a> – Per user site-packages directory</p> </div> </dd></dl> <dl class="envvar"> <dt id="envvar-PYTHONEXECUTABLE"> <tt class="descname">PYTHONEXECUTABLE</tt><a class="headerlink" href="#envvar-PYTHONEXECUTABLE" title="Permalink to this definition">¶</a></dt> <dd>If this environment variable is set, <tt class="docutils literal"><span class="pre">sys.argv[0]</span></tt> will be set to its value instead of the value got through the C runtime. Only works on Mac OS X.</dd></dl> <div class="section" id="debug-mode-variables"> <h3>1.2.1. Debug-mode variables<a class="headerlink" href="#debug-mode-variables" title="Permalink to this headline">¶</a></h3> <p>Setting these variables only has an effect in a debug build of Python, that is, if Python was configured with the <em class="xref">--with-pydebug</em> build option.</p> <dl class="envvar"> <dt id="envvar-PYTHONTHREADDEBUG"> <tt class="descname">PYTHONTHREADDEBUG</tt><a class="headerlink" href="#envvar-PYTHONTHREADDEBUG" title="Permalink to this definition">¶</a></dt> <dd><p>If set, Python will print threading debug info.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.6: </span>Previously, this variable was called <tt class="docutils literal"><span class="pre">THREADDEBUG</span></tt>.</p> </dd></dl> <dl class="envvar"> <dt id="envvar-PYTHONDUMPREFS"> <tt class="descname">PYTHONDUMPREFS</tt><a class="headerlink" href="#envvar-PYTHONDUMPREFS" title="Permalink to this definition">¶</a></dt> <dd>If set, Python will dump objects and reference counts still alive after shutting down the interpreter.</dd></dl> <dl class="envvar"> <dt id="envvar-PYTHONMALLOCSTATS"> <tt class="descname">PYTHONMALLOCSTATS</tt><a class="headerlink" href="#envvar-PYTHONMALLOCSTATS" title="Permalink to this definition">¶</a></dt> <dd>If set, Python will print memory allocation statistics every time a new object arena is created, and on shutdown.</dd></dl> </div> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="../contents.html">Table Of Contents</a></h3> <ul> <li><a class="reference external" href="#">1. Command line and environment</a><ul> <li><a class="reference external" href="#command-line">1.1. Command line</a><ul> <li><a class="reference external" href="#interface-options">1.1.1. Interface options</a></li> <li><a class="reference external" href="#generic-options">1.1.2. Generic options</a></li> <li><a class="reference external" href="#miscellaneous-options">1.1.3. Miscellaneous options</a></li> <li><a class="reference external" href="#options-you-shouldn-t-use">1.1.4. Options you shouldn’t use</a></li> </ul> </li> <li><a class="reference external" href="#environment-variables">1.2. Environment variables</a><ul> <li><a class="reference external" href="#debug-mode-variables">1.2.1. Debug-mode variables</a></li> </ul> </li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="index.html" title="previous chapter">Using Python</a></p> <h4>Next topic</h4> <p class="topless"><a href="unix.html" title="next chapter">2. Using Python on Unix platforms</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li><a href="../_sources/using/cmdline.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" size="18" /> <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="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="../modindex.html" title="Global Module Index" >modules</a> |</li> <li class="right" > <a href="unix.html" title="2. Using Python on Unix platforms" >next</a> |</li> <li class="right" > <a href="index.html" title="Using Python" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="../index.html">Python v2.6.6 documentation</a> »</li> <li><a href="index.html" >Using Python</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2011, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="http://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Jul 20, 2011. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.6. </div> </body> </html>
Back to File Manager