[Python-checkins] gh-99087: Add missing newline for prompts in docs (GH-98993)
ethanfurman
webhook-mailer at python.org
Thu Dec 8 22:31:25 EST 2022
https://github.com/python/cpython/commit/286e3c76a9cb8f1adc2a915f0d246a1e2e408733
commit: 286e3c76a9cb8f1adc2a915f0d246a1e2e408733
branch: main
author: Stanley <46876382+slateny at users.noreply.github.com>
committer: ethanfurman <ethan at stoneleaf.us>
date: 2022-12-08T19:31:19-08:00
summary:
gh-99087: Add missing newline for prompts in docs (GH-98993)
Add newline for prompts so copying to REPL does not cause errors.
files:
M Doc/howto/enum.rst
M Doc/library/argparse.rst
M Doc/library/bz2.rst
M Doc/library/collections.rst
M Doc/library/datetime.rst
M Doc/library/decimal.rst
M Doc/library/doctest.rst
M Doc/library/email.policy.rst
M Doc/library/enum.rst
M Doc/library/functions.rst
M Doc/library/hashlib.rst
M Doc/library/inspect.rst
M Doc/library/re.rst
M Doc/library/sqlite3.rst
M Doc/library/statistics.rst
M Doc/library/stdtypes.rst
M Doc/library/unittest.mock.rst
M Doc/library/xml.etree.elementtree.rst
M Doc/library/zipfile.rst
M Doc/whatsnew/2.7.rst
M Doc/whatsnew/3.2.rst
M Doc/whatsnew/3.3.rst
diff --git a/Doc/howto/enum.rst b/Doc/howto/enum.rst
index 3155c6cb977b..4525acb04503 100644
--- a/Doc/howto/enum.rst
+++ b/Doc/howto/enum.rst
@@ -158,6 +158,7 @@ And a function to display the chores for a given day::
... for chore, days in chores.items():
... if day in days:
... print(chore)
+ ...
>>> show_chores(chores_for_ethan, Weekday.SATURDAY)
answer SO questions
@@ -712,6 +713,7 @@ It is also possible to name the combinations::
... W = 2
... X = 1
... RWX = 7
+ ...
>>> Perm.RWX
<Perm.RWX: 7>
>>> ~Perm.RWX
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index f8839d0986d0..e6c964864925 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -565,6 +565,7 @@ arguments they contain. For example::
>>> with open('args.txt', 'w', encoding=sys.getfilesystemencoding()) as fp:
... fp.write('-f\nbar')
+ ...
>>> parser = argparse.ArgumentParser(fromfile_prefix_chars='@')
>>> parser.add_argument('-f')
>>> parser.parse_args(['-f', 'foo', '@args.txt'])
diff --git a/Doc/library/bz2.rst b/Doc/library/bz2.rst
index ae5a1598f84b..32df99869eb5 100644
--- a/Doc/library/bz2.rst
+++ b/Doc/library/bz2.rst
@@ -320,9 +320,11 @@ Writing and reading a bzip2-compressed file in binary mode:
>>> with bz2.open("myfile.bz2", "wb") as f:
... # Write compressed data to file
... unused = f.write(data)
+ ...
>>> with bz2.open("myfile.bz2", "rb") as f:
... # Decompress data from file
... content = f.read()
+ ...
>>> content == data # Check equality to original object after round-trip
True
diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst
index 53b4b69f84b7..2cffc2300a22 100644
--- a/Doc/library/collections.rst
+++ b/Doc/library/collections.rst
@@ -229,6 +229,7 @@ For example::
>>> cnt = Counter()
>>> for word in ['red', 'blue', 'red', 'green', 'blue', 'blue']:
... cnt[word] += 1
+ ...
>>> cnt
Counter({'blue': 3, 'red': 2, 'green': 1})
@@ -818,6 +819,7 @@ zero):
>>> def constant_factory(value):
... return lambda: value
+ ...
>>> d = defaultdict(constant_factory('<missing>'))
>>> d.update(name='John', action='ran')
>>> '%(name)s %(action)s to %(object)s' % d
diff --git a/Doc/library/datetime.rst b/Doc/library/datetime.rst
index f7e2bb3f3c6d..0b39512a2d23 100644
--- a/Doc/library/datetime.rst
+++ b/Doc/library/datetime.rst
@@ -765,6 +765,7 @@ Example of counting days to an event::
>>> my_birthday = date(today.year, 6, 24)
>>> if my_birthday < today:
... my_birthday = my_birthday.replace(year=today.year + 1)
+ ...
>>> my_birthday
datetime.date(2008, 6, 24)
>>> time_to_birthday = abs(my_birthday - today)
diff --git a/Doc/library/decimal.rst b/Doc/library/decimal.rst
index 260108136df7..fec9b86864c5 100644
--- a/Doc/library/decimal.rst
+++ b/Doc/library/decimal.rst
@@ -2057,6 +2057,7 @@ to handle the :meth:`quantize` step:
>>> def mul(x, y, fp=TWOPLACES):
... return (x * y).quantize(fp)
+ ...
>>> def div(x, y, fp=TWOPLACES):
... return (x / y).quantize(fp)
diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst
index c106d5a3383a..b6dd7f7e1232 100644
--- a/Doc/library/doctest.rst
+++ b/Doc/library/doctest.rst
@@ -351,6 +351,7 @@ The fine print:
>>> def f(x):
... r'''Backslashes in a raw docstring: m\n'''
+ ...
>>> print(f.__doc__)
Backslashes in a raw docstring: m\n
@@ -360,6 +361,7 @@ The fine print:
>>> def f(x):
... '''Backslashes in a raw docstring: m\\n'''
+ ...
>>> print(f.__doc__)
Backslashes in a raw docstring: m\n
diff --git a/Doc/library/email.policy.rst b/Doc/library/email.policy.rst
index bf53b9520fc7..2439dee676c9 100644
--- a/Doc/library/email.policy.rst
+++ b/Doc/library/email.policy.rst
@@ -97,6 +97,7 @@ file on disk and pass it to the system ``sendmail`` program on a Unix system:
>>> from subprocess import Popen, PIPE
>>> with open('mymsg.txt', 'rb') as f:
... msg = message_from_binary_file(f, policy=policy.default)
+ ...
>>> p = Popen(['sendmail', msg['To'].addresses[0]], stdin=PIPE)
>>> g = BytesGenerator(p.stdin, policy=msg.policy.clone(linesep='\r\n'))
>>> g.flatten(msg)
diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst
index f8875440baf5..295152c69082 100644
--- a/Doc/library/enum.rst
+++ b/Doc/library/enum.rst
@@ -292,6 +292,7 @@ Data Types
... @classmethod
... def today(cls):
... print('today is %s' % cls(date.today().isoweekday()).name)
+ ...
>>> dir(Weekday.SATURDAY)
['__class__', '__doc__', '__eq__', '__hash__', '__module__', 'name', 'today', 'value']
@@ -312,6 +313,7 @@ Data Types
... return (count + 1) * 3
... FIRST = auto()
... SECOND = auto()
+ ...
>>> PowersOfThree.SECOND.value
6
@@ -336,6 +338,7 @@ Data Types
... if member.value == value:
... return member
... return None
+ ...
>>> Build.DEBUG.value
'debug'
>>> Build('deBUG')
@@ -353,6 +356,7 @@ Data Types
... def __repr__(self):
... cls_name = self.__class__.__name__
... return f'{cls_name}.{self.name}'
+ ...
>>> OtherStyle.ALTERNATE, str(OtherStyle.ALTERNATE), f"{OtherStyle.ALTERNATE}"
(OtherStyle.ALTERNATE, 'OtherStyle.ALTERNATE', 'OtherStyle.ALTERNATE')
@@ -367,6 +371,7 @@ Data Types
... SOMETHING_ELSE = auto()
... def __str__(self):
... return f'{self.name}'
+ ...
>>> OtherStyle.ALTERNATE, str(OtherStyle.ALTERNATE), f"{OtherStyle.ALTERNATE}"
(<OtherStyle.ALTERNATE: 1>, 'ALTERNATE', 'ALTERNATE')
@@ -381,6 +386,7 @@ Data Types
... SOMETHING_ELSE = auto()
... def __format__(self, spec):
... return f'{self.name}'
+ ...
>>> OtherStyle.ALTERNATE, str(OtherStyle.ALTERNATE), f"{OtherStyle.ALTERNATE}"
(<OtherStyle.ALTERNATE: 1>, 'OtherStyle.ALTERNATE', 'ALTERNATE')
@@ -403,6 +409,7 @@ Data Types
... ONE = 1
... TWO = 2
... THREE = 3
+ ...
>>> Numbers.THREE
<Numbers.THREE: 3>
>>> Numbers.ONE + Numbers.TWO
@@ -463,6 +470,7 @@ Data Types
... RED = auto()
... GREEN = auto()
... BLUE = auto()
+ ...
>>> purple = Color.RED | Color.BLUE
>>> white = Color.RED | Color.GREEN | Color.BLUE
>>> Color.GREEN in purple
@@ -570,6 +578,7 @@ Data Types
... RED = auto()
... GREEN = auto()
... BLUE = auto()
+ ...
>>> Color.RED & 2
<Color: 0>
>>> Color.RED | 2
@@ -695,6 +704,7 @@ Data Types
... RED = auto()
... GREEN = auto()
... BLUE = auto()
+ ...
>>> StrictFlag(2**2 + 2**4)
Traceback (most recent call last):
...
@@ -712,6 +722,7 @@ Data Types
... RED = auto()
... GREEN = auto()
... BLUE = auto()
+ ...
>>> ConformFlag(2**2 + 2**4)
<ConformFlag.BLUE: 4>
@@ -725,6 +736,7 @@ Data Types
... RED = auto()
... GREEN = auto()
... BLUE = auto()
+ ...
>>> EjectFlag(2**2 + 2**4)
20
@@ -738,6 +750,7 @@ Data Types
... RED = auto()
... GREEN = auto()
... BLUE = auto()
+ ...
>>> KeepFlag(2**2 + 2**4)
<KeepFlag.BLUE|16: 20>
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 110e7e5d7fb9..2110990d1889 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -462,6 +462,7 @@ are always available. They are listed here in alphabetical order.
>>> class Shape:
... def __dir__(self):
... return ['area', 'perimeter', 'location']
+ ...
>>> s = Shape()
>>> dir(s)
['area', 'location', 'perimeter']
diff --git a/Doc/library/hashlib.rst b/Doc/library/hashlib.rst
index 8e47312fe77b..f8d10c0c295c 100644
--- a/Doc/library/hashlib.rst
+++ b/Doc/library/hashlib.rst
@@ -497,6 +497,7 @@ update the hash:
>>> h = blake2b()
>>> for item in items:
... h.update(item)
+ ...
>>> h.hexdigest()
'6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183'
diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst
index 9cb7a6f94e49..6705577551dc 100644
--- a/Doc/library/inspect.rst
+++ b/Doc/library/inspect.rst
@@ -715,6 +715,7 @@ function.
>>> def test(a, b):
... pass
+ ...
>>> sig = signature(test)
>>> new_sig = sig.replace(return_annotation="new return anno")
>>> str(new_sig)
@@ -1054,6 +1055,7 @@ Classes and functions
>>> from inspect import getcallargs
>>> def f(a, b=1, *pos, **named):
... pass
+ ...
>>> getcallargs(f, 1, 2, 3) == {'a': 1, 'named': {}, 'b': 2, 'pos': (3,)}
True
>>> getcallargs(f, a=2, x=4) == {'a': 2, 'named': {'x': 4}, 'b': 1, 'pos': ()}
diff --git a/Doc/library/re.rst b/Doc/library/re.rst
index e6e242320fd8..f7d46586cf75 100644
--- a/Doc/library/re.rst
+++ b/Doc/library/re.rst
@@ -973,6 +973,7 @@ Functions
>>> def dashrepl(matchobj):
... if matchobj.group(0) == '-': return ' '
... else: return '-'
+ ...
>>> re.sub('-{1,2}', dashrepl, 'pro----gram-files')
'pro--gram files'
>>> re.sub(r'\sAND\s', ' & ', 'Baked Beans And Spam', flags=re.IGNORECASE)
@@ -1672,6 +1673,7 @@ in each word of a sentence except for the first and last characters::
... inner_word = list(m.group(2))
... random.shuffle(inner_word)
... return m.group(1) + "".join(inner_word) + m.group(3)
+ ...
>>> text = "Professor Abdolmalek, please report your absences promptly."
>>> re.sub(r"(\w)(\w+)(\w)", repl, text)
'Poefsrosr Aealmlobdk, pslaee reorpt your abnseces plmrptoy.'
diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst
index 2b6387cbfb52..3622864a4b06 100644
--- a/Doc/library/sqlite3.rst
+++ b/Doc/library/sqlite3.rst
@@ -397,6 +397,7 @@ Module functions
>>> con = sqlite3.connect(":memory:")
>>> def evil_trace(stmt):
... 5/0
+ ...
>>> con.set_trace_callback(evil_trace)
>>> def debug(unraisable):
... print(f"{unraisable.exc_value!r} in callback {unraisable.object.__name__}")
diff --git a/Doc/library/statistics.rst b/Doc/library/statistics.rst
index 88a887960edb..f934b0e0319d 100644
--- a/Doc/library/statistics.rst
+++ b/Doc/library/statistics.rst
@@ -996,6 +996,7 @@ probability that the Python room will stay within its capacity limits?
>>> seed(8675309)
>>> def trial():
... return choices(('Python', 'Ruby'), (p, q), k=n).count('Python')
+ ...
>>> mean(trial() <= k for i in range(10_000))
0.8398
diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
index 785b76a11f2f..73debe5ceeaf 100644
--- a/Doc/library/stdtypes.rst
+++ b/Doc/library/stdtypes.rst
@@ -4459,6 +4459,7 @@ can be used interchangeably to index the same dictionary entry.
>>> class Counter(dict):
... def __missing__(self, key):
... return 0
+ ...
>>> c = Counter()
>>> c['red']
0
@@ -4716,6 +4717,7 @@ An example of dictionary view usage::
>>> n = 0
>>> for val in values:
... n += val
+ ...
>>> print(n)
504
diff --git a/Doc/library/unittest.mock.rst b/Doc/library/unittest.mock.rst
index b768557e6075..e009f303fef3 100644
--- a/Doc/library/unittest.mock.rst
+++ b/Doc/library/unittest.mock.rst
@@ -1604,6 +1604,7 @@ decorator:
>>> @patch.dict(foo, {'newkey': 'newvalue'})
... def test():
... assert foo == {'newkey': 'newvalue'}
+ ...
>>> test()
>>> assert foo == {}
diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst
index 2fe0d2e082fb..876de29b17ca 100644
--- a/Doc/library/xml.etree.elementtree.rst
+++ b/Doc/library/xml.etree.elementtree.rst
@@ -1212,6 +1212,7 @@ Example of changing the attribute "target" of every link in first paragraph::
[<Element 'a' at 0xb77ec2ac>, <Element 'a' at 0xb77ec1cc>]
>>> for i in links: # Iterates through all found links
... i.attrib["target"] = "blank"
+ ...
>>> tree.write("output.xhtml")
.. _elementtree-qname-objects:
diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst
index 4dd9fa961a8d..82709dbc9249 100644
--- a/Doc/library/zipfile.rst
+++ b/Doc/library/zipfile.rst
@@ -672,6 +672,7 @@ The :class:`PyZipFile` constructor takes the same parameters as the
>>> def notests(s):
... fn = os.path.basename(s)
... return (not (fn == 'test' or fn.startswith('test_')))
+ ...
>>> zf.writepy('myprog', filterfunc=notests)
The :meth:`writepy` method makes archives with file names like
diff --git a/Doc/whatsnew/2.7.rst b/Doc/whatsnew/2.7.rst
index 276ab63b97f8..810a2cd2537c 100644
--- a/Doc/whatsnew/2.7.rst
+++ b/Doc/whatsnew/2.7.rst
@@ -1331,6 +1331,7 @@ changes, or look through the Subversion logs for all the details.
>>> from inspect import getcallargs
>>> def f(a, b=1, *pos, **named):
... pass
+ ...
>>> getcallargs(f, 1, 2, 3)
{'a': 1, 'b': 2, 'pos': (3,), 'named': {}}
>>> getcallargs(f, a=2, x=4)
diff --git a/Doc/whatsnew/3.2.rst b/Doc/whatsnew/3.2.rst
index 6037db9f954d..1b1455b72b92 100644
--- a/Doc/whatsnew/3.2.rst
+++ b/Doc/whatsnew/3.2.rst
@@ -468,6 +468,7 @@ Some smaller changes made to the core Python language are:
>>> class LowerCasedDict(dict):
... def __getitem__(self, key):
... return dict.__getitem__(self, key.lower())
+ ...
>>> lcd = LowerCasedDict(part='widgets', quantity=10)
>>> 'There are {QUANTITY} {Part} in stock'.format_map(lcd)
'There are 10 widgets in stock'
@@ -475,6 +476,7 @@ Some smaller changes made to the core Python language are:
>>> class PlaceholderDict(dict):
... def __missing__(self, key):
... return '<{}>'.format(key)
+ ...
>>> 'Hello {name}, welcome to {location}'.format_map(PlaceholderDict())
'Hello <name>, welcome to <location>'
@@ -1886,6 +1888,7 @@ inspect
>>> from inspect import getgeneratorstate
>>> def gen():
... yield 'demo'
+ ...
>>> g = gen()
>>> getgeneratorstate(g)
'GEN_CREATED'
diff --git a/Doc/whatsnew/3.3.rst b/Doc/whatsnew/3.3.rst
index 96a632577b2c..9e8d42469b01 100644
--- a/Doc/whatsnew/3.3.rst
+++ b/Doc/whatsnew/3.3.rst
@@ -560,6 +560,7 @@ Example with (non-bound) methods::
>>> class C:
... def meth(self):
... pass
+ ...
>>> C.meth.__name__
'meth'
>>> C.meth.__qualname__
More information about the Python-checkins
mailing list