Deploying to gh-pages from @ aa8e180 🚀

Author: mattwang44

_sources/c-api/arg.rst.txt

@@ -5,7 +5,7 @@
 Parsing arguments and building values
 =====================================
 
-These functions are useful when creating your own extensions functions and
+These functions are useful when creating your own extension functions and
 methods.  Additional information and examples are available in
 :ref:`extending-index`.
 

_sources/c-api/module.rst.txt

@@ -415,7 +415,7 @@ The available slot types are:
    in one module definition.
 
    If ``Py_mod_multiple_interpreters`` is not specified, the import
-   machinery defaults to ``Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED``.
+   machinery defaults to ``Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED``.
 
    .. versionadded:: 3.12
 

_sources/c-api/unicode.rst.txt

@@ -607,6 +607,15 @@ APIs:
    decref'ing the returned objects.
 
 
+.. c:function:: const char* PyUnicode_GetDefaultEncoding(void)
+
+   Return the name of the default string encoding, ``"utf-8"``.
+   See :func:`sys.getdefaultencoding`.
+
+   The returned string does not need to be freed, and is valid
+   until interpreter shutdown.
+
+
 .. c:function:: Py_ssize_t PyUnicode_GetLength(PyObject *unicode)
 
    Return the length of the Unicode object, in code points.

_sources/deprecations/pending-removal-in-3.15.rst.txt

@@ -55,6 +55,11 @@ Pending Removal in Python 3.15
     This function is only useful for Jython support, has a confusing API,
     and is largely untested.
 
+* :mod:`sysconfig`:
+
+  * The *check_home* argument of :func:`sysconfig.is_python_build` has been
+    deprecated since Python 3.12.
+
 * :mod:`threading`:
 
   * :func:`~threading.RLock` will take no arguments in Python 3.15.

_sources/deprecations/pending-removal-in-future.rst.txt

@@ -105,9 +105,6 @@ although there is currently no date scheduled for their removal.
   * ``ssl.TLSVersion.TLSv1``
   * ``ssl.TLSVersion.TLSv1_1``
 
-* :func:`sysconfig.is_python_build` *check_home* parameter is deprecated and
-  ignored.
-
 * :mod:`threading` methods:
 
   * :meth:`!threading.Condition.notifyAll`: use :meth:`~threading.Condition.notify_all`.

_sources/glossary.rst.txt

@@ -706,7 +706,7 @@ Glossary
       iterables include all sequence types (such as :class:`list`, :class:`str`,
       and :class:`tuple`) and some non-sequence types like :class:`dict`,
       :term:`file objects <file object>`, and objects of any classes you define
-      with an :meth:`~iterator.__iter__` method or with a
+      with an :meth:`~object.__iter__` method or with a
       :meth:`~object.__getitem__` method
       that implements :term:`sequence` semantics.
 

_sources/library/abc.rst.txt

@@ -141,18 +141,18 @@ a helper class :class:`ABC` to alternatively define ABCs through inheritance:
       MyIterable.register(Foo)
 
    The ABC ``MyIterable`` defines the standard iterable method,
-   :meth:`~iterator.__iter__`, as an abstract method.  The implementation given
+   :meth:`~object.__iter__`, as an abstract method.  The implementation given
    here can still be called from subclasses.  The :meth:`!get_iterator` method
    is also part of the ``MyIterable`` abstract base class, but it does not have
    to be overridden in non-abstract derived classes.
 
    The :meth:`__subclasshook__` class method defined here says that any class
-   that has an :meth:`~iterator.__iter__` method in its
+   that has an :meth:`~object.__iter__` method in its
    :attr:`~object.__dict__` (or in that of one of its base classes, accessed
    via the :attr:`~type.__mro__` list) is considered a ``MyIterable`` too.
 
    Finally, the last line makes ``Foo`` a virtual subclass of ``MyIterable``,
