From 93c0885dc84381cbbb970402b1a21bf690ee312c Mon Sep 17 00:00:00 2001 From: Rohit Balasubramanian Date: Sat, 7 Oct 2017 10:57:36 +0530 Subject: [PATCH] bpo-31507 Add docstring to parseaddr function in email.utils.parseaddr (GH-3647) (GH-3733) (cherry picked from commit 9e7b9b21fe45f7d93eaf9382fedfa18247d0d2b2) --- Lib/email/utils.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Lib/email/utils.py b/Lib/email/utils.py index a759d23308d..e2bfb362c6e 100644 --- a/Lib/email/utils.py +++ b/Lib/email/utils.py @@ -215,6 +215,12 @@ def parsedate_to_datetime(data): def parseaddr(addr): + """ + Parse addr into its constituent realname and email address parts. + + Return a tuple of realname and email address, unless the parse fails, in + which case return a 2-tuple of ('', ''). + """ addrs = _AddressList(addr).addresslist if not addrs: return '', ''