Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
2to3.html	70.96 KB	-rw-r--r--
__future__.html	20.75 KB	-rw-r--r--
__main__.html	44.87 KB	-rw-r--r--
_thread.html	30.39 KB	-rw-r--r--
abc.html	46.87 KB	-rw-r--r--
aifc.html	35.56 KB	-rw-r--r--
allos.html	34.33 KB	-rw-r--r--
archiving.html	17 KB	-rw-r--r--
argparse.html	300.89 KB	-rw-r--r--
array.html	37.28 KB	-rw-r--r--
ast.html	293.08 KB	-rw-r--r--
asynchat.html	37.41 KB	-rw-r--r--
asyncio-api-index.html	27.68 KB	-rw-r--r--
asyncio-dev.html	36.1 KB	-rw-r--r--
asyncio-eventloop.html	204.43 KB	-rw-r--r--
asyncio-exceptions.html	17.11 KB	-rw-r--r--
asyncio-future.html	38.23 KB	-rw-r--r--
asyncio-llapi-index.html	61.97 KB	-rw-r--r--
asyncio-platforms.html	21.77 KB	-rw-r--r--
asyncio-policy.html	39.56 KB	-rw-r--r--
asyncio-protocol.html	118.33 KB	-rw-r--r--
asyncio-queue.html	31.86 KB	-rw-r--r--
asyncio-stream.html	69.98 KB	-rw-r--r--
asyncio-subprocess.html	49.25 KB	-rw-r--r--
asyncio-sync.html	42.79 KB	-rw-r--r--
asyncio-task.html	109.14 KB	-rw-r--r--
asyncio.html	17.31 KB	-rw-r--r--
asyncore.html	49.36 KB	-rw-r--r--
atexit.html	22.87 KB	-rw-r--r--
audioop.html	46 KB	-rw-r--r--
audit_events.html	72.85 KB	-rw-r--r--
base64.html	48.09 KB	-rw-r--r--
bdb.html	66 KB	-rw-r--r--
binary.html	15.97 KB	-rw-r--r--
binascii.html	36.3 KB	-rw-r--r--
binhex.html	15.97 KB	-rw-r--r--
bisect.html	43.38 KB	-rw-r--r--
builtins.html	14.87 KB	-rw-r--r--
bz2.html	50.68 KB	-rw-r--r--
calendar.html	69.35 KB	-rw-r--r--
cgi.html	59.95 KB	-rw-r--r--
cgitb.html	19.96 KB	-rw-r--r--
chunk.html	22.21 KB	-rw-r--r--
cmath.html	43.89 KB	-rw-r--r--
cmd.html	50.42 KB	-rw-r--r--
code.html	35.38 KB	-rw-r--r--
codecs.html	157.96 KB	-rw-r--r--
codeop.html	18.26 KB	-rw-r--r--
collections.abc.html	79.17 KB	-rw-r--r--
collections.html	189.43 KB	-rw-r--r--
colorsys.html	17.31 KB	-rw-r--r--
compileall.html	50.68 KB	-rw-r--r--
concurrency.html	24.15 KB	-rw-r--r--
concurrent.futures.html	79.03 KB	-rw-r--r--
concurrent.html	11.56 KB	-rw-r--r--
configparser.html	159.4 KB	-rw-r--r--
constants.html	22.41 KB	-rw-r--r--
contextlib.html	117.2 KB	-rw-r--r--
contextvars.html	38.38 KB	-rw-r--r--
copy.html	17.92 KB	-rw-r--r--
copyreg.html	18.63 KB	-rw-r--r--
crypt.html	28.29 KB	-rw-r--r--
crypto.html	13.93 KB	-rw-r--r--
csv.html	82.89 KB	-rw-r--r--
ctypes.html	295.49 KB	-rw-r--r--
curses.ascii.html	32.04 KB	-rw-r--r--
curses.html	221.24 KB	-rw-r--r--
curses.panel.html	22.16 KB	-rw-r--r--
custominterp.html	11.85 KB	-rw-r--r--
dataclasses.html	113.16 KB	-rw-r--r--
datatypes.html	31.82 KB	-rw-r--r--
datetime.html	374.92 KB	-rw-r--r--
dbm.html	51.16 KB	-rw-r--r--
debug.html	17 KB	-rw-r--r--
decimal.html	270.12 KB	-rw-r--r--
development.html	32.34 KB	-rw-r--r--
devmode.html	31.72 KB	-rw-r--r--
dialog.html	43.03 KB	-rw-r--r--
difflib.html	111.99 KB	-rw-r--r--
dis.html	136.07 KB	-rw-r--r--
distribution.html	13.67 KB	-rw-r--r--
distutils.html	14.73 KB	-rw-r--r--
doctest.html	199.32 KB	-rw-r--r--
email.charset.html	31.92 KB	-rw-r--r--
email.compat32-message.html	97.74 KB	-rw-r--r--
email.contentmanager.html	37.02 KB	-rw-r--r--
email.encoders.html	18.47 KB	-rw-r--r--
email.errors.html	24.45 KB	-rw-r--r--
email.examples.html	60.49 KB	-rw-r--r--
email.generator.html	48.79 KB	-rw-r--r--
email.header.html	37.61 KB	-rw-r--r--
email.headerregistry.html	66.26 KB	-rw-r--r--
email.html	30.75 KB	-rw-r--r--
email.iterators.html	18.23 KB	-rw-r--r--
email.message.html	99.75 KB	-rw-r--r--
email.mime.html	44.89 KB	-rw-r--r--
email.parser.html	57.39 KB	-rw-r--r--
email.policy.html	84.24 KB	-rw-r--r--
email.utils.html	42.57 KB	-rw-r--r--
ensurepip.html	23.9 KB	-rw-r--r--
enum.html	151 KB	-rw-r--r--
errno.html	60.17 KB	-rw-r--r--
exceptions.html	108.44 KB	-rw-r--r--
faulthandler.html	31.5 KB	-rw-r--r--
fcntl.html	36.67 KB	-rw-r--r--
filecmp.html	32.08 KB	-rw-r--r--
fileformats.html	13.52 KB	-rw-r--r--
fileinput.html	40.37 KB	-rw-r--r--
filesys.html	16.78 KB	-rw-r--r--
fnmatch.html	21.02 KB	-rw-r--r--
fractions.html	35.29 KB	-rw-r--r--
frameworks.html	16.15 KB	-rw-r--r--
ftplib.html	71.97 KB	-rw-r--r--
functional.html	12.19 KB	-rw-r--r--
functions.html	260.33 KB	-rw-r--r--
functools.html	92.96 KB	-rw-r--r--
gc.html	40.97 KB	-rw-r--r--
getopt.html	29.4 KB	-rw-r--r--
getpass.html	16.01 KB	-rw-r--r--
gettext.html	98.02 KB	-rw-r--r--
glob.html	27.2 KB	-rw-r--r--
graphlib.html	34.82 KB	-rw-r--r--
grp.html	16.03 KB	-rw-r--r--
gzip.html	45.65 KB	-rw-r--r--
hashlib.html	93.19 KB	-rw-r--r--
heapq.html	42.43 KB	-rw-r--r--
hmac.html	24.74 KB	-rw-r--r--
html.entities.html	14.91 KB	-rw-r--r--
html.html	14.81 KB	-rw-r--r--
html.parser.html	47.7 KB	-rw-r--r--
http.client.html	85.63 KB	-rw-r--r--
http.cookiejar.html	113.94 KB	-rw-r--r--
http.cookies.html	47.64 KB	-rw-r--r--
http.html	45.52 KB	-rw-r--r--
http.server.html	73.05 KB	-rw-r--r--
i18n.html	13.44 KB	-rw-r--r--
idle.html	77.18 KB	-rw-r--r--
imaplib.html	87.08 KB	-rw-r--r--
imghdr.html	17.94 KB	-rw-r--r--
imp.html	54.32 KB	-rw-r--r--
importlib.html	239.96 KB	-rw-r--r--
importlib.metadata.html	43.14 KB	-rw-r--r--
index.html	75.06 KB	-rw-r--r--
inspect.html	168.74 KB	-rw-r--r--
internet.html	29.89 KB	-rw-r--r--
intro.html	13.81 KB	-rw-r--r--
io.html	154.15 KB	-rw-r--r--
ipaddress.html	137.75 KB	-rw-r--r--
ipc.html	12.6 KB	-rw-r--r--
itertools.html	153.27 KB	-rw-r--r--
json.html	98.9 KB	-rw-r--r--
keyword.html	14.88 KB	-rw-r--r--
language.html	16.71 KB	-rw-r--r--
linecache.html	18.09 KB	-rw-r--r--
locale.html	77.35 KB	-rw-r--r--
logging.config.html	100.3 KB	-rw-r--r--
logging.handlers.html	146.28 KB	-rw-r--r--
logging.html	169.67 KB	-rw-r--r--
lzma.html	66.89 KB	-rw-r--r--
mailbox.html	176.34 KB	-rw-r--r--
mailcap.html	20.86 KB	-rw-r--r--
markup.html	22.31 KB	-rw-r--r--
marshal.html	24.43 KB	-rw-r--r--
math.html	85.82 KB	-rw-r--r--
mimetypes.html	40.27 KB	-rw-r--r--
mm.html	11.16 KB	-rw-r--r--
mmap.html	55.53 KB	-rw-r--r--
modulefinder.html	23.67 KB	-rw-r--r--
modules.html	15.88 KB	-rw-r--r--
msilib.html	78.38 KB	-rw-r--r--
msvcrt.html	29.22 KB	-rw-r--r--
multiprocessing.html	405.24 KB	-rw-r--r--
multiprocessing.shared_memory....	60 KB	-rw-r--r--
netdata.html	20.24 KB	-rw-r--r--
netrc.html	20.39 KB	-rw-r--r--
nis.html	16.76 KB	-rw-r--r--
nntplib.html	84.93 KB	-rw-r--r--
numbers.html	45.67 KB	-rw-r--r--
numeric.html	19.29 KB	-rw-r--r--
operator.html	107.32 KB	-rw-r--r--
optparse.html	256.96 KB	-rw-r--r--
os.html	594.39 KB	-rw-r--r--
os.path.html	65.54 KB	-rw-r--r--
ossaudiodev.html	56.35 KB	-rw-r--r--
pathlib.html	170.01 KB	-rw-r--r--
pdb.html	68.67 KB	-rw-r--r--
persistence.html	19.13 KB	-rw-r--r--
pickle.html	154.45 KB	-rw-r--r--
pickletools.html	22.92 KB	-rw-r--r--
pipes.html	21.7 KB	-rw-r--r--
pkgutil.html	42.76 KB	-rw-r--r--
platform.html	45.08 KB	-rw-r--r--
plistlib.html	30.06 KB	-rw-r--r--
poplib.html	41.42 KB	-rw-r--r--
posix.html	20.96 KB	-rw-r--r--
pprint.html	55.35 KB	-rw-r--r--
profile.html	84.63 KB	-rw-r--r--
pty.html	23.7 KB	-rw-r--r--
pwd.html	16.84 KB	-rw-r--r--
py_compile.html	29 KB	-rw-r--r--
pyclbr.html	24.06 KB	-rw-r--r--
pydoc.html	19.59 KB	-rw-r--r--
pyexpat.html	104.38 KB	-rw-r--r--
python.html	22.46 KB	-rw-r--r--
queue.html	43.39 KB	-rw-r--r--
quopri.html	18.64 KB	-rw-r--r--
random.html	86.31 KB	-rw-r--r--
re.html	214.24 KB	-rw-r--r--
readline.html	50.19 KB	-rw-r--r--
reprlib.html	30.85 KB	-rw-r--r--
resource.html	48.26 KB	-rw-r--r--
rlcompleter.html	18.06 KB	-rw-r--r--
runpy.html	30.99 KB	-rw-r--r--
sched.html	27.04 KB	-rw-r--r--
secrets.html	30.2 KB	-rw-r--r--
security_warnings.html	16.21 KB	-rw-r--r--
select.html	74.58 KB	-rw-r--r--
selectors.html	41.91 KB	-rw-r--r--
shelve.html	36.54 KB	-rw-r--r--
shlex.html	61.03 KB	-rw-r--r--
shutil.html	100.13 KB	-rw-r--r--
signal.html	95.39 KB	-rw-r--r--
site.html	38.16 KB	-rw-r--r--
smtpd.html	44.09 KB	-rw-r--r--
smtplib.html	81.4 KB	-rw-r--r--
sndhdr.html	16.4 KB	-rw-r--r--
socket.html	256.95 KB	-rw-r--r--
socketserver.html	91.95 KB	-rw-r--r--
spwd.html	16.71 KB	-rw-r--r--
sqlite3.html	225.51 KB	-rw-r--r--
ssl.html	328.83 KB	-rw-r--r--
stat.html	57.79 KB	-rw-r--r--
statistics.html	123.22 KB	-rw-r--r--
stdtypes.html	615.43 KB	-rw-r--r--
string.html	108.03 KB	-rw-r--r--
stringprep.html	24.94 KB	-rw-r--r--
struct.html	70.58 KB	-rw-r--r--
subprocess.html	199.03 KB	-rw-r--r--
sunau.html	39.84 KB	-rw-r--r--
superseded.html	26.21 KB	-rw-r--r--
symtable.html	33.26 KB	-rw-r--r--
sys.html	198.83 KB	-rw-r--r--
sysconfig.html	39.81 KB	-rw-r--r--
syslog.html	27.36 KB	-rw-r--r--
tabnanny.html	16.18 KB	-rw-r--r--
tarfile.html	161.92 KB	-rw-r--r--
telnetlib.html	38.21 KB	-rw-r--r--
tempfile.html	58.39 KB	-rw-r--r--
termios.html	22.86 KB	-rw-r--r--
test.html	222.85 KB	-rw-r--r--
text.html	16.8 KB	-rw-r--r--
textwrap.html	48.83 KB	-rw-r--r--
threading.html	128.33 KB	-rw-r--r--
time.html	107.46 KB	-rw-r--r--
timeit.html	52.63 KB	-rw-r--r--
tk.html	28.08 KB	-rw-r--r--
tkinter.colorchooser.html	14.49 KB	-rw-r--r--
tkinter.dnd.html	17.09 KB	-rw-r--r--
tkinter.font.html	22.21 KB	-rw-r--r--
tkinter.html	106.85 KB	-rw-r--r--
tkinter.messagebox.html	20.09 KB	-rw-r--r--
tkinter.scrolledtext.html	14.52 KB	-rw-r--r--
tkinter.tix.html	59.69 KB	-rw-r--r--
tkinter.ttk.html	138.37 KB	-rw-r--r--
token.html	45.73 KB	-rw-r--r--
tokenize.html	39.86 KB	-rw-r--r--
trace.html	38.85 KB	-rw-r--r--
traceback.html	75.61 KB	-rw-r--r--
tracemalloc.html	122.33 KB	-rw-r--r--
tty.html	14.46 KB	-rw-r--r--
turtle.html	271.71 KB	-rw-r--r--
types.html	64.85 KB	-rw-r--r--
typing.html	315.69 KB	-rw-r--r--
unicodedata.html	27.3 KB	-rw-r--r--
unittest.html	310.01 KB	-rw-r--r--
unittest.mock-examples.html	177.75 KB	-rw-r--r--
unittest.mock.html	363.51 KB	-rw-r--r--
unix.html	13.46 KB	-rw-r--r--
urllib.error.html	18.56 KB	-rw-r--r--
urllib.html	12.92 KB	-rw-r--r--
urllib.parse.html	104.65 KB	-rw-r--r--
urllib.request.html	208.87 KB	-rw-r--r--
urllib.robotparser.html	22.63 KB	-rw-r--r--
uu.html	18.2 KB	-rw-r--r--
uuid.html	42.88 KB	-rw-r--r--
venv.html	90.43 KB	-rw-r--r--
warnings.html	69.13 KB	-rw-r--r--
wave.html	36.12 KB	-rw-r--r--
weakref.html	73.36 KB	-rw-r--r--
webbrowser.html	33.98 KB	-rw-r--r--
windows.html	12.32 KB	-rw-r--r--
winreg.html	89.48 KB	-rw-r--r--
winsound.html	26.3 KB	-rw-r--r--
wsgiref.html	111.52 KB	-rw-r--r--
xdrlib.html	42.07 KB	-rw-r--r--
xml.dom.html	114.66 KB	-rw-r--r--
xml.dom.minidom.html	49.6 KB	-rw-r--r--
xml.dom.pulldom.html	30.06 KB	-rw-r--r--
xml.etree.elementtree.html	186.49 KB	-rw-r--r--
xml.html	22.34 KB	-rw-r--r--
xml.sax.handler.html	55.78 KB	-rw-r--r--
xml.sax.html	31.74 KB	-rw-r--r--
xml.sax.reader.html	56.23 KB	-rw-r--r--
xml.sax.utils.html	22.28 KB	-rw-r--r--
xmlrpc.client.html	79.73 KB	-rw-r--r--
xmlrpc.html	11.9 KB	-rw-r--r--
xmlrpc.server.html	63.56 KB	-rw-r--r--
zipapp.html	52.45 KB	-rw-r--r--
zipfile.html	116.59 KB	-rw-r--r--
zipimport.html	33.76 KB	-rw-r--r--
zlib.html	42.29 KB	-rw-r--r--
zoneinfo.html	57.25 KB	-rw-r--r--

