8000 [3.13] Format None, True, False and NotImplemented as literals (GH-11… · python/cpython@8f31af6 · GitHub
[go: up one dir, main page]
Skip to content

Commit 8f31af6

Browse files
miss-islingtonserhiy-storchaka
miss-islington
and
serhiy-storchaka
authored
[3.13] Format None, True, False and NotImplemented as literals (GH-118758) (GH-118792)
(cherry picked from commit 05c2fe1) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
1 parent c33bba6 commit 8f31af6

39 files changed

+85
-83
lines changed

‎Doc/c-api/object.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Object Protocol
6565
6666
Properly handle returning :c:data:`Py_NotImplemented` from within a C
6767
function (that is, create a new :term:`strong reference`
68-
to NotImplemented and return it).
68+
to :const:`NotImplemented` and return it).
6969
7070
7171
.. c:macro:: Py_PRINT_RAW

‎Doc/library/_thread.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -169,14 +169,14 @@ Lock objects have the following methods:
169169
time can acquire a lock --- that's their reason for existence).
170170

171171
If the *blocking* argument is present, the action depends on its
172-
value: if it is False, the lock is only acquired if it can be acquired
173-
immediately without waiting, while if it is True, the lock is acquired
172+
value: if it is false, the lock is only acquired if it can be acquired
173+
immediately without waiting, while if it is true, the lock is acquired
174174
unconditionally as above.
175175

176176
If the floating-point *timeout* argument is present and positive, it
177177
specifies the maximum wait time in seconds before returning. A negative
178178
*timeout* argument specifies an unbounded wait. You cannot specify
179-
a *timeout* if *blocking* is False.
179+
a *timeout* if *blocking* is false.
180180

181181
The return value is ``True`` if the lock is acquired successfully,
182182
``False`` if not.

‎Doc/library/asyncio-eventloop.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -796,7 +796,7 @@ Creating network servers
796796
:class:`str`, :class:`bytes`, and :class:`~pathlib.Path` paths
797797
are supported.
798798

799-
If *cleanup_socket* is True then the Unix socket will automatically
799+
If *cleanup_socket* is true then the Unix socket will automatically
800800
be removed from the filesystem when the server is closed, unless the
801801
socket has been replaced after the server has been created.
802802

‎Doc/library/asyncio-task.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -538,7 +538,7 @@ Running Tasks Concurrently
538538
# [2, 6, 24]
539539

540540
.. note::
541-
If *return_exceptions* is False, cancelling gather() after it
541+
If *return_exceptions* is false, cancelling gather() after it
54 10000 2542
has been marked done won't cancel any submitted awaitables.
543543
For instance, gather can be marked done after propagating an
544544
exception to the caller, therefore, calling ``gather.cancel()``

‎Doc/library/bdb.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ The :mod:`bdb` module also defines two classes:
8686

8787
.. attribute:: temporary
8888

89-
True if a :class:`Breakpoint` at (file, line) is temporary.
89+
``True`` if a :class:`Breakpoint` at (file, line) is temporary.
9090

9191
.. attribute:: cond
9292

@@ -99,7 +99,7 @@ The :mod:`bdb` module also defines two classes:
9999

100100
.. attribute:: enabled
101101

102-
True if :class:`Breakpoint` is enabled.
102+
``True`` if :class:`Breakpoint` is enabled.
103103

104104
.. attribute:: bpbynumber
105105

@@ -215,22 +215,22 @@ The :mod:`bdb` module also defines two classes:
215215

216216
.. method:: is_skipped_line(module_name)
217217

218-
Return True if *module_name* matches any skip pattern.
218+
Return ``True`` if *module_name* matches any skip pattern.
219219

220220
.. method:: stop_here(frame)
221221

222-
Return True if *frame* is below the starting frame in the stack.
222+
Return ``True`` if *frame* is below the starting frame in the stack.
223223

224224
.. method:: break_here(frame)
225225

226-
Return True if there is an effective breakpoint for this line.
226+
Return ``True`` if there is an effective breakpoint for this line.
227227

228228
Check whether a line or function breakpoint exists and is in effect. Delete temporary
229229
breakpoints based on information from :func:`effective`.
230230

