Adding Sentence class in language implementation.

dhermes · dhermes · commit d490cd6824a8 · 2016-08-29T12:59:36.000-07:00
Also adding a from_api_repr() method for parsing it
from the API.
diff --git a/gcloud/language/test_token.py b/gcloud/language/test_token.py
@@ -91,3 +91,34 @@ def test_from_api_repr(self):
         self.assertEqual(token.edge_index, edge_index)
         self.assertEqual(token.edge_label, edge_label)
         self.assertEqual(token.lemma, lemma)
+
+
+class TestSentence(unittest.TestCase):
+
+    def _getTargetClass(self):
+        from gcloud.language.token import Sentence
+        return Sentence
+
+    def _makeOne(self, *args, **kw):
+        return self._getTargetClass()(*args, **kw)
+
+    def test_constructor(self):
+        content = "All the king's horses."
+        begin = 11
+        sentence = self._makeOne(content, begin)
+        self.assertEqual(sentence.content, content)
+        self.assertEqual(sentence.begin, begin)
+
+    def test_from_api_repr(self):
+        klass = self._getTargetClass()
+        content = 'All the pretty horses.'
+        begin = -1
+        payload = {
+            'text': {
+                'content': content,
+                'beginOffset': begin,
+            },
+        }
+        sentence = klass.from_api_repr(payload)
+        self.assertEqual(sentence.content, content)
+        self.assertEqual(sentence.begin, begin)
diff --git a/gcloud/language/token.py b/gcloud/language/token.py
@@ -166,3 +166,38 @@ def from_api_repr(cls, payload):
         lemma = payload['lemma']
         return cls(text_content, text_begin, part_of_speech,
                    edge_index, edge_label, lemma)
+
+
+class Sentence(object):
+    """A Google Cloud Natural Language API sentence object.
+
+    .. _Sentence message: https://cloud.google.com/natural-language/reference\
+                          /rest/v1beta1/documents/annotateText#Sentence
+
+    See `Sentence message`_.
+
+    :type content: str
+    :param content: The text that the sentence is composed of.
+
+    :type begin: int
+    :param begin: The beginning offset of the sentence in the original
+                  document according to the encoding type specified
+                  in the API request.
+    """
+
+    def __init__(self, content, begin):
+        self.content = content
+        self.begin = begin
+
+    @classmethod
+    def from_api_repr(cls, payload):
+        """Convert a sentence from the JSON API into a :class:`Sentiment`.
+
+        :param payload: dict
+        :type payload: The value from the backend.
+
+        :rtype: :class:`Sentence`
+        :returns: The sentence parsed from the API representation.
+        """
+        text_span = payload['text']
+        return cls(text_span['content'], text_span['beginOffset'])
