Skip to content

Commit 78863cf

Browse files
mattwang44mattwang44
committed
Deploying to gh-pages from @ 5066292 🚀
1 parent 88aa045 commit 78863cf

File tree

541 files changed

+5380
-5049
lines changed

Some content is hidden

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

541 files changed

+5380
-5049
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: 8d2a63f8d0d0e4817e06bdd0e3c1ff4a
3+
config: 504ff18b217855dba7d76c99e50837cf
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎_sources/c-api/exceptions.rst.txt

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -528,7 +528,8 @@ Querying the error indicator
528528
529529
.. note::
530530
531-
This function *does not* implicitly set the ``__traceback__``
531+
This function *does not* implicitly set the
532+
:attr:`~BaseException.__traceback__`
532533
attribute on the exception value. If setting the traceback
533534
appropriately is desired, the following additional snippet is needed::
534535
@@ -740,7 +741,8 @@ Exception Objects
740741
.. c:function:: PyObject* PyException_GetTraceback(PyObject *ex)
741742
742743
Return the traceback associated with the exception as a new reference, as
743-
accessible from Python through :attr:`__traceback__`. If there is no
744+
accessible from Python through the :attr:`~BaseException.__traceback__`
745+
attribute. If there is no
744746
traceback associated, this returns ``NULL``.
745747
746748
@@ -754,8 +756,8 @@ Exception Objects
754756
755757
Return the context (another exception instance during whose handling *ex* was
756758
raised) associated with the exception as a new reference, as accessible from
757-
Python through :attr:`__context__`. If there is no context associated, this
758-
returns ``NULL``.
759+
Python through the :attr:`~BaseException.__context__` attribute.
760+
If there is no context associated, this returns ``NULL``.
759761
760762
761763
.. c:function:: void PyException_SetContext(PyObject *ex, PyObject *ctx)
@@ -769,7 +771,8 @@ Exception Objects
769771
770772
Return the cause (either an exception instance, or ``None``,
771773
set by ``raise ... from ...``) associated with the exception as a new
772-
reference, as accessible from Python through :attr:`__cause__`.
774+
reference, as accessible from Python through the
775+
:attr:`~BaseException.__cause__` attribute.
773776
774777
775778
.. c:function:: void PyException_SetCause(PyObject *ex, PyObject *cause)
@@ -778,7 +781,8 @@ Exception Objects
778781
it. There is no type check to make sure that *cause* is either an exception
779782
instance or ``None``. This steals a reference to *cause*.
780783
781-
:attr:`__suppress_context__` is implicitly set to ``True`` by this function.
784+
The :attr:`~BaseException.__suppress_context__` attribute is implicitly set
785+
to ``True`` by this function.
782786
783787
784788
.. c:function:: PyObject* PyException_GetArgs(PyObject *ex)

‎_sources/library/collections.abc.rst.txt

Lines changed: 41 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
This module provides :term:`abstract base classes <abstract base class>` that
2424
can be used to test whether a class provides a particular interface; for
25-
example, whether it is :term:`hashable` or whether it is a mapping.
25+
example, whether it is :term:`hashable` or whether it is a :term:`mapping`.
2626

2727
An :func:`issubclass` or :func:`isinstance` test for an interface works in one
2828
of three ways.
@@ -73,7 +73,7 @@ of the API:
7373
>>> isinstance(D(), Sequence)
7474
True
7575

76-
In this example, class :class:`D` does not need to define
76+
In this example, class :class:`!D` does not need to define
7777
``__contains__``, ``__iter__``, and ``__reversed__`` because the
7878
:ref:`in-operator <comparisons>`, the :term:`iteration <iterable>`
7979
logic, and the :func:`reversed` function automatically fall back to
@@ -183,14 +183,14 @@ ABC Inherits from Abstract Methods Mi
183183

184184
.. rubric:: Footnotes
185185

186-
.. [1] These ABCs override :meth:`object.__subclasshook__` to support
186+
.. [1] These ABCs override :meth:`~abc.ABCMeta.__subclasshook__` to support
187187
testing an interface by verifying the required methods are present
188188
and have not been set to :const:`None`. This only works for simple
189189
interfaces. More complex interfaces require registration or direct
190190
subclassing.
191191
192192
.. [2] Checking ``isinstance(obj, Iterable)`` detects classes that are
193-
registered as :class:`Iterable` or that have an :meth:`__iter__`
193+
registered as :class:`Iterable` or that have an :meth:`~container.__iter__`
194194
method, but it does not detect classes that iterate with the
195195
:meth:`~object.__getitem__` method. The only reliable way to determine
196196
whether an object is :term:`iterable` is to call ``iter(obj)``.
@@ -202,26 +202,27 @@ Collections Abstract Base Classes -- Detailed Descriptions
202202

