Skip to content

Commit d5a3606

Browse files
committed
Deploying to gh-pages from @ 77db681 🚀
1 parent e58950f commit d5a3606

File tree

546 files changed

+1067
-1003
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

546 files changed

+1067
-1003
lines changed

.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 7a764389baf1a95484db3d7b5e8a5e85
3+
config: 3ea43e60487463a8f0bf943db7da9fca
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/c-api/set.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ subtypes but not for instances of :class:`frozenset` or its subtypes.
147147
148148
Return ``1`` if found and removed, ``0`` if not found (no action taken), and ``-1`` if an
149149
error is encountered. Does not raise :exc:`KeyError` for missing keys. Raise a
150-
:exc:`TypeError` if the *key* is unhashable. Unlike the Python :meth:`~set.discard`
150+
:exc:`TypeError` if the *key* is unhashable. Unlike the Python :meth:`~frozenset.discard`
151151
method, this function does not automatically convert unhashable sets into
152152
temporary frozensets. Raise :exc:`SystemError` if *set* is not an
153153
instance of :class:`set` or its subtype.

_sources/extending/newtypes.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ An interesting advantage of using the :c:member:`~PyTypeObject.tp_members` table
296296
descriptors that are used at runtime is that any attribute defined this way can
297297
have an associated doc string simply by providing the text in the table. An
298298
application can use the introspection API to retrieve the descriptor from the
299-
class object, and get the doc string using its :attr:`__doc__` attribute.
299+
class object, and get the doc string using its :attr:`!__doc__` attribute.
300300

301301
As with the :c:member:`~PyTypeObject.tp_methods` table, a sentinel entry with a :c:member:`~PyMethodDef.ml_name` value
302302
of ``NULL`` is required.
@@ -448,7 +448,7 @@ instance of your data type. Here is a simple example::
448448
return result;
449449
}
450450

451-
:c:type:`Py_hash_t` is a signed integer type with a platform-varying width.
451+
:c:type:`!Py_hash_t` is a signed integer type with a platform-varying width.
452452
Returning ``-1`` from :c:member:`~PyTypeObject.tp_hash` indicates an error,
453453
which is why you should be careful to avoid returning it when hash computation
454454
is successful, as seen above.

_sources/howto/descriptor.rst.txt

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1013,17 +1013,23 @@ here is a pure Python equivalent:
10131013
if obj is None:
10141014
return self
10151015
if self.fget is None:
1016-
raise AttributeError(f"property '{self._name}' has no getter")
1016+
raise AttributeError(
1017+
f'property {self._name!r} of {type(obj).__name__!r} object has no getter'
1018+
)
10171019
return self.fget(obj)
10181020

10191021
def __set__(self, obj, value):
10201022
if self.fset is None:
1021-
raise AttributeError(f"property '{self._name}' has no setter")
1023+
raise AttributeError(
1024+
f'property {self._name!r} of {type(obj).__name__!r} object has no setter'
1025+
)
10221026
self.fset(obj, value)
10231027

10241028
def __delete__(self, obj):
10251029
if self.fdel is None:
1026-
raise AttributeError(f"property '{self._name}' has no deleter")
1030+
raise AttributeError(
1031+
f'property {self._name!r} of {type(obj).__name__!r} object has no deleter'
1032+
)
10271033
self.fdel(obj)
10281034

10291035
def getter(self, fget):
@@ -1054,6 +1060,11 @@ here is a pure Python equivalent:
10541060
def delx(self):
10551061
del self.__x
10561062
x = Property(getx, setx, delx, "I'm the 'x' property.")
1063+
no_getter = Property(None, setx, delx, "I'm the 'x' property.")
1064+
no_setter = Property(getx, None, delx, "I'm the 'x' property.")
1065+
no_deleter = Property(getx, setx, None, "I'm the 'x' property.")
1066+
no_doc = Property(getx, setx, delx, None)
1067+
10571068

10581069
# Now do it again but use the decorator style
10591070

@@ -1092,6 +1103,32 @@ here is a pure Python equivalent:
10921103
>>> hasattr(ccc, 'x')
10931104
False
10941105

