https://github.com/python/cpython/commit/a105f990199f99a352efd481ac039604feceaab5 commit: a105f990199f99a352efd481ac039604feceaab5 branch: main author: Yuki Kobayashi <drsuaimqj...@gmail.com> committer: hugovk <1324225+hug...@users.noreply.github.com> date: 2025-03-03T11:56:45+02:00 summary:
gh-101100: Fix sphinx warnings in `library/email.errors.rst` (#130774) files: M Doc/library/email.errors.rst M Doc/tools/.nitignore diff --git a/Doc/library/email.errors.rst b/Doc/library/email.errors.rst index 61142d58ca8280..689e7397cbcf1f 100644 --- a/Doc/library/email.errors.rst +++ b/Doc/library/email.errors.rst @@ -77,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 -* :class:`StartBoundaryNotFoundDefect` -- The start boundary claimed in the - :mailheader:`Content-Type` header was never found. + A message claimed to be a multipart, but had no :mimetype:`boundary` + parameter. -* :class:`CloseBoundaryNotFoundDefect` -- A start boundary was found, but - no corresponding close boundary was ever found. +.. exception:: StartBoundaryNotFoundDefect - .. versionadded:: 3.3 + The start boundary claimed in the :mailheader:`Content-Type` header was + never found. -* :class:`FirstHeaderLineIsContinuationDefect` -- The message had a continuation - line as its first header line. +.. exception:: CloseBoundaryNotFoundDefect -* :class:`MisplacedEnvelopeHeaderDefect` - A "Unix From" header was found in the - middle of a header block. + A start boundary was found, but no corresponding close boundary was ever + found. -* :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. + .. versionadded:: 3.3 - .. versionadded:: 3.3 +.. exception:: FirstHeaderLineIsContinuationDefect -* :class:`MalformedHeaderDefect` -- A header was found that was missing a colon, - or was otherwise malformed. + The message had a continuation line as its first header line. - .. deprecated:: 3.3 - This defect has not been used for several Python versions. +.. exception:: MisplacedEnvelopeHeaderDefect -* :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`. + A "Unix From" header was found in the middle of a header block. -* :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:: MissingHeaderBodySeparatorDefect -* :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. + 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:`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. + .. versionadded:: 3.3 -* :class:`InvalidDateDefect` -- When decoding an invalid or unparsable date field. - The original value is kept as-is. +.. exception:: MalformedHeaderDefect + + A header was found that was missing a colon, or was otherwise malformed. + + .. deprecated:: 3.3 + This defect has not been used for several Python versions. + +.. exception:: 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`. + +.. exception:: 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:: 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. + +.. exception:: 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 + + When decoding an invalid or unparsable date field. The original value is + kept as-is. diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore index 8ca7c7727574f4..a158d447d4732e 100644 --- a/Doc/tools/.nitignore +++ b/Doc/tools/.nitignore @@ -18,7 +18,6 @@ Doc/library/asyncio-subprocess.rst Doc/library/decimal.rst Doc/library/email.charset.rst Doc/library/email.compat32-message.rst -Doc/library/email.errors.rst Doc/library/email.parser.rst Doc/library/exceptions.rst Doc/library/functools.rst _______________________________________________ Python-checkins mailing list -- python-checkins@python.org To unsubscribe send an email to python-checkins-le...@python.org https://mail.python.org/mailman3/lists/python-checkins.python.org/ Member address: arch...@mail-archive.com
