Merge pull request Unidata#2269 from sgdecker/treenode1_repr

Add `__repr__` to TreeNode objects

Author: dopplershift

src/metpy/io/metar.py

@@ -11,7 +11,7 @@
 import numpy as np
 import pandas as pd
 
-from ._metar_parser.metar_parser import parse, ParseError
+from ._metar_parser.metar_parser import parse, ParseError, TreeNode
 from ._tools import open_as_needed
 from .station_data import station_info
 from ..package_tools import Exporter
@@ -61,6 +61,23 @@
              'current_wx3_symbol': None}
 
 
+def _tree_repr_(self):
+    """Produce string representation of a TreeNodex object."""
+    rep = self.__class__.__name__ + '('
+    args = []
+    for key, value in self.__dict__.items():
+        if key == 'elements':
+            continue
+        args.append(key + '=' + repr(value))
+        dict_str = ', '.join(args) + ')'
+    rep += dict_str
+    return rep
+
+
+# Monkey patch to improve debugging
+TreeNode.__repr__ = _tree_repr_
+
+
 @exporter.export
 def parse_metar_to_dataframe(metar_text, *, year=None, month=None):
     """Parse a single METAR report into a Pandas DataFrame.

tests/io/test_metar.py

@@ -10,6 +10,7 @@
 
 from metpy.cbook import get_test_data
 from metpy.io import parse_metar_file, parse_metar_to_dataframe
+from metpy.io._metar_parser.metar_parser import parse
 from metpy.io.metar import Metar, parse_metar
 from metpy.units import units
 
@@ -352,3 +353,29 @@ def test_parse_no_pint_objects_in_df():
     for df in (parse_metar_file(input_file), parse_metar_to_dataframe(metar_str)):
         for column in df:
             assert not isinstance(df[column][0], units.Quantity)
+
+
+def test_repr():
+    """Test that the TreeNode string representation works."""
+    str1 = 'KSMQ 201953Z AUTO VRB05KT 10SM CLR 03/M10 A3026'
+    tree = parse(str1)
+    rep = repr(tree)
+    assert rep == ("TreeNode1(text='KSMQ 201953Z AUTO VRB05KT 10SM CLR 03/M10 A3026', "
+                   "offset=0, metar=TreeNode(text='', offset=0), "
+                   "siteid=TreeNode(text='KSMQ', offset=0), "
+                   "datetime=TreeNode2(text=' 201953Z', offset=4, "
+                   "sep=TreeNode(text=' ', offset=4)), "
+                   "auto=TreeNode(text=' AUTO', offset=12), "
+                   "wind=TreeNode4(text=' VRB05KT', offset=17, "
+                   "wind_dir=TreeNode(text='VRB', offset=18), "
+                   "wind_spd=TreeNode(text='05', offset=21), "
+                   "gust=TreeNode(text='', offset=23)), "
+                   "vis=TreeNode6(text=' 10SM', offset=25, "
+                   "sep=TreeNode(text=' ', offset=25)), run=TreeNode(text='', offset=30), "
+                   "curwx=TreeNode(text='', offset=30), "
+                   "skyc=TreeNode(text=' CLR', offset=30), "
+                   "temp_dewp=TreeNode13(text=' 03/M10', offset=34, "
+                   "sep=TreeNode(text=' ', offset=34), temp=TreeNode(text='03', offset=35), "
+                   "dewp=TreeNode(text='M10', offset=38)), "
+                   "altim=TreeNode(text=' A3026', offset=41), "
+                   "remarks=TreeNode(text='', offset=47), end=TreeNode(text='', offset=47))")