Code Editor : shlex.html

<!DOCTYPE html>

<title>shlex — Simple lexical analysis &#8212; Python 3.10.12 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?2022.1" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 3.10.12 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="Graphical User Interfaces with Tk" href="tk.html" />
 <link rel="prev" title="cmd — Support for line-oriented command interpreters" href="cmd.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/library/shlex.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <label for="menuToggler" class="toggler__label">
 
 </label>
 <nav class="nav-content" role="navigation">
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Logo"/>
 </a>
 <div class="version_switcher_placeholder"></div>
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero"
 d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z" fill="#444"></path>
 </svg>
 <input type="text" name="q" aria-label="Quick search"/>
 <input type="submit" value="Go"/>
 </form>
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">shlex</code> — Simple lexical analysis</a><ul>
<li><a class="reference internal" href="#shlex-objects">shlex Objects</a></li>
<li><a class="reference internal" href="#parsing-rules">Parsing Rules</a></li>
<li><a class="reference internal" href="#improved-compatibility-with-shells">Improved Compatibility with Shells</a></li>
</ul>
</li>
</ul>

<div class="related" role="navigation" aria-label="related navigation">
 <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="Graphical User Interfaces with Tk"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="cmd.html" title="cmd — Support for line-oriented command interpreters"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.10.12 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="frameworks.html" accesskey="U">Program Frameworks</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">shlex</code> — Simple lexical analysis</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-shlex">