231231
.. method:: break_anywhere(frame)
232232

233-
Return True if any breakpoint exists for *frame*'s filename.
233+
Return ``True`` if any breakpoint exists for *frame*'s filename.
234234

235235
Derived classes should override these methods to gain control over debugger
236236
operation.
@@ -348,7 +348,7 @@ The :mod:`bdb` module also defines two classes:
348348

349349
.. method:: get_break(filename, lineno)
350350

351-
Return True if there is a breakpoint for *lineno* in *filename*.
351+
Return ``True`` if there is a breakpoint for *lineno* in *filename*.
352352

353353
.. method:: get_breaks(filename, lineno)
354354

@@ -412,7 +412,7 @@ Finally, the module defines the following functions:
412412

413413
.. function:: checkfuncname(b, frame)
414414

415-
Return True if we should break here, depending on the way the
415+
Return ``True`` if we should break here, depending on the way the
416416
:class:`Breakpoint` *b* was set.
417417

418418
If it was set via line number, it checks if
@@ -431,14 +431,14 @@ Finally, the module defines the following functions:
431431
:attr:`bplist <bdb.Breakpoint.bplist>` for the
432432
(:attr:`file <bdb.Breakpoint.file>`, :attr:`line <bdb.Breakpoint.line>`)
433433
(which must exist) that is :attr:`enabled <bdb.Breakpoint.enabled>`, for
434-
which :func:`checkfuncname` is True, and that has neither a False
434+
which :func:`checkfuncname` is true, and that has neither a false
435435
:attr:`condition <bdb.Breakpoint.cond>` nor positive
436436
:attr:`ignore <bdb.Breakpoint.ignore>` count. The *flag*, meaning that a
437-
temporary breakpoint should be deleted, is False only when the
437+
temporary breakpoint should be deleted, is ``False`` only when the
438438
:attr:`cond <bdb.Breakpoint.cond>` cannot be evaluated (in which case,
439439
:attr:`ignore <bdb.Breakpoint.ignore>` count is ignored).
440440

441-
If no such entry exists, then (None, None) is returned.
441+
If no such entry exists, then ``(None, None)`` is returned.
442442

443443

444444
.. function:: set_trace()

‎Doc/library/code.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ build applications which provide an interactive interpreter prompt.
2727

2828
Closely emulate the behavior of the interactive Python interpreter. This class
2929
builds on :class:`InteractiveInterpreter` and adds prompting using the familiar
30-
``sys.ps1`` and ``sys.ps2``, and input buffering. If *local_exit* is True,
30+
``sys.ps1`` and ``sys.ps2``, and input buffering. If *local_exit* is true,
3131
``exit()`` and ``quit()`` in the console will not raise :exc:`SystemExit`, but
3232
instead return to the calling code.
3333

‎Doc/library/compileall.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ Public functions
226226
The *invalidation_mode* parameter was added.
227227

228228
.. versionchanged:: 3.7.2
229-
The *invalidation_mode* parameter's default value is updated to None.
229+
The *invalidation_mode* parameter's default value is updated to ``None``.
230230

231231
.. versionchanged:: 3.8
232232
Setting *workers* to 0 now chooses the optimal number of cores.
@@ -289,7 +289,7 @@ Public functions
289289
The *invalidation_mode* parameter was added.
290290

291291
.. versionchanged:: 3.7.2
292-
The *invalidation_mode* parameter's default value is updated to None.
292+
The *invalidation_mode* parameter's default value is updated to ``None``.
293293

294294
.. versionchanged:: 3.9
295295
Added *stripdir*, *prependdir*, *limit_sl_dest* and *hardlink_dupes* arguments.
@@ -318,7 +318,7 @@ Public functions
318318
The *invalidation_mode* parameter was added.
319319

320320
.. versionchanged:: 3.7.2
321-
The *invalidation_mode* parameter's default value is updated to None.
321+
The *invalidation_mode* parameter's default value is updated to ``None``.
322322

323323
To force a recompile of all the :file:`.py` files in the :file:`Lib/`
324324
subdirectory and all its subdirectories::

