Add missing description field to Template class

Author: Zack Kendall

grafanalib/core.py

@@ -999,6 +999,7 @@ class Template(object):
 
     :param default: the default value for the variable
     :param dataSource: where to fetch the values for the variable from
+    :param description: Optional description for the template variable.
     :param label: the variable's human label
     :param name: the variable's name
     :param query: the query users to fetch the valid values of the variable
@@ -1057,6 +1058,7 @@ class Template(object):
         validator=instance_of(int)
     )
     autoMin = attr.ib(default=DEFAULT_MIN_AUTO_INTERVAL)
+    description = attr.ib(default=None)
 
     def __attrs_post_init__(self):
         if self.type == 'custom':
@@ -1089,6 +1091,7 @@ def to_json_data(self):
             'allValue': self.allValue,
             'current': self._current,
             'datasource': self.dataSource,
+            'description': self.description,
             'hide': self.hide,
             'includeAll': self.includeAll,
             'label': self.label,

grafanalib/tests/test_core.py

@@ -96,6 +96,25 @@ def test_custom_template_dont_override_options():
     assert t.to_json_data()['current']['value'] == '1'
 
 
+def test_template_description():
+    # Test that description is None by default
+    t = G.Template(
+        name='test',
+        query='1m,5m,10m',
+        type='interval',
+    )
+    assert t.to_json_data()['description'] is None
+
+    # Test that description is included when set
+    t = G.Template(
+        name='test',
+        query='1m,5m,10m',
+        type='interval',
+        description='This is a test description',
+    )
+    assert t.to_json_data()['description'] == 'This is a test description'
+
+
 def test_table():
     t = G.Table(
         dataSource='some data source',