1106+
>>> cc = CC()
1107+
>>> cc.x = 33
1108+
>>> try:
1109+
... cc.no_getter
1110+
... except AttributeError as e:
1111+
... e.args[0]
1112+
...
1113+
"property 'no_getter' of 'CC' object has no getter"
1114+
1115+
>>> try:
1116+
... cc.no_setter = 33
1117+
... except AttributeError as e:
1118+
... e.args[0]
1119+
...
1120+
"property 'no_setter' of 'CC' object has no setter"
1121+
1122+
>>> try:
1123+
... del cc.no_deleter
1124+
... except AttributeError as e:
1125+
... e.args[0]
1126+
...
1127+
"property 'no_deleter' of 'CC' object has no deleter"
1128+
1129+
>>> CC.no_doc.__doc__ is None
1130+
True
1131+
10951132
The :func:`property` builtin helps whenever a user interface has granted
10961133
attribute access and then subsequent changes require the intervention of a
10971134
method.

_sources/library/asyncio-stream.rst.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,10 @@ StreamReader
204204
directly; use :func:`open_connection` and :func:`start_server`
205205
instead.
206206

207+
.. method:: feed_eof()
208+
209+
Acknowledge the EOF.
210+
207211
.. coroutinemethod:: read(n=-1)
208212

209213
Read up to *n* bytes from the stream.

_sources/library/doctest.rst.txt

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -143,13 +143,13 @@ Simple Usage: Checking Examples in Docstrings
143143
---------------------------------------------
144144

145145
The simplest way to start using doctest (but not necessarily the way you'll
146-
continue to do it) is to end each module :mod:`M` with::
146+
continue to do it) is to end each module :mod:`!M` with::
147147

148148
if __name__ == "__main__":
149149
import doctest
150150
doctest.testmod()
151151

152-
:mod:`doctest` then examines docstrings in module :mod:`M`.
152+
:mod:`!doctest` then examines docstrings in module :mod:`!M`.
153153

154154
Running the module as a script causes the examples in the docstrings to get
155155
executed and verified::
@@ -403,10 +403,10 @@ What's the Execution Context?
403403
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
404404

405405
By default, each time :mod:`doctest` finds a docstring to test, it uses a
406-
*shallow copy* of :mod:`M`'s globals, so that running tests doesn't change the
407-
module's real globals, and so that one test in :mod:`M` can't leave behind
406+
*shallow copy* of :mod:`!M`'s globals, so that running tests doesn't change the
407+
module's real globals, and so that one test in :mod:`!M` can't leave behind
408408
crumbs that accidentally allow another test to work. This means examples can
409-
freely use any names defined at top-level in :mod:`M`, and names defined earlier
409+
freely use any names defined at top-level in :mod:`!M`, and names defined earlier
410410
in the docstring being run. Examples cannot see names defined in other
411411
docstrings.
412412

@@ -958,7 +958,8 @@ and :ref:`doctest-simple-testfile`.
958958

959959
Optional argument *exclude_empty* defaults to false. If true, objects for which
960960
no doctests are found are excluded from consideration. The default is a backward
961-
compatibility hack, so that code still using :meth:`doctest.master.summarize` in
961+
compatibility hack, so that code still using
962+
:meth:`doctest.master.summarize <DocTestRunner.summarize>` in
962963
conjunction with :func:`testmod` continues to get output for objects with no
963964
tests. The *exclude_empty* argument to the newer :class:`DocTestFinder`
964965
constructor defaults to true.
@@ -997,7 +998,7 @@ As your collection of doctest'ed modules grows, you'll want a way to run all
997998
their doctests systematically. :mod:`doctest` provides two functions that can
998999
be used to create :mod:`unittest` test suites from modules and text files
9991000
containing doctests. To integrate with :mod:`unittest` test discovery, include
1000-
a :func:`load_tests` function in your test module::
1001+
a :ref:`load_tests <load_tests-protocol>` function in your test module::
10011002

10021003
import unittest
10031004
import doctest
@@ -1111,19 +1112,24 @@ from text files and modules with doctests:
11111112
:func:`DocTestSuite` returns an empty :class:`unittest.TestSuite` if *module*
11121113
contains no docstrings instead of raising :exc:`ValueError`.
11131114

1115+
.. exception:: failureException
1116+
1117+
When doctests which have been converted to unit tests by :func:`DocFileSuite`
1118+
or :func:`DocTestSuite` fail, this exception is raised showing the name of
1119+
the file containing the test and a (sometimes approximate) line number.
11141120

