Remove expand option, this is now the default

Author: hugovk

Doc/library/pprint.rst

@@ -31,8 +31,7 @@ Functions
 ---------
 
 .. function:: pp(object, stream=None, indent=4, width=88, depth=None, *, \
-                 compact=False, expand=True, sort_dicts=False, \
-                 underscore_numbers=False)
+                 compact=False, sort_dicts=False, underscore_numbers=False)
 
    Prints the formatted representation of *object*, followed by a newline.
    This function may be used in the interactive interpreter
@@ -66,22 +65,12 @@ Functions
 
    :param bool compact:
       Control the way long :term:`sequences <sequence>` are formatted.
-      If ``True``, as many items as will fit within the *width*
-      will be formatted on each output line.
-      If ``False`` (the default), each item of a sequence
-      will be formatted on a separate line,
-      *unless* *expand* mode is also active (which is now the default);
-      to opt out of *expand* mode, pass ``expand=False`` rather than
-      relying on ``compact=False``.
-      Takes precedence over *expand*.
-
-   :param bool expand:
-      If ``True`` (the default),
+      If ``False`` (the default),
       opening parentheses and brackets will be followed by a newline and the
       following content will be indented by one level, similar to
-      pretty-printed JSON. Has no effect when *compact* is also ``True``.
-      Pass ``expand=False`` to restore the pre-3.15 layout where each
-      item appears on its own line without the extra indentation.
+      pretty-printed JSON.
+      If ``True``, as many items as will fit within the *width*
+      will be formatted on each output line.
 
    :param bool sort_dicts:
       If ``True``, dictionaries will be formatted with
@@ -103,20 +92,18 @@ Functions
 
 
 .. function:: pprint(object, stream=None, indent=4, width=88, depth=None, *, \
-                     compact=False, expand=True, sort_dicts=True, \
-                     underscore_numbers=False)
+                     compact=False, sort_dicts=True, underscore_numbers=False)
 
    Alias for :func:`~pprint.pp` with *sort_dicts* set to ``True`` by default,
    which would automatically sort the dictionaries' keys,
    you might want to use :func:`~pprint.pp` instead where it is ``False`` by default.
 
 
 .. function:: pformat(object, indent=4, width=88, depth=None, *, \
-                      compact=False, expand=True, sort_dicts=True, \
-                      underscore_numbers=False)
+                      compact=False, sort_dicts=True, underscore_numbers=False)
 
    Return the formatted representation of *object* as a string.  *indent*,
-   *width*, *depth*, *compact*, *expand*, *sort_dicts* and *underscore_numbers* are
+   *width*, *depth*, *compact*, *sort_dicts* and *underscore_numbers* are
    passed to the :class:`PrettyPrinter` constructor as formatting parameters
    and their meanings are as described in the documentation above.
 
@@ -160,7 +147,7 @@ PrettyPrinter objects
 .. index:: single: ...; placeholder
 
 .. class:: PrettyPrinter(indent=4, width=88, depth=None, stream=None, *, \
-                         compact=False, expand=True, sort_dicts=True, \
+                         compact=False, sort_dicts=True, \
                          underscore_numbers=False)
 
    Construct a :class:`PrettyPrinter` instance.
@@ -181,7 +168,7 @@ PrettyPrinter objects
        'knights',
        'ni',
    ]
-   >>> pp = pprint.PrettyPrinter(indent=1, width=41, compact=True, expand=False)
+   >>> pp = pprint.PrettyPrinter(indent=1, width=41, compact=True)
    >>> pp.pprint(stuff)
    [['spam', 'eggs', 'lumberjack',
      'knights', 'ni'],
@@ -222,14 +209,12 @@ PrettyPrinter objects
    .. versionchanged:: 3.11
       No longer attempts to write to :data:`!sys.stdout` if it is ``None``.
 
-   .. versionchanged:: 3.15
-      Added the *expand* parameter.
-
    .. versionchanged:: next
-      Changed default *indent* from 1 to 4,
-      default *width* from 80 to 88,
-      and default *expand* from ``False`` to ``True``.
-      *compact* takes precedence over *expand* when both are ``True``.
+      Changed default *indent* from 1 to 4
+      and default *width* from 80 to 88.
+      The default ``compact=False`` layout is now similar to
+      pretty-printed JSON, with opening parentheses and brackets
+      followed by a newline and the contents indented by one level.
 
 
 :class:`PrettyPrinter` instances have the following methods:
@@ -447,60 +432,3 @@ cannot be split, the specified width will be exceeded::
        'summary': 'A sample Python project',
        'version': '1.2.0',
    }
