Changeset 8 for formatflowed

Timestamp:

09/05/05 13:20:18 (7 years ago)

Author:

mj

Message:

Switch to symbolic constants for chunk types

Files:

• formatflowed/trunk/formatflowed.py (modified) (14 diffs)

formatflowed/trunk/formatflowed.py

@@ -16 +16 @@
 import textwrap
 
-__all__ = ['FormatFlowedDecoder', 'decode', 'convertToWrapped']
+__all__ = [
+    'PARAGRAPH',
+    'FIXED',
+    'SIGNATURE_SEPARATOR',
+    'FormatFlowedDecoder', 
+    'decode', 
+    'convertToWrapped'
+]
+
+# Constants denoting the various text chunk types recognized by format=flowed
+PARAGRAPH, FIXED, SIGNATURE_SEPARATOR = range(3)
 
 class FormatFlowedDecoder:
@@ -114 +124 @@
         tuples. information is a dictionary with the following fields:
           type
-            One of 'paragraph', 'fixed', 'signature-separator'
+            One of PARAGRAPH, FIXED, SIGNATURE_SEPARATOR
           quotedepth
             Number of quotemarks found on the text chunk
@@ -120 +130 @@
         chunk is a unicode string. All text is unwrapped and without any 
         quotemarks; when displaying these chunks, the appropriate quotemarks
-        should be added again, and chunks of type 'paragraph' should be
-        displayed wrapped. Chunks of type 'fixed' should be displayed 
+        should be added again, and chunks of type PARAGRAPH should be
+        displayed wrapped. Chunks of type FIXED should be displayed 
         unwrapped.
         
@@ -141 +151 @@
             ... "Lewis Carroll")))
             >>> list(result) == [
-            ...   ({'quotedepth': 2, 'type': 'paragraph'}, 
+            ...   ({'quotedepth': 2, 'type': PARAGRAPH}, 
             ...     u"`Take some more tea,' the March Hare said to Alice, "
             ...     u"very earnestly."),
-            ...   ({'quotedepth': 1, 'type': 'fixed'}, u""),
-            ...   ({'quotedepth': 1, 'type': 'paragraph'}, 
+            ...   ({'quotedepth': 1, 'type': FIXED}, u""),
+            ...   ({'quotedepth': 1, 'type': PARAGRAPH}, 
             ...    u"`I've had nothing yet,' Alice replied in an offended "
             ...    u"tone, `so I can't take more.'"),
-            ...   ({'quotedepth': 0, 'type': 'fixed'}, u""),
-            ...   ({'quotedepth': 0, 'type': 'paragraph'}, 
+            ...   ({'quotedepth': 0, 'type': FIXED}, u""),
+            ...   ({'quotedepth': 0, 'type': PARAGRAPH}, 
             ...    u"`You mean you can't take less,' said the Hatter: `it's "
             ...    u"very easy to take more than nothing.'"),
-            ...   ({'quotedepth': 0, 'type': 'fixed'}, u""),
-            ...   ({'quotedepth': 0, 'type': 'signature-separator'}, u"-- "),
-            ...   ({'quotedepth': 0, 'type': 'fixed'}, u"Lewis Carroll")
+            ...   ({'quotedepth': 0, 'type': FIXED}, u""),
+            ...   ({'quotedepth': 0, 'type': SIGNATURE_SEPARATOR}, u"-- "),
+            ...   ({'quotedepth': 0, 'type': FIXED}, u"Lewis Carroll")
             ... ]
             True
@@ -169 +179 @@
             ... "Depth zero paragraph with fixed line.")))
             >>> list(result) == [
-            ...   ({'quotedepth': 1, 'type': 'paragraph'},
+            ...   ({'quotedepth': 1, 'type': PARAGRAPH},
             ...    u"Depth one paragraph with flow space. "),
-            ...   ({'quotedepth': 2, 'type': 'paragraph'},
+            ...   ({'quotedepth': 2, 'type': PARAGRAPH},
             ...    u"Depth two paragraph with flow space. "),
-            ...   ({'quotedepth': 0, 'type': 'fixed'},
+            ...   ({'quotedepth': 0, 'type': FIXED},
             ...    u"Depth zero paragraph with fixed line.")]
             True
@@ -183 +193 @@
             ... "-- ")))
             >>> list(result) == [
-            ...   ({'quotedepth': 0, 'type': 'paragraph'},
+            ...   ({'quotedepth': 0, 'type': PARAGRAPH},
             ...    u"A paragraph with flow space. "),
-            ...   ({'quotedepth': 0, 'type': 'signature-separator'}, u"-- ")]
+            ...   ({'quotedepth': 0, 'type': SIGNATURE_SEPARATOR}, u"-- ")]
             True
             
@@ -193 +203 @@
             ... "A paragraph with flow space. ",)))
             >>> list(result) == [
-            ...   ({'quotedepth': 0, 'type': 'paragraph'},
+            ...   ({'quotedepth': 0, 'type': PARAGRAPH},
             ...    u"A paragraph with flow space. ")]
             True
@@ -206 +216 @@
             ... "break across the paragraph.")))
             >>> list(result) == [
-            ...   ({'quotedepth': 0, 'type': 'paragraph'}, 
+            ...   ({'quotedepth': 0, 'type': PARAGRAPH}, 
             ...    u'Contrived example with a word-break across the '
             ...    u'paragraph.')]
@@ -222 +232 @@
             ... "\xf7K")))
             >>> list(result) == [
-            ...   ({'quotedepth': 1, 'type': 'paragraph'},
+            ...   ({'quotedepth': 1, 'type': PARAGRAPH},
             ...    u'This is a quoted paragraph encoded in cp037.')]
             True
@@ -228 +238 @@
         """
         para = u''
-        pinfo = {'type': 'paragraph'}
+        pinfo = {'type': PARAGRAPH}
         for line in flowed.split('\r\n'):
             line = line.decode(self.character_set)
@@ -238 +248 @@
                     # exception case: flowed line followed by sig-sep
                     yield (pinfo, para)
-                    pinfo = {'type': 'paragraph'}
+                    pinfo = {'type': PARAGRAPH}
                     para = u''
-                yield ({'type': 'signature-separator', 
+                yield ({'type': SIGNATURE_SEPARATOR, 
                         'quotedepth': quotedepth}, line)
                 continue
@@ -248 +258 @@
                     # exception case: flowed line followed by quotedepth change
                     yield (pinfo, para)
-                    pinfo = {'type': 'paragraph'}
+                    pinfo = {'type': PARAGRAPH}
                     para = u''
                 para += self._stripflow(line)
@@ -259 +269 @@
                     # exception case: flowed line followed by quotedepth change
                     yield (pinfo, para)
-                    pinfo = {'type': 'paragraph'}
+                    pinfo = {'type': PARAGRAPH}
                     para = u''
                 else:
                     yield (pinfo, para + line)
-                    pinfo = {'type': 'paragraph'}
+                    pinfo = {'type': PARAGRAPH}
                     para = u''
                     continue
-            yield ({'type': 'fixed', 'quotedepth': quotedepth}, line)
+            yield ({'type': FIXED, 'quotedepth': quotedepth}, line)
             
         if para:
@@ -349 +359 @@
         if quotemarker and quote[-1] != ' ':
             quotemarker += ' '
-        if type == 'fixed' and not wrap_fixed:
+        if type == FIXED and not wrap_fixed:
             result.append(quotemarker + chunk)
-        elif not chunk or type == 'signature-separator':
+        elif not chunk or type == SIGNATURE_SEPARATOR:
             result.append(quotemarker + chunk)
         else: