From 638c6a69b1d08244e8f16e85efa72dea7148f984 Mon Sep 17 00:00:00 2001
From: Luke Hsiao <lwhsiao@stanford.edu>
Date: Wed, 25 Jul 2018 10:18:23 +0900
Subject: [PATCH] Remove get parent/children/sentence generator from Context

Only a few of the classes inheriting from Context implemented these
functions, and they are not as clear as explicitly navigating the data
model. For example, the Span.get_parent() is less explicit than just
saying Span.sentence. Rather than prsent an interface that is not
explicit and rarely implemented, this commit just removes it.
---
 CHANGELOG.rst                     | 10 +++++++++-
 fonduer/_version.py               |  2 +-
 fonduer/candidates/models/span.py |  6 ------
 fonduer/parser/models/context.py  |  9 ---------
 fonduer/parser/models/document.py | 10 ----------
 5 files changed, 10 insertions(+), 27 deletions(-)

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index dc6436ff9..f01127364 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -1,8 +1,16 @@
-Version 0.2.4 (coming soon...)
+Version 0.3.0 (coming soon...)
 ------------------------------
 
+.. warning::
+    This release is NOT backwards compatable with v0.2.3. Specifically we have
+    removed the ``get_parent()``, ``get_children()``, and
+    ``get_sentence_generator()`` functions from the classes inhereting from
+    Context in the data model.
+
 * `@lukehsiao`_: Organize documentation for lf_helpers by modality.
   (`#85 <https://github.com/HazyResearch/fonduer/pull/85>`_)
+* `@lukehsiao`_: Remove get parent/children/sentence generator from Context. 
+  (`#87 <https://github.com/HazyResearch/fonduer/pull/87>`_)
 
 Version 0.2.3
 -------------
diff --git a/fonduer/_version.py b/fonduer/_version.py
index 788da1fb3..493f7415d 100644
--- a/fonduer/_version.py
+++ b/fonduer/_version.py
@@ -1 +1 @@
-__version__ = "0.2.4"
+__version__ = "0.3.0"
diff --git a/fonduer/candidates/models/span.py b/fonduer/candidates/models/span.py
index dca4241fd..17cc0d81e 100644
--- a/fonduer/candidates/models/span.py
+++ b/fonduer/candidates/models/span.py
@@ -177,12 +177,6 @@ class Span(Context, TemporarySpan):
         foreign_keys=sentence_id,
     )
 
-    def get_parent(self):
-        return self.sentence
-
-    def get_children(self):
-        return None
-
     def _get_instance(self, **kwargs):
         return Span(**kwargs)
 
diff --git a/fonduer/parser/models/context.py b/fonduer/parser/models/context.py
index e290a6690..3121cb6ff 100644
--- a/fonduer/parser/models/context.py
+++ b/fonduer/parser/models/context.py
@@ -18,15 +18,6 @@ class Context(_meta.Base):
 
     __mapper_args__ = {"polymorphic_identity": "context", "polymorphic_on": type}
 
-    def get_parent(self):
-        raise NotImplementedError()
-
-    def get_children(self):
-        raise NotImplementedError()
-
-    def get_sentence_generator(self):
-        raise NotImplementedError()
-
 
 def construct_stable_id(
     parent_context,
diff --git a/fonduer/parser/models/document.py b/fonduer/parser/models/document.py
index 45c15b72b..0b82036e0 100644
--- a/fonduer/parser/models/document.py
+++ b/fonduer/parser/models/document.py
@@ -17,16 +17,6 @@ class Document(Context):
 
     __mapper_args__ = {"polymorphic_identity": "document"}
 
-    def get_parent(self):
-        return None
-
-    def get_children(self):
-        return self.sentences
-
-    def get_sentence_generator(self):
-        for sentence in self.sentences:
-            yield sentence
-
     def __repr__(self):
         return "Document " + str(self.name)