-
-The *expand* format (similar to pretty-printed JSON) is the default.
-To disable it, pass ``expand=False``::
-
-   >>> pprint.pp(project_info, expand=False)
-   {   'author': 'The Python Packaging Authority',
-       'author_email': 'pypa-dev@googlegroups.com',
-       'bugtrack_url': None,
-       'classifiers': [   'Development Status :: 3 - Alpha',
-                          'Intended Audience :: Developers',
-                          'License :: OSI Approved :: MIT License',
-                          'Programming Language :: Python :: 2',
-                          'Programming Language :: Python :: 2.6',
-                          'Programming Language :: Python :: 2.7',
-                          'Programming Language :: Python :: 3',
-                          'Programming Language :: Python :: 3.2',
-                          'Programming Language :: Python :: 3.3',
-                          'Programming Language :: Python :: 3.4',
-                          'Topic :: Software Development :: Build Tools'],
-       'description': 'A sample Python project\n'
-                      '=======================\n'
-                      '\n'
-                      'This is the description file for the project.\n'
-                      '\n'
-                      'The file should use UTF-8 encoding and be written using '
-                      'ReStructured Text. It\n'
-                      'will be used to generate the project webpage on PyPI, and should '
-                      'be written for\n'
-                      'that purpose.\n'
-                      '\n'
-                      'Typical contents for this file would include an overview of the '
-                      'project, basic\n'
-                      'usage examples, etc. Generally, including the project changelog in '
-                      'here is not\n'
-                      'a good idea, although a simple "What\'s New" section for the most '
-                      'recent version\n'
-                      'may be appropriate.',
-       'description_content_type': None,
-       'docs_url': None,
-       'download_url': 'UNKNOWN',
-       'downloads': {'last_day': -1, 'last_month': -1, 'last_week': -1},
-       'home_page': 'https://github.com/pypa/sampleproject',
-       'keywords': 'sample setuptools development',
-       'license': 'MIT',
-       'maintainer': None,
-       'maintainer_email': None,
-       'name': 'sampleproject',
-       'package_url': 'https://pypi.org/project/sampleproject/',
-       'platform': 'UNKNOWN',
-       'project_url': 'https://pypi.org/project/sampleproject/',
-       'project_urls': {   'Download': 'UNKNOWN',
-                           'Homepage': 'https://github.com/pypa/sampleproject'},
-       'release_url': 'https://pypi.org/project/sampleproject/1.2.0/',
-       'requires_dist': None,
-       'requires_python': None,
-       'summary': 'A sample Python project',
-       'version': '1.2.0'}

Doc/whatsnew/3.15.rst

@@ -1087,16 +1087,11 @@ pickletools
 pprint
 ------
 
-* Add an *expand* keyword argument for :func:`pprint.pprint`,
-  :func:`pprint.pformat`, :func:`pprint.pp`. If true, the output will be
-  formatted similar to pretty-printed :func:`json.dumps` when
-  *indent* is supplied.
+* :mod:`pprint` now uses modern defaults: ``indent=4, width=88``,
+  and the default ``compact=False`` output is now formatted similar to
+  pretty-printed :func:`json.dumps`.
   (Contributed by Stefan Todoran, Semyon Moroz and Hugo van Kemenade in
-  :gh:`112632`.)
-
-* :mod:`pprint` now uses modern defaults: ``indent=4, width=88, expand=True``.
-  Use ``indent=1, width=80, expand=False`` to retain old output.
-  (Contributed by Hugo van Kemenade in :gh:`149189`.)
+  :gh:`112632` and :gh:`149189`.)
 
 * Add t-string support to :mod:`pprint`.
   (Contributed by Loïc Simon and Hugo van Kemenade in :gh:`134551`.)