Skip to content

plugin.api.validate: refactor, turn into package #4514

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
May 8, 2022
Merged

plugin.api.validate: refactor, turn into package #4514

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
57289f4
plugin.api.validate: refactor all + any
bastimeyer May 7, 2022
03e3c59
plugin.api.validate: refactor get
bastimeyer May 7, 2022
5a77225
plugin.api.validate: refactor callable
bastimeyer May 7, 2022
c5df6b2
plugin.api.validate: fix xml_element
bastimeyer May 7, 2022
d1d8057
plugin.api.validate: refactor Schema class
bastimeyer May 7, 2022
8bf91e1
plugin.api.validate: turn module into package
bastimeyer May 7, 2022
a59217b
plugin.api.validate: implement ValidationError
bastimeyer May 7, 2022
5c24fe4
plugin.api.validate: truncate error messages
bastimeyer May 7, 2022
3153e8d
plugin.api.validate: rewrite tests
bastimeyer May 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
plugin.api.validate: fix xml_element 
Add missing tail attribute and clone child nodes
  • Loading branch information
@bastimeyer
bastimeyer committed May 7, 2022
commit c5df6b2b1fc0025a0b01de1f49f04ed4de4a4f7b
21 changes: 16 additions & 5 deletions src/streamlink/plugin/api/validate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@


from collections import abc
from copy import copy as copy_obj
from copy import copy, deepcopy
from functools import singledispatch
from re import Match
from typing import Any, Tuple, Union
Expand Down Expand Up @@ -121,12 +121,15 @@ def __init__(self, *keys, seq=tuple):


class xml_element:
"""A XML element."""
"""
Validate an XML element.
"""

def __init__(self, tag=None, text=None, attrib=None):
def __init__(self, tag=None, text=None, attrib=None, tail=None):
self.tag = tag
self.text = text
self.attrib = attrib
self.tail = tail


# ----
Expand Down Expand Up @@ -447,6 +450,7 @@ def validate_xml_element(schema, value):
_tag = value.tag
_attrib = value.attrib
_text = value.text
_tail = value.tail

if schema.attrib is not None:
try:
Expand All @@ -466,17 +470,24 @@ def validate_xml_element(schema, value):
except ValueError as err:
raise ValueError(f"Unable to validate XML text: {err}")

if schema.tail is not None:
try:
_tail = validate(schema.tail, value.tail)
except ValueError as err:
raise ValueError(f"Unable to validate XML text: {err}")

new = Element(_tag, _attrib)
new.text = _text
new.tail = _tail
for child in value:
new.append(child)
new.append(deepcopy(child))

return new


@validate.register(attr)
def validate_attr(schema, value):
new = copy_obj(value)
new = copy(value)

for attr, schema in schema.schema.items():
if not _hasattr(value, attr):
Expand Down
6 changes: 5 additions & 1 deletion tests/test_api_validate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,10 +186,14 @@ def test_xml_element(self):
upper = transform(str.upper)
newelem: Element = validate(xml_element(tag=upper, text=upper, attrib={upper: upper}), el)

assert newelem is not el
assert newelem.tag == "TAG"
assert newelem.text == "TEST"
assert newelem.attrib == {"KEY": "VALUE"}
assert list(newelem.iterchildren()) == [childA, childB]
assert newelem[0].tag == "childA"
assert newelem[1].tag == "childB"
assert newelem[0] is not childA
assert newelem[1] is not childB

with self.assertRaises(ValueError) as cm:
validate(xml_element(tag="invalid"), el)
Expand Down