Return ``1`` if found and removed, ``0`` if not found (no action taken), and ``-1`` if an
error is encountered. Does not raise :exc:`KeyError` for missing keys. Raise a
- :exc:`TypeError` if the *key* is unhashable. Unlike the Python :meth:`~set.discard`
+ :exc:`TypeError` if the *key* is unhashable. Unlike the Python :meth:`~frozenset.discard`
method, this function does not automatically convert unhashable sets into
temporary frozensets. Raise :exc:`SystemError` if *set* is not an
instance of :class:`set` or its subtype.
descriptors that are used at runtime is that any attribute defined this way can
have an associated doc string simply by providing the text in the table. An
application can use the introspection API to retrieve the descriptor from the
-class object, and get the doc string using its :attr:`__doc__` attribute.
+class object, and get the doc string using its :attr:`!__doc__` attribute.
As with the :c:member:`~PyTypeObject.tp_methods` table, a sentinel entry with a :c:member:`~PyMethodDef.ml_name` value
of ``NULL`` is required.
return result;
}
-:c:type:`Py_hash_t` is a signed integer type with a platform-varying width.
+:c:type:`!Py_hash_t` is a signed integer type with a platform-varying width.
Returning ``-1`` from :c:member:`~PyTypeObject.tp_hash` indicates an error,
which is why you should be careful to avoid returning it when hash computation
is successful, as seen above.
directly; use :func:`open_connection` and :func:`start_server`
instead.
+ .. method:: feed_eof()
+
+ Acknowledge the EOF.
+
.. coroutinemethod:: read(n=-1)
Read up to *n* bytes from the stream.
:class:`~email.mime.nonmultipart.MIMENonMultipart` (e.g.
:class:`~email.mime.image.MIMEImage`).
+.. exception:: MessageDefect()
+
+ This is the base class for all defects found when parsing email messages.
+ It is derived from :exc:`ValueError`.
+
+.. exception:: HeaderDefect()
+
+ This is the base class for all defects found when parsing email headers.
+ It is derived from :exc:`MessageDefect`.
Here is the list of the defects that the :class:`~email.parser.FeedParser`
can find while parsing messages. Note that the defects are added to the message
should only be provided in compression mode. If omitted or ``None``, the
current time is used. See the :attr:`mtime` attribute for more details.
- Calling a :class:`GzipFile` object's :meth:`close` method does not close
+ Calling a :class:`GzipFile` object's :meth:`!close` method does not close
*fileobj*, since you might wish to append more material after the compressed
data. This also allows you to pass an :class:`io.BytesIO` object opened for
writing as *fileobj*, and retrieve the resulting memory buffer using the
``get_resource_reader(fullname)`` method as specified by
:class:`importlib.resources.abc.ResourceReader`.
-.. data:: Anchor
+.. class:: Anchor
Represents an anchor for resources, either a :class:`module object
<types.ModuleType>` or a module name as a string. Defined as
(think files). A Traversable may contain other containers (think
subdirectories).
- *anchor* is an optional :data:`Anchor`. If the anchor is a
+ *anchor* is an optional :class:`Anchor`. If the anchor is a
package, resources are resolved from that package. If a module,
resources are resolved adjacent to that module (in the same package
or the package root). If the anchor is omitted, the caller's module
.. versionadded:: 3.9
.. versionchanged:: 3.12
- "package" parameter was renamed to "anchor". "anchor" can now
+ *package* parameter was renamed to *anchor*. *anchor* can now
be a non-package module and if omitted will default to the caller's
- module. "package" is still accepted for compatibility but will raise
- a DeprecationWarning. Consider passing the anchor positionally or
+ module. *package* is still accepted for compatibility but will raise
+ a :exc:`DeprecationWarning`. Consider passing the anchor positionally or
using ``importlib_resources >= 5.10`` for a compatible interface
on older Pythons.
.. versionadded:: 3.9
.. versionchanged:: 3.12
- Added support for ``traversable`` representing a directory.
+ Added support for *traversable* representing a directory.
Deprecated functions
1. Expat 2.4.1 and newer is not vulnerable to the "billion laughs" and
"quadratic blowup" vulnerabilities. Items still listed as vulnerable due to
potential reliance on system-provided libraries. Check
- :const:`pyexpat.EXPAT_VERSION`.
+ :const:`!pyexpat.EXPAT_VERSION`.
2. :mod:`xml.etree.ElementTree` doesn't expand external entities and raises a
:exc:`~xml.etree.ElementTree.ParseError` when an entity occurs.
3. :mod:`xml.dom.minidom` doesn't expand external entities and simply returns
Doc/c-api/memoryview.rst
Doc/c-api/module.rst
Doc/c-api/object.rst
-Doc/c-api/set.rst
Doc/c-api/stable.rst
Doc/c-api/structures.rst
Doc/c-api/sys.rst
Doc/c-api/type.rst
Doc/c-api/typeobj.rst
Doc/extending/extending.rst
-Doc/extending/newtypes.rst
Doc/glossary.rst
Doc/howto/descriptor.rst
Doc/howto/enum.rst
Doc/library/ast.rst
Doc/library/asyncio-extending.rst
Doc/library/asyncio-policy.rst
-Doc/library/asyncio-stream.rst
Doc/library/asyncio-subprocess.rst
Doc/library/asyncio-task.rst
Doc/library/audioop.rst
Doc/library/email.charset.rst
Doc/library/email.compat32-message.rst
Doc/library/email.errors.rst
-Doc/library/email.headerregistry.rst
Doc/library/email.mime.rst
Doc/library/email.parser.rst
Doc/library/email.policy.rst
Doc/library/functools.rst
Doc/library/getopt.rst
Doc/library/gettext.rst
-Doc/library/gzip.rst
Doc/library/http.client.rst
Doc/library/http.cookiejar.rst
Doc/library/http.cookies.rst
Doc/library/http.server.rst
-Doc/library/importlib.resources.rst
Doc/library/importlib.rst
Doc/library/inspect.rst
Doc/library/locale.rst
Doc/library/xml.dom.minidom.rst
Doc/library/xml.dom.pulldom.rst
Doc/library/xml.dom.rst
-Doc/library/xml.rst
Doc/library/xml.sax.handler.rst
Doc/library/xml.sax.reader.rst
Doc/library/xml.sax.rst
projects / thirdparty / Python / cpython.git / commitdiff
