You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
285 lines
11 KiB
Python
285 lines
11 KiB
Python
|
|
from __future__ import absolute_import
|
|
|
|
from lxml.etree import tounicode
|
|
from lxml.html import document_fromstring
|
|
from lxml.html import fragment_fromstring
|
|
try:
|
|
# Python < 2.7
|
|
import unittest2 as unittest
|
|
except ImportError:
|
|
import unittest
|
|
|
|
from breadability._py3k import to_unicode
|
|
from breadability.readable import Article
|
|
from breadability.readable import get_class_weight
|
|
from breadability.readable import get_link_density
|
|
from breadability.readable import is_bad_link
|
|
from breadability.readable import score_candidates
|
|
from breadability.readable import transform_misused_divs_into_paragraphs
|
|
from breadability.scoring import ScoredNode
|
|
from .utils import load_snippet, load_article
|
|
|
|
|
|
class TestReadableDocument(unittest.TestCase):
|
|
"""Verify we can process html into a document to work off of."""
|
|
|
|
def test_load_doc(self):
|
|
"""We get back an element tree from our original doc"""
|
|
doc = Article(load_snippet('document_min.html'))
|
|
# We get back the document as a div tag currently by default.
|
|
self.assertEqual(doc.readable_dom.tag, 'div')
|
|
|
|
def test_doc_no_scripts_styles(self):
|
|
"""Step #1 remove all scripts from the document"""
|
|
doc = Article(load_snippet('document_scripts.html'))
|
|
readable = doc.readable_dom
|
|
self.assertEqual(readable.findall(".//script"), [])
|
|
self.assertEqual(readable.findall(".//style"), [])
|
|
self.assertEqual(readable.findall(".//link"), [])
|
|
|
|
def test_find_body_exists(self):
|
|
"""If the document has a body, we store that as the readable html
|
|
|
|
No sense processing anything other than the body content.
|
|
|
|
"""
|
|
doc = Article(load_snippet('document_min.html'))
|
|
self.assertEqual(doc.readable_dom.tag, 'div')
|
|
self.assertEqual(doc.readable_dom.get('id'), 'readabilityBody')
|
|
|
|
def test_body_doesnt_exist(self):
|
|
"""If we can't find a body, then we create one.
|
|
|
|
We build our doc around the rest of the html we parsed.
|
|
|
|
"""
|
|
doc = Article(load_snippet('document_no_body.html'))
|
|
self.assertEqual(doc.readable_dom.tag, 'div')
|
|
self.assertEqual(doc.readable_dom.get('id'), 'readabilityBody')
|
|
|
|
def test_bare_content(self):
|
|
"""If the document is just pure content, no html tags we should be ok
|
|
|
|
We build our doc around the rest of the html we parsed.
|
|
|
|
"""
|
|
doc = Article(load_snippet('document_only_content.html'))
|
|
self.assertEqual(doc.readable_dom.tag, 'div')
|
|
self.assertEqual(doc.readable_dom.get('id'), 'readabilityBody')
|
|
|
|
|
|
def test_no_content(self):
|
|
"""Without content we supply an empty unparsed doc."""
|
|
doc = Article('')
|
|
self.assertEqual(doc.readable_dom.tag, 'div')
|
|
self.assertEqual(doc.readable_dom.get('id'), 'readabilityBody')
|
|
self.assertEqual(doc.readable_dom.get('class'), 'parsing-error')
|
|
|
|
|
|
class TestCleaning(unittest.TestCase):
|
|
"""Test out our cleaning processing we do."""
|
|
|
|
def test_unlikely_hits(self):
|
|
"""Verify we wipe out things from our unlikely list."""
|
|
doc = Article(load_snippet('test_readable_unlikely.html'))
|
|
readable = doc.readable_dom
|
|
must_not_appear = ['comment', 'community', 'disqus', 'extra', 'foot',
|
|
'header', 'menu', 'remark', 'rss', 'shoutbox', 'sidebar',
|
|
'sponsor', 'ad-break', 'agegate', 'pagination' '', 'pager',
|
|
'popup', 'tweet', 'twitter', 'imgBlogpostPermalink']
|
|
|
|
want_to_appear = ['and', 'article', 'body', 'column', 'main', 'shadow']
|
|
|
|
for i in must_not_appear:
|
|
# we cannot find any class or id with this value
|
|
by_class = readable.find_class(i)
|
|
|
|
for test in by_class:
|
|
# if it's here it cannot have the must not class without the
|
|
# want to appear class
|
|
found = False
|
|
for cls in test.get('class').split():
|
|
if cls in want_to_appear:
|
|
found = True
|
|
self.assertTrue(found)
|
|
|
|
by_ids = readable.get_element_by_id(i, False)
|
|
if by_ids is not False:
|
|
found = False
|
|
for ids in test.get('id').split():
|
|
if ids in want_to_appear:
|
|
found = True
|
|
self.assertTrue(found)
|
|
|
|
def test_misused_divs_transform(self):
|
|
"""Verify we replace leaf node divs with p's
|
|
|
|
They should have the same content, just be a p vs a div
|
|
|
|
"""
|
|
test_html = "<html><body><div>simple</div></body></html>"
|
|
test_doc = document_fromstring(test_html)
|
|
self.assertEqual(
|
|
tounicode(
|
|
transform_misused_divs_into_paragraphs(test_doc)),
|
|
to_unicode("<html><body><p>simple</p></body></html>")
|
|
)
|
|
|
|
test_html2 = ('<html><body><div>simple<a href="">link</a>'
|
|
'</div></body></html>')
|
|
test_doc2 = document_fromstring(test_html2)
|
|
self.assertEqual(
|
|
tounicode(
|
|
transform_misused_divs_into_paragraphs(test_doc2)),
|
|
to_unicode('<html><body><p>simple<a href="">link</a></p></body></html>')
|
|
)
|
|
|
|
def test_bad_links(self):
|
|
"""Some links should just not belong."""
|
|
bad_links = [
|
|
'<a name="amazonAndGoogleHaveMadeAnAudaciousGrabOfNamespaceOnTheInternetAsFarAsICanSeeTheresBeenNoMentionOfThisInTheTechPress"> </a>',
|
|
'<a href="#amazonAndGoogleHaveMadeAnAudaciousGrabOfNamespaceOnTheInternetAsFarAsICanSeeTheresBeenNoMentionOfThisInTheTechPress"><img src="http://scripting.com/images/2001/09/20/sharpPermaLink3.gif" class="imgBlogpostPermalink" width="6" height="9" border="0" alt="permalink"></a>',
|
|
'<a href="http://scripting.com/stories/2012/06/15/theTechPressIsOutToLunch.html#anExampleGoogleDoesntIntendToShareBlogAndItWillOnlyBeUsedToPointToBloggerSitesIfYouHaveATumblrOrWordpressBlogYouCantHaveABlogDomainHereIsTheAHrefhttpgtldresulticannorgapplicationresultapplicationstatusapplicationdetails527publicListingaOfGooglesAHrefhttpdropboxscriptingcomdavemiscgoogleblogapplicationhtmlapplicationa"><img src="http://scripting.com/images/2001/09/20/sharpPermaLink3.gif" class="imgBlogpostPermalink" width="6" height="9" border="0" alt="permalink"></a>'
|
|
]
|
|
|
|
for l in bad_links:
|
|
link = fragment_fromstring(l)
|
|
self.assertTrue(is_bad_link(link))
|
|
|
|
|
|
class TestCandidateNodes(unittest.TestCase):
|
|
"""Candidate nodes are scoring containers we use."""
|
|
|
|
def test_candidate_scores(self):
|
|
"""We should be getting back objects with some scores."""
|
|
fives = ['<div/>']
|
|
threes = ['<pre/>', '<td/>', '<blockquote/>']
|
|
neg_threes = ['<address/>', '<ol/>']
|
|
neg_fives = ['<h1/>', '<h2/>', '<h3/>', '<h4/>']
|
|
|
|
for n in fives:
|
|
doc = fragment_fromstring(n)
|
|
self.assertEqual(ScoredNode(doc).content_score, 5)
|
|
|
|
for n in threes:
|
|
doc = fragment_fromstring(n)
|
|
self.assertEqual(ScoredNode(doc).content_score, 3)
|
|
|
|
for n in neg_threes:
|
|
doc = fragment_fromstring(n)
|
|
self.assertEqual(ScoredNode(doc).content_score, -3)
|
|
|
|
for n in neg_fives:
|
|
doc = fragment_fromstring(n)
|
|
self.assertEqual(ScoredNode(doc).content_score, -5)
|
|
|
|
def test_article_enables_candidate_access(self):
|
|
"""Candidates are accessible after document processing."""
|
|
doc = Article(load_article('ars/ars.001.html'))
|
|
self.assertTrue(hasattr(doc, 'candidates'))
|
|
|
|
|
|
class TestClassWeights(unittest.TestCase):
|
|
"""Certain ids and classes get us bonus points."""
|
|
|
|
def test_positive_class(self):
|
|
"""Some classes get us bonus points."""
|
|
node = fragment_fromstring('<p class="article">')
|
|
self.assertEqual(get_class_weight(node), 25)
|
|
|
|
def test_positive_ids(self):
|
|
"""Some ids get us bonus points."""
|
|
node = fragment_fromstring('<p id="content">')
|
|
self.assertEqual(get_class_weight(node), 25)
|
|
|
|
def test_negative_class(self):
|
|
"""Some classes get us negative points."""
|
|
node = fragment_fromstring('<p class="comment">')
|
|
self.assertEqual(get_class_weight(node), -25)
|
|
|
|
def test_negative_ids(self):
|
|
"""Some ids get us negative points."""
|
|
node = fragment_fromstring('<p id="media">')
|
|
self.assertEqual(get_class_weight(node), -25)
|
|
|
|
|
|
class TestScoringNodes(unittest.TestCase):
|
|
"""We take out list of potential nodes and score them up."""
|
|
|
|
def test_we_get_candidates(self):
|
|
"""Processing candidates should get us a list of nodes to try out."""
|
|
# we'll start out using our first real test document
|
|
test_nodes = []
|
|
doc = document_fromstring(load_article('ars/ars.001.html'))
|
|
for node in doc.getiterator():
|
|
if node.tag in ['p', 'td', 'pre']:
|
|
test_nodes.append(node)
|
|
|
|
candidates = score_candidates(test_nodes)
|
|
|
|
# this might change as we tweak our algorithm, but if it does change,
|
|
# it signifies we need to look at what we changed.
|
|
self.assertEqual(len(candidates.keys()), 6)
|
|
|
|
# one of these should have a decent score
|
|
scores = sorted([c.content_score for c in candidates.values()])
|
|
self.assertTrue(scores[-1] > 100)
|
|
|
|
def test_bonus_score_per_100_chars_in_p(self):
|
|
"""Nodes get 1pt per 100 characters up to 3 max points"""
|
|
def build_doc(length):
|
|
div = '<div id="content" class=""><p>{0}</p></div>'
|
|
document_str = '<html><body>{0}</body></html>'
|
|
content = 'c' * length
|
|
test_div = div.format(content)
|
|
doc = document_fromstring(document_str.format(test_div))
|
|
test_nodes = []
|
|
for node in doc.getiterator():
|
|
if node.tag == 'p':
|
|
test_nodes.append(node)
|
|
return test_nodes
|
|
|
|
test_nodes = build_doc(400)
|
|
candidates = score_candidates(test_nodes)
|
|
pscore_400 = max([c.content_score for c in candidates.values()])
|
|
|
|
test_nodes = build_doc(100)
|
|
candidates = score_candidates(test_nodes)
|
|
pscore_100 = max([c.content_score for c in candidates.values()])
|
|
|
|
test_nodes = build_doc(50)
|
|
candidates = score_candidates(test_nodes)
|
|
pscore_50 = max([c.content_score for c in candidates.values()])
|
|
|
|
self.assertEqual(pscore_100, pscore_50 + 1)
|
|
self.assertEqual(pscore_400, pscore_50 + 3)
|
|
|
|
|
|
class TestLinkDensityScoring(unittest.TestCase):
|
|
"""Link density will adjust out candidate scoresself."""
|
|
|
|
def test_link_density(self):
|
|
"""Test that we get a link density"""
|
|
doc = document_fromstring(load_article('ars/ars.001.html'))
|
|
for node in doc.getiterator():
|
|
if node.tag in ['p', 'td', 'pre']:
|
|
density = get_link_density(node)
|
|
|
|
# the density must be between 0, 1
|
|
self.assertTrue(density >= 0.0 and density <= 1.0)
|
|
|
|
|
|
class TestSiblings(unittest.TestCase):
|
|
"""Siblings will be included if their content is related."""
|
|
|
|
def test_bad_siblings_not_counted(self):
|
|
""""""
|
|
|
|
assert True, "TBD"
|
|
|
|
def test_good_siblings_counted(self):
|
|
""""""
|
|
|
|
assert True, "TBD"
|