11151121
Under the covers, :func:`DocTestSuite` creates a :class:`unittest.TestSuite` out
1116-
of :class:`doctest.DocTestCase` instances, and :class:`DocTestCase` is a
1117-
subclass of :class:`unittest.TestCase`. :class:`DocTestCase` isn't documented
1122+
of :class:`!doctest.DocTestCase` instances, and :class:`!DocTestCase` is a
1123+
subclass of :class:`unittest.TestCase`. :class:`!DocTestCase` isn't documented
11181124
here (it's an internal detail), but studying its code can answer questions about
11191125
the exact details of :mod:`unittest` integration.
11201126

11211127
Similarly, :func:`DocFileSuite` creates a :class:`unittest.TestSuite` out of
1122-
:class:`doctest.DocFileCase` instances, and :class:`DocFileCase` is a subclass
1123-
of :class:`DocTestCase`.
1128+
:class:`!doctest.DocFileCase` instances, and :class:`!DocFileCase` is a subclass
1129+
of :class:`!DocTestCase`.
11241130

11251131
So both ways of creating a :class:`unittest.TestSuite` run instances of
1126-
:class:`DocTestCase`. This is important for a subtle reason: when you run
1132+
:class:`!DocTestCase`. This is important for a subtle reason: when you run
11271133
:mod:`doctest` functions yourself, you can control the :mod:`doctest` options in
11281134
use directly, by passing option flags to :mod:`doctest` functions. However, if
11291135
you're writing a :mod:`unittest` framework, :mod:`unittest` ultimately controls
@@ -1144,14 +1150,14 @@ reporting flags specific to :mod:`unittest` support, via this function:
11441150
section :ref:`doctest-options`. Only "reporting flags" can be used.
11451151

11461152
This is a module-global setting, and affects all future doctests run by module
1147-
:mod:`unittest`: the :meth:`runTest` method of :class:`DocTestCase` looks at
1148-
the option flags specified for the test case when the :class:`DocTestCase`
1153+
:mod:`unittest`: the :meth:`!runTest` method of :class:`!DocTestCase` looks at
1154+
the option flags specified for the test case when the :class:`!DocTestCase`
11491155
instance was constructed. If no reporting flags were specified (which is the
1150-
typical and expected case), :mod:`doctest`'s :mod:`unittest` reporting flags are
1156+
typical and expected case), :mod:`!doctest`'s :mod:`unittest` reporting flags are
11511157
:ref:`bitwise ORed <bitwise>` into the option flags, and the option flags
11521158
so augmented are passed to the :class:`DocTestRunner` instance created to
11531159
run the doctest. If any reporting flags were specified when the
1154-
:class:`DocTestCase` instance was constructed, :mod:`doctest`'s
1160+
:class:`!DocTestCase` instance was constructed, :mod:`!doctest`'s
11551161
:mod:`unittest` reporting flags are ignored.
11561162

11571163
The value of the :mod:`unittest` reporting flags in effect before the function
@@ -1321,7 +1327,8 @@ Example Objects
13211327
A dictionary mapping from option flags to ``True`` or ``False``, which is used
13221328
to override default options for this example. Any option flags not contained
13231329
in this dictionary are left at their default value (as specified by the
1324-
:class:`DocTestRunner`'s :attr:`optionflags`). By default, no options are set.
1330+
:class:`DocTestRunner`'s :ref:`optionflags <doctest-options>`).
1331+
By default, no options are set.
13251332

13261333

13271334
.. _doctest-doctestfinder:
@@ -1448,7 +1455,7 @@ DocTestRunner objects
14481455
passing a subclass of :class:`OutputChecker` to the constructor.
14491456

14501457
The test runner's display output can be controlled in two ways. First, an output
1451-
function can be passed to :meth:`TestRunner.run`; this function will be called
1458+
function can be passed to :meth:`run`; this function will be called
14521459
with strings that should be displayed. It defaults to ``sys.stdout.write``. If
14531460
capturing the output is not sufficient, then the display output can be also
14541461
customized by subclassing DocTestRunner, and overriding the methods
@@ -1534,7 +1541,7 @@ DocTestRunner objects
15341541

15351542
The output of each example is checked using the :class:`DocTestRunner`'s
15361543
output checker, and the results are formatted by the
1537-
:meth:`DocTestRunner.report_\*` methods.
1544+
:meth:`!DocTestRunner.report_\*` methods.
15381545

15391546

15401547
.. method:: summarize(verbose=None)
@@ -1692,12 +1699,12 @@ code under the debugger:
16921699
module) of the object with the doctests of interest. The result is a string,
16931700
containing the object's docstring converted to a Python script, as described for
16941701
:func:`script_from_examples` above. For example, if module :file:`a.py`
1695-
contains a top-level function :func:`f`, then ::
1702+
contains a top-level function :func:`!f`, then ::
16961703