‎Doc/library/csv.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -349,8 +349,8 @@ The :mod:`csv` module defines the following constants:
349349
``None``. This is similar to :data:`QUOTE_ALL`, except that if a
350350
field value is ``None`` an empty (unquoted) string is written.
351351

352-
Instructs :class:`reader` objects to interpret an empty (unquoted) field as None and
353-
to otherwise behave as :data:`QUOTE_ALL`.
352+
Instructs :class:`reader` objects to interpret an empty (unquoted) field
353+
as ``None`` and to otherwise behave as :data:`QUOTE_ALL`.
354354

355355
.. versionadded:: 3.12
356356

‎Doc/library/dataclasses.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ Module contents
278278
generated equality and comparison methods (:meth:`~object.__eq__`,
279279
:meth:`~object.__gt__`, et al.).
280280

281-
- *metadata*: This can be a mapping or None. None is treated as
281+
- *metadata*: This can be a mapping or ``None``. ``None`` is treated as
282282
an empty dict. This value is wrapped in
283283
:func:`~types.MappingProxyType` to make it read-only, and exposed
284284
on the :class:`Field` object. It is not used at all by Data

‎Doc/library/functools.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@ The :mod:`functools` module defines the following functions:
325325
.. versionadded:: 3.2
326326

327327
.. versionchanged:: 3.4
328-
Returning NotImplemented from the underlying comparison function for
328+
Returning ``NotImplemented`` from the underlying comparison function for
329329
unrecognised types is now supported.
330330

331331
.. function:: partial(func, /, *args, **keywords)

‎Doc/library/gc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ The :mod:`gc` module provides the following functions:
6969
.. function:: get_objects(generation=None)
7070

7171
Returns a list of all objects tracked by the collector, excluding the list
72-
returned. If *generation* is not None, return only the objects tracked by
72+
returned. If *generation* is not ``None``, return only the objects tracked by
7373
the collector that are in that generation.
7474

7575
.. versionchanged:: 3.8

‎Doc/library/gzip.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ The module defines the following items:
102102

103103
The optional *mtime* argument is the timestamp requested by gzip. The time
104104
is in Unix format, i.e., seconds since 00:00:00 UTC, January 1, 1970.
105-
If *mtime* is omitted or None, the current time is used. Use *mtime* = 0
105+
If *mtime* is omitted or ``None``, the current time is used. Use *mtime* = 0
106106
to generate a compressed stream that does not depend on creation time.
107107

108108
See below for the :attr:`mtime` attribute that is set when decompressing.

‎Doc/library/imaplib.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ base class:
3939
initialized. If *host* is not specified, ``''`` (the local host) is used. If
4040
*port* is omitted, the standard IMAP4 port (143) is used. The optional *timeout*
4141
parameter specifies a timeout in seconds for the connection attempt.
42-
If timeout is not given or is None, the global default socket timeout is used.
42+
If timeout is not given or is ``None``, the global default socket timeout is used.
4343

4444
The :class:`IMAP4` class supports the :keyword:`with` statement. When used
4545
like this, the IMAP4 ``LOGOUT`` command is issued automatically when the
@@ -97,7 +97,7 @@ There's also a subclass for secure connections:
9797
best practices.
9898

9999
The optional *timeout* parameter specifies a timeout in seconds for the
100-
connection attempt. If timeout is not given or is None, the global default
100+
connection attempt. If timeout is not given or is ``None``, the global default
101101
socket timeout is used.
102102

103103
.. versionchanged:: 3.3
@@ -360,7 +360,7 @@ An :class:`IMAP4` instance has the following methods:
360360

361361
Opens socket to *port* at *host*. The optional *timeout* parameter
362362
specifies a timeout in seconds for the connection attempt.
363-
If timeout is not given or is None, the global default socket timeout
363+
If timeout is not given or is ``None``, the global default socket timeout
364364
is used. Also note that if the *timeout* parameter is set to be zero,
365365
it will raise a :class:`ValueError` to reject creating a non-blocking socket.
366366
This method is implicitly called by the :class:`IMAP4` constructor.

‎Doc/library/importlib.resources.abc.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,11 @@
103103

104104
.. abstractmethod:: is_dir()
105105

