[ Avaa Bypassed ]




Upload:

Command:

hmhc3928@3.143.4.178: ~ $

<!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>23.2. shlex — Simple lexical analysis &mdash; Python 2.7.5 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.7.5',
        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>
    <script type="text/javascript" src="../_static/sidebar.js"></script>
    <link rel="search" type="application/opensearchdescription+xml"
          title="Search within Python 2.7.5 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 2.7.5 documentation" href="../index.html" />
    <link rel="up" title="23. Program Frameworks" href="frameworks.html" />
    <link rel="next" title="24. Graphical User Interfaces with Tk" href="tk.html" />
    <link rel="prev" title="23.1. cmd — Support for line-oriented command interpreters" href="cmd.html" />
    <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
    <script type="text/javascript" src="../_static/copybutton.js"></script>
    
 

  </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="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="tk.html" title="24. Graphical User Interfaces with Tk"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="cmd.html" title="23.1. cmd — Support for line-oriented command interpreters"
             accesskey="P">previous</a> |</li>
        <li><img src="../_static/py.png" alt=""
                 style="vertical-align: middle; margin-top: -1px"/></li>
        <li><a href="http://www.python.org/">Python</a> &raquo;</li>
        <li>
          <a href="../index.html">Python 2.7.5 documentation</a> &raquo;
        </li>

          <li><a href="index.html" >The Python Standard Library</a> &raquo;</li>
          <li><a href="frameworks.html" accesskey="U">23. Program Frameworks</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-shlex">
