summaryrefslogtreecommitdiffstats
path: root/Lib/email/__init__.py
diff options
context:
space:
mode:
authorBarry Warsaw <barry@python.org>2002-09-28 20:52:26 (GMT)
committerBarry Warsaw <barry@python.org>2002-09-28 20:52:26 (GMT)
commitf776e6922cf558b9d8aa89cda9dc5df3f5b00e6e (patch)
treefc5905ced11e694908028d986d769d0c429f3f53 /Lib/email/__init__.py
parent5bdb2bee376067b0ee7682b95c51a29999449ab9 (diff)
downloadcpython-f776e6922cf558b9d8aa89cda9dc5df3f5b00e6e.zip
cpython-f776e6922cf558b9d8aa89cda9dc5df3f5b00e6e.tar.gz
cpython-f776e6922cf558b9d8aa89cda9dc5df3f5b00e6e.tar.bz2
Code cleanup and add docstrings.
Diffstat (limited to 'Lib/email/__init__.py')
-rw-r--r--Lib/email/__init__.py19
1 files changed, 17 insertions, 2 deletions
diff --git a/Lib/email/__init__.py b/Lib/email/__init__.py
index 4d62a9f..f7759b7 100644
--- a/Lib/email/__init__.py
+++ b/Lib/email/__init__.py
@@ -27,18 +27,33 @@ __all__ = ['Charset',
]
+try:
+ True, False
+except NameError:
+ True = 1
+ False = 0
+
+
# Some convenience routines. Don't import Parser and Message as side-effects
# of importing email since those cascadingly import most of the rest of the
# email package.
-def message_from_string(s, _class=None, strict=0):
+def message_from_string(s, _class=None, strict=False):
+ """Parse a string into a Message object model.
+
+ Optional _class and strict are passed to the Parser constructor.
+ """
from email.Parser import Parser
if _class is None:
from email.Message import Message
_class = Message
return Parser(_class, strict=strict).parsestr(s)
-def message_from_file(fp, _class=None, strict=0):
+def message_from_file(fp, _class=None, strict=False):
+ """Read a file and parse its contents into a Message object model.
+
+ Optional _class and strict are passed to the Parser constructor.
+ """
from email.Parser import Parser
if _class is None:
from email.Message import Message