|
|
|
@ -1,4 +1,6 @@
|
|
|
|
|
import sys
|
|
|
|
|
from typing import Dict, TYPE_CHECKING
|
|
|
|
|
|
|
|
|
|
from bs4.element import Tag
|
|
|
|
|
|
|
|
|
|
if TYPE_CHECKING:
|
|
|
|
@ -8,6 +10,8 @@ if TYPE_CHECKING:
|
|
|
|
|
INPUT, SELECT, OPTION = 'input', 'select', 'option'
|
|
|
|
|
NAME, VALUE, SELECTED = 'name', 'value', 'selected'
|
|
|
|
|
|
|
|
|
|
NON_PRINTABLE_TO_NONE = {code: None for code in range(sys.maxunicode + 1) if not chr(code).isprintable()}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class WrongInterface(Exception):
|
|
|
|
|
pass
|
|
|
|
@ -29,6 +33,10 @@ class UnknownField(WrongInterface):
|
|
|
|
|
pass
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def printable_only(string: str) -> str:
|
|
|
|
|
return string.translate(NON_PRINTABLE_TO_NONE)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def check_select_field_options(field_tag: Tag, field_interface: 'FormField', check_defaults: bool = True) -> None:
|
|
|
|
|
"""
|
|
|
|
|
Compares the `options` and `default` attributes of a `'FormField'` object with the options of its HTML counterpart.
|
|
|
|
@ -45,13 +53,23 @@ def check_select_field_options(field_tag: Tag, field_interface: 'FormField', che
|
|
|
|
|
`FieldInterfaceWrong`
|
|
|
|
|
if the `default` is not equal to the value of the <option> tag which has the `selected` attribute
|
|
|
|
|
"""
|
|
|
|
|
options = {tag[VALUE]: tag.get_text(strip=True) for tag in field_tag.find_all(OPTION)}
|
|
|
|
|
if options != field_interface.options:
|
|
|
|
|
raise SelectOptionsWrong(f"Wrong options in {field_interface}")
|
|
|
|
|
html_options = {(tag[VALUE], printable_only(tag.get_text(strip=True))) for tag in field_tag.find_all(OPTION)}
|
|
|
|
|
interface_options = set(field_interface.options.items())
|
|
|
|
|
missing_in_interface = html_options - interface_options
|
|
|
|
|
not_in_html = interface_options - html_options
|
|
|
|
|
s = ""
|
|
|
|
|
if missing_in_interface:
|
|
|
|
|
s += "\nThe following <options> HTML tags were not found in the interface:\n"
|
|
|
|
|
s += "\n".join(str(tup) for tup in missing_in_interface)
|
|
|
|
|
if not_in_html:
|
|
|
|
|
s += "\nThe following options were defined, but are not present in the HTML:\n"
|
|
|
|
|
s += "\n".join(str(tup) for tup in not_in_html)
|
|
|
|
|
if s:
|
|
|
|
|
raise SelectOptionsWrong(f"Wrong options in field '{field_interface.name}'." + s)
|
|
|
|
|
if check_defaults:
|
|
|
|
|
default = field_tag.find(lambda tag: tag.name == OPTION and tag.has_attr(SELECTED))[VALUE]
|
|
|
|
|
if default != field_interface.default:
|
|
|
|
|
raise FieldInterfaceWrong(f"Default option '{default}' missing for {field_interface}")
|
|
|
|
|
default_option = field_tag.find(lambda tag: tag.name == OPTION and tag.has_attr(SELECTED))
|
|
|
|
|
if default_option is not None and default_option[VALUE] != field_interface.default:
|
|
|
|
|
raise FieldInterfaceWrong(f"Default option '{default_option[VALUE]}' missing for {field_interface}")
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def check_field_interface(field_tag: Tag, field_interface: 'FormField', check_defaults: bool = True) -> None:
|
|
|
|
@ -99,7 +117,7 @@ def check_form_interface(form_tag: Tag, form_interface: 'Form', check_defaults:
|
|
|
|
|
"""
|
|
|
|
|
field_tags: Dict[str, Tag] = {tag[NAME]: tag for tag in form_tag.find_all(INPUT) + form_tag.find_all(SELECT)}
|
|
|
|
|
for field in form_interface.fields.values():
|
|
|
|
|
tag = field_tags.pop(field.name)
|
|
|
|
|
tag = field_tags.pop(field.name, None)
|
|
|
|
|
if tag is None:
|
|
|
|
|
raise UnknownField(f"The defined field does not exist in the form: {field}")
|
|
|
|
|
check_field_interface(tag, field, check_defaults=check_defaults)
|
|
|
|
|