From 057b8428d02bd8179cab752cf23ebc11b934a1c4 Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Mon, 30 Sep 2002 20:07:22 +0000 Subject: Docstring consistency with the updated .tex files. --- Lib/email/Parser.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/Lib/email/Parser.py b/Lib/email/Parser.py index 98d20c3..119a90d 100644 --- a/Lib/email/Parser.py +++ b/Lib/email/Parser.py @@ -49,6 +49,13 @@ class Parser: self._strict = strict def parse(self, fp, headersonly=False): + """Create a message structure from the data in a file. + + Reads all the data from the file and returns the root of the message + structure. Optional headersonly is a flag specifying whether to stop + parsing after reading the headers or not. The default is False, + meaning it parses the entire contents of the file. + """ root = self._class() self._parseheaders(root, fp) if not headersonly: @@ -56,6 +63,13 @@ class Parser: return root def parsestr(self, text, headersonly=False): + """Create a message structure from a string. + + Returns the root of the message structure. Optional headersonly is a + flag specifying whether to stop parsing after reading the headers or + not. The default is False, meaning it parses the entire contents of + the file. + """ return self.parse(StringIO(text), headersonly=headersonly) def _parseheaders(self, container, fp): -- cgit v0.12