Bamboo Panda

✏️ Editing: shlex.py

"""A lexical analyzer class for simple shell-like syntaxes."""

# Module and documentation by Eric S. Raymond, 21 Dec 1998
# Input stacking and error message cleanup added by ESR, March 2000
# push_source() and pop_source() made explicit by ESR, January 2001.
# Posix compliance, split(), string arguments, and
# iterator interface by Gustavo Niemeyer, April 2003.
# changes to tokenize more like Posix shells by Vinay Sajip, July 2016.

import os
import re
import sys
from collections import deque

from io import StringIO

__all__ = ["shlex", "split", "quote", "join"]

class shlex:
    "A lexical analyzer class for simple shell-like syntaxes."
    def __init__(self, instream=None, infile=None, posix=False,
                 punctuation_chars=False):
        if isinstance(instream, str):
            instream = StringIO(instream)
        if instream is not None:
            self.instream = instream
            self.infile = infile
        else:
            self.instream = sys.stdin
            self.infile = None
        self.posix = posix
        if posix:
            self.eof = None
        else:
            self.eof = ''
        self.commenters = '#'
        self.wordchars = ('abcdfeghijklmnopqrstuvwxyz'
                          'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_')
        if self.posix:
            self.wordchars += ('ßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýþÿ'
                               'ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝÞ')
        self.whitespace = ' \t\r\n'
        self.whitespace_split = False
        self.quotes = '\'"'
        self.escape = '\\'
        self.escapedquotes = '"'
        self.state = ' '
        self.pushback = deque()
        self.lineno = 1
        self.debug = 0
        self.token = ''
        self.filestack = deque()
        self.source = None
        if not punctuation_chars:
            punctuation_chars = ''
        elif punctuation_chars is True:
            punctuation_chars = '();<>|&'
        self._punctuation_chars = punctuation_chars
        if punctuation_chars:
            # _pushback_chars is a push back queue used by lookahead logic
            self._pushback_chars = deque()
            # these chars added because allowed in file names, args, wildcards
            self.wordchars += '~-./*?='
            #remove any punctuation chars from wordchars
            t = self.wordchars.maketrans(dict.fromkeys(punctuation_chars))
            self.wordchars = self.wordchars.translate(t)

@property
    def punctuation_chars(self):
        return self._punctuation_chars

def push_token(self, tok):
        "Push a token onto the stack popped by the get_token method"
        if self.debug >= 1:
            print("shlex: pushing token " + repr(tok))
        self.pushback.appendleft(tok)

def push_source(self, newstream, newfile=None):
        "Push an input source onto the lexer's input source stack."
        if isinstance(newstream, str):
            newstream = StringIO(newstream)
        self.filestack.appendleft((self.infile, self.instream, self.lineno))
        self.infile = newfile
        self.instream = newstream
        self.lineno = 1
        if self.debug:
            if newfile is not None:
                print('shlex: pushing to file %s' % (self.infile,))
            else:
                print('shlex: pushing to stream %s' % (self.instream,))

def pop_source(self):
        "Pop the input source stack."
        self.instream.close()
        (self.infile, self.instream, self.lineno) = self.filestack.popleft()
        if self.debug:
            print('shlex: popping to %s, line %d' \
                  % (self.instream, self.lineno))
        self.state = ' '

def get_token(self):
        "Get a token from the input stream (or from stack if it's nonempty)"
        if self.pushback:
            tok = self.pushback.popleft()
            if self.debug >= 1:
                print("shlex: popping token " + repr(tok))
            return tok
        # No pushback.  Get a token.
        raw = self.read_token()
        # Handle inclusions
        if self.source is not None:
            while raw == self.source:
                spec = self.sourcehook(self.read_token())
                if spec:
                    (newfile, newstream) = spec
                    self.push_source(newstream, newfile)
                raw = self.get_token()
        # Maybe we got EOF instead?
        while raw == self.eof:
            if not self.filestack:
                return self.eof
            else:
                self.pop_source()
                raw = self.get_token()
        # Neither inclusion nor EOF
        if self.debug >= 1:
            if raw != self.eof:
                print("shlex: token=" + repr(raw))
            else:
                print("shlex: token=EOF")
        return raw

