Commit 003014bf authored by Ezio Melotti's avatar Ezio Melotti

#15980: properly escape newlines in docstrings. Patch by Serhiy Storchaka.

parent 3d2fc15f
...@@ -48,7 +48,7 @@ def lwp_cookie_str(cookie): ...@@ -48,7 +48,7 @@ def lwp_cookie_str(cookie):
class LWPCookieJar(FileCookieJar): class LWPCookieJar(FileCookieJar):
""" """
The LWPCookieJar saves a sequence of"Set-Cookie3" lines. The LWPCookieJar saves a sequence of "Set-Cookie3" lines.
"Set-Cookie3" is the format used by the libwww-perl libary, not known "Set-Cookie3" is the format used by the libwww-perl libary, not known
to be compatible with any browser, but which is easy to read and to be compatible with any browser, but which is easy to read and
doesn't lose information about RFC 2965 cookies. doesn't lose information about RFC 2965 cookies.
...@@ -60,7 +60,7 @@ class LWPCookieJar(FileCookieJar): ...@@ -60,7 +60,7 @@ class LWPCookieJar(FileCookieJar):
""" """
def as_lwp_str(self, ignore_discard=True, ignore_expires=True): def as_lwp_str(self, ignore_discard=True, ignore_expires=True):
"""Return cookies as a string of "\n"-separated "Set-Cookie3" headers. """Return cookies as a string of "\\n"-separated "Set-Cookie3" headers.
ignore_discard and ignore_expires: see docstring for FileCookieJar.save ignore_discard and ignore_expires: see docstring for FileCookieJar.save
......
...@@ -130,7 +130,7 @@ def encode(s, binary=True, maxlinelen=76, eol=NL): ...@@ -130,7 +130,7 @@ def encode(s, binary=True, maxlinelen=76, eol=NL):
verbatim (this is the default). verbatim (this is the default).
Each line of encoded text will end with eol, which defaults to "\\n". Set Each line of encoded text will end with eol, which defaults to "\\n". Set
this to "\r\n" if you will be using the result of this function directly this to "\\r\\n" if you will be using the result of this function directly
in an email. in an email.
""" """
if not s: if not s:
......
...@@ -63,7 +63,7 @@ def _bdecode(s): ...@@ -63,7 +63,7 @@ def _bdecode(s):
"""Decodes a base64 string. """Decodes a base64 string.
This function is equivalent to base64.decodestring and it's retained only This function is equivalent to base64.decodestring and it's retained only
for backward compatibility. It used to remove the last \n of the decoded for backward compatibility. It used to remove the last \\n of the decoded
string, if it had any (see issue 7143). string, if it had any (see issue 7143).
""" """
if not s: if not s:
...@@ -73,7 +73,7 @@ def _bdecode(s): ...@@ -73,7 +73,7 @@ def _bdecode(s):
def fix_eols(s): def fix_eols(s):
"""Replace all line-ending characters with \r\n.""" """Replace all line-ending characters with \\r\\n."""
# Fix newlines with no preceding carriage return # Fix newlines with no preceding carriage return
s = re.sub(r'(?<!\r)\n', CRLF, s) s = re.sub(r'(?<!\r)\n', CRLF, s)
# Fix carriage returns with no following newline # Fix carriage returns with no following newline
......
...@@ -212,7 +212,7 @@ class Message: ...@@ -212,7 +212,7 @@ class Message:
You may override this method if your application wants to bend the You may override this method if your application wants to bend the
rules, e.g. to strip trailing whitespace, or to recognize MH template rules, e.g. to strip trailing whitespace, or to recognize MH template
separators ('--------'). For convenience (e.g. for code reading from separators ('--------'). For convenience (e.g. for code reading from
sockets) a line consisting of \r\n also matches. sockets) a line consisting of \\r\\n also matches.
""" """
return line in _blanklines return line in _blanklines
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment