"""Test Soup Sieve API."""
import soupsieve as sv
from . import util
import copy
import random
import pytest
import pickle
class TestSoupSieve(util.TestCase):
"""Test Soup Sieve."""
def test_select(self):
"""Test select."""
markup = """
"""
soup = self.soup(markup, 'html.parser')
ids = [el.attrs['id'] for el in sv.select('span[id]', soup)]
self.assertEqual(sorted(['5', 'some-id']), sorted(ids))
def test_select_order(self):
"""Test select order."""
markup = """
"""
soup = self.soup(markup, 'html.parser')
ids = [el.attrs['id'] for el in sv.select('[id]', soup.body)]
self.assertEqual(['1', '2', '3', '4', '5', 'some-id', '6'], ids)
def test_select_limit(self):
"""Test select limit."""
markup = """
"""
soup = self.soup(markup, 'html.parser')
ids = [el.attrs['id'] for el in sv.select('span[id]', soup, limit=1)]
self.assertEqual(sorted(['5']), sorted(ids))
def test_select_one(self):
"""Test select one."""
markup = """
"""
soup = self.soup(markup, 'html.parser')
self.assertEqual(
sv.select('span[id]', soup, limit=1)[0].attrs['id'],
sv.select_one('span[id]', soup).attrs['id']
)
def test_select_one_none(self):
"""Test select one returns none for no match."""
markup = """
"""
soup = self.soup(markup, 'html.parser')
self.assertEqual(None, sv.select_one('h1', soup))
def test_iselect(self):
"""Test select iterator."""
markup = """
"""
soup = self.soup(markup, 'html.parser')
ids = [el.attrs['id'] for el in sv.iselect('span[id]', soup)]
self.assertEqual(sorted(['5', 'some-id']), sorted(ids))
def test_iselect_order(self):
"""Test select iterator order."""
markup = """
"""
soup = self.soup(markup, 'html.parser')
ids = [el.attrs['id'] for el in sv.iselect('[id]', soup)]
self.assertEqual(['1', '2', '3', '4', '5', 'some-id', '6'], ids)
def test_match(self):
"""Test matching."""
markup = """
"""
soup = self.soup(markup, 'html.parser')
nodes = sv.select('span[id]', soup)
self.assertTrue(sv.match('span#\\35', nodes[0]))
self.assertFalse(sv.match('span#\\35', nodes[1]))
def test_filter_tag(self):
"""Test filter tag."""
markup = """
"""
soup = self.soup(markup, 'html.parser')
nodes = sv.filter('pre#\\36', soup.html.body)
self.assertEqual(len(nodes), 1)
self.assertEqual(nodes[0].attrs['id'], '6')
def test_filter_tag_order(self):
"""Test filter tag order."""
markup = """
"""
soup = self.soup(markup, 'html.parser')
ids = [tag['id'] for tag in sv.filter('[id]', soup.html.body.p)]
self.assertEqual(['2', '3'], ids)
def test_filter_list(self):
"""
Test filter list.
Even if a list is created from the content of a tag, as long as the
content is document nodes, filter will still handle it. It doesn't have
to be just tags.
"""
markup = """
"""
soup = self.soup(markup, 'html.parser')
nodes = sv.filter('pre#\\36', list(soup.html.body.children))
self.assertEqual(len(nodes), 1)
self.assertEqual(nodes[0].attrs['id'], '6')
def test_closest_match_parent(self):
"""Test match parent closest."""
markup = """
Here is div-01
Here is div-02
Here is div-04
Here is div-03
Here is div-05
"""
soup = self.soup(markup, 'html.parser')
el = sv.select_one('#div-03', soup)
self.assertTrue(sv.closest('#div-02', el).attrs['id'] == 'div-02')
def test_closest_match_complex_parent(self):
"""Test closest match complex parent."""
markup = """
Here is div-01
Here is div-02
Here is div-04
Here is div-03
Here is div-05
"""
soup = self.soup(markup, 'html.parser')
el = sv.select_one('#div-03', soup)
self.assertTrue(sv.closest('article > div', el).attrs['id'] == 'div-01')
self.assertTrue(sv.closest(':not(div)', el).attrs['id'] == 'article')
def test_closest_match_self(self):
"""Test closest match self."""
markup = """
Here is div-01
Here is div-02
Here is div-04
Here is div-03
Here is div-05
"""
soup = self.soup(markup, 'html.parser')
el = sv.select_one('#div-03', soup)
self.assertTrue(sv.closest('div div', el).attrs['id'] == 'div-03')
def test_closest_must_be_parent(self):
"""Test that closest only matches parents or self."""
markup = """
Here is div-01
Here is div-02
Here is div-04
Here is div-03
Here is div-05
"""
soup = self.soup(markup, 'html.parser')
el = sv.select_one('#div-03', soup)
self.assertTrue(sv.closest('div #div-05', el) is None)
self.assertTrue(sv.closest('a', el) is None)
def test_escape_hyphen(self):
"""Test escape hyphen cases."""
self.assertEqual(r'\-', sv.escape('-'))
self.assertEqual(r'--', sv.escape('--'))
def test_escape_numbers(self):
"""Test escape hyphen cases."""
self.assertEqual(r'\33 ', sv.escape('3'))
self.assertEqual(r'-\33 ', sv.escape('-3'))
self.assertEqual(r'--3', sv.escape('--3'))
def test_escape_null(self):
"""Test escape null character."""
self.assertEqual('\ufffdtest', sv.escape('\x00test'))
def test_escape_ctrl(self):
"""Test escape control character."""
self.assertEqual(r'\1 test', sv.escape('\x01test'))
def test_escape_special(self):
"""Test escape special character."""
self.assertEqual(r'\{\}\[\]\ \(\)', sv.escape('{}[] ()'))
def test_escape_wide_unicode(self):
"""Test handling of wide Unicode."""
self.assertEqual('Emoji\\ \U0001F60D', sv.escape('Emoji \U0001F60D'))
def test_copy_pickle(self):
"""Test copy and pickle."""
# Test that we can pickle and unpickle
# We force a pattern that contains all custom types:
# `Selector`, `NullSelector`, `SelectorTag`, `SelectorAttribute`,
# `SelectorNth`, `SelectorLang`, `SelectorList`, `Namespaces`,
# `SelectorContains`, and `CustomSelectors`.
p1 = sv.compile(
'p.class#id[id]:nth-child(2):lang(en):focus:-soup-contains("text", "other text")',
{'html': 'http://www.w3.org/TR/html4/'},
custom={':--header': 'h1, h2, h3, h4, h5, h6'}
)
sp1 = pickle.dumps(p1)
pp1 = pickle.loads(sp1)
self.assertTrue(pp1 == p1)
# Test that we pull the same one from cache
p2 = sv.compile(
'p.class#id[id]:nth-child(2):lang(en):focus:-soup-contains("text", "other text")',
{'html': 'http://www.w3.org/TR/html4/'},
custom={':--header': 'h1, h2, h3, h4, h5, h6'}
)
self.assertTrue(p1 is p2)
# Test that we compile a new one when providing a different flags
p3 = sv.compile(
'p.class#id[id]:nth-child(2):lang(en):focus:-soup-contains("text", "other text")',
{'html': 'http://www.w3.org/TR/html4/'},
custom={':--header': 'h1, h2, h3, h4, h5, h6'},
flags=0x10
)
self.assertTrue(p1 is not p3)
self.assertTrue(p1 != p3)
# Test that the copy is equivalent, but not same.
p4 = copy.copy(p1)
self.assertTrue(p4 is not p1)
self.assertTrue(p4 == p1)
p5 = copy.copy(p3)
self.assertTrue(p5 is not p3)
self.assertTrue(p5 == p3)
self.assertTrue(p5 is not p4)
def test_cache(self):
"""Test cache."""
sv.purge()
self.assertEqual(sv.cp._cached_css_compile.cache_info().currsize, 0)
for _x in range(1000):
value = f'[value="{random.randint(1, 10000)!s}"]'
p = sv.compile(value)
self.assertTrue(p.pattern == value)
self.assertTrue(sv.cp._cached_css_compile.cache_info().currsize > 0)
self.assertTrue(sv.cp._cached_css_compile.cache_info().currsize == 500)
sv.purge()
self.assertEqual(sv.cp._cached_css_compile.cache_info().currsize, 0)
def test_recompile(self):
"""If you feed through the same object, it should pass through unless you change parameters."""
p1 = sv.compile('p[id]')
p2 = sv.compile(p1)
self.assertTrue(p1 is p2)
with pytest.raises(ValueError):
sv.compile(p1, flags=sv.DEBUG)
with pytest.raises(ValueError):
sv.compile(p1, namespaces={"": ""})
with pytest.raises(ValueError):
sv.compile(p1, custom={":--header": 'h1, h2, h3, h4, h5, h6'})
def test_immutable_dict_size(self):
"""Test immutable dictionary."""
idict = sv.ct.ImmutableDict({'a': 'b', 'c': 'd'})
self.assertEqual(2, len(idict))
class TestInvalid(util.TestCase):
"""Test invalid."""
def test_immutable_object(self):
"""Test immutable object."""
obj = sv.ct.Immutable()
with self.assertRaises(AttributeError):
obj.member = 3
def test_immutable_dict_read_only(self):
"""Test immutable dictionary is read only."""
idict = sv.ct.ImmutableDict({'a': 'b', 'c': 'd'})
with self.assertRaises(TypeError):
idict['a'] = 'f'
def test_immutable_dict_hashable_value(self):
"""Test immutable dictionary has a hashable value."""
with self.assertRaises(TypeError):
sv.ct.ImmutableDict([[3, {}]])
def test_immutable_dict_hashable_key(self):
"""Test immutable dictionary has a hashable key."""
with self.assertRaises(TypeError):
sv.ct.ImmutableDict([[{}, 3]])
def test_immutable_dict_hashable_value_dict(self):
"""Test immutable dictionary has a hashable value."""
with self.assertRaises(TypeError):
sv.ct.ImmutableDict({3: {}})
def test_invalid_namespace_type(self):
"""Test invalid namespace type."""
with self.assertRaises(TypeError):
sv.ct.Namespaces(((3, 3),))
def test_invalid_namespace_hashable_value(self):
"""Test namespace has hashable value."""
with self.assertRaises(TypeError):
sv.ct.Namespaces({'a': {}})
def test_invalid_namespace_hashable_key(self):
"""Test namespace key is hashable."""
with self.assertRaises(TypeError):
sv.ct.Namespaces({{}: 'string'})
def test_invalid_custom_type(self):
"""Test invalid custom selector type."""
with self.assertRaises(TypeError):
sv.ct.CustomSelectors(((3, 3),))
def test_invalid_custom_hashable_value(self):
"""Test custom selector has hashable value."""
with self.assertRaises(TypeError):
sv.ct.CustomSelectors({'a': {}})
def test_invalid_custom_hashable_key(self):
"""Test custom selector key is hashable."""
with self.assertRaises(TypeError):
sv.ct.CustomSelectors({{}: 'string'})
def test_invalid_type_input_match(self):
"""Test bad input into the match API."""
flags = sv.DEBUG
with self.assertRaises(TypeError):
sv.match('div', "not a tag", flags=flags)
def test_invalid_type_input_select(self):
"""Test bad input into the select API."""
flags = sv.DEBUG
with self.assertRaises(TypeError):
sv.select('div', "not a tag", flags=flags)
def test_invalid_type_input_filter(self):
"""Test bad input into the filter API."""
flags = sv.DEBUG
with self.assertRaises(TypeError):
sv.filter('div', "not a tag", flags=flags)
class TestSyntaxErrorReporting(util.TestCase):
"""Test reporting of syntax errors."""
def test_syntax_error_has_text_and_position(self):
"""Test that selector syntax errors contain the position."""
with self.assertRaises(sv.SelectorSyntaxError) as cm:
sv.compile('input.field[type=42]')
e = cm.exception
self.assertEqual(e.context, 'input.field[type=42]\n ^')
self.assertEqual(e.line, 1)
self.assertEqual(e.col, 12)
def test_syntax_error_with_multiple_lines(self):
"""Test that multiline selector errors have the right position."""
with self.assertRaises(sv.SelectorSyntaxError) as cm:
sv.compile(
'input\n'
'.field[type=42]')
e = cm.exception
self.assertEqual(e.context, ' input\n--> .field[type=42]\n ^')
self.assertEqual(e.line, 2)
self.assertEqual(e.col, 7)
def test_syntax_error_on_third_line(self):
"""Test that multiline selector errors have the right position."""
with self.assertRaises(sv.SelectorSyntaxError) as cm:
sv.compile(
'input:is(\n'
' [name=foo]\n'
' [type=42]\n'
')\n'
)
e = cm.exception
self.assertEqual(e.line, 3)
self.assertEqual(e.col, 3)
def test_simple_syntax_error(self):
"""Test a simple syntax error (no context)."""
with self.assertRaises(sv.SelectorSyntaxError) as cm:
raise sv.SelectorSyntaxError('Syntax Message')
e = cm.exception
self.assertEqual(e.context, None)
self.assertEqual(e.line, None)
self.assertEqual(e.col, None)
self.assertEqual(str(e), 'Syntax Message')