- Changed shlex.split() method to have more useful and

niemeyer · niemeyer · commit 48f3dcc93e57 · 2003-04-20T01:57:03.000Z
meaningful parameters.
diff --git a/Doc/lib/libshlex.tex b/Doc/lib/libshlex.tex
@@ -25,12 +25,11 @@ \subsection{Module Contents}
 
 The \module{shlex} module defines the following functions:
 
-\begin{funcdesc}{split}{s\optional{, posix=\code{True}\optional{,
-			spaces=\code{True}}}}
-Split the string \var{s} using shell-like syntax. If \var{posix} is
-\code{True}, operate in \POSIX{} mode. If \var{spaces} is \code{True}, it
-will only split words in whitespaces (setting the
-\member{whitespace_split} member of the \class{shlex} instance).
+\begin{funcdesc}{split}{s\optional{, comments=\code{False}}}
+Split the string \var{s} using shell-like syntax. If \var{comments} is
+\code{False}, the parsing of comments in the given string will be
+disabled (setting the \member{commenters} member of the \class{shlex}
+instance to the empty string). This function operates in \POSIX{} mode.
 \versionadded{2.3}
 \end{funcdesc}
 
diff --git a/Lib/shlex.py b/Lib/shlex.py
@@ -271,9 +271,11 @@ def next(self):
             raise StopIteration
         return token
 
-def split(s, posix=True, spaces=True):
-    lex = shlex(s, posix=posix)
-    lex.whitespace_split = spaces
+def split(s, comments=False):
+    lex = shlex(s, posix=True)
+    lex.whitespace_split = True
+    if not comments:
+        lex.commenters = ''
     return list(lex)
 
 if __name__ == '__main__':
diff --git a/Lib/test/test_shlex.py b/Lib/test/test_shlex.py
@@ -151,9 +151,9 @@ def setUp(self):
         for item in self.posix_data:
             item[0] = item[0].replace(r"\n", "\n")
 
-    def splitTest(self, data, posix, spaces):
+    def splitTest(self, data, comments):
         for i in range(len(data)):
-            l = shlex.split(data[i][0], posix=posix, spaces=spaces)
+            l = shlex.split(data[i][0], comments=comments)
             self.assertEqual(l, data[i][1:],
                              "%s: %s != %s" %
                              (data[i][0], l, data[i][1:]))
@@ -167,13 +167,9 @@ def oldSplit(self, s):
             tok = lex.get_token()
         return ret
     
-    def testSplit(self):
-        """Test data splitting with non-posix parser"""
-        self.splitTest(self.data, posix=0, spaces=0) 
-
     def testSplitPosix(self):
         """Test data splitting with posix parser"""
-        self.splitTest(self.posix_data, posix=1, spaces=1) 
+        self.splitTest(self.posix_data, comments=True) 
 
     def testCompat(self):
         """Test compatibility interface"""
