diff options
Diffstat (limited to 'Doc/library')
| -rw-r--r-- | Doc/library/json.rst | 13 | ||||
| -rw-r--r-- | Doc/library/shutil.rst | 3 | ||||
| -rw-r--r-- | Doc/library/subprocess.rst | 4 |
3 files changed, 17 insertions, 3 deletions
diff --git a/Doc/library/json.rst b/Doc/library/json.rst index 95f120cc7f..f9547cb358 100644 --- a/Doc/library/json.rst +++ b/Doc/library/json.rst @@ -116,7 +116,10 @@ Using json.tool from the shell to validate and pretty-print:: Basic Usage ----------- -.. function:: dump(obj, fp, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, **kw) +.. function:: dump(obj, fp, skipkeys=False, ensure_ascii=True, \ + check_circular=True, allow_nan=True, cls=None, \ + indent=None, separators=None, default=None, \ + sort_keys=False, **kw) Serialize *obj* as a JSON formatted stream to *fp* (a ``.write()``-supporting :term:`file-like object`). @@ -159,12 +162,18 @@ Basic Usage *default(obj)* is a function that should return a serializable version of *obj* or raise :exc:`TypeError`. The default simply raises :exc:`TypeError`. + If *sort_keys* is ``True`` (default: ``False``), then the output of + dictionaries will be sorted by key. + To use a custom :class:`JSONEncoder` subclass (e.g. one that overrides the :meth:`default` method to serialize additional types), specify it with the *cls* kwarg; otherwise :class:`JSONEncoder` is used. -.. function:: dumps(obj, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, **kw) +.. function:: dumps(obj, skipkeys=False, ensure_ascii=True, \ + check_circular=True, allow_nan=True, cls=None, \ + indent=None, separators=None, default=None, \ + sort_keys=False, **kw) Serialize *obj* to a JSON formatted :class:`str`. The arguments have the same meaning as in :func:`dump`. diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst index ec8cad25f2..b2efcbdd48 100644 --- a/Doc/library/shutil.rst +++ b/Doc/library/shutil.rst @@ -70,7 +70,8 @@ Directory and files operations Now returns *dst*. .. versionchanged:: 3.4 - Raise :exc:`SameFileError` instead of :exc:`Error`. + Raise :exc:`SameFileError` instead of :exc:`Error`. Since the former is + a subclass of the latter, this change is backward compatible. .. exception:: SameFileError diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst index 66d6cbbd64..34fdf106a3 100644 --- a/Doc/library/subprocess.rst +++ b/Doc/library/subprocess.rst @@ -341,6 +341,10 @@ default values. The arguments that are most commonly needed are: from this vulnerability; see the Note in the :class:`Popen` constructor documentation for helpful hints in getting ``shell=False`` to work. + When using ``shell=True``, :func:`shlex.quote` can be used to properly + escape whitespace and shell metacharacters in strings that are going to + be used to construct shell commands. + These options, along with all of the other options, are described in more detail in the :class:`Popen` constructor documentation. |