]> granicus.if.org Git - python/commitdiff
Code cleanup and add docstrings.
authorBarry Warsaw <barry@python.org>
Sat, 28 Sep 2002 20:52:26 +0000 (20:52 +0000)
committerBarry Warsaw <barry@python.org>
Sat, 28 Sep 2002 20:52:26 +0000 (20:52 +0000)
Lib/email/__init__.py

index 4d62a9fc9ec9ff48a9a7f2a2d6a9fac1895fcd3a..f7759b7a95a197890cea09a1a95191f0afeac16a 100644 (file)
@@ -27,18 +27,33 @@ __all__ = ['Charset',
            ]
 
 
+try:
+    True, False
+except NameError:
+    True = 1
+    False = 0
+
+
 \f
 # 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