-   even though it does not define an :meth:`~iterator.__iter__` method (it uses
+   even though it does not define an :meth:`~object.__iter__` method (it uses
    the old-style iterable protocol, defined in terms of :meth:`~object.__len__` and
    :meth:`~object.__getitem__`).  Note that this will not make ``get_iterator``
    available as a method of ``Foo``, so it is provided separately.

_sources/library/collections.rst.txt

@@ -748,8 +748,8 @@ stack manipulations such as ``dup``, ``drop``, ``swap``, ``over``, ``pick``,
         returns or raises is then returned or raised by :meth:`~object.__getitem__`.
 
         Note that :meth:`__missing__` is *not* called for any operations besides
-        :meth:`~object.__getitem__`. This means that :meth:`get` will, like normal
-        dictionaries, return ``None`` as a default rather than using
+        :meth:`~object.__getitem__`. This means that :meth:`~dict.get` will, like
+        normal dictionaries, return ``None`` as a default rather than using
         :attr:`default_factory`.
 
 
@@ -849,8 +849,9 @@ they add the ability to access fields by name instead of position index.
     Returns a new tuple subclass named *typename*.  The new subclass is used to
     create tuple-like objects that have fields accessible by attribute lookup as
     well as being indexable and iterable.  Instances of the subclass also have a
-    helpful docstring (with typename and field_names) and a helpful :meth:`__repr__`
-    method which lists the tuple contents in a ``name=value`` format.
+    helpful docstring (with *typename* and *field_names*) and a helpful
+    :meth:`~object.__repr__` method which lists the tuple contents in a ``name=value``
+    format.
 
     The *field_names* are a sequence of strings such as ``['x', 'y']``.
     Alternatively, *field_names* can be a single string with each fieldname
@@ -894,10 +895,10 @@ they add the ability to access fields by name instead of position index.
        Added the *module* parameter.
 
     .. versionchanged:: 3.7
-       Removed the *verbose* parameter and the :attr:`_source` attribute.
+       Removed the *verbose* parameter and the :attr:`!_source` attribute.
 
     .. versionchanged:: 3.7
-       Added the *defaults* parameter and the :attr:`_field_defaults`
+       Added the *defaults* parameter and the :attr:`~somenamedtuple._field_defaults`
        attribute.
 
 .. doctest::
@@ -1109,7 +1110,7 @@ Some differences from :class:`dict` still remain:
   A regular :class:`dict` can emulate the order sensitive equality test with
   ``p == q and all(k1 == k2 for k1, k2 in zip(p, q))``.
 
-* The :meth:`popitem` method of :class:`OrderedDict` has a different
+* The :meth:`~OrderedDict.popitem` method of :class:`OrderedDict` has a different
   signature.  It accepts an optional argument to specify which item is popped.
 
   A regular :class:`dict` can emulate OrderedDict's ``od.popitem(last=True)``
@@ -1119,7 +1120,7 @@ Some differences from :class:`dict` still remain:
   with ``(k := next(iter(d)), d.pop(k))`` which will return and remove the
   leftmost (first) item if it exists.
 
-* :class:`OrderedDict` has a :meth:`move_to_end` method to efficiently
+* :class:`OrderedDict` has a :meth:`~OrderedDict.move_to_end` method to efficiently
   reposition an element to an endpoint.
 
   A regular :class:`dict` can emulate OrderedDict's ``od.move_to_end(k,
@@ -1130,7 +1131,7 @@ Some differences from :class:`dict` still remain:
   OrderedDict's ``od.move_to_end(k, last=False)`` which moves the key
   and its associated value to the leftmost (first) position.
 
-* Until Python 3.8, :class:`dict` lacked a :meth:`__reversed__` method.
+* Until Python 3.8, :class:`dict` lacked a :meth:`~object.__reversed__` method.
 
 
 .. class:: OrderedDict([items])
@@ -1185,7 +1186,7 @@ anywhere a regular dictionary is used.
 
 .. versionchanged:: 3.6
    With the acceptance of :pep:`468`, order is retained for keyword arguments
-   passed to the :class:`OrderedDict` constructor and its :meth:`update`
+   passed to the :class:`OrderedDict` constructor and its :meth:`~dict.update`
    method.
 
 .. versionchanged:: 3.9

_sources/library/constants.rst.txt

@@ -46,11 +46,12 @@ A small number of constants live in the built-in namespace.  They are:
 
       See :ref:`implementing-the-arithmetic-operations` for examples.
 
-   .. note::
+   .. caution::
 
-      ``NotImplementedError`` and :data:`!NotImplemented` are not interchangeable,
-      even though they have similar names and purposes.
-      See :exc:`NotImplementedError` for details on when to use it.
+      :data:`!NotImplemented` and :exc:`!NotImplementedError` are not
+      interchangeable. This constant should only be used as described
+      above; see :exc:`NotImplementedError` for details on correct usage
+      of the exception.
 
    .. versionchanged:: 3.9
       Evaluating :data:`!NotImplemented` in a boolean context is deprecated. While

_sources/library/email.errors.rst.txt

@@ -45,18 +45,12 @@ The following exception classes are defined in the :mod:`email.errors` module:
 
 .. exception:: MultipartConversionError()
 
-   Raised when a payload is added to a :class:`~email.message.Message` object
-   using :meth:`add_payload`, but the payload is already a scalar and the
-   message's :mailheader:`Content-Type` main type is not either
-   :mimetype:`multipart` or missing.  :exc:`MultipartConversionError` multiply
-   inherits from :exc:`MessageError` and the built-in :exc:`TypeError`.
-
-   Since :meth:`Message.add_payload` is deprecated, this exception is rarely
-   raised in practice.  However the exception may also be raised if the
-   :meth:`~email.message.Message.attach`
-   method is called on an instance of a class derived from
+   Raised if the :meth:`~email.message.Message.attach` method is called
+   on an instance of a class derived from
    :class:`~email.mime.nonmultipart.MIMENonMultipart` (e.g.
    :class:`~email.mime.image.MIMEImage`).
+   :exc:`MultipartConversionError` multiply
+   inherits from :exc:`MessageError` and the built-in :exc:`TypeError`.
 
 
 .. exception:: HeaderWriteError()
@@ -83,51 +77,72 @@ object would have a defect, but the containing messages would not.
 
 All defect classes are subclassed from :class:`email.errors.MessageDefect`.
 
-* :class:`NoBoundaryInMultipartDefect` -- A message claimed to be a multipart,
-  but had no :mimetype:`boundary` parameter.
+.. exception:: NoBoundaryInMultipartDefect
+
+   A message claimed to be a multipart, but had no :mimetype:`boundary`
+   parameter.
+
+.. exception:: StartBoundaryNotFoundDefect
+
+   The start boundary claimed in the :mailheader:`Content-Type` header was
+   never found.
+
+.. exception:: CloseBoundaryNotFoundDefect
+
+   A start boundary was found, but no corresponding close boundary was ever
+   found.
+
+   .. versionadded:: 3.3
+
+.. exception:: FirstHeaderLineIsContinuationDefect
+
+   The message had a continuation line as its first header line.
+
+.. exception:: MisplacedEnvelopeHeaderDefect
+
+   A "Unix From" header was found in the middle of a header block.
+
+.. exception:: MissingHeaderBodySeparatorDefect
+
+   A line was found while parsing headers that had no leading white space but
+   contained no ':'.  Parsing continues assuming that the line represents the
+   first line of the body.
 
-* :class:`StartBoundaryNotFoundDefect` -- The start boundary claimed in the
-  :mailheader:`Content-Type` header was never found.
+   .. versionadded:: 3.3
 
-* :class:`CloseBoundaryNotFoundDefect` -- A start boundary was found, but
-  no corresponding close boundary was ever found.
+.. exception:: MalformedHeaderDefect
 
-  .. versionadded:: 3.3
+   A header was found that was missing a colon, or was otherwise malformed.
 
-* :class:`FirstHeaderLineIsContinuationDefect` -- The message had a continuation
-  line as its first header line.
+   .. deprecated:: 3.3
+      This defect has not been used for several Python versions.
 
-* :class:`MisplacedEnvelopeHeaderDefect` - A "Unix From" header was found in the
-  middle of a header block.
+.. exception:: MultipartInvariantViolationDefect
 
-* :class:`MissingHeaderBodySeparatorDefect` - A line was found while parsing
-  headers that had no leading white space but contained no ':'.  Parsing
-  continues assuming that the line represents the first line of the body.
+   A message claimed to be a :mimetype:`multipart`, but no subparts were found.
+   Note that when a message has this defect, its
+   :meth:`~email.message.Message.is_multipart` method may return ``False``
+   even though its content type claims to be :mimetype:`multipart`.
 
-  .. versionadded:: 3.3
+.. exception:: InvalidBase64PaddingDefect
 
-* :class:`MalformedHeaderDefect` -- A header was found that was missing a colon,
-  or was otherwise malformed.
+   When decoding a block of base64 encoded bytes, the padding was not correct.
+   Enough padding is added to perform the decode, but the resulting decoded
+   bytes may be invalid.
 
-  .. deprecated:: 3.3
-     This defect has not been used for several Python versions.
+.. exception:: InvalidBase64CharactersDefect
 
-* :class:`MultipartInvariantViolationDefect` -- A message claimed to be a
-  :mimetype:`multipart`, but no subparts were found.  Note that when a message
-  has this defect, its :meth:`~email.message.Message.is_multipart` method may
-  return ``False`` even though its content type claims to be :mimetype:`multipart`.
+   When decoding a block of base64 encoded bytes, characters outside the base64
+   alphabet were encountered.  The characters are ignored, but the resulting
+   decoded bytes may be invalid.
 
-* :class:`InvalidBase64PaddingDefect` -- When decoding a block of base64
-  encoded bytes, the padding was not correct.  Enough padding is added to
-  perform the decode, but the resulting decoded bytes may be invalid.
+.. exception:: InvalidBase64LengthDefect
 
-* :class:`InvalidBase64CharactersDefect` -- When decoding a block of base64
-  encoded bytes, characters outside the base64 alphabet were encountered.
-  The characters are ignored, but the resulting decoded bytes may be invalid.
+   When decoding a block of base64 encoded bytes, the number of non-padding
+   base64 characters was invalid (1 more than a multiple of 4).  The encoded
+   block was kept as-is.
 
-* :class:`InvalidBase64LengthDefect` -- When decoding a block of base64 encoded
-  bytes, the number of non-padding base64 characters was invalid (1 more than
-  a multiple of 4).  The encoded block was kept as-is.
+.. exception:: InvalidDateDefect
 
-* :class:`InvalidDateDefect` -- When decoding an invalid or unparsable date field.
-  The original value is kept as-is.
+   When decoding an invalid or unparsable date field.  The original value is
+   kept as-is.