def read_token(self):
        quoted = False
        escapedstate = ' '
        while True:
            if self.punctuation_chars and self._pushback_chars:
                nextchar = self._pushback_chars.pop()
            else:
                nextchar = self.instream.read(1)
            if nextchar == '\n':
                self.lineno += 1
            if self.debug >= 3:
                print("shlex: in state %r I see character: %r" % (self.state,
                                                                  nextchar))
            if self.state is None:
                self.token = ''        # past end of file
                break
            elif self.state == ' ':
                if not nextchar:
                    self.state = None  # end of file
                    break
                elif nextchar in self.whitespace:
                    if self.debug >= 2:
                        print("shlex: I see whitespace in whitespace state")
                    if self.token or (self.posix and quoted):
                        break   # emit current token
                    else:
                        continue
                elif nextchar in self.commenters:
                    self.instream.readline()
                    self.lineno += 1
                elif self.posix and nextchar in self.escape:
                    escapedstate = 'a'
                    self.state = nextchar
                elif nextchar in self.wordchars:
                    self.token = nextchar
                    self.state = 'a'
                elif nextchar in self.punctuation_chars:
                    self.token = nextchar
                    self.state = 'c'
                elif nextchar in self.quotes:
                    if not self.posix:
                        self.token = nextchar
                    self.state = nextchar
                elif self.whitespace_split:
                    self.token = nextchar
                    self.state = 'a'
                else:
                    self.token = nextchar
                    if self.token or (self.posix and quoted):
                        break   # emit current token
                    else:
                        continue
            elif self.state in self.quotes:
                quoted = True
                if not nextchar:      # end of file
                    if self.debug >= 2:
                        print("shlex: I see EOF in quotes state")
                    # XXX what error should be raised here?
                    raise ValueError("No closing quotation")
                if nextchar == self.state:
                    if not self.posix:
                        self.token += nextchar
                        self.state = ' '
                        break
                    else:
                        self.state = 'a'
                elif (self.posix and nextchar in self.escape and self.state
                      in self.escapedquotes):
                    escapedstate = self.state
                    self.state = nextchar
                else:
                    self.token += nextchar
            elif self.state in self.escape:
                if not nextchar:      # end of file
                    if self.debug >= 2:
                        print("shlex: I see EOF in escape state")
                    # XXX what error should be raised here?
                    raise ValueError("No escaped character")
                # In posix shells, only the quote itself or the escape
                # character may be escaped within quotes.
                if (escapedstate in self.quotes and
                        nextchar != self.state and nextchar != escapedstate):
                    self.token += self.state
                self.token += nextchar
                self.state = escapedstate
            elif self.state in ('a', 'c'):
                if not nextchar:
                    self.state = None   # end of file
                    break
                elif nextchar in self.whitespace:
                    if self.debug >= 2:
                        print("shlex: I see whitespace in word state")
                    self.state = ' '
                    if self.token or (self.posix and quoted):
                        break   # emit current token
                    else:
                        continue
                elif nextchar in self.commenters:
                    self.instream.readline()
                    self.lineno += 1
                    if self.posix:
                        self.state = ' '
                        if self.token or (self.posix and quoted):
                            break   # emit current token
                        else:
                            continue
                elif self.state == 'c':
                    if nextchar in self.punctuation_chars:
                        self.token += nextchar
                    else:
                        if nextchar not in self.whitespace:
                            self._pushback_chars.append(nextchar)
                        self.state = ' '
                        break
                elif self.posix and nextchar in self.quotes:
                    self.state = nextchar
                elif self.posix and nextchar in self.escape:
                    escapedstate = 'a'
                    self.state = nextchar
                elif (nextchar in self.wordchars or nextchar in self.quotes
                      or (self.whitespace_split and
                          nextchar not in self.punctuation_chars)):
                    self.token += nextchar
                else:
                    if self.punctuation_chars:
                        self._pushback_chars.append(nextchar)
                    else:
                        self.pushback.appendleft(nextchar)
                    if self.debug >= 2:
                        print("shlex: I see punctuation in word state")
                    self.state = ' '
                    if self.token or (self.posix and quoted):
                        break   # emit current token
                    else:
                        continue
        result = self.token
        self.token = ''
        if self.posix and not quoted and result == '':
            result = None
        if self.debug > 1:
            if result:
                print("shlex: raw token=" + repr(result))
            else:
                print("shlex: raw token=EOF")
        return result

def sourcehook(self, newfile):
        "Hook called on a filename to be sourced."
        if newfile[0] == '"':
            newfile = newfile[1:-1]
        # This implements cpp-like semantics for relative-path inclusion.
        if isinstance(self.infile, str) and not os.path.isabs(newfile):
            newfile = os.path.join(os.path.dirname(self.infile), newfile)
        return (newfile, open(newfile, "r"))

def error_leader(self, infile=None, lineno=None):
        "Emit a C-compiler-like, Emacs-friendly error-message leader."
        if infile is None:
            infile = self.infile
        if lineno is None:
            lineno = self.lineno
        return "\"%s\", line %d: " % (infile, lineno)

def __iter__(self):
        return self