<h1><a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><code class="xref py py-mod docutils literal notranslate">shlex</code></a> — Simple lexical analysis<a class="headerlink" href="#module-shlex" title="Permalink to this headline">¶</a></h1>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.10/Lib/shlex.py">Lib/shlex.py</a>
<hr class="docutils" />
The <a class="reference internal" href="#shlex.shlex" title="shlex.shlex"><code class="xref py py-class docutils literal notranslate">shlex</code></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.
The <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><code class="xref py py-mod docutils literal notranslate">shlex</code></a> module defines the following functions:
<dl class="py function">
<dt class="sig sig-object py" id="shlex.split">
shlex.split(s, comments=False, posix=True)<a class="headerlink" href="#shlex.split" title="Permalink to this definition">¶</a></dt>
<dd>Split the string s using shell-like syntax. If comments is <a class="reference internal" href="constants.html#False" title="False"><code class="xref py py-const docutils literal notranslate">False</code></a>
(the default), the parsing of comments in the given string will be disabled
(setting the <a class="reference internal" href="#shlex.shlex.commenters" title="shlex.shlex.commenters"><code class="xref py py-attr docutils literal notranslate">commenters</code></a> attribute of the
<a class="reference internal" href="#shlex.shlex" title="shlex.shlex"><code class="xref py py-class docutils literal notranslate">shlex</code></a> instance to the empty string). This function operates
in POSIX mode by default, but uses non-POSIX mode if the posix argument is
false.
<div class="admonition note">
Note
Since the <a class="reference internal" href="#shlex.split" title="shlex.split"><code class="xref py py-func docutils literal notranslate">split()</code></a> function instantiates a <a class="reference internal" href="#shlex.shlex" title="shlex.shlex"><code class="xref py py-class docutils literal notranslate">shlex</code></a>
instance, passing <code class="docutils literal notranslate">None</code> for s will read the string to split from
standard input.
</div>
<div class="deprecated">
Deprecated since version 3.9: Passing <code class="docutils literal notranslate">None</code> for s will raise an exception in future Python
versions.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shlex.join">
shlex.join(split_command)<a class="headerlink" href="#shlex.join" title="Permalink to this definition">¶</a></dt>
<dd>Concatenate the tokens of the list split_command and return a string.
This function is the inverse of <a class="reference internal" href="#shlex.split" title="shlex.split"><code class="xref py py-func docutils literal notranslate">split()</code></a>.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from shlex import join
&gt;&gt;&gt; print(join([&#39;echo&#39;, &#39;-n&#39;, &#39;Multiple words&#39;]))
echo -n &#39;Multiple words&#39;
</pre></div>
</div>
The returned value is shell-escaped to protect against injection
vulnerabilities (see <a class="reference internal" href="#shlex.quote" title="shlex.quote"><code class="xref py py-func docutils literal notranslate">quote()</code></a>).
<div class="versionadded">
New in version 3.8.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shlex.quote">
shlex.quote(s)<a class="headerlink" href="#shlex.quote" title="Permalink to this definition">¶</a></dt>
<dd>Return a shell-escaped version of the string s. The returned value is a
string that can safely be used as one token in a shell command line, for
cases where you cannot use a list.
<div class="admonition warning" id="shlex-quote-warning">
Warning
The <code class="docutils literal notranslate">shlex</code> module is only designed for Unix shells.
The <a class="reference internal" href="#shlex.quote" title="shlex.quote"><code class="xref py py-func docutils literal notranslate">quote()</code></a> function is not guaranteed to be correct on non-POSIX
compliant shells or shells from other operating systems such as Windows.
Executing commands quoted by this module on such shells can open up the
possibility of a command injection vulnerability.
Consider using functions that pass command arguments with lists such as
<a class="reference internal" href="subprocess.html#subprocess.run" title="subprocess.run"><code class="xref py py-func docutils literal notranslate">subprocess.run()</code></a> with <code class="docutils literal notranslate">shell=False</code>.
</div>
This idiom would be unsafe:
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; filename = &#39;somefile; rm -rf ~&#39;
&gt;&gt;&gt; command = &#39;ls -l {}&#39;.format(filename)
&gt;&gt;&gt; print(command) # executed by a shell: boom!
ls -l somefile; rm -rf ~
</pre></div>
</div>
<a class="reference internal" href="#shlex.quote" title="shlex.quote"><code class="xref py py-func docutils literal notranslate">quote()</code></a> lets you plug the security hole:
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from shlex import quote
&gt;&gt;&gt; command = &#39;ls -l {}&#39;.format(quote(filename))
&gt;&gt;&gt; print(command)
ls -l &#39;somefile; rm -rf ~&#39;
&gt;&gt;&gt; remote_command = &#39;ssh home {}&#39;.format(quote(command))
&gt;&gt;&gt; print(remote_command)
ssh home &#39;ls -l &#39;&quot;&#39;&quot;&#39;somefile; rm -rf ~&#39;&quot;&#39;&quot;&#39;&#39;
</pre></div>
</div>
The quoting is compatible with UNIX shells and with <a class="reference internal" href="#shlex.split" title="shlex.split"><code class="xref py py-func docutils literal notranslate">split()</code></a>:
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from shlex import split
&gt;&gt;&gt; remote_command = split(remote_command)
&gt;&gt;&gt; remote_command
[&#39;ssh&#39;, &#39;home&#39;, &quot;ls -l &#39;somefile; rm -rf ~&#39;&quot;]
&gt;&gt;&gt; command = split(remote_command[-1])
&gt;&gt;&gt; command
[&#39;ls&#39;, &#39;-l&#39;, &#39;somefile; rm -rf ~&#39;]
</pre></div>
</div>
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

The <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><code class="xref py py-mod docutils literal notranslate">shlex</code></a> module defines the following class:
<dl class="py class">
<dt class="sig sig-object py" id="shlex.shlex">
class shlex.shlex(instream=None, infile=None, posix=False, punctuation_chars=False)<a class="headerlink" href="#shlex.shlex" title="Permalink to this definition">¶</a></dt>
<dd>A <a class="reference internal" href="#shlex.shlex" title="shlex.shlex"><code class="xref py py-class docutils literal notranslate">shlex</code></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
<a class="reference internal" href="io.html#io.TextIOBase.read" title="io.TextIOBase.read"><code class="xref py py-meth docutils literal notranslate">read()</code></a> and <a class="reference internal" href="io.html#io.TextIOBase.readline" title="io.TextIOBase.readline"><code class="xref py py-meth docutils literal notranslate">readline()</code></a> methods, or
a string. If no argument is given, input will be taken from <code class="docutils literal notranslate">sys.stdin</code>.
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"><code class="xref py py-attr docutils literal notranslate">infile</code></a> attribute. If the instream
argument is omitted or equal to <code class="docutils literal notranslate">sys.stdin</code>, this second argument
defaults to “stdin”. The posix argument defines the operational mode:
when posix is not true (default), the <a class="reference internal" href="#shlex.shlex" title="shlex.shlex"><code class="xref py py-class docutils literal notranslate">shlex</code></a> instance will
operate in compatibility mode. When operating in POSIX mode,
<a class="reference internal" href="#shlex.shlex" title="shlex.shlex"><code class="xref py py-class docutils literal notranslate">shlex</code></a> will try to be as close as possible to the POSIX shell
parsing rules. The punctuation_chars argument provides a way to make the
behaviour even closer to how real shells parse. This can take a number of
values: the default value, <code class="docutils literal notranslate">False</code>, preserves the behaviour seen under
Python 3.5 and earlier. If set to <code class="docutils literal notranslate">True</code>, then parsing of the characters
<code class="docutils literal notranslate">();&lt;&gt;|&amp;</code> is changed: any run of these characters (considered punctuation
characters) is returned as a single token. If set to a non-empty string of
characters, those characters will be used as the punctuation characters. Any
characters in the <a class="reference internal" href="#shlex.shlex.wordchars" title="shlex.shlex.wordchars"><code class="xref py py-attr docutils literal notranslate">wordchars</code></a> attribute that appear in
punctuation_chars will be removed from <a class="reference internal" href="#shlex.shlex.wordchars" title="shlex.shlex.wordchars"><code class="xref py py-attr docutils literal notranslate">wordchars</code></a>. See
<a class="reference internal" href="#improved-shell-compatibility">Improved Compatibility with Shells</a> for more information. punctuation_chars
can be set only upon <a class="reference internal" href="#shlex.shlex" title="shlex.shlex"><code class="xref py py-class docutils literal notranslate">shlex</code></a> instance creation and can’t be
modified later.
<div class="versionchanged">
Changed in version 3.6: The punctuation_chars parameter was added.
</div>
</dd></dl>

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

<dl class="py method">
<dt class="sig sig-object py" id="shlex.shlex.push_token">
shlex.push_token(str)<a class="headerlink" href="#shlex.shlex.push_token" title="Permalink to this definition">¶</a></dt>
<dd>Push the argument onto the token stack.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="shlex.shlex.read_token">
shlex.read_token()<a class="headerlink" href="#shlex.shlex.read_token" title="Permalink to this definition">¶</a></dt>
<dd>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.)
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="shlex.shlex.sourcehook">
shlex.sourcehook(filename)<a class="headerlink" href="#shlex.shlex.sourcehook" title="Permalink to this definition">¶</a></dt>
<dd>When <a class="reference internal" href="#shlex.shlex" title="shlex.shlex"><code class="xref py py-class docutils literal notranslate">shlex</code></a> detects a source request (see <a class="reference internal" href="#shlex.shlex.source" title="shlex.shlex.source"><code class="xref py py-attr docutils literal notranslate">source</code></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.
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 <code class="docutils literal notranslate">sys.stdin</code>), 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 <code class="docutils literal notranslate">#include
&quot;file.h&quot;</code>).
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"><code class="xref py py-func docutils literal notranslate">open()</code></a> 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
<a class="reference internal" href="io.html#io.IOBase.close" title="io.IOBase.close"><code class="xref py py-meth docutils literal notranslate">close()</code></a> method of the sourced input stream when it returns
EOF.
For more explicit control of source stacking, use the <a class="reference internal" href="#shlex.shlex.push_source" title="shlex.shlex.push_source"><code class="xref py py-meth docutils literal notranslate">push_source()</code></a> and
<a class="reference internal" href="#shlex.shlex.pop_source" title="shlex.shlex.pop_source"><code class="xref py py-meth docutils literal notranslate">pop_source()</code></a> methods.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="shlex.shlex.push_source">
shlex.push_source(newstream, newfile=None)<a class="headerlink" href="#shlex.shlex.push_source" title="Permalink to this definition">¶</a></dt>
<dd>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"><code class="xref py py-meth docutils literal notranslate">sourcehook()</code></a> method.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="shlex.shlex.pop_source">
shlex.pop_source()<a class="headerlink" href="#shlex.shlex.pop_source" title="Permalink to this definition">¶</a></dt>
<dd>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.
</dd></dl>

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

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

<dl class="py attribute">
<dt class="sig sig-object py" id="shlex.shlex.wordchars">
shlex.wordchars<a class="headerlink" href="#shlex.shlex.wordchars" title="Permalink to this definition">¶</a></dt>
<dd>The string of characters that will accumulate into multi-character tokens. By
default, includes all ASCII alphanumerics and underscore. In POSIX mode, the
accented characters in the Latin-1 set are also included. If
<a class="reference internal" href="#shlex.shlex.punctuation_chars" title="shlex.shlex.punctuation_chars"><code class="xref py py-attr docutils literal notranslate">punctuation_chars</code></a> is not empty, the characters <code class="docutils literal notranslate">~-./*?=</code>, which can
appear in filename specifications and command line parameters, will also be
included in this attribute, and any characters which appear in
<code class="docutils literal notranslate">punctuation_chars</code> will be removed from <code class="docutils literal notranslate">wordchars</code> if they are present
there. If <a class="reference internal" href="#shlex.shlex.whitespace_split" title="shlex.shlex.whitespace_split"><code class="xref py py-attr docutils literal notranslate">whitespace_split</code></a> is set to <code class="docutils literal notranslate">True</code>, this will have no
effect.
</dd></dl>

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

<dl class="py attribute">
<dt class="sig sig-object py" id="shlex.shlex.escape">
shlex.escape<a class="headerlink" href="#shlex.shlex.escape" title="Permalink to this definition">¶</a></dt>
<dd>Characters that will be considered as escape. This will be only used in POSIX
mode, and includes just <code class="docutils literal notranslate">'\'</code> by default.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="shlex.shlex.quotes">
shlex.quotes<a class="headerlink" href="#shlex.shlex.quotes" title="Permalink to this definition">¶</a></dt>
<dd>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.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="shlex.shlex.escapedquotes">
shlex.escapedquotes<a class="headerlink" href="#shlex.shlex.escapedquotes" title="Permalink to this definition">¶</a></dt>
<dd>Characters in <a class="reference internal" href="#shlex.shlex.quotes" title="shlex.shlex.quotes"><code class="xref py py-attr docutils literal notranslate">quotes</code></a> that will interpret escape characters defined in
<a class="reference internal" href="#shlex.shlex.escape" title="shlex.shlex.escape"><code class="xref py py-attr docutils literal notranslate">escape</code></a>. This is only used in POSIX mode, and includes just <code class="docutils literal notranslate">'&quot;'</code> by
default.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="shlex.shlex.whitespace_split">
shlex.whitespace_split<a class="headerlink" href="#shlex.shlex.whitespace_split" title="Permalink to this definition">¶</a></dt>
<dd>If <code class="docutils literal notranslate">True</code>, tokens will only be split in whitespaces. This is useful, for
example, for parsing command lines with <a class="reference internal" href="#shlex.shlex" title="shlex.shlex"><code class="xref py py-class docutils literal notranslate">shlex</code></a>, getting
tokens in a similar way to shell arguments. When used in combination with
<a class="reference internal" href="#shlex.shlex.punctuation_chars" title="shlex.shlex.punctuation_chars"><code class="xref py py-attr docutils literal notranslate">punctuation_chars</code></a>, tokens will be split on whitespace in addition to
those characters.
<div class="versionchanged">
Changed in version 3.8: The <a class="reference internal" href="#shlex.shlex.punctuation_chars" title="shlex.shlex.punctuation_chars"><code class="xref py py-attr docutils literal notranslate">punctuation_chars</code></a> attribute was made compatible with the
<a class="reference internal" href="#shlex.shlex.whitespace_split" title="shlex.shlex.whitespace_split"><code class="xref py py-attr docutils literal notranslate">whitespace_split</code></a> attribute.
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="shlex.shlex.infile">
shlex.infile<a class="headerlink" href="#shlex.shlex.infile" title="Permalink to this definition">¶</a></dt>
<dd>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.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="shlex.shlex.instream">
shlex.instream<a class="headerlink" href="#shlex.shlex.instream" title="Permalink to this definition">¶</a></dt>
<dd>The input stream from which this <a class="reference internal" href="#shlex.shlex" title="shlex.shlex"><code class="xref py py-class docutils literal notranslate">shlex</code></a> instance is reading
characters.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="shlex.shlex.source">
shlex.source<a class="headerlink" href="#shlex.shlex.source" title="Permalink to this definition">¶</a></dt>
<dd>This attribute is <code class="docutils literal notranslate">None</code> by default. If you assign a string to it, that
string will be recognized as a lexical-level inclusion request similar to the
<code class="docutils literal notranslate">source</code> 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 <a class="reference internal" href="io.html#io.IOBase.close" title="io.IOBase.close"><code class="xref py py-meth docutils literal notranslate">close()</code></a> 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.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="shlex.shlex.debug">
shlex.debug<a class="headerlink" href="#shlex.shlex.debug" title="Permalink to this definition">¶</a></dt>
<dd>If this attribute is numeric and <code class="docutils literal notranslate">1</code> or more, a <a class="reference internal" href="#shlex.shlex" title="shlex.shlex"><code class="xref py py-class docutils literal notranslate">shlex</code></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.
</dd></dl>

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

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

<dl class="py attribute">
<dt class="sig sig-object py" id="shlex.shlex.eof">
shlex.eof<a class="headerlink" href="#shlex.shlex.eof" title="Permalink to this definition">¶</a></dt>
<dd>Token used to determine end of file. This will be set to the empty string
(<code class="docutils literal notranslate">''</code>), in non-POSIX mode, and to <code class="docutils literal notranslate">None</code> in POSIX mode.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="shlex.shlex.punctuation_chars">
shlex.punctuation_chars<a class="headerlink" href="#shlex.shlex.punctuation_chars" title="Permalink to this definition">¶</a></dt>
<dd>A read-only property. Characters that will be considered punctuation. Runs of
punctuation characters will be returned as a single token. However, note that no
semantic validity checking will be performed: for example, ‘&gt;&gt;&gt;’ could be
returned as a token, even though it may not be recognised as such by shells.
<div class="versionadded">
New in version 3.6.
</div>
</dd></dl>

</section>
<section id="parsing-rules">
<h2>Parsing Rules<a class="headerlink" href="#parsing-rules" title="Permalink to this headline">¶</a></h2>
When operating in non-POSIX mode, <a class="reference internal" href="#shlex.shlex" title="shlex.shlex"><code class="xref py py-class docutils literal notranslate">shlex</code></a> will try to obey to the
following rules.
<ul class="simple">
<li>Quote characters are not recognized within words (<code class="docutils literal notranslate">Do&quot;Not&quot;Separate</code> is
parsed as the single word <code class="docutils literal notranslate">Do&quot;Not&quot;Separate</code>);</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 (<code class="docutils literal notranslate">&quot;Do&quot;Separate</code> is parsed as <code class="docutils literal notranslate">&quot;Do&quot;</code> and
<code class="docutils literal notranslate">Separate</code>);</li>
<li>If <a class="reference internal" href="#shlex.shlex.whitespace_split" title="shlex.shlex.whitespace_split"><code class="xref py py-attr docutils literal notranslate">whitespace_split</code></a> is <code class="docutils literal notranslate">False</code>, any character not
declared to be a word character, whitespace, or a quote will be returned as
a single-character token. If it is <code class="docutils literal notranslate">True</code>, <a class="reference internal" href="#shlex.shlex" title="shlex.shlex"><code class="xref py py-class docutils literal notranslate">shlex</code></a> will only
split words in whitespaces;</li>
<li>EOF is signaled with an empty string (<code class="docutils literal notranslate">''</code>);</li>
<li>It’s not possible to parse empty strings, even if quoted.</li>
</ul>
When operating in POSIX mode, <a class="reference internal" href="#shlex.shlex" title="shlex.shlex"><code class="xref py py-class docutils literal notranslate">shlex</code></a> will try to obey to the
following parsing rules.
<ul class="simple">
<li>Quotes are stripped out, and do not separate words (<code class="docutils literal notranslate">&quot;Do&quot;Not&quot;Separate&quot;</code> is
parsed as the single word <code class="docutils literal notranslate">DoNotSeparate</code>);</li>
<li>Non-quoted escape characters (e.g. <code class="docutils literal notranslate">'\'</code>) preserve the literal value of the
next character that follows;</li>
<li>Enclosing characters in quotes which are not part of
<a class="reference internal" href="#shlex.shlex.escapedquotes" title="shlex.shlex.escapedquotes"><code class="xref py py-attr docutils literal notranslate">escapedquotes</code></a> (e.g. <code class="docutils literal notranslate">&quot;'&quot;</code>) preserve the literal value
of all characters within the quotes;</li>
<li>Enclosing characters in quotes which are part of
<a class="reference internal" href="#shlex.shlex.escapedquotes" title="shlex.shlex.escapedquotes"><code class="xref py py-attr docutils literal notranslate">escapedquotes</code></a> (e.g. <code class="docutils literal notranslate">'&quot;'</code>) preserves the literal value
of all characters within the quotes, with the exception of the characters
mentioned in <a class="reference internal" href="#shlex.shlex.escape" title="shlex.shlex.escape"><code class="xref py py-attr docutils literal notranslate">escape</code></a>. 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"><code class="xref py py-const docutils literal notranslate">None</code></a> value;</li>
<li>Quoted empty strings (<code class="docutils literal notranslate">''</code>) are allowed.</li>
</ul>
</section>
<section id="improved-compatibility-with-shells">
<h2>Improved Compatibility with Shells<a class="headerlink" href="#improved-compatibility-with-shells" title="Permalink to this headline">¶</a></h2>
<div class="versionadded">
New in version 3.6.
</div>
The <a class="reference internal" href="#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><code class="xref py py-class docutils literal notranslate">shlex</code></a> class provides compatibility with the parsing performed by
common Unix shells like <code class="docutils literal notranslate">bash</code>, <code class="docutils literal notranslate">dash</code>, and <code class="docutils literal notranslate">sh</code>. To take advantage of
this compatibility, specify the <code class="docutils literal notranslate">punctuation_chars</code> argument in the
constructor. This defaults to <code class="docutils literal notranslate">False</code>, which preserves pre-3.6 behaviour.
However, if it is set to <code class="docutils literal notranslate">True</code>, then parsing of the characters <code class="docutils literal notranslate">();&lt;&gt;|&amp;</code>
is changed: any run of these characters is returned as a single token. While
this is short of a full parser for shells (which would be out of scope for the
standard library, given the multiplicity of shells out there), it does allow
you to perform processing of command lines more easily than you could
otherwise. To illustrate, you can see the difference in the following snippet:
<div class="highlight-pycon3 notranslate"><div class="highlight"><pre> &gt;&gt;&gt; import shlex
 &gt;&gt;&gt; text = &quot;a &amp;&amp; b; c &amp;&amp; d || e; f &gt;&#39;abc&#39;; (def \&quot;ghi\&quot;)&quot;
 &gt;&gt;&gt; s = shlex.shlex(text, posix=True)
 &gt;&gt;&gt; s.whitespace_split = True
 &gt;&gt;&gt; list(s)
 [&#39;a&#39;, &#39;&amp;&amp;&#39;, &#39;b;&#39;, &#39;c&#39;, &#39;&amp;&amp;&#39;, &#39;d&#39;, &#39;||&#39;, &#39;e;&#39;, &#39;f&#39;, &#39;&gt;abc;&#39;, &#39;(def&#39;, &#39;ghi)&#39;]
 &gt;&gt;&gt; s = shlex.shlex(text, posix=True, punctuation_chars=True)
 &gt;&gt;&gt; s.whitespace_split = True
 &gt;&gt;&gt; list(s)
 [&#39;a&#39;, &#39;&amp;&amp;&#39;, &#39;b&#39;, &#39;;&#39;, &#39;c&#39;, &#39;&amp;&amp;&#39;, &#39;d&#39;, &#39;||&#39;, &#39;e&#39;, &#39;;&#39;, &#39;f&#39;, &#39;&gt;&#39;, &#39;abc&#39;, &#39;;&#39;,
 &#39;(&#39;, &#39;def&#39;, &#39;ghi&#39;, &#39;)&#39;]
</pre></div>
</div>
Of course, tokens will be returned which are not valid for shells, and you’ll
need to implement your own error checks on the returned tokens.
Instead of passing <code class="docutils literal notranslate">True</code> as the value for the punctuation_chars parameter,
you can pass a string with specific characters, which will be used to determine
which characters constitute punctuation. For example:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; import shlex
&gt;&gt;&gt; s = shlex.shlex(&quot;a &amp;&amp; b || c&quot;, punctuation_chars=&quot;|&quot;)
&gt;&gt;&gt; list(s)
[&#39;a&#39;, &#39;&amp;&#39;, &#39;&amp;&#39;, &#39;b&#39;, &#39;||&#39;, &#39;c&#39;]
</pre></div>
</div>
<div class="admonition note">
Note
When <code class="docutils literal notranslate">punctuation_chars</code> is specified, the <a class="reference internal" href="#shlex.shlex.wordchars" title="shlex.shlex.wordchars"><code class="xref py py-attr docutils literal notranslate">wordchars</code></a>
attribute is augmented with the characters <code class="docutils literal notranslate">~-./*?=</code>. That is because these
characters can appear in file names (including wildcards) and command-line
arguments (e.g. <code class="docutils literal notranslate">--color=auto</code>). Hence:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; import shlex
&gt;&gt;&gt; s = shlex.shlex(&#39;~/a &amp;&amp; b-c --color=auto || d *.py?&#39;,
... punctuation_chars=True)
&gt;&gt;&gt; list(s)
[&#39;~/a&#39;, &#39;&amp;&amp;&#39;, &#39;b-c&#39;, &#39;--color=auto&#39;, &#39;||&#39;, &#39;d&#39;, &#39;*.py?&#39;]
</pre></div>
</div>
However, to match the shell as closely as possible, it is recommended to
always use <code class="docutils literal notranslate">posix</code> and <a class="reference internal" href="#shlex.shlex.whitespace_split" title="shlex.shlex.whitespace_split"><code class="xref py py-attr docutils literal notranslate">whitespace_split</code></a> when using
<a class="reference internal" href="#shlex.shlex.punctuation_chars" title="shlex.shlex.punctuation_chars"><code class="xref py py-attr docutils literal notranslate">punctuation_chars</code></a>, which will negate
<a class="reference internal" href="#shlex.shlex.wordchars" title="shlex.shlex.wordchars"><code class="xref py py-attr docutils literal notranslate">wordchars</code></a> entirely.
</div>
For best effect, <code class="docutils literal notranslate">punctuation_chars</code> should be set in conjunction with
<code class="docutils literal notranslate">posix=True</code>. (Note that <code class="docutils literal notranslate">posix=False</code> is the default for
<a class="reference internal" href="#shlex.shlex" title="shlex.shlex"><code class="xref py py-class docutils literal notranslate">shlex</code></a>.)
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">shlex</code> — Simple lexical analysis</a><ul>
<li><a class="reference internal" href="#shlex-objects">shlex Objects</a></li>
<li><a class="reference internal" href="#parsing-rules">Parsing Rules</a></li>
<li><a class="reference internal" href="#improved-compatibility-with-shells">Improved Compatibility with Shells</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="cmd.html"
 title="previous chapter"><code class="xref py py-mod docutils literal notranslate">cmd</code> — Support for line-oriented command interpreters</a>
 <h4>Next topic</h4>
 <a href="tk.html"
 title="next chapter">Graphical User Interfaces with Tk</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/library/shlex.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <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="Graphical User Interfaces with Tk"
 >next</a> |</li>
 <li class="right" >
 <a href="cmd.html" title="cmd — Support for line-oriented command interpreters"
 >previous</a> |</li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="frameworks.html" >Program Frameworks</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">shlex</code> — Simple lexical analysis</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" 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>
 </div>
 |
 </li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 2001-2026, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>

Last updated on January 26, 2026.
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : shlex.html