Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions Doc/library/shlex.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,9 @@ The :mod:`shlex` module defines the following class:
characters, those characters will be used as the punctuation characters. Any
characters in the :attr:`wordchars` attribute that appear in
*punctuation_chars* will be removed from :attr:`wordchars`. See
:ref:`improved-shell-compatibility` for more information.
:ref:`improved-shell-compatibility` for more information. *punctuation_chars*
can be set only upon :class:`~shlex.shlex` instance creation and can't be
modified later.

.. versionchanged:: 3.6
The *punctuation_chars* parameter was added.
Expand Down Expand Up @@ -317,8 +319,8 @@ variables which either control lexical analysis or can be used for debugging:

.. attribute:: shlex.punctuation_chars

Characters that will be considered punctuation. Runs of punctuation
characters will be returned as a single token. However, note that no
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, '>>>' could be
returned as a token, even though it may not be recognised as such by shells.

Expand Down
6 changes: 5 additions & 1 deletion Lib/shlex.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ def __init__(self, instream=None, infile=None, posix=False,
punctuation_chars = ''
elif punctuation_chars is True:
punctuation_chars = '();<>|&'
self.punctuation_chars = 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()
Expand All @@ -65,6 +65,10 @@ def __init__(self, instream=None, infile=None, posix=False,
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:
Expand Down
7 changes: 7 additions & 0 deletions Lib/test/test_shlex.py
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,13 @@ def testJoinRoundtrip(self):
resplit = shlex.split(joined)
self.assertEqual(split_command, resplit)

def testPunctuationCharsReadOnly(self):
punctuation_chars = "/|$%^"
shlex_instance = shlex.shlex(punctuation_chars=punctuation_chars)
self.assertEqual(shlex_instance.punctuation_chars, punctuation_chars)
with self.assertRaises(AttributeError):
shlex_instance.punctuation_chars = False


# Allow this test to be used with old shlex.py
if not getattr(shlex, "split", None):
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
:attr:`shlex.shlex.punctuation_chars` is now a read-only property.