106-
Return True if self is a directory.
106+
Return ``True`` if self is a directory.
107107

108108
.. abstractmethod:: is_file()
109109

110-
Return True if self is a file.
110+
Return ``True`` if self is a file.
111111

112112
.. abstractmethod:: joinpath(*pathsegments)
113113

‎Doc/library/logging.handlers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ and :meth:`flush` methods).
6666

6767
:param stream: The stream that the handler should use.
6868

69-
:return: the old stream, if the stream was changed, or *None* if it wasn't.
69+
:return: the old stream, if the stream was changed, or ``None`` if it wasn't.
7070

7171
.. versionadded:: 3.7
7272

‎Doc/library/math.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ Number-theoretic and representation functions
268268
Evaluates to ``n! / (n - k)!`` when ``k <= n`` and evaluates
269269
to zero when ``k > n``.
270270

271-
If *k* is not specified or is None, then *k* defaults to *n*
271+
If *k* is not specified or is ``None``, then *k* defaults to *n*
272272
and the function returns ``n!``.
273273

274274
Raises :exc:`TypeError` if either of the arguments are not integers.

‎Doc/library/multiprocessing.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2483,9 +2483,9 @@ multiple connections at the same time.
24832483
generally be omitted since it can usually be inferred from the format of
24842484
*address*. (See :ref:`multiprocessing-address-formats`)
24852485

2486-
If *authkey* is given and not None, it should be a byte string and will be
2486+
If *authkey* is given and not ``None``, it should be a byte string and will be
24872487
used as the secret key for an HMAC-based authentication challenge. No
2488-
authentication is done if *authkey* is None.
2488+
authentication is done if *authkey* is ``None``.
24892489
:exc:`~multiprocessing.AuthenticationError` is raised if authentication fails.
24902490
See :ref:`multiprocessing-auth-keys`.
24912491

@@ -2518,9 +2518,9 @@ multiple connections at the same time.
25182518
to the :meth:`~socket.socket.listen` method of the socket once it has been
25192519
bound.
25202520

2521-
If *authkey* is given and not None, it should be a byte string and will be
2521+
If *authkey* is given and not ``None``, it should be a byte string and will be
25222522
used as the secret key for an HMAC-based authentication challenge. No
2523-
authentication is done if *authkey* is None.
2523+
authentication is done if *authkey* is ``None``.
25242524
:exc:`~multiprocessing.AuthenticationError` is raised if authentication fails.
25252525
See :ref:`multiprocessing-auth-keys`.
25262526

‎Doc/library/os.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -923,7 +923,7 @@ as internal buffering of data.
923923

924924
Copy *count* bytes from file descriptor *src*, starting from offset
925925
*offset_src*, to file descriptor *dst*, starting from offset *offset_dst*.
926-
If *offset_src* is None, then *src* is read from the current position;
926+
If *offset_src* is ``None``, then *src* is read from the current position;
927927
respectively for *offset_dst*.
928928