203203
.. class:: Container
204204

205-
ABC for classes that provide the :meth:`__contains__` method.
205+
ABC for classes that provide the :meth:`~object.__contains__` method.
206206

207207
.. class:: Hashable
208208

209-
ABC for classes that provide the :meth:`__hash__` method.
209+
ABC for classes that provide the :meth:`~object.__hash__` method.
210210

211211
.. class:: Sized
212212

213-
ABC for classes that provide the :meth:`__len__` method.
213+
ABC for classes that provide the :meth:`~object.__len__` method.
214214

215215
.. class:: Callable
216216

217-
ABC for classes that provide the :meth:`__call__` method.
217+
ABC for classes that provide the :meth:`~object.__call__` method.
218218

219219
.. class:: Iterable
220220

221-
ABC for classes that provide the :meth:`__iter__` method.
221+
ABC for classes that provide the :meth:`~container.__iter__` method.
222222

223223
Checking ``isinstance(obj, Iterable)`` detects classes that are registered
224-
as :class:`Iterable` or that have an :meth:`__iter__` method, but it does
224+
as :class:`Iterable` or that have an :meth:`~container.__iter__` method,
225+
but it does
225226
not detect classes that iterate with the :meth:`~object.__getitem__` method.
226227
The only reliable way to determine whether an object is :term:`iterable`
227228
is to call ``iter(obj)``.
@@ -240,17 +241,17 @@ Collections Abstract Base Classes -- Detailed Descriptions
240241

241242
.. class:: Reversible
242243

243-
ABC for iterable classes that also provide the :meth:`__reversed__`
244+
ABC for iterable classes that also provide the :meth:`~object.__reversed__`
244245
method.
245246

246247
.. versionadded:: 3.6
247248

248249
.. class:: Generator
249250

250-
ABC for generator classes that implement the protocol defined in
251-
:pep:`342` that extends iterators with the :meth:`~generator.send`,
251+
ABC for :term:`generator` classes that implement the protocol defined in
252+
:pep:`342` that extends :term:`iterators <iterator>` with the
253+
:meth:`~generator.send`,
252254
:meth:`~generator.throw` and :meth:`~generator.close` methods.
253-
See also the definition of :term:`generator`.
254255

255256
.. versionadded:: 3.5
256257

@@ -261,7 +262,7 @@ Collections Abstract Base Classes -- Detailed Descriptions
261262
ABCs for read-only and mutable :term:`sequences <sequence>`.
262263

263264
Implementation note: Some of the mixin methods, such as
264-
:meth:`__iter__`, :meth:`__reversed__` and :meth:`index`, make
265+
:meth:`~container.__iter__`, :meth:`~object.__reversed__` and :meth:`index`, make
265266
repeated calls to the underlying :meth:`~object.__getitem__` method.
266267
Consequently, if :meth:`~object.__getitem__` is implemented with constant
267268
access speed, the mixin methods will have linear performance;
@@ -282,7 +283,7 @@ Collections Abstract Base Classes -- Detailed Descriptions
282283
.. class:: Set
283284
MutableSet
284285

285-
ABCs for read-only and mutable sets.
286+
ABCs for read-only and mutable :ref:`sets <types-set>`.
286287

287288
.. class:: Mapping
288289
MutableMapping
@@ -299,42 +300,42 @@ Collections Abstract Base Classes -- Detailed Descriptions
299300
.. class:: Awaitable
300301

301302
ABC for :term:`awaitable` objects, which can be used in :keyword:`await`
302-
expressions. Custom implementations must provide the :meth:`__await__`
303-
method.
303+
expressions. Custom implementations must provide the
304+
:meth:`~object.__await__` method.
304305

305306
:term:`Coroutine <coroutine>` objects and instances of the
306307
:class:`~collections.abc.Coroutine` ABC are all instances of this ABC.
307308

308309
.. note::
309-
In CPython, generator-based coroutines (generators decorated with
310-
:func:`types.coroutine`) are
311-
*awaitables*, even though they do not have an :meth:`__await__` method.
310+
In CPython, generator-based coroutines (:term:`generators <generator>`
311+
decorated with :func:`@types.coroutine <types.coroutine>`) are
312+
*awaitables*, even though they do not have an :meth:`~object.__await__` method.
312313
Using ``isinstance(gencoro, Awaitable)`` for them will return ``False``.
313314
Use :func:`inspect.isawaitable` to detect them.
314315

315316
.. versionadded:: 3.5
316317

317318
.. class:: Coroutine
318319