def __next__(self):
        token = self.get_token()
        if token == self.eof:
            raise StopIteration
        return token

def split(s, comments=False, posix=True):
    """Split the string *s* using shell-like syntax."""
    if s is None:
        import warnings
        warnings.warn("Passing None for 's' to shlex.split() is deprecated.",
                      DeprecationWarning, stacklevel=2)
    lex = shlex(s, posix=posix)
    lex.whitespace_split = True
    if not comments:
        lex.commenters = ''
    return list(lex)

def join(split_command):
    """Return a shell-escaped string from *split_command*."""
    return ' '.join(quote(arg) for arg in split_command)

_find_unsafe = re.compile(r'[^\w@%+=:,./-]', re.ASCII).search

def quote(s):
    """Return a shell-escaped version of the string *s*."""
    if not s:
        return "''"
    if _find_unsafe(s) is None:
        return s

# use single quotes, and put single quotes into double quotes
    # the string $'b is then quoted as '$'"'"'b'
    return "'" + s.replace("'", "'\"'\"'") + "'"

def _print_tokens(lexer):
    while 1:
        tt = lexer.get_token()
        if not tt:
            break
        print("Token: " + repr(tt))

if __name__ == '__main__':
    if len(sys.argv) == 1:
        _print_tokens(shlex())
    else:
        fn = sys.argv[1]
        with open(fn) as f:
            _print_tokens(shlex(f, fn))