16971704
import a, doctest
16981705
print(doctest.testsource(a, "a.f"))
16991706

1700-
prints a script version of function :func:`f`'s docstring, with doctests
1707+
prints a script version of function :func:`!f`'s docstring, with doctests
17011708
converted to code, and the rest placed in comments.
17021709

17031710

_sources/library/email.errors.rst.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,15 @@ The following exception classes are defined in the :mod:`email.errors` module:
5858
:class:`~email.mime.nonmultipart.MIMENonMultipart` (e.g.
5959
:class:`~email.mime.image.MIMEImage`).
6060

61+
.. exception:: MessageDefect()
62+
63+
This is the base class for all defects found when parsing email messages.
64+
It is derived from :exc:`ValueError`.
65+
66+
.. exception:: HeaderDefect()
67+
68+
This is the base class for all defects found when parsing email headers.
69+
It is derived from :exc:`MessageDefect`.
6170

6271
Here is the list of the defects that the :class:`~email.parser.FeedParser`
6372
can find while parsing messages. Note that the defects are added to the message

_sources/library/functions.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1221,7 +1221,7 @@ are always available. They are listed here in alphabetical order.
12211221

12221222
*buffering* is an optional integer used to set the buffering policy. Pass 0
12231223
to switch buffering off (only allowed in binary mode), 1 to select line
1224-
buffering (only usable in text mode), and an integer > 1 to indicate the size
1224+
buffering (only usable when writing in text mode), and an integer > 1 to indicate the size
12251225
in bytes of a fixed-size chunk buffer. Note that specifying a buffer size this
12261226
way applies for binary buffered I/O, but ``TextIOWrapper`` (i.e., files opened
12271227
with ``mode='r+'``) would have another buffering. To disable buffering in

_sources/library/gzip.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ The module defines the following items:
105105
should only be provided in compression mode. If omitted or ``None``, the
106106
current time is used. See the :attr:`mtime` attribute for more details.
107107

108-
Calling a :class:`GzipFile` object's :meth:`close` method does not close
108+
Calling a :class:`GzipFile` object's :meth:`!close` method does not close
109109
*fileobj*, since you might wish to append more material after the compressed
110110
data. This also allows you to pass an :class:`io.BytesIO` object opened for
111111
writing as *fileobj*, and retrieve the resulting memory buffer using the

_sources/library/importlib.resources.rst.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ for example, a package and its resources can be imported from a zip file using
5050
``get_resource_reader(fullname)`` method as specified by
5151
:class:`importlib.resources.abc.ResourceReader`.
5252

53-
.. data:: Anchor
53+
.. class:: Anchor
5454

5555
Represents an anchor for resources, either a :class:`module object
5656
<types.ModuleType>` or a module name as a string. Defined as
@@ -63,7 +63,7 @@ for example, a package and its resources can be imported from a zip file using
6363
(think files). A Traversable may contain other containers (think
6464
subdirectories).
6565

66-
*anchor* is an optional :data:`Anchor`. If the anchor is a
66+
*anchor* is an optional :class:`Anchor`. If the anchor is a
6767
package, resources are resolved from that package. If a module,
6868
resources are resolved adjacent to that module (in the same package
6969
or the package root). If the anchor is omitted, the caller's module
@@ -72,10 +72,10 @@ for example, a package and its resources can be imported from a zip file using
7272
.. versionadded:: 3.9
7373

7474
.. versionchanged:: 3.12
75-
"package" parameter was renamed to "anchor". "anchor" can now
75+
*package* parameter was renamed to *anchor*. *anchor* can now
7676
be a non-package module and if omitted will default to the caller's
77-
module. "package" is still accepted for compatibility but will raise
78-
a DeprecationWarning. Consider passing the anchor positionally or
77+
module. *package* is still accepted for compatibility but will raise
78+
a :exc:`DeprecationWarning`. Consider passing the anchor positionally or
7979
using ``importlib_resources >= 5.10`` for a compatible interface
8080
on older Pythons.
8181

@@ -96,7 +96,7 @@ for example, a package and its resources can be imported from a zip file using
9696
.. versionadded:: 3.9
9797

9898
.. versionchanged:: 3.12
99-
Added support for ``traversable`` representing a directory.
99+
Added support for *traversable* representing a directory.
100100

101101

102102
Deprecated functions

0 commit comments

Comments
 (0)