Name	Size	Mode	Actions
2to3.rst.txt	14647	0644	editdlrm
abc.rst.txt	7219	0644	editdlrm
aepack.rst.txt	4257	0644	editdlrm
aetools.rst.txt	3532	0644	editdlrm
aetypes.rst.txt	4257	0644	editdlrm
aifc.rst.txt	7086	0644	editdlrm
al.rst.txt	5309	0644	editdlrm
allos.rst.txt	695	0644	editdlrm
anydbm.rst.txt	4111	0644	editdlrm
archiving.rst.txt	424	0644	editdlrm
argparse.rst.txt	74685	0644	editdlrm
array.rst.txt	10524	0644	editdlrm
ast.rst.txt	10111	0644	editdlrm
asynchat.rst.txt	9206	0644	editdlrm
asyncore.rst.txt	12937	0644	editdlrm
atexit.rst.txt	3910	0644	editdlrm
audioop.rst.txt	10395	0644	editdlrm
autogil.rst.txt	1015	0644	editdlrm
base64.rst.txt	6252	0644	editdlrm
basehttpserver.rst.txt	10404	0644	editdlrm
bastion.rst.txt	2611	0644	editdlrm
bdb.rst.txt	12456	0644	editdlrm
binascii.rst.txt	6508	0644	editdlrm
binhex.rst.txt	1910	0644	editdlrm
bisect.rst.txt	5415	0644	editdlrm
bsddb.rst.txt	7575	0644	editdlrm
bz2.rst.txt	8064	0644	editdlrm
calendar.rst.txt	11282	0644	editdlrm
carbon.rst.txt	15956	0644	editdlrm
cd.rst.txt	11974	0644	editdlrm
cgi.rst.txt	22853	0644	editdlrm
cgihttpserver.rst.txt	2788	0644	editdlrm
cgitb.rst.txt	2874	0644	editdlrm
chunk.rst.txt	4955	0644	editdlrm
cmath.rst.txt	7647	0644	editdlrm
cmd.rst.txt	8565	0644	editdlrm
code.rst.txt	7115	0644	editdlrm
codecs.rst.txt	66966	0644	editdlrm
codeop.rst.txt	3774	0644	editdlrm
collections.rst.txt	41448	0644	editdlrm
colorpicker.rst.txt	913	0644	editdlrm
colorsys.rst.txt	1819	0644	editdlrm
commands.rst.txt	2595	0644	editdlrm
compileall.rst.txt	4678	0644	editdlrm
compiler.rst.txt	37464	0644	editdlrm
configparser.rst.txt	19607	0644	editdlrm
constants.rst.txt	2328	0644	editdlrm
contextlib.rst.txt	6012	0644	editdlrm
cookie.rst.txt	9543	0644	editdlrm
cookielib.rst.txt	27875	0644	editdlrm
copy.rst.txt	3351	0644	editdlrm
copy_reg.rst.txt	2329	0644	editdlrm
crypt.rst.txt	2292	0644	editdlrm
crypto.rst.txt	355	0644	editdlrm
csv.rst.txt	22757	0644	editdlrm
ctypes.rst.txt	90513	0644	editdlrm
curses.ascii.rst.txt	9046	0644	editdlrm
curses.panel.rst.txt	2740	0644	editdlrm
curses.rst.txt	74877	0644	editdlrm
custominterp.rst.txt	570	0644	editdlrm
datatypes.rst.txt	864	0644	editdlrm
datetime.rst.txt	74679	0644	editdlrm
dbhash.rst.txt	3865	0644	editdlrm
dbm.rst.txt	3117	0644	editdlrm
debug.rst.txt	446	0644	editdlrm
decimal.rst.txt	70926	0644	editdlrm
development.rst.txt	640	0644	editdlrm
difflib.rst.txt	30716	0644	editdlrm
dircache.rst.txt	1813	0644	editdlrm
dis.rst.txt	23248	0644	editdlrm
distribution.rst.txt	426	0644	editdlrm
distutils.rst.txt	1958	0644	editdlrm
dl.rst.txt	3392	0644	editdlrm
doctest.rst.txt	73985	0644	editdlrm
docxmlrpcserver.rst.txt	3802	0644	editdlrm
dumbdbm.rst.txt	2841	0644	editdlrm
dummy_thread.rst.txt	1058	0644	editdlrm
dummy_threading.rst.txt	799	0644	editdlrm
easydialogs.rst.txt	10346	0644	editdlrm
email-examples.rst.txt	1271	0644	editdlrm
email.charset.rst.txt	9654	0644	editdlrm
email.encoders.rst.txt	2376	0644	editdlrm
email.errors.rst.txt	4006	0644	editdlrm
email.generator.rst.txt	6132	0644	editdlrm
email.header.rst.txt	7531	0644	editdlrm
email.iterators.rst.txt	2421	0644	editdlrm
email.message.rst.txt	25217	0644	editdlrm
email.mime.rst.txt	9917	0644	editdlrm
email.parser.rst.txt	10327	0644	editdlrm
email.rst.txt	16111	0644	editdlrm
email.utils.rst.txt	6475	0644	editdlrm
ensurepip.rst.txt	5022	0644	editdlrm
errno.rst.txt	6708	0644	editdlrm
exceptions.rst.txt	18343	0644	editdlrm
fcntl.rst.txt	7361	0644	editdlrm
filecmp.rst.txt	5348	0644	editdlrm
fileformats.rst.txt	302	0644	editdlrm
fileinput.rst.txt	7417	0644	editdlrm
filesys.rst.txt	806	0644	editdlrm
fl.rst.txt	17646	0644	editdlrm
fm.rst.txt	2699	0644	editdlrm
fnmatch.rst.txt	3104	0644	editdlrm
formatter.rst.txt	13245	0644	editdlrm
fpectl.rst.txt	4171	0644	editdlrm
fpformat.rst.txt	1747	0644	editdlrm
fractions.rst.txt	5297	0644	editdlrm
framework.rst.txt	11444	0644	editdlrm
frameworks.rst.txt	378	0644	editdlrm
ftplib.rst.txt	15720	0644	editdlrm
functions.rst.txt	75554	0644	editdlrm
functools.rst.txt	7448	0644	editdlrm
future_builtins.rst.txt	2010	0644	editdlrm
gc.rst.txt	9014	0644	editdlrm
gdbm.rst.txt	4882	0644	editdlrm
gensuitemodule.rst.txt	3113	0644	editdlrm
getopt.rst.txt	6670	0644	editdlrm
getpass.rst.txt	1876	0644	editdlrm
gettext.rst.txt	29040	0644	editdlrm
gl.rst.txt	6009	0644	editdlrm
glob.rst.txt	2414	0644	editdlrm
grp.rst.txt	2256	0644	editdlrm
gzip.rst.txt	4828	0644	editdlrm
hashlib.rst.txt	7379	0644	editdlrm
heapq.rst.txt	13185	0644	editdlrm
hmac.rst.txt	3073	0644	editdlrm
hotshot.rst.txt	4289	0644	editdlrm
htmllib.rst.txt	7379	0644	editdlrm
htmlparser.rst.txt	11640	0644	editdlrm
httplib.rst.txt	37454	0644	editdlrm
i18n.rst.txt	409	0644	editdlrm
ic.rst.txt	5005	0644	editdlrm
idle.rst.txt	22182	0644	editdlrm
imageop.rst.txt	4001	0644	editdlrm
imaplib.rst.txt	17221	0644	editdlrm
imgfile.rst.txt	2765	0644	editdlrm
imghdr.rst.txt	2635	0644	editdlrm
imp.rst.txt	12593	0644	editdlrm
importlib.rst.txt	1126	0644	editdlrm
imputil.rst.txt	7023	0644	editdlrm
index.rst.txt	2287	0644	editdlrm
inspect.rst.txt	28151	0644	editdlrm
internet.rst.txt	950	0644	editdlrm
intro.rst.txt	2803	0644	editdlrm
io.rst.txt	39015	0644	editdlrm
ipc.rst.txt	630	0644	editdlrm
itertools.rst.txt	36324	0644	editdlrm
jpeg.rst.txt	3858	0644	editdlrm
json.rst.txt	25545	0644	editdlrm
keyword.rst.txt	617	0644	editdlrm
language.rst.txt	523	0644	editdlrm
linecache.rst.txt	1887	0644	editdlrm
locale.rst.txt	24975	0644	editdlrm
logging.config.rst.txt	31560	0644	editdlrm
logging.handlers.rst.txt	28153	0644	editdlrm
logging.rst.txt	46882	0644	editdlrm
mac.rst.txt	791	0644	editdlrm
macos.rst.txt	3824	0644	editdlrm
macosa.rst.txt	3964	0644	editdlrm
macostools.rst.txt	4017	0644	editdlrm
macpath.rst.txt	650	0644	editdlrm
mailbox.rst.txt	68129	0644	editdlrm
mailcap.rst.txt	3675	0644	editdlrm
markup.rst.txt	1249	0644	editdlrm
marshal.rst.txt	5689	0644	editdlrm
math.rst.txt	10920	0644	editdlrm
md5.rst.txt	2815	0644	editdlrm
mhlib.rst.txt	3966	0644	editdlrm
mimetools.rst.txt	4504	0644	editdlrm
mimetypes.rst.txt	9839	0644	editdlrm
mimewriter.rst.txt	3360	0644	editdlrm
mimify.rst.txt	3519	0644	editdlrm
miniaeframe.rst.txt	2564	0644	editdlrm
misc.rst.txt	248	0644	editdlrm
mm.rst.txt	447	0644	editdlrm
mmap.rst.txt	10481	0644	editdlrm
modulefinder.rst.txt	3380	0644	editdlrm
modules.rst.txt	382	0644	editdlrm
msilib.rst.txt	19062	0644	editdlrm
msvcrt.rst.txt	4346	0644	editdlrm
multifile.rst.txt	6613	0644	editdlrm
multiprocessing.rst.txt	92621	0644	editdlrm
mutex.rst.txt	1939	0644	editdlrm
netdata.rst.txt	432	0644	editdlrm
netrc.rst.txt	3119	0644	editdlrm
new.rst.txt	2653	0644	editdlrm
nis.rst.txt	2108	0644	editdlrm
nntplib.rst.txt	14531	0644	editdlrm
numbers.rst.txt	8007	0644	editdlrm
numeric.rst.txt	751	0644	editdlrm
operator.rst.txt	22092	0644	editdlrm
optparse.rst.txt	77101	0644	editdlrm
os.path.rst.txt	13094	0644	editdlrm
os.rst.txt	82580	0644	editdlrm
ossaudiodev.rst.txt	17309	0644	editdlrm
othergui.rst.txt	2721	0644	editdlrm
parser.rst.txt	15385	0644	editdlrm
pdb.rst.txt	16043	0644	editdlrm
persistence.rst.txt	826	0644	editdlrm
pickle.rst.txt	37262	0644	editdlrm
pickletools.rst.txt	1997	0644	editdlrm
pipes.rst.txt	3786	0644	editdlrm
pkgutil.rst.txt	7714	0644	editdlrm
platform.rst.txt	9554	0644	editdlrm
plistlib.rst.txt	4134	0644	editdlrm
popen2.rst.txt	7022	0644	editdlrm
poplib.rst.txt	6220	0644	editdlrm
posix.rst.txt	3630	0644	editdlrm
posixfile.rst.txt	7200	0644	editdlrm
pprint.rst.txt	9071	0644	editdlrm
profile.rst.txt	28666	0644	editdlrm
pty.rst.txt	1762	0644	editdlrm
pwd.rst.txt	2725	0644	editdlrm
pyclbr.rst.txt	3296	0644	editdlrm
pydoc.rst.txt	4083	0644	editdlrm
pyexpat.rst.txt	28891	0644	editdlrm
python.rst.txt	514	0644	editdlrm
py_compile.rst.txt	2479	0644	editdlrm
queue.rst.txt	7034	0644	editdlrm
quopri.rst.txt	2670	0644	editdlrm
random.rst.txt	13319	0644	editdlrm
re.rst.txt	55102	0644	editdlrm
readline.rst.txt	10513	0644	editdlrm
repr.rst.txt	4718	0644	editdlrm
resource.rst.txt	9595	0644	editdlrm
restricted.rst.txt	3327	0644	editdlrm
rexec.rst.txt	11742	0644	editdlrm
rfc822.rst.txt	14037	0644	editdlrm
rlcompleter.rst.txt	2494	0644	editdlrm
robotparser.rst.txt	2190	0644	editdlrm
runpy.rst.txt	6938	0644	editdlrm
sched.rst.txt	4644	0644	editdlrm
scrolledtext.rst.txt	1379	0644	editdlrm
select.rst.txt	20705	0644	editdlrm
sets.rst.txt	14973	0644	editdlrm
sgi.rst.txt	322	0644	editdlrm
sgmllib.rst.txt	10664	0644	editdlrm
sha.rst.txt	2807	0644	editdlrm
shelve.rst.txt	8319	0644	editdlrm
shlex.rst.txt	11313	0644	editdlrm
shutil.rst.txt	13491	0644	editdlrm
signal.rst.txt	10719	0644	editdlrm
simplehttpserver.rst.txt	4559	0644	editdlrm
simplexmlrpcserver.rst.txt	10881	0644	editdlrm
site.rst.txt	7880	0644	editdlrm
smtpd.rst.txt	2464	0644	editdlrm
smtplib.rst.txt	14906	0644	editdlrm
sndhdr.rst.txt	1759	0644	editdlrm
socket.rst.txt	40765	0644	editdlrm
socketserver.rst.txt	22512	0644	editdlrm
someos.rst.txt	599	0644	editdlrm
spwd.rst.txt	2825	0644	editdlrm
sqlite3.rst.txt	35448	0644	editdlrm
ssl.rst.txt	76554	0644	editdlrm
stat.rst.txt	7778	0644	editdlrm
statvfs.rst.txt	1300	0644	editdlrm
stdtypes.rst.txt	122668	0644	editdlrm
string.rst.txt	44085	0644	editdlrm
stringio.rst.txt	4166	0644	editdlrm
stringprep.rst.txt	4238	0644	editdlrm
strings.rst.txt	746	0644	editdlrm
struct.rst.txt	17100	0644	editdlrm
subprocess.rst.txt	33648	0644	editdlrm
sun.rst.txt	249	0644	editdlrm
sunau.rst.txt	7124	0644	editdlrm
sunaudio.rst.txt	5849	0644	editdlrm
symbol.rst.txt	975	0644	editdlrm
symtable.rst.txt	5064	0644	editdlrm
sys.rst.txt	47520	0644	editdlrm
sysconfig.rst.txt	7639	0644	editdlrm
syslog.rst.txt	3931	0644	editdlrm
tabnanny.rst.txt	1999	0644	editdlrm
tarfile.rst.txt	28214	0644	editdlrm
telnetlib.rst.txt	7482	0644	editdlrm
tempfile.rst.txt	10504	0644	editdlrm
termios.rst.txt	3733	0644	editdlrm
test.rst.txt	17659	0644	editdlrm
textwrap.rst.txt	8552	0644	editdlrm
thread.rst.txt	6588	0644	editdlrm
threading.rst.txt	32468	0644	editdlrm
time.rst.txt	26020	0644	editdlrm
timeit.rst.txt	11598	0644	editdlrm
tix.rst.txt	22693	0644	editdlrm
tk.rst.txt	1612	0644	editdlrm
tkinter.rst.txt	33456	0644	editdlrm
token.rst.txt	2451	0644	editdlrm
tokenize.rst.txt	5570	0644	editdlrm
trace.rst.txt	6724	0644	editdlrm
traceback.rst.txt	10711	0644	editdlrm
ttk.rst.txt	57411	0644	editdlrm
tty.rst.txt	1011	0644	editdlrm
turtle.rst.txt	64097	0644	editdlrm
types.rst.txt	6200	0644	editdlrm
undoc.rst.txt	6550	0644	editdlrm
unicodedata.rst.txt	5736	0644	editdlrm
unittest.rst.txt	82952	0644	editdlrm
unix.rst.txt	490	0644	editdlrm
urllib.rst.txt	24960	0644	editdlrm
urllib2.rst.txt	35211	0644	editdlrm
urlparse.rst.txt	16071	0644	editdlrm
user.rst.txt	2748	0644	editdlrm
userdict.rst.txt	9290	0644	editdlrm
uu.rst.txt	2369	0644	editdlrm
uuid.rst.txt	8378	0644	editdlrm
warnings.rst.txt	19815	0644	editdlrm
wave.rst.txt	5047	0644	editdlrm
weakref.rst.txt	12926	0644	editdlrm
webbrowser.rst.txt	9863	0644	editdlrm
whichdb.rst.txt	931	0644	editdlrm
windows.rst.txt	273	0644	editdlrm
winsound.rst.txt	5066	0644	editdlrm
wsgiref.rst.txt	30567	0644	editdlrm
xdrlib.rst.txt	8077	0644	editdlrm
xml.dom.minidom.rst.txt	11208	0644	editdlrm
xml.dom.pulldom.rst.txt	1571	0644	editdlrm
xml.dom.rst.txt	40182	0644	editdlrm
xml.etree.elementtree.rst.txt	35707	0644	editdlrm
xml.rst.txt	6090	0644	editdlrm
xml.sax.handler.rst.txt	15371	0644	editdlrm
xml.sax.reader.rst.txt	12257	0644	editdlrm
xml.sax.rst.txt	6460	0644	editdlrm
xml.sax.utils.rst.txt	3560	0644	editdlrm
xmlrpclib.rst.txt	22559	0644	editdlrm
zipfile.rst.txt	18871	0644	editdlrm
zipimport.rst.txt	5957	0644	editdlrm
zlib.rst.txt	12766	0644	editdlrm
_winreg.rst.txt	23305	0644	editdlrm
__builtin__.rst.txt	1494	0644	editdlrm
__future__.rst.txt	4952	0644	editdlrm
__main__.rst.txt	535	0644	editdlrm