T	Name	Size
📁	..	-
📁	__pycache__	-
📁	asyncio	-
📁	collections	-
📁	concurrent	-
📁	config-3.9-x86_64-linux-gnu	-
📁	ctypes	-
📁	curses	-
📁	dbm	-
📁	distutils	-
📁	email	-
📁	encodings	-
📁	ensurepip	-
📁	html	-
📁	http	-
📁	importlib	-
📁	json	-
📁	lib-dynload	-
📁	lib2to3	-
📁	logging	-
📁	multiprocessing	-
📁	pydoc_data	-
📁	site-packages	-
📁	sqlite3	-
📁	unittest	-
📁	urllib	-
📁	venv	-
📁	wsgiref	-
📁	xml	-
📁	xmlrpc	-
📁	zoneinfo	-
📄	LICENSE.txt	13.61 KB
📄	__future__.py	5.03 KB
📄	__phello__.foo.py	64.00 B
📄	_aix_support.py	3.31 KB
📄	_bootlocale.py	1.76 KB
📄	_bootsubprocess.py	2.61 KB
📄	_collections_abc.py	28.69 KB
📄	_compat_pickle.py	8.54 KB
📄	_compression.py	5.21 KB
📄	_markupbase.py	14.28 KB
📄	_osx_support.py	21.26 KB
📄	_py_abc.py	6.04 KB
📄	_pydecimal.py	223.31 KB
📄	_pyio.py	91.13 KB
📄	_sitebuiltins.py	3.04 KB
📄	_strptime.py	24.68 KB
📄	_sysconfigdata__linux_x86_64-linux-gnu.py	40.27 KB
📄	_threading_local.py	7.05 KB
📄	_weakrefset.py	5.78 KB
📄	abc.py	4.80 KB
📄	aifc.py	31.84 KB
📄	antigravity.py	500.00 B
📄	argparse.py	95.82 KB
📄	ast.py	54.94 KB
📄	asynchat.py	11.06 KB
📄	asyncore.py	19.63 KB
📄	base64.py	19.39 KB
📄	bdb.py	30.65 KB
📄	binhex.py	14.44 KB
📄	bisect.py	2.29 KB
📄	bz2.py	12.16 KB
📄	cProfile.py	6.20 KB
📄	calendar.py	24.25 KB
📄	cgi.py	33.14 KB
📄	cgitb.py	11.81 KB
📄	chunk.py	5.31 KB
📄	cmd.py	14.51 KB
📄	code.py	10.37 KB
📄	codecs.py	35.81 KB
📄	codeop.py	6.18 KB
📄	colorsys.py	3.97 KB
📄	compileall.py	19.63 KB
📄	configparser.py	53.30 KB
📄	contextlib.py	24.05 KB
📄	contextvars.py	129.00 B
📄	copy.py	8.45 KB
📄	copyreg.py	7.10 KB
📄	crypt.py	3.73 KB
📄	csv.py	15.77 KB
📄	dataclasses.py	48.42 KB
📄	datetime.py	87.09 KB
📄	decimal.py	320.00 B
📄	difflib.py	81.35 KB
📄	dis.py	20.09 KB
📄	doctest.py	102.12 KB
📄	enum.py	38.52 KB
📄	filecmp.py	9.79 KB
📄	fileinput.py	14.44 KB
📄	fnmatch.py	5.86 KB
📄	formatter.py	14.79 KB
📄	fractions.py	23.75 KB
📄	ftplib.py	34.66 KB
📄	functools.py	37.97 KB
📄	genericpath.py	5.12 KB
📄	getopt.py	7.31 KB
📄	getpass.py	5.85 KB
📄	gettext.py	26.63 KB
📄	glob.py	5.69 KB
📄	graphlib.py	9.35 KB
📄	gzip.py	21.26 KB
📄	hashlib.py	7.88 KB
📄	heapq.py	22.34 KB
📄	hmac.py	7.85 KB
📄	imaplib.py	54.13 KB
📄	imghdr.py	3.72 KB
📄	imp.py	10.29 KB
📄	inspect.py	115.46 KB
📄	io.py	3.46 KB
📄	ipaddress.py	79.03 KB
📄	keyword.py	1.02 KB
📄	linecache.py	5.33 KB
📄	locale.py	76.44 KB
📄	lzma.py	12.92 KB
📄	mailbox.py	76.95 KB
📄	mailcap.py	8.90 KB
📄	mimetypes.py	21.06 KB
📄	modulefinder.py	23.83 KB
📄	netrc.py	5.44 KB
📄	nntplib.py	40.06 KB
📄	ntpath.py	25.84 KB
📄	nturl2path.py	2.82 KB
📄	numbers.py	10.10 KB
📄	opcode.py	5.53 KB
📄	operator.py	10.50 KB
📄	optparse.py	58.95 KB
📄	os.py	38.15 KB
📄	pathlib.py	49.94 KB
📄	pdb.py	61.75 KB
📄	pickle.py	63.40 KB
📄	pickletools.py	91.29 KB
📄	pipes.py	8.71 KB
📄	pkgutil.py	23.71 KB
📄	platform.py	39.65 KB
📄	plistlib.py	27.59 KB
📄	poplib.py	14.96 KB
📄	posixpath.py	15.77 KB
📄	pprint.py	22.00 KB
📄	profile.py	22.34 KB
📄	pstats.py	28.64 KB
📄	pty.py	4.69 KB
📄	py_compile.py	8.01 KB
📄	pyclbr.py	14.90 KB
📄	pydoc.py	107.03 KB
📄	queue.py	11.23 KB
📄	quopri.py	7.10 KB
📄	random.py	30.75 KB
📄	re.py	15.49 KB
📄	reprlib.py	5.14 KB
📄	rlcompleter.py	7.47 KB
📄	runpy.py	12.78 KB
📄	sched.py	6.29 KB
📄	secrets.py	1.99 KB
📄	selectors.py	19.08 KB
📄	shelve.py	8.33 KB
📄	shlex.py	13.18 KB
📄	shutil.py	51.79 KB
📄	signal.py	2.38 KB
📄	site.py	21.57 KB
📄	smtpd.py	34.00 KB
📄	smtplib.py	44.34 KB
📄	sndhdr.py	6.93 KB
📄	socket.py	36.05 KB
📄	socketserver.py	26.66 KB
📄	sre_compile.py	27.32 KB
📄	sre_constants.py	7.01 KB
📄	sre_parse.py	39.82 KB
📄	ssl.py	51.39 KB
📄	stat.py	5.36 KB
📄	statistics.py	37.17 KB
📄	string.py	10.32 KB
📄	stringprep.py	12.61 KB
📄	struct.py	257.00 B
📄	subprocess.py	81.61 KB
📄	sunau.py	17.73 KB
📄	symbol.py	2.23 KB
📄	symtable.py	7.72 KB
📄	sysconfig.py	24.96 KB
📄	tabnanny.py	11.14 KB
📄	tarfile.py	110.43 KB
📄	telnetlib.py	22.71 KB
📄	tempfile.py	27.31 KB
📄	textwrap.py	18.95 KB
📄	this.py	1,003.00 B
📄	threading.py	52.91 KB
📄	timeit.py	13.16 KB
📄	token.py	2.31 KB
📄	tokenize.py	25.28 KB
📄	trace.py	28.52 KB
📄	traceback.py	24.08 KB
📄	tracemalloc.py	17.62 KB
📄	tty.py	879.00 B
📄	types.py	9.56 KB
📄	typing.py	75.24 KB
📄	uu.py	7.11 KB
📄	uuid.py	26.68 KB
📄	warnings.py	19.23 KB
📄	wave.py	17.58 KB
📄	weakref.py	21.05 KB
📄	webbrowser.py	24.01 KB
📄	xdrlib.py	5.77 KB
📄	zipapp.py	7.36 KB
📄	zipfile.py	86.82 KB
📄	zipimport.py	30.04 KB