rename the document_only flag to html_partial

mitechie · mitechie · commit 46f0302ebc0e · 2012-04-17T10:17:14.000-04:00
diff --git a/readability/readability.py b/readability/readability.py
@@ -123,10 +123,10 @@ def title(self):
     def short_title(self):
         return shorten_title(self._html(True))
 
-    def summary(self, document_only=False):
+    def summary(self, html_partial=False):
         """Generate the summary of the html docuemnt
 
-        :param document_only: return only the div of the document, don't wrap
+        :param html_partial: return only the div of the document, don't wrap
         in html and body tags.
 
         """
@@ -147,7 +147,7 @@ def summary(self, document_only=False):
 
                 if best_candidate:
                     article = self.get_article(candidates, best_candidate,
-                            document_only=document_only)
+                            html_partial=html_partial)
                 else:
                     if ruthless:
                         log.debug("ruthless removal did not work. ")
@@ -180,15 +180,15 @@ def summary(self, document_only=False):
             log.exception('error getting summary: ')
             raise Unparseable(str(e)), None, sys.exc_info()[2]
 
-    def get_article(self, candidates, best_candidate, document_only=False):
+    def get_article(self, candidates, best_candidate, html_partial=False):
         # Now that we have the top candidate, look through its siblings for
         # content that might also be related.
         # Things like preambles, content split by ads that we removed, etc.
         sibling_score_threshold = max([
             10,
             best_candidate['content_score'] * 0.2])
         # create a new html document with a html->body->div
-        if document_only:
+        if html_partial:
             output = fragment_fromstring('<div/>')
         else:
             output = document_fromstring('<div/>')
@@ -219,7 +219,7 @@ def get_article(self, candidates, best_candidate, document_only=False):
             if append:
                 # We don't want to append directly to output, but the div
                 # in html->body->div
-                if document_only:
+                if html_partial:
                     output.append(sibling)
                 else:
                     output.getchildren()[0].getchildren()[0].append(sibling)
diff --git a/tests/test_article_only.py b/tests/test_article_only.py
@@ -30,10 +30,10 @@ def test_si_sample(self):
         res = doc.summary()
         self.assertEqual('<html><body><div><div class', res[0:27])
 
-    def test_si_sample_doc_only(self):
+    def test_si_sample_html_partial(self):
         """Using the si sample, make sure we can get the article alone."""
         sample = load_sample('si-game.sample.html')
         doc = Document(sample, url='http://sportsillustrated.cnn.com/baseball/mlb/gameflash/2012/04/16/40630_preview.html')
-        res = doc.summary(document_only=True)
+        res = doc.summary(html_partial=True)
         self.assertEqual('<div><div class="', res[0:17])
 
