adds unit property to Stream [ch1579]

Author: looselycoupled

btrdb/stream.py

@@ -179,6 +179,21 @@ def name(self):
         """
         return self.tags()["name"]
 
+    @property
+    def unit(self):
+        """
+        Returns the stream's unit which is parsed from the stream tags.  This
+        may require a round trip to the server depending on how the stream was
+        acquired.
+
+        Returns
+        -------
+        str
+            The unit for values of the stream.
+
+        """
+        return self.tags()["unit"]
+
     @property
     def collection(self):
         """

tests/btrdb/test_stream.py

@@ -126,6 +126,26 @@ def test_refresh_metadata_deserializes_annotations(self):
         assert stream.annotations()[0] == expected
 
 
+    def test_stream_name_property(self):
+        """
+        Assert name property comes from tags
+        """
+        name = "LINE222VA-ANG"
+        stream = Stream(None, "FAKE_UUID")
+        stream._tags = {"name": name}
+        assert stream.name == name
+
+
+    def test_stream_unit_property(self):
+        """
+        Assert unit property comes from tags
+        """
+        unit = "whales"
+        stream = Stream(None, "FAKE_UUID")
+        stream._tags = {"unit": unit}
+        assert stream.unit == unit
+
+
     ##########################################################################
     ## update tests
     ##########################################################################