bpo-31507 Add docstring to parseaddr function in email.utils.parseaddr (gh-3647)

9e7b9b21 · Rohit Balasubramanian · R. David Murray · 9abee722 · 9e7b9b21
Commit 9e7b9b21 authored Sep 20, 2017 by Rohit Balasubramanian Committed by R. David Murray Sep 19, 2017
Hide whitespace changes
Inline Side-by-side

Showing with 6 additions and 0 deletions

Lib/email/utils.py Lib/email/utils.py +6 -0

No files found.
--- 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 '', ''