929929
In Linux kernel older than 5.3, the files pointed to by *src* and *dst*
@@ -1718,7 +1718,7 @@ or `the MSDN <https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Windo
17181718
Transfer *count* bytes from file descriptor *src*, starting from offset
17191719
*offset_src*, to file descriptor *dst*, starting from offset *offset_dst*.
17201720
At least one of the file descriptors must refer to a pipe. If *offset_src*
1721-
is None, then *src* is read from the current position; respectively for
1721+
is ``None``, then *src* is read from the current position; respectively for
17221722
*offset_dst*. The offset associated to the file descriptor that refers to a
17231723
pipe must be ``None``. The files pointed to by *src* and *dst* must reside in
17241724
the same filesystem, otherwise an :exc:`OSError` is raised with

‎Doc/library/pathlib.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -627,8 +627,8 @@ Pure paths provide the following methods and properties:
627627
raise ValueError(error_message.format(str(self), str(formatted)))
628628
ValueError: '/etc/passwd' is not in the subpath of '/usr' OR one path is relative and the other is absolute.
629629

630-
When *walk_up* is False (the default), the path must start with *other*.
631-
When the argument is True, ``..`` entries may be added to form the
630+
When *walk_up* is false (the default), the path must start with *other*.
631+
When the argument is true, ``..`` entries may be added to form the
632632
relative path. In all other cases, such as the paths referencing
633633
different drives, :exc:`ValueError` is raised.::
634634

‎Doc/library/pickle.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -314,16 +314,16 @@ The :mod:`pickle` module exports three classes, :class:`Pickler`,
314314
map the new Python 3 names to the old module names used in Python 2, so
315315
that the pickle data stream is readable with Python 2.
316316

317-
If *buffer_callback* is None (the default), buffer views are
317+
If *buffer_callback* is ``None`` (the default), buffer views are
318318
serialized into *file* as part of the pickle stream.
319319

320-
If *buffer_callback* is not None, then it can be called any number
320+
If *buffer_callback* is not ``None``, then it can be called any number
321321
of times with a buffer view. If the callback returns a false value
322-
(such as None), the given buffer is :ref:`out-of-band <pickle-oob>`;
322+
(such as ``None``), the given buffer is :ref:`out-of-band <pickle-oob>`;
323323
otherwise the buffer is serialized in-band, i.e. inside the pickle stream.
324324

325-
It is an error if *buffer_callback* is not None and *protocol* is
326-
None or smaller than 5.
325+
It is an error if *buffer_callback* is not ``None`` and *protocol* is
326+
``None`` or smaller than 5.
327327

328328
.. versionchanged:: 3.8
329329
The *buffer_callback* argument was added.
@@ -420,12 +420,12 @@ The :mod:`pickle` module exports three classes, :class:`Pickler`,
420420
instances of :class:`~datetime.datetime`, :class:`~datetime.date` and
421421
:class:`~datetime.time` pickled by Python 2.
422422

423-
If *buffers* is None (the default), then all data necessary for
423+
If *buffers* is ``None`` (the default), then all data necessary for
424424
deserialization must be contained in the pickle stream. This means
425-
that the *buffer_callback* argument was None when a :class:`Pickler`
425+
that the *buffer_callback* argument was ``None`` when a :class:`Pickler`
426426
was instantiated (or when :func:`dump` or :func:`dumps` was called).
427427

428-
If *buffers* is not None, it should be an iterable of buffer-enabled
428+
If *buffers* is not ``None``, it should be an iterable of buffer-enabled
429429
objects that is consumed each time the pickle stream references
430430
an :ref:`out-of-band <pickle-oob>` buffer view. Such buffers have been
431431
given in order to the *buffer_callback* of a Pickler object.

‎Doc/library/pyclbr.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Class Objects
142142

143143
.. attribute:: parent
144144

145-
For top-level classes, None. For nested classes, the parent.
145+
For top-level classes, ``None``. For nested classes, the parent.
146146

147147
.. versionadded:: 3.7
148148

‎Doc/library/statistics.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ However, for reading convenience, most of the examples show sorted sequences.
220220
.. function:: harmonic_mean(data, weights=None)
221221

222222
Return the harmonic mean of *data*, a sequence or iterable of
223-
real-valued numbers. If *weights* is omitted or *None*, then
223+
real-valued numbers. If *weights* is omitted or ``None``, then
224224
equal weighting is assumed.
225225

226226
The harmonic mean is the reciprocal of the arithmetic :func:`mean` of the

‎Doc/library/sys.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1708,7 +1708,7 @@ always available.
17081708
contain a tuple of (filename, line number, function name) tuples
17091709
describing the traceback where the coroutine object was created,
17101710
with the most recent call first. When disabled, ``cr_origin`` will
1711-
be None.
1711+
be ``None``.
17121712

17131713
To enable, pass a *depth* value greater than zero; this sets the
17141714
number of frames whose information will be captured. To disable,

‎Doc/library/test.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ The :mod:`test.support` module defines the following constants:
324324

325325
.. data:: Py_DEBUG
326326

327-
True if Python was built with the :c:macro:`Py_DEBUG` macro
327+
``True`` if Python was built with the :c:macro:`Py_DEBUG` macro
328328
defined, that is, if
329329
Python was :ref:`built in debug mode <debug-build>`.
330330

0 commit comments

Comments
 (0)
0