<span id="shlex-simple-lexical-analysis"></span><h1>23.2. <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-mod docutils literal"><span class="pre">shlex</span></tt></a> &#8212; Simple lexical analysis<a class="headerlink" href="#module-shlex" title="Permalink to this headline">¶</a></h1>
<p class="versionadded">
<span class="versionmodified">New in version 1.5.2.</span></p>
<p><strong>Source code:</strong> <a class="reference external" href="http://hg.python.org/cpython/file/2.7/Lib/shlex.py">Lib/shlex.py</a></p>
<hr class="docutils" />
<p>The <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-class docutils literal"><span class="pre">shlex</span></tt></a> class makes it easy to write lexical analyzers for simple
syntaxes resembling that of the Unix shell.  This will often be useful for
writing minilanguages, (for example, in run control files for Python
applications) or for parsing quoted strings.</p>
<p>Prior to Python 2.7.3, this module did not support Unicode input.</p>
<p>The <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-mod docutils literal"><span class="pre">shlex</span></tt></a> module defines the following functions:</p>
<dl class="function">
<dt id="shlex.split">
<tt class="descclassname">shlex.</tt><tt class="descname">split</tt><big>(</big><em>s</em><span class="optional">[</span>, <em>comments</em><span class="optional">[</span>, <em>posix</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#shlex.split" title="Permalink to this definition">¶</a></dt>
<dd><p>Split the string <em>s</em> using shell-like syntax. If <em>comments</em> is <a class="reference internal" href="constants.html#False" title="False"><tt class="xref py py-const docutils literal"><span class="pre">False</span></tt></a>
(the default), the parsing of comments in the given string will be disabled
(setting the <tt class="xref py py-attr docutils literal"><span class="pre">commenters</span></tt> attribute of the <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-class docutils literal"><span class="pre">shlex</span></tt></a> instance to
the empty string).  This function operates in POSIX mode by default, but uses
non-POSIX mode if the <em>posix</em> argument is false.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.3.</span></p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.6: </span>Added the <em>posix</em> parameter.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Since the <a class="reference internal" href="#shlex.split" title="shlex.split"><tt class="xref py py-func docutils literal"><span class="pre">split()</span></tt></a> function instantiates a <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-class docutils literal"><span class="pre">shlex</span></tt></a> instance, passing
<tt class="docutils literal"><span class="pre">None</span></tt> for <em>s</em> will read the string to split from standard input.</p>
</div>
</dd></dl>

<p>The <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-mod docutils literal"><span class="pre">shlex</span></tt></a> module defines the following class:</p>
<dl class="class">
<dt id="shlex.shlex">
<em class="property">class </em><tt class="descclassname">shlex.</tt><tt class="descname">shlex</tt><big>(</big><span class="optional">[</span><em>instream</em><span class="optional">[</span>, <em>infile</em><span class="optional">[</span>, <em>posix</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#shlex.shlex" title="Permalink to this definition">¶</a></dt>
<dd><p>A <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-class docutils literal"><span class="pre">shlex</span></tt></a> instance or subclass instance is a lexical analyzer object.
The initialization argument, if present, specifies where to read characters
from. It must be a file-/stream-like object with <tt class="xref py py-meth docutils literal"><span class="pre">read()</span></tt> and
<a class="reference internal" href="readline.html#module-readline" title="readline: GNU readline support for Python. (Unix)"><tt class="xref py py-meth docutils literal"><span class="pre">readline()</span></tt></a> methods, or a string (strings are accepted since Python 2.3).
If no argument is given, input will be taken from <tt class="docutils literal"><span class="pre">sys.stdin</span></tt>.  The second
optional argument is a filename string, which sets the initial value of the
<a class="reference internal" href="#shlex.shlex.infile" title="shlex.shlex.infile"><tt class="xref py py-attr docutils literal"><span class="pre">infile</span></tt></a> attribute.  If the <em>instream</em> argument is omitted or equal to
<tt class="docutils literal"><span class="pre">sys.stdin</span></tt>, this second argument defaults to &#8220;stdin&#8221;.  The <em>posix</em> argument
was introduced in Python 2.3, and defines the operational mode.  When <em>posix</em> is
not true (default), the <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-class docutils literal"><span class="pre">shlex</span></tt></a> instance will operate in compatibility
mode.  When operating in POSIX mode, <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-class docutils literal"><span class="pre">shlex</span></tt></a> will try to be as close as
possible to the POSIX shell parsing rules.</p>
</dd></dl>

<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt>Module <a class="reference internal" href="configparser.html#module-ConfigParser" title="ConfigParser: Configuration file parser."><tt class="xref py py-mod docutils literal"><span class="pre">ConfigParser</span></tt></a></dt>
<dd>Parser for configuration files similar to the Windows <tt class="file docutils literal"><span class="pre">.ini</span></tt> files.</dd>
</dl>
</div>
<div class="section" id="shlex-objects">
<span id="id1"></span><h2>23.2.1. shlex Objects<a class="headerlink" href="#shlex-objects" title="Permalink to this headline">¶</a></h2>
<p>A <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-class docutils literal"><span class="pre">shlex</span></tt></a> instance has the following methods:</p>
<dl class="method">
<dt id="shlex.shlex.get_token">
<tt class="descclassname">shlex.</tt><tt class="descname">get_token</tt><big>(</big><big>)</big><a class="headerlink" href="#shlex.shlex.get_token" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a token.  If tokens have been stacked using <a class="reference internal" href="#shlex.shlex.push_token" title="shlex.shlex.push_token"><tt class="xref py py-meth docutils literal"><span class="pre">push_token()</span></tt></a>, pop a
token off the stack.  Otherwise, read one from the input stream.  If reading
encounters an immediate end-of-file, <tt class="xref py py-attr docutils literal"><span class="pre">self.eof</span></tt> is returned (the empty
string (<tt class="docutils literal"><span class="pre">''</span></tt>) in non-POSIX mode, and <tt class="docutils literal"><span class="pre">None</span></tt> in POSIX mode).</p>
</dd></dl>

<dl class="method">
<dt id="shlex.shlex.push_token">
<tt class="descclassname">shlex.</tt><tt class="descname">push_token</tt><big>(</big><em>str</em><big>)</big><a class="headerlink" href="#shlex.shlex.push_token" title="Permalink to this definition">¶</a></dt>
<dd><p>Push the argument onto the token stack.</p>
</dd></dl>

<dl class="method">
<dt id="shlex.shlex.read_token">
<tt class="descclassname">shlex.</tt><tt class="descname">read_token</tt><big>(</big><big>)</big><a class="headerlink" href="#shlex.shlex.read_token" title="Permalink to this definition">¶</a></dt>
<dd><p>Read a raw token.  Ignore the pushback stack, and do not interpret source
requests.  (This is not ordinarily a useful entry point, and is documented here
only for the sake of completeness.)</p>
</dd></dl>

<dl class="method">
<dt id="shlex.shlex.sourcehook">
<tt class="descclassname">shlex.</tt><tt class="descname">sourcehook</tt><big>(</big><em>filename</em><big>)</big><a class="headerlink" href="#shlex.shlex.sourcehook" title="Permalink to this definition">¶</a></dt>
<dd><p>When <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-class docutils literal"><span class="pre">shlex</span></tt></a> detects a source request (see <a class="reference internal" href="#shlex.shlex.source" title="shlex.shlex.source"><tt class="xref py py-attr docutils literal"><span class="pre">source</span></tt></a> below) this
method is given the following token as argument, and expected to return a tuple
consisting of a filename and an open file-like object.</p>
<p>Normally, this method first strips any quotes off the argument.  If the result
is an absolute pathname, or there was no previous source request in effect, or
the previous source was a stream (such as <tt class="docutils literal"><span class="pre">sys.stdin</span></tt>), the result is left
alone.  Otherwise, if the result is a relative pathname, the directory part of
the name of the file immediately before it on the source inclusion stack is
prepended (this behavior is like the way the C preprocessor handles <tt class="docutils literal"><span class="pre">#include</span>
<span class="pre">&quot;file.h&quot;</span></tt>).</p>
<p>The result of the manipulations is treated as a filename, and returned as the
first component of the tuple, with <a class="reference internal" href="functions.html#open" title="open"><tt class="xref py py-func docutils literal"><span class="pre">open()</span></tt></a> called on it to yield the second
component. (Note: this is the reverse of the order of arguments in instance
initialization!)</p>
<p>This hook is exposed so that you can use it to implement directory search paths,
addition of file extensions, and other namespace hacks. There is no
corresponding &#8216;close&#8217; hook, but a shlex instance will call the <tt class="xref py py-meth docutils literal"><span class="pre">close()</span></tt>
method of the sourced input stream when it returns EOF.</p>
<p>For more explicit control of source stacking, use the <a class="reference internal" href="#shlex.shlex.push_source" title="shlex.shlex.push_source"><tt class="xref py py-meth docutils literal"><span class="pre">push_source()</span></tt></a> and
<a class="reference internal" href="#shlex.shlex.pop_source" title="shlex.shlex.pop_source"><tt class="xref py py-meth docutils literal"><span class="pre">pop_source()</span></tt></a> methods.</p>
</dd></dl>

<dl class="method">
<dt id="shlex.shlex.push_source">
<tt class="descclassname">shlex.</tt><tt class="descname">push_source</tt><big>(</big><em>stream</em><span class="optional">[</span>, <em>filename</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#shlex.shlex.push_source" title="Permalink to this definition">¶</a></dt>
<dd><p>Push an input source stream onto the input stack.  If the filename argument is
specified it will later be available for use in error messages.  This is the
same method used internally by the <a class="reference internal" href="#shlex.shlex.sourcehook" title="shlex.shlex.sourcehook"><tt class="xref py py-meth docutils literal"><span class="pre">sourcehook()</span></tt></a> method.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.1.</span></p>
</dd></dl>

<dl class="method">
<dt id="shlex.shlex.pop_source">
<tt class="descclassname">shlex.</tt><tt class="descname">pop_source</tt><big>(</big><big>)</big><a class="headerlink" href="#shlex.shlex.pop_source" title="Permalink to this definition">¶</a></dt>
<dd><p>Pop the last-pushed input source from the input stack. This is the same method
used internally when the lexer reaches EOF on a stacked input stream.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.1.</span></p>
</dd></dl>

<dl class="method">
<dt id="shlex.shlex.error_leader">
<tt class="descclassname">shlex.</tt><tt class="descname">error_leader</tt><big>(</big><span class="optional">[</span><em>file</em><span class="optional">[</span>, <em>line</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#shlex.shlex.error_leader" title="Permalink to this definition">¶</a></dt>
<dd><p>This method generates an error message leader in the format of a Unix C compiler
error label; the format is <tt class="docutils literal"><span class="pre">'&quot;%s&quot;,</span> <span class="pre">line</span> <span class="pre">%d:</span> <span class="pre">'</span></tt>, where the <tt class="docutils literal"><span class="pre">%s</span></tt> is replaced
with the name of the current source file and the <tt class="docutils literal"><span class="pre">%d</span></tt> with the current input
line number (the optional arguments can be used to override these).</p>
<p>This convenience is provided to encourage <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-mod docutils literal"><span class="pre">shlex</span></tt></a> users to generate error
messages in the standard, parseable format understood by Emacs and other Unix
tools.</p>
</dd></dl>

<p>Instances of <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-class docutils literal"><span class="pre">shlex</span></tt></a> subclasses have some public instance variables which
either control lexical analysis or can be used for debugging:</p>
<dl class="attribute">
<dt id="shlex.shlex.commenters">
<tt class="descclassname">shlex.</tt><tt class="descname">commenters</tt><a class="headerlink" href="#shlex.shlex.commenters" title="Permalink to this definition">¶</a></dt>
<dd><p>The string of characters that are recognized as comment beginners. All
characters from the comment beginner to end of line are ignored. Includes just
<tt class="docutils literal"><span class="pre">'#'</span></tt> by default.</p>
</dd></dl>

<dl class="attribute">
<dt id="shlex.shlex.wordchars">
<tt class="descclassname">shlex.</tt><tt class="descname">wordchars</tt><a class="headerlink" href="#shlex.shlex.wordchars" title="Permalink to this definition">¶</a></dt>
<dd><p>The string of characters that will accumulate into multi-character tokens.  By
default, includes all ASCII alphanumerics and underscore.</p>
</dd></dl>

<dl class="attribute">
<dt id="shlex.shlex.whitespace">
<tt class="descclassname">shlex.</tt><tt class="descname">whitespace</tt><a class="headerlink" href="#shlex.shlex.whitespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Characters that will be considered whitespace and skipped.  Whitespace bounds
tokens.  By default, includes space, tab, linefeed and carriage-return.</p>
</dd></dl>

<dl class="attribute">
<dt id="shlex.shlex.escape">
<tt class="descclassname">shlex.</tt><tt class="descname">escape</tt><a class="headerlink" href="#shlex.shlex.escape" title="Permalink to this definition">¶</a></dt>
<dd><p>Characters that will be considered as escape. This will be only used in POSIX
mode, and includes just <tt class="docutils literal"><span class="pre">'\'</span></tt> by default.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.3.</span></p>
</dd></dl>

<dl class="attribute">
<dt id="shlex.shlex.quotes">
<tt class="descclassname">shlex.</tt><tt class="descname">quotes</tt><a class="headerlink" href="#shlex.shlex.quotes" title="Permalink to this definition">¶</a></dt>
<dd><p>Characters that will be considered string quotes.  The token accumulates until
the same quote is encountered again (thus, different quote types protect each
other as in the shell.)  By default, includes ASCII single and double quotes.</p>
</dd></dl>

<dl class="attribute">
<dt id="shlex.shlex.escapedquotes">
<tt class="descclassname">shlex.</tt><tt class="descname">escapedquotes</tt><a class="headerlink" href="#shlex.shlex.escapedquotes" title="Permalink to this definition">¶</a></dt>
<dd><p>Characters in <a class="reference internal" href="#shlex.shlex.quotes" title="shlex.shlex.quotes"><tt class="xref py py-attr docutils literal"><span class="pre">quotes</span></tt></a> that will interpret escape characters defined in
<a class="reference internal" href="#shlex.shlex.escape" title="shlex.shlex.escape"><tt class="xref py py-attr docutils literal"><span class="pre">escape</span></tt></a>.  This is only used in POSIX mode, and includes just <tt class="docutils literal"><span class="pre">'&quot;'</span></tt> by
default.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.3.</span></p>
</dd></dl>

<dl class="attribute">
<dt id="shlex.shlex.whitespace_split">
<tt class="descclassname">shlex.</tt><tt class="descname">whitespace_split</tt><a class="headerlink" href="#shlex.shlex.whitespace_split" title="Permalink to this definition">¶</a></dt>
<dd><p>If <tt class="docutils literal"><span class="pre">True</span></tt>, tokens will only be split in whitespaces. This is useful, for
example, for parsing command lines with <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-class docutils literal"><span class="pre">shlex</span></tt></a>, getting tokens in a
similar way to shell arguments.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.3.</span></p>
</dd></dl>

<dl class="attribute">
<dt id="shlex.shlex.infile">
<tt class="descclassname">shlex.</tt><tt class="descname">infile</tt><a class="headerlink" href="#shlex.shlex.infile" title="Permalink to this definition">¶</a></dt>
<dd><p>The name of the current input file, as initially set at class instantiation time
or stacked by later source requests.  It may be useful to examine this when
constructing error messages.</p>
</dd></dl>

<dl class="attribute">
<dt id="shlex.shlex.instream">
<tt class="descclassname">shlex.</tt><tt class="descname">instream</tt><a class="headerlink" href="#shlex.shlex.instream" title="Permalink to this definition">¶</a></dt>
<dd><p>The input stream from which this <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-class docutils literal"><span class="pre">shlex</span></tt></a> instance is reading characters.</p>
</dd></dl>

<dl class="attribute">
<dt id="shlex.shlex.source">
<tt class="descclassname">shlex.</tt><tt class="descname">source</tt><a class="headerlink" href="#shlex.shlex.source" title="Permalink to this definition">¶</a></dt>
<dd><p>This attribute is <tt class="docutils literal"><span class="pre">None</span></tt> by default.  If you assign a string to it, that
string will be recognized as a lexical-level inclusion request similar to the
<tt class="docutils literal"><span class="pre">source</span></tt> keyword in various shells.  That is, the immediately following token
will opened as a filename and input taken from that stream until EOF, at which
point the <tt class="xref py py-meth docutils literal"><span class="pre">close()</span></tt> method of that stream will be called and the input
source will again become the original input stream. Source requests may be
stacked any number of levels deep.</p>
</dd></dl>

<dl class="attribute">
<dt id="shlex.shlex.debug">
<tt class="descclassname">shlex.</tt><tt class="descname">debug</tt><a class="headerlink" href="#shlex.shlex.debug" title="Permalink to this definition">¶</a></dt>
<dd><p>If this attribute is numeric and <tt class="docutils literal"><span class="pre">1</span></tt> or more, a <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-class docutils literal"><span class="pre">shlex</span></tt></a> instance will
print verbose progress output on its behavior.  If you need to use this, you can
read the module source code to learn the details.</p>
</dd></dl>

<dl class="attribute">
<dt id="shlex.shlex.lineno">
<tt class="descclassname">shlex.</tt><tt class="descname">lineno</tt><a class="headerlink" href="#shlex.shlex.lineno" title="Permalink to this definition">¶</a></dt>
<dd><p>Source line number (count of newlines seen so far plus one).</p>
</dd></dl>

<dl class="attribute">
<dt id="shlex.shlex.token">
<tt class="descclassname">shlex.</tt><tt class="descname">token</tt><a class="headerlink" href="#shlex.shlex.token" title="Permalink to this definition">¶</a></dt>
<dd><p>The token buffer.  It may be useful to examine this when catching exceptions.</p>
</dd></dl>

<dl class="attribute">
<dt id="shlex.shlex.eof">
<tt class="descclassname">shlex.</tt><tt class="descname">eof</tt><a class="headerlink" href="#shlex.shlex.eof" title="Permalink to this definition">¶</a></dt>
<dd><p>Token used to determine end of file. This will be set to the empty string
(<tt class="docutils literal"><span class="pre">''</span></tt>), in non-POSIX mode, and to <tt class="docutils literal"><span class="pre">None</span></tt> in POSIX mode.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.3.</span></p>
</dd></dl>

</div>
<div class="section" id="parsing-rules">
<span id="shlex-parsing-rules"></span><h2>23.2.2. Parsing Rules<a class="headerlink" href="#parsing-rules" title="Permalink to this headline">¶</a></h2>
<p>When operating in non-POSIX mode, <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-class docutils literal"><span class="pre">shlex</span></tt></a> will try to obey to the
following rules.</p>
<ul class="simple">
<li>Quote characters are not recognized within words (<tt class="docutils literal"><span class="pre">Do&quot;Not&quot;Separate</span></tt> is
parsed as the single word <tt class="docutils literal"><span class="pre">Do&quot;Not&quot;Separate</span></tt>);</li>
<li>Escape characters are not recognized;</li>
<li>Enclosing characters in quotes preserve the literal value of all characters
within the quotes;</li>
<li>Closing quotes separate words (<tt class="docutils literal"><span class="pre">&quot;Do&quot;Separate</span></tt> is parsed as <tt class="docutils literal"><span class="pre">&quot;Do&quot;</span></tt> and
<tt class="docutils literal"><span class="pre">Separate</span></tt>);</li>
<li>If <tt class="xref py py-attr docutils literal"><span class="pre">whitespace_split</span></tt> is <tt class="docutils literal"><span class="pre">False</span></tt>, any character not declared to be a
word character, whitespace, or a quote will be returned as a single-character
token. If it is <tt class="docutils literal"><span class="pre">True</span></tt>, <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-class docutils literal"><span class="pre">shlex</span></tt></a> will only split words in whitespaces;</li>
<li>EOF is signaled with an empty string (<tt class="docutils literal"><span class="pre">''</span></tt>);</li>
<li>It&#8217;s not possible to parse empty strings, even if quoted.</li>
</ul>
<p>When operating in POSIX mode, <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-class docutils literal"><span class="pre">shlex</span></tt></a> will try to obey to the following
parsing rules.</p>
<ul class="simple">
<li>Quotes are stripped out, and do not separate words (<tt class="docutils literal"><span class="pre">&quot;Do&quot;Not&quot;Separate&quot;</span></tt> is
parsed as the single word <tt class="docutils literal"><span class="pre">DoNotSeparate</span></tt>);</li>
<li>Non-quoted escape characters (e.g. <tt class="docutils literal"><span class="pre">'\'</span></tt>) preserve the literal value of the
next character that follows;</li>
<li>Enclosing characters in quotes which are not part of <tt class="xref py py-attr docutils literal"><span class="pre">escapedquotes</span></tt>
(e.g. <tt class="docutils literal"><span class="pre">&quot;'&quot;</span></tt>) preserve the literal value of all characters within the quotes;</li>
<li>Enclosing characters in quotes which are part of <tt class="xref py py-attr docutils literal"><span class="pre">escapedquotes</span></tt> (e.g.
<tt class="docutils literal"><span class="pre">'&quot;'</span></tt>) preserves the literal value of all characters within the quotes, with
the exception of the characters mentioned in <tt class="xref py py-attr docutils literal"><span class="pre">escape</span></tt>. The escape
characters retain its special meaning only when followed by the quote in use, or
the escape character itself. Otherwise the escape character will be considered a
normal character.</li>
<li>EOF is signaled with a <a class="reference internal" href="constants.html#None" title="None"><tt class="xref py py-const docutils literal"><span class="pre">None</span></tt></a> value;</li>
<li>Quoted empty strings (<tt class="docutils literal"><span class="pre">''</span></tt>) are allowed;</li>
</ul>
</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 internal" href="#">23.2. <tt class="docutils literal"><span class="pre">shlex</span></tt> &#8212; Simple lexical analysis</a><ul>
<li><a class="reference internal" href="#shlex-objects">23.2.1. shlex Objects</a></li>
<li><a class="reference internal" href="#parsing-rules">23.2.2. Parsing Rules</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="cmd.html"
                        title="previous chapter">23.1. <tt class="docutils literal"><span class="pre">cmd</span></tt> &#8212; Support for line-oriented command interpreters</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="tk.html"
                        title="next chapter">24. Graphical User Interfaces with Tk</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/library/shlex.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="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="tk.html" title="24. Graphical User Interfaces with Tk"
             >next</a> |</li>
        <li class="right" >
          <a href="cmd.html" title="23.1. cmd — Support for line-oriented command interpreters"
             >previous</a> |</li>
        <li><img src="../_static/py.png" alt=""
                 style="vertical-align: middle; margin-top: -1px"/></li>
        <li><a href="http://www.python.org/">Python</a> &raquo;</li>
        <li>
          <a href="../index.html">Python 2.7.5 documentation</a> &raquo;
        </li>

          <li><a href="index.html" >The Python Standard Library</a> &raquo;</li>
          <li><a href="frameworks.html" >23. Program Frameworks</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
    &copy; <a href="../copyright.html">Copyright</a> 1990-2019, 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 03, 2019.
    <a href="../bugs.html">Found a bug</a>?
    <br />
    Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    </div>

  </body>
</html>

Filemanager

Name Type Size Permission Actions
2to3.html File 49.27 KB 0644
__builtin__.html File 10.26 KB 0644
__future__.html File 13.79 KB 0644
__main__.html File 7.05 KB 0644
_winreg.html File 59.21 KB 0644
abc.html File 23.9 KB 0644
aepack.html File 13.16 KB 0644
aetools.html File 14.91 KB 0644
aetypes.html File 18.88 KB 0644
aifc.html File 22.4 KB 0644
al.html File 17.34 KB 0644
allos.html File 33.72 KB 0644
anydbm.html File 16.33 KB 0644
archiving.html File 9.26 KB 0644
argparse.html File 237.62 KB 0644
array.html File 29.29 KB 0644
ast.html File 34.98 KB 0644
asynchat.html File 31.43 KB 0644
asyncore.html File 36.51 KB 0644
atexit.html File 16.8 KB 0644
audioop.html File 31.36 KB 0644
autogil.html File 8.19 KB 0644
base64.html File 19.67 KB 0644
basehttpserver.html File 34.04 KB 0644
bastion.html File 11.04 KB 0644
bdb.html File 36.68 KB 0644
binascii.html File 20.67 KB 0644
binhex.html File 10.58 KB 0644
bisect.html File 23.24 KB 0644
bsddb.html File 26.43 KB 0644
bz2.html File 26.08 KB 0644
calendar.html File 37.79 KB 0644
carbon.html File 48.94 KB 0644
cd.html File 27.96 KB 0644
cgi.html File 49.92 KB 0644
cgihttpserver.html File 13.1 KB 0644
cgitb.html File 11.41 KB 0644
chunk.html File 14.66 KB 0644
cmath.html File 25.63 KB 0644
cmd.html File 26.09 KB 0644
code.html File 24.58 KB 0644
codecs.html File 100.64 KB 0644
codeop.html File 14.84 KB 0644
collections.html File 133.96 KB 0644
colorpicker.html File 7.52 KB 0644
colorsys.html File 11.04 KB 0644
commands.html File 14.36 KB 0644
compileall.html File 16.83 KB 0644
compiler.html File 67.75 KB 0644
configparser.html File 62.13 KB 0644
constants.html File 12.83 KB 0644
contextlib.html File 19.39 KB 0644
cookie.html File 39.07 KB 0644
cookielib.html File 83.82 KB 0644
copy.html File 12.19 KB 0644
copy_reg.html File 13.76 KB 0644
crypt.html File 10.04 KB 0644
crypto.html File 7.59 KB 0644
csv.html File 67.37 KB 0644
ctypes.html File 238.78 KB 0644
curses.ascii.html File 22.29 KB 0644
curses.html File 146.63 KB 0644
curses.panel.html File 14.39 KB 0644
custominterp.html File 7.62 KB 0644
datatypes.html File 16.84 KB 0644
datetime.html File 226.59 KB 0644
dbhash.html File 15.48 KB 0644
dbm.html File 12.07 KB 0644
debug.html File 10.15 KB 0644
decimal.html File 194.44 KB 0644
development.html File 14.17 KB 0644
difflib.html File 84.83 KB 0644
dircache.html File 11.41 KB 0644
dis.html File 69.95 KB 0644
distutils.html File 8.05 KB 0644
dl.html File 16.33 KB 0644
doctest.html File 165.54 KB 0644
docxmlrpcserver.html File 16.43 KB 0644
dumbdbm.html File 14.02 KB 0644
dummy_thread.html File 9.43 KB 0644
dummy_threading.html File 8.37 KB 0644
easydialogs.html File 30.55 KB 0644
email-examples.html File 45.65 KB 0644
email.charset.html File 26.8 KB 0644
email.encoders.html File 11.86 KB 0644
email.errors.html File 15.77 KB 0644
email.generator.html File 20.77 KB 0644
email.header.html File 26.92 KB 0644
email.html File 44.24 KB 0644
email.iterators.html File 11.52 KB 0644
email.message.html File 63.16 KB 0644
email.mime.html File 27.93 KB 0644
email.parser.html File 30.45 KB 0644
email.util.html File 24.46 KB 0644
errno.html File 37.99 KB 0644
exceptions.html File 56.13 KB 0644
fcntl.html File 22.67 KB 0644
filecmp.html File 22.3 KB 0644
fileformats.html File 9.14 KB 0644
fileinput.html File 24.28 KB 0644
filesys.html File 10.2 KB 0644
fl.html File 49.92 KB 0644
fm.html File 11.91 KB 0644
fnmatch.html File 14.58 KB 0644
formatter.html File 34.06 KB 0644
fpectl.html File 16.01 KB 0644
fpformat.html File 10.59 KB 0644
fractions.html File 22.61 KB 0644
framework.html File 33.34 KB 0644
frameworks.html File 7.14 KB 0644
ftplib.html File 43.99 KB 0644
functions.html File 183.14 KB 0644
functools.html File 27.17 KB 0644
future_builtins.html File 13.04 KB 0644
gc.html File 25.75 KB 0644
gdbm.html File 15.96 KB 0644
gensuitemodule.html File 11.51 KB 0644
getopt.html File 23.66 KB 0644
getpass.html File 10.65 KB 0644
gettext.html File 78.76 KB 0644
gl.html File 22.09 KB 0644
glob.html File 13.26 KB 0644
grp.html File 10.49 KB 0644
gzip.html File 18.99 KB 0644
hashlib.html File 18.2 KB 0644
heapq.html File 31.61 KB 0644
hmac.html File 10.46 KB 0644
hotshot.html File 18.65 KB 0644
htmllib.html File 25.32 KB 0644
htmlparser.html File 39.11 KB 0644
httplib.html File 62.95 KB 0644
i18n.html File 9.52 KB 0644
ic.html File 17.17 KB 0644
idle.html File 20.9 KB 0644
imageop.html File 14.76 KB 0644
imaplib.html File 51.99 KB 0644
imgfile.html File 11.71 KB 0644
imghdr.html File 11.3 KB 0644
imp.html File 34.34 KB 0644
importlib.html File 8.26 KB 0644
imputil.html File 31.81 KB 0644
index.html File 72.78 KB 0644
inspect.html File 50.71 KB 0644
internet.html File 24.87 KB 0644
intro.html File 8.93 KB 0644
io.html File 98.13 KB 0644
ipc.html File 13.41 KB 0644
itertools.html File 115.91 KB 0644
jpeg.html File 12.74 KB 0644
json.html File 67.04 KB 0644
keyword.html File 7.68 KB 0644
language.html File 11.03 KB 0644
linecache.html File 10.59 KB 0644
locale.html File 55.14 KB 0644
logging.config.html File 63.36 KB 0644
logging.handlers.html File 69.64 KB 0644
logging.html File 95.64 KB 0644
mac.html File 21.79 KB 0644
macos.html File 14.76 KB 0644
macosa.html File 12.96 KB 0644
macostools.html File 15.52 KB 0644
macpath.html File 7.76 KB 0644
mailbox.html File 156.75 KB 0644
mailcap.html File 13.21 KB 0644
markup.html File 18.77 KB 0644
marshal.html File 17.98 KB 0644
math.html File 39.24 KB 0644
md5.html File 13.97 KB 0644
mhlib.html File 21.54 KB 0644
mimetools.html File 19.25 KB 0644
mimetypes.html File 28.39 KB 0644
mimewriter.html File 15.02 KB 0644
mimify.html File 13.36 KB 0644
miniaeframe.html File 12.2 KB 0644
misc.html File 6.87 KB 0644
mm.html File 9.03 KB 0644
mmap.html File 28.36 KB 0644
modulefinder.html File 15.31 KB 0644
modules.html File 8.46 KB 0644
msilib.html File 52.43 KB 0644
msvcrt.html File 19.37 KB 0644
multifile.html File 24.3 KB 0644
multiprocessing.html File 365.71 KB 0644
mutex.html File 11.23 KB 0644
netdata.html File 16.98 KB 0644
netrc.html File 12.3 KB 0644
new.html File 12.12 KB 0644
nis.html File 10.64 KB 0644
nntplib.html File 41.92 KB 0644
numbers.html File 37.75 KB 0644
numeric.html File 13.55 KB 0644
operator.html File 82 KB 0644
optparse.html File 222.56 KB 0644
os.html File 214.25 KB 0644
os.path.html File 38.34 KB 0644
ossaudiodev.html File 41.5 KB 0644
othergui.html File 9.08 KB 0644
parser.html File 39.36 KB 0644
pdb.html File 33.96 KB 0644
persistence.html File 14.87 KB 0644
pickle.html File 102.27 KB 0644
pickletools.html File 10.63 KB 0644
pipes.html File 18.01 KB 0644
pkgutil.html File 25.11 KB 0644
platform.html File 28.37 KB 0644
plistlib.html File 17.03 KB 0644
popen2.html File 25.43 KB 0644
poplib.html File 22.32 KB 0644
posix.html File 14.41 KB 0644
posixfile.html File 19.76 KB 0644
pprint.html File 29.92 KB 0644
profile.html File 63.56 KB 0644
pty.html File 9.48 KB 0644
pwd.html File 11.43 KB 0644
py_compile.html File 11.12 KB 0644
pyclbr.html File 14.71 KB 0644
pydoc.html File 11.48 KB 0644
pyexpat.html File 71.53 KB 0644
python.html File 12.27 KB 0644
queue.html File 24.22 KB 0644
quopri.html File 11.9 KB 0644
random.html File 37.83 KB 0644
re.html File 134.74 KB 0644
readline.html File 28.24 KB 0644
repr.html File 20.43 KB 0644
resource.html File 26.48 KB 0644
restricted.html File 11.65 KB 0644
rexec.html File 37.41 KB 0644
rfc822.html File 42.22 KB 0644
rlcompleter.html File 13.51 KB 0644
robotparser.html File 12.27 KB 0644
runpy.html File 19.34 KB 0644
sched.html File 18.54 KB 0644
scrolledtext.html File 9.32 KB 0644
select.html File 39.67 KB 0644
sets.html File 36.92 KB 0644
sgi.html File 9.71 KB 0644
sgmllib.html File 30.77 KB 0644
sha.html File 12.09 KB 0644
shelve.html File 27.02 KB 0644
shlex.html File 32.1 KB 0644
shutil.html File 40.22 KB 0644
signal.html File 31.14 KB 0644
simplehttpserver.html File 18.41 KB 0644
simplexmlrpcserver.html File 31.39 KB 0644
site.html File 23.64 KB 0644
smtpd.html File 12.46 KB 0644
smtplib.html File 42.13 KB 0644
sndhdr.html File 10.02 KB 0644
socket.html File 106.34 KB 0644
socketserver.html File 59.83 KB 0644
someos.html File 15.11 KB 0644
spwd.html File 10.33 KB 0644
sqlite3.html File 139.5 KB 0644
ssl.html File 65.62 KB 0644
stat.html File 32.31 KB 0644
statvfs.html File 10.6 KB 0644
stdtypes.html File 260.4 KB 0644
string.html File 106.65 KB 0644
stringio.html File 18.81 KB 0644
stringprep.html File 16.13 KB 0644
strings.html File 14.93 KB 0644
struct.html File 40.88 KB 0644
subprocess.html File 84.91 KB 0644
sun.html File 6.84 KB 0644
sunau.html File 27.1 KB 0644
sunaudio.html File 17.79 KB 0644
symbol.html File 7.66 KB 0644
symtable.html File 22.94 KB 0644
sys.html File 98.7 KB 0644
sysconfig.html File 23.84 KB 0644
syslog.html File 17.92 KB 0644
tabnanny.html File 10.63 KB 0644
tarfile.html File 78.68 KB 0644
telnetlib.html File 25.48 KB 0644
tempfile.html File 29.42 KB 0644
termios.html File 16.01 KB 0644
test.html File 52.62 KB 0644
textwrap.html File 27.25 KB 0644
thread.html File 20.47 KB 0644
threading.html File 76.69 KB 0644
time.html File 56.93 KB 0644
timeit.html File 36.27 KB 0644
tix.html File 46.96 KB 0644
tk.html File 23.64 KB 0644
tkinter.html File 67.67 KB 0644
token.html File 19.62 KB 0644
tokenize.html File 18.45 KB 0644
trace.html File 25.54 KB 0644
traceback.html File 33.44 KB 0644
ttk.html File 101.75 KB 0644
tty.html File 9.06 KB 0644
turtle.html File 211.74 KB 0644
types.html File 27.59 KB 0644
undoc.html File 23.16 KB 0644
unicodedata.html File 18.55 KB 0644
unittest.html File 202.85 KB 0644
unix.html File 10.55 KB 0644
urllib.html File 58.68 KB 0644
urllib2.html File 100.58 KB 0644
urlparse.html File 40.41 KB 0644
user.html File 11.83 KB 0644
userdict.html File 29.73 KB 0644
uu.html File 11.03 KB 0644
uuid.html File 28.19 KB 0644
warnings.html File 46.6 KB 0644
wave.html File 22.22 KB 0644
weakref.html File 36.52 KB 0644
webbrowser.html File 23.07 KB 0644
whichdb.html File 8.85 KB 0644
windows.html File 9.33 KB 0644
winsound.html File 18.75 KB 0644
wsgiref.html File 81.04 KB 0644
xdrlib.html File 29.94 KB 0644
xml.dom.html File 89.04 KB 0644
xml.dom.minidom.html File 40.42 KB 0644
xml.dom.pulldom.html File 12.71 KB 0644
xml.etree.elementtree.html File 93.22 KB 0644
xml.html File 16.49 KB 0644
xml.sax.handler.html File 38.63 KB 0644
xml.sax.html File 20.22 KB 0644
xml.sax.reader.html File 39.09 KB 0644
xml.sax.utils.html File 14.26 KB 0644
xmlrpclib.html File 60.79 KB 0644
zipfile.html File 53.14 KB 0644
zipimport.html File 20.42 KB 0644
zlib.html File 25.46 KB 0644