:mod:`shlex` --- Simple lexical analysis ======================================== .. module:: shlex :synopsis: Simple lexical analysis for Unix shell-like languages. .. moduleauthor:: Eric S. Raymond .. moduleauthor:: Gustavo Niemeyer .. sectionauthor:: Eric S. Raymond .. sectionauthor:: Gustavo Niemeyer .. versionadded:: 1.5.2 **Source code:** :source:`Lib/shlex.py` -------------- The :class:`~shlex.shlex` 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. Prior to Python 2.7.3, this module did not support Unicode input. The :mod:`shlex` module defines the following functions: .. function:: split(s[, comments[, posix]]) Split the string *s* using shell-like syntax. If *comments* is :const:`False` (the default), the parsing of comments in the given string will be disabled (setting the :attr:`~shlex.commenters` attribute of the :class:`~shlex.shlex` instance to the empty string). This function operates in POSIX mode by default, but uses non-POSIX mode if the *posix* argument is false. .. versionadded:: 2.3 .. versionchanged:: 2.6 Added the *posix* parameter. .. note:: Since the :func:`split` function instantiates a :class:`~shlex.shlex` instance, passing ``None`` for *s* will read the string to split from standard input. The :mod:`shlex` module defines the following class: .. class:: shlex([instream[, infile[, posix]]]) A :class:`~shlex.shlex` 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 :meth:`~io.TextIOBase.read` and :meth:`~io.TextIOBase.readline` methods, or a string (strings are accepted since Python 2.3). If no argument is given, input will be taken from ``sys.stdin``. The second optional argument is a filename string, which sets the initial value of the :attr:`~shlex.infile` attribute. If the *instream* argument is omitted or equal to ``sys.stdin``, this second argument defaults to "stdin". The *posix* argument was introduced in Python 2.3, and defines the operational mode. When *posix* is not true (default), the :class:`~shlex.shlex` instance will operate in compatibility mode. When operating in POSIX mode, :class:`~shlex.shlex` will try to be as close as possible to the POSIX shell parsing rules. .. seealso:: Module :mod:`ConfigParser` Parser for configuration files similar to the Windows :file:`.ini` files. .. _shlex-objects: shlex Objects ------------- A :class:`~shlex.shlex` instance has the following methods: .. method:: shlex.get_token() Return a token. If tokens have been stacked using :meth:`push_token`, pop a token off the stack. Otherwise, read one from the input stream. If reading encounters an immediate end-of-file, :attr:`eof` is returned (the empty string (``''``) in non-POSIX mode, and ``None`` in POSIX mode). .. method:: shlex.push_token(str) Push the argument onto the token stack. .. method:: shlex.read_token() 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.) .. method:: shlex.sourcehook(filename) When :class:`~shlex.shlex` detects a source request (see :attr:`source` 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. 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 ``sys.stdin``), 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 ``#include "file.h"``). The result of the manipulations is treated as a filename, and returned as the first component of the tuple, with :func:`open` called on it to yield the second component. (Note: this is the reverse of the order of arguments in instance initialization!) 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 'close' hook, but a shlex instance will call the :meth:`~io.IOBase.close` method of the sourced input stream when it returns EOF. For more explicit control of source stacking, use the :meth:`push_source` and :meth:`pop_source` methods. .. method:: shlex.push_source(stream[, filename]) 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 :meth:`sourcehook` method. .. versionadded:: 2.1 .. method:: shlex.pop_source() 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. .. versionadded:: 2.1 .. method:: shlex.error_leader([file[, line]]) This method generates an error message leader in the format of a Unix C compiler error label; the format is ``'"%s", line %d: '``, where the ``%s`` is replaced with the name of the current source file and the ``%d`` with the current input line number (the optional arguments can be used to override these). This convenience is provided to encourage :mod:`shlex` users to generate error messages in the standard, parseable format understood by Emacs and other Unix tools. Instances of :class:`~shlex.shlex` subclasses have some public instance variables which either control lexical analysis or can be used for debugging: .. attribute:: shlex.commenters The string of characters that are recognized as comment beginners. All characters from the comment beginner to end of line are ignored. Includes just ``'#'`` by default. .. attribute:: shlex.wordchars The string of characters that will accumulate into multi-character tokens. By default, includes all ASCII alphanumerics and underscore. .. attribute:: shlex.whitespace Characters that will be considered whitespace and skipped. Whitespace bounds tokens. By default, includes space, tab, linefeed and carriage-return. .. attribute:: shlex.escape Characters that will be considered as escape. This will be only used in POSIX mode, and includes just ``'\'`` by default. .. versionadded:: 2.3 .. attribute:: shlex.quotes 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. .. attribute:: shlex.escapedquotes Characters in :attr:`quotes` that will interpret escape characters defined in :attr:`escape`. This is only used in POSIX mode, and includes just ``'"'`` by default. .. versionadded:: 2.3 .. attribute:: shlex.whitespace_split If ``True``, tokens will only be split in whitespaces. This is useful, for example, for parsing command lines with :class:`~shlex.shlex`, getting tokens in a similar way to shell arguments. .. versionadded:: 2.3 .. attribute:: shlex.infile 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. .. attribute:: shlex.instream The input stream from which this :class:`~shlex.shlex` instance is reading characters. .. attribute:: shlex.source This attribute is ``None`` by default. If you assign a string to it, that string will be recognized as a lexical-level inclusion request similar to the ``source`` keyword in various shells. That is, the immediately following token will be opened as a filename and input will be taken from that stream until EOF, at which point the :meth:`~io.IOBase.close` 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. .. attribute:: shlex.debug If this attribute is numeric and ``1`` or more, a :class:`~shlex.shlex` 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. .. attribute:: shlex.lineno Source line number (count of newlines seen so far plus one). .. attribute:: shlex.token The token buffer. It may be useful to examine this when catching exceptions. .. attribute:: shlex.eof Token used to determine end of file. This will be set to the empty string (``''``), in non-POSIX mode, and to ``None`` in POSIX mode. .. versionadded:: 2.3 .. _shlex-parsing-rules: Parsing Rules ------------- When operating in non-POSIX mode, :class:`~shlex.shlex` will try to obey to the following rules. * Quote characters are not recognized within words (``Do"Not"Separate`` is parsed as the single word ``Do"Not"Separate``); * Escape characters are not recognized; * Enclosing characters in quotes preserve the literal value of all characters within the quotes; * Closing quotes separate words (``"Do"Separate`` is parsed as ``"Do"`` and ``Separate``); * If :attr:`~shlex.whitespace_split` is ``False``, any character not declared to be a word character, whitespace, or a quote will be returned as a single-character token. If it is ``True``, :class:`~shlex.shlex` will only split words in whitespaces; * EOF is signaled with an empty string (``''``); * It's not possible to parse empty strings, even if quoted. When operating in POSIX mode, :class:`~shlex.shlex` will try to obey to the following parsing rules. * Quotes are stripped out, and do not separate words (``"Do"Not"Separate"`` is parsed as the single word ``DoNotSeparate``); * Non-quoted escape characters (e.g. ``'\'``) preserve the literal value of the next character that follows; * Enclosing characters in quotes which are not part of :attr:`~shlex.escapedquotes` (e.g. ``"'"``) preserve the literal value of all characters within the quotes; * Enclosing characters in quotes which are part of :attr:`~shlex.escapedquotes` (e.g. ``'"'``) preserves the literal value of all characters within the quotes, with the exception of the characters mentioned in :attr:`~shlex.escape`. 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. * EOF is signaled with a :const:`None` value; * Quoted empty strings (``''``) are allowed;