319-
ABC for coroutine compatible classes. These implement the
320+
ABC for :term:`coroutine` compatible classes. These implement the
320321
following methods, defined in :ref:`coroutine-objects`:
321322
:meth:`~coroutine.send`, :meth:`~coroutine.throw`, and
322323
:meth:`~coroutine.close`. Custom implementations must also implement
323-
:meth:`__await__`. All :class:`Coroutine` instances are also instances of
324-
:class:`Awaitable`. See also the definition of :term:`coroutine`.
324+
:meth:`~object.__await__`. All :class:`Coroutine` instances are also
325+
instances of :class:`Awaitable`.
325326

326327
.. note::
327-
In CPython, generator-based coroutines (generators decorated with
328-
:func:`types.coroutine`) are
329-
*awaitables*, even though they do not have an :meth:`__await__` method.
328+
In CPython, generator-based coroutines (:term:`generators <generator>`
329+
decorated with :func:`@types.coroutine <types.coroutine>`) are
330+
*awaitables*, even though they do not have an :meth:`~object.__await__` method.
330331
Using ``isinstance(gencoro, Coroutine)`` for them will return ``False``.
331332
Use :func:`inspect.isawaitable` to detect them.
332333

333334
.. versionadded:: 3.5
334335

335336
.. class:: AsyncIterable
336337

337-
ABC for classes that provide ``__aiter__`` method. See also the
338+
ABC for classes that provide an ``__aiter__`` method. See also the
338339
definition of :term:`asynchronous iterable`.
339340

340341
.. versionadded:: 3.5
@@ -348,7 +349,7 @@ Collections Abstract Base Classes -- Detailed Descriptions
348349

349350
.. class:: AsyncGenerator
350351

351-
ABC for asynchronous generator classes that implement the protocol
352+
ABC for :term:`asynchronous generator` classes that implement the protocol
352353
defined in :pep:`525` and :pep:`492`.
353354

354355
.. versionadded:: 3.6
@@ -373,9 +374,9 @@ particular functionality, for example::
373374
Several of the ABCs are also useful as mixins that make it easier to develop
374375
classes supporting container APIs. For example, to write a class supporting
375376
the full :class:`Set` API, it is only necessary to supply the three underlying
376-
abstract methods: :meth:`__contains__`, :meth:`__iter__`, and :meth:`__len__`.
377-
The ABC supplies the remaining methods such as :meth:`__and__` and
378-
:meth:`isdisjoint`::
377+
abstract methods: :meth:`~object.__contains__`, :meth:`~container.__iter__`, and
378+
:meth:`~object.__len__`. The ABC supplies the remaining methods such as
379+
:meth:`!__and__` and :meth:`~frozenset.isdisjoint`::
379380

380381
class ListBasedSet(collections.abc.Set):
381382
''' Alternate set implementation favoring space over speed
@@ -403,23 +404,24 @@ Notes on using :class:`Set` and :class:`MutableSet` as a mixin:
403404

404405
(1)
405406
Since some set operations create new sets, the default mixin methods need
406-
a way to create new instances from an iterable. The class constructor is
407+
a way to create new instances from an :term:`iterable`. The class constructor is
407408
assumed to have a signature in the form ``ClassName(iterable)``.
408-
That assumption is factored-out to an internal classmethod called
409-
:meth:`_from_iterable` which calls ``cls(iterable)`` to produce a new set.
409+
That assumption is factored-out to an internal :class:`classmethod` called
410+
:meth:`!_from_iterable` which calls ``cls(iterable)`` to produce a new set.
410411
If the :class:`Set` mixin is being used in a class with a different
411-
constructor signature, you will need to override :meth:`_from_iterable`
412+
constructor signature, you will need to override :meth:`!_from_iterable`
412413
with a classmethod or regular method that can construct new instances from
413414
an iterable argument.
414415

415416
(2)
416417
To override the comparisons (presumably for speed, as the
417-
semantics are fixed), redefine :meth:`__le__` and :meth:`__ge__`,
418+
semantics are fixed), redefine :meth:`~object.__le__` and
419+
:meth:`~object.__ge__`,
418420
then the other operations will automatically follow suit.
419421

420422
(3)
421-
The :class:`Set` mixin provides a :meth:`_hash` method to compute a hash value
422-
for the set; however, :meth:`__hash__` is not defined because not all sets
423+
The :class:`Set` mixin provides a :meth:`!_hash` method to compute a hash value
424+
for the set; however, :meth:`~object.__hash__` is not defined because not all sets
423425
are :term:`hashable` or immutable. To add set hashability using mixins,
424426
inherit from both :meth:`Set` and :meth:`Hashable`, then define
425427
``__hash__ = Set._hash``.

‎_sources/library/doctest.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1477,7 +1477,7 @@ DocTestRunner objects
14771477
For more information, see section :ref:`doctest-options`.
14781478

14791479

1480-
:class:`DocTestParser` defines the following methods:
1480+
:class:`DocTestRunner` defines the following methods:
14811481

14821482

14831483
.. method:: report_start(out, test, example)

0 commit comments

Comments
 (0)