Doctests for pyparsing.common

ferdnyc · ptmcg · commit 0bae3cdcc927 · 2025-09-06T19:42:19.000-05:00
diff --git a/pyparsing/common.py b/pyparsing/common.py
@@ -30,7 +30,9 @@ class pyparsing_common:
     - :class:`upcase_tokens`
     - :class:`downcase_tokens`
 
-    Example::
+    Examples:
+
+    .. testcode::
 
         pyparsing_common.number.run_tests('''
             # any int or real number, returned as the appropriate type
@@ -42,44 +44,9 @@ class pyparsing_common:
             1e-12
             ''')
 
-        pyparsing_common.fnumber.run_tests('''
-            # any int or real number, returned as float
-            100
-            -100
-            +100
-            3.14159
-            6.02e23
-            1e-12
-            ''')
-
-        pyparsing_common.hex_integer.run_tests('''
-            # hex numbers
-            100
-            FF
-            ''')
+    .. testoutput::
+        :options: +NORMALIZE_WHITESPACE
 
-        pyparsing_common.fraction.run_tests('''
-            # fractions
-            1/2
-            -3/4
-            ''')
-
-        pyparsing_common.mixed_integer.run_tests('''
-            # mixed fractions
-            1
-            1/2
-            -3/4
-            1-3/4
-            ''')
-
-        import uuid
-        pyparsing_common.uuid.set_parse_action(token_map(uuid.UUID))
-        pyparsing_common.uuid.run_tests('''
-            # uuid
-            12345678-1234-5678-1234-567812345678
-            ''')
-
-    prints::
 
         # any int or real number, returned as the appropriate type
         100
@@ -100,6 +67,22 @@ class pyparsing_common:
         1e-12
         [1e-12]
 
+    .. testcode::
+
+        pyparsing_common.fnumber.run_tests('''
+            # any int or real number, returned as float
+            100
+            -100
+            +100
+            3.14159
+            6.02e23
+            1e-12
+            ''')
+
+    .. testoutput::
+        :options: +NORMALIZE_WHITESPACE
+
+
         # any int or real number, returned as float
         100
         [100.0]
@@ -119,20 +102,58 @@ class pyparsing_common:
         1e-12
         [1e-12]
 
+    .. testcode::
+
+        pyparsing_common.hex_integer.run_tests('''
+            # hex numbers
+            100
+            FF
+            ''')
+
+    .. testoutput::
+        :options: +NORMALIZE_WHITESPACE
+
+
         # hex numbers
         100
         [256]
 
         FF
         [255]
 
+    .. testcode::
+
+        pyparsing_common.fraction.run_tests('''
+            # fractions
+            1/2
+            -3/4
+            ''')
+
+    .. testoutput::
+        :options: +NORMALIZE_WHITESPACE
+
+
         # fractions
         1/2
         [0.5]
 
         -3/4
         [-0.75]
 
+    .. testcode::
+
+        pyparsing_common.mixed_integer.run_tests('''
+            # mixed fractions
+            1
+            1/2
+            -3/4
+            1-3/4
+            ''')
+
+    .. testoutput::
+        :options: +NORMALIZE_WHITESPACE
+
+
         # mixed fractions
         1
         [1]
@@ -145,6 +166,18 @@ class pyparsing_common:
 
         1-3/4
         [1.75]
+    .. testcode::
+
+        import uuid
+        pyparsing_common.uuid.set_parse_action(token_map(uuid.UUID))
+        pyparsing_common.uuid.run_tests('''
+            # uuid
+            12345678-1234-5678-1234-567812345678
+            ''')
+
+    .. testoutput::
+        :options: +NORMALIZE_WHITESPACE
+
 
         # uuid
         12345678-1234-5678-1234-567812345678
@@ -264,13 +297,17 @@ def convert_to_date(fmt: str = "%Y-%m-%d"):
         Params -
         - fmt - format to be passed to datetime.strptime (default= ``"%Y-%m-%d"``)
 
-        Example::
+        Example:
+
+        .. testcode::
 
             date_expr = pyparsing_common.iso8601_date.copy()
             date_expr.set_parse_action(pyparsing_common.convert_to_date())
             print(date_expr.parse_string("1999-12-31"))
 
-        prints::
+        prints:
+
+        .. testoutput::
 
             [datetime.date(1999, 12, 31)]
         """
@@ -291,13 +328,17 @@ def convert_to_datetime(fmt: str = "%Y-%m-%dT%H:%M:%S.%f"):
         Params -
         - fmt - format to be passed to datetime.strptime (default= ``"%Y-%m-%dT%H:%M:%S.%f"``)
 
-        Example::
+        Example:
+
+        .. testcode::
 
             dt_expr = pyparsing_common.iso8601_datetime.copy()
             dt_expr.set_parse_action(pyparsing_common.convert_to_datetime())
             print(dt_expr.parse_string("1999-12-31T23:59:59.999"))
 
-        prints::
+        prints:
+
+        .. testoutput::
 
             [datetime.datetime(1999, 12, 31, 23, 59, 59, 999000)]
         """
@@ -329,15 +370,20 @@ def cvt_fn(s, l, t):
     def strip_html_tags(s: str, l: int, tokens: ParseResults):
         """Parse action to remove HTML tags from web page HTML source
 
-        Example::
+        Example:
+
+        .. testcode::
 
             # strip HTML links from normal text
             text = '<td>More info at the <a href="https://github.com/pyparsing/pyparsing/wiki">pyparsing</a> wiki page</td>'
             td, td_end = make_html_tags("TD")
-            table_text = td + SkipTo(td_end).set_parse_action(pyparsing_common.strip_html_tags)("body") + td_end
+            table_text = td + SkipTo(td_end).set_parse_action(
+                pyparsing_common.strip_html_tags)("body") + td_end
             print(table_text.parse_string(text).body)
 
-        Prints::
+        Prints:
+
+        .. testoutput::
 
             More info at the pyparsing wiki page
         """
