FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-119670: Add `force` keyword only argument to `shlex.quote` by jb2170 · Pull Request #148846 · python/cpython · GitHub

Repository navigation

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

Filter by extension

Filter by extension .py  (2) .rst  (3) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
20 changes: 19 additions & 1 deletion Doc/library/shlex.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,15 @@ The :mod:`!shlex` module defines the following functions:
.. versionadded:: 3.8


.. function:: quote(s)
.. function:: quote(s, *, force=False)

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.

If *force* is :const:`True`, then *s* is unconditionally quoted,
even if it is already safe for a shell without being quoted.

.. _shlex-quote-warning:

.. warning::
Expand Down Expand Up @@ -91,8 +94,23 @@ The :mod:`!shlex` module defines the following functions:
>>> command
['ls', '-l', 'somefile; rm -rf ~']

The *force* keyword can be used to produce consistent behavior when
escaping multiple strings:

>>> from shlex import quote
>>> filenames = ['my first file', 'file2', 'file 3']
>>> filenames_some_escaped = [quote(f) for f in filenames]
>>> filenames_some_escaped
["'my first file'", 'file2', "'file 3'"]
>>> filenames_all_escaped = [quote(f, force=True) for f in filenames]
>>> filenames_all_escaped
["'my first file'", "'file2'", "'file 3'"]

.. versionadded:: 3.3

.. versionchanged:: next
The *force* keyword was added.
Comment thread
jb2170 marked this conversation as resolved.

The :mod:`!shlex` module defines the following class:


Expand Down
7 changes: 7 additions & 0 deletions Doc/whatsnew/3.16.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,13 @@ os
process via a pidfd. Available on Linux 5.6+.
(Contributed by Maurycy Pawłowski-Wieroński in :gh:`149464`.)

shlex
-----

* Add keyword-only parameter *force* to :func:`shlex.quote` to force quoting
a string, even if it is already safe for a shell without being quoted.
(Contributed by Jay Berry in :gh:`148846`.)

xml
---

Expand Down
14 changes: 10 additions & 4 deletions Lib/shlex.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -317,8 +317,12 @@ def join(split_command):
return ' '.join(quote(arg) for arg in split_command)


def quote(s):
"""Return a shell-escaped version of the string *s*."""
def quote(s, *, force=False):
"""Return a shell-escaped version of the string *s*.

If *force* is *True*, then *s* is unconditionally quoted,
even if it is already safe for a shell without being quoted.
"""
if not s:
return "''"

Expand All @@ -329,8 +333,10 @@ def quote(s):
safe_chars = (b'%+,-./0123456789:=@'
b'ABCDEFGHIJKLMNOPQRSTUVWXYZ_'
b'abcdefghijklmnopqrstuvwxyz')
# No quoting is needed if `s` is an ASCII string consisting only of `safe_chars`
if s.isascii() and not s.encode().translate(None, delete=safe_chars):
# No quoting is needed if we are not forcing quoting
# and `s` is an ASCII string consisting only of `safe_chars`.
if (not force
and s.isascii() and not s.encode().translate(None, delete=safe_chars)):
return s

# use single quotes, and put single quotes into double quotes
Expand Down
8 changes: 8 additions & 0 deletions Lib/test/test_shlex.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,14 @@ def testQuote(self):
self.assertRaises(TypeError, shlex.quote, 42)
self.assertRaises(TypeError, shlex.quote, b"abc")

def testForceQuote(self):
self.assertEqual(shlex.quote("spam"), "spam")
Comment thread
jb2170 marked this conversation as resolved.
self.assertEqual(shlex.quote("spam", force=False), "spam")
self.assertEqual(shlex.quote("spam", force=True), "'spam'")
self.assertEqual(shlex.quote("spam eggs", force=False), "'spam eggs'")
self.assertEqual(shlex.quote("spam eggs", force=True), "'spam eggs'")
self.assertEqual(shlex.quote("two's-complement", force=False), "'two'\"'\"'s-complement'")

def testJoin(self):
for split_command, command in [
(['a ', 'b'], "'a ' b"),
Expand Down
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Add keyword-only parameter *force* to :func:`shlex.quote` to force quoting
a string, even if it is already safe for a shell without being quoted.
Loading

Back | FazBrowse Home | New Git URL