Welcome to HTML5Validator’s documentation!¶
A requests-based interface to the validator.nu service.
This module provides access to the functionality provided by validator.nu or a private instance of it.
-
class
vnu.HTML5Validator(validator_url=None, out='json', asciiquotes='yes', laxtype='yes', content_type='text/html', charset='utf-8')¶ HTML5 validator.
-
validator_url¶ str
The http endpoint. Defaults to https://validator.nu/.
-
fragment_prefix¶ str
HTML5 boilerplate start. Used for fragment checking.
-
fragment_suffix¶ str
HTML5 boilerplate end. Used for fragment checking.
-
fragment_template¶ str
String template for HTML5 fragments. Used to surround a fragment with minimal HTML5 boilerplate.
-
validate(to_validate, params=None)¶ Validate given input (trying to guess what it is).
Parameters: - to_validate (str or filelike) – Validation input Depending on input, the real validation handler is guessed.
- params (Optional[dict]) – Parameter override. Defaults to None.
Returns: tuple of (status_code, response_obj). response_obj depends on out param.
-
validate_document(document, params=None)¶ Validate a full HTML5 document.
Parameters: - document (str or unicode) – The full document.
- params (Optional[dict]) – Parameter override. Defaults to None.
-
validate_file(fileinput, params=None)¶ Validate a (local) file.
Parameters: - fileinput (str of file) – Filename or file-like object.
- params (Optional[dict]) – Parameter override. Defaults to None.
-
validate_fragment(fragment, params=None)¶ Validate a HTML5 fragment.
In order to be able to validate just a fragment, the given piece of text is wrapped into minimal HTML5 boilerplate.
Parameters: - fragment (str or unicode) – A HTML5 fragment.
- params (Optional[dict]) – Parameter override. Defaults to None.
-
validate_url(url, params=None)¶ Validate given URL.
The URL must be reachable by the configured validation service.
Parameters: - url (str) – URL to validate
- params (Otional[dict]) – Parameter override. Defaults to None.
-