src.validationLogging package

Submodules

src.validationLogging.validationCodes module

class ValidationCode(*values)

Bases: Enum

bbc_block_backgroundColor_constraint = 77
bbc_document_validity = 76
bbc_region_attributes_constraint = 78
bbc_region_backgroundColor_constraint = 79
bbc_region_overflow_constraint = 80
bbc_region_position_constraint = 81
bbc_text_backgroundColor_constraint = 82
bbc_text_color_constraint = 83
bbc_text_fillLineGap_constraint = 84
bbc_text_fontFamily_constraint = 85
bbc_text_fontSize_constraint = 86
bbc_text_fontStyle_constraint = 87
bbc_text_lineHeight_constraint = 88
bbc_text_linePadding_constraint = 89
bbc_text_multiRowAlign_constraint = 90
bbc_text_span_constraint = 91
bbc_timing_gaps = 92
bbc_timing_minimum_subtitles = 93
bbc_timing_segment_overlap = 94
dapt_document_validity = 17
dapt_lang_audio = 18
dapt_lang_root = 19
dapt_metadata_content_descriptor = 20
dapt_metadata_desctype_validity = 21
dapt_metadata_represents = 22
dapt_metadata_scriptRepresents = 23
dapt_timing_attribute_constraint = 24
dapt_timing_framerate = 25
dapt_timing_origin_timecode = 26
dapt_timing_segment_overlap = 27
dapt_timing_start_of_programme_timecode = 28
dapt_timing_tickrate = 29
dapt_timing_timecode_offset = 30
dapt_timing_timecontainer = 31
ebuttd_document_validity = 32
ebuttd_empty_body_constraint = 34
ebuttd_empty_div_constraint = 35
ebuttd_head_element_constraint = 36
ebuttd_inline_styling_constraint = 47
ebuttd_layout_element_constraint = 37
ebuttd_multiRowAlign = 38
ebuttd_nested_div_constraint = 39
ebuttd_nested_span_constraint = 40
ebuttd_nested_timing_constraint = 41
ebuttd_overlapping_region_constraint = 42
ebuttd_p_xml_id_constraint = 33
ebuttd_parameter_timeBase = 53
ebuttd_region_attributes_constraint = 44
ebuttd_region_element_constraint = 43
ebuttd_region_position_constraint = 45
ebuttd_style_element_constraint = 46
ebuttd_styling_element_constraint = 48
ebuttd_timing_attribute_constraint = 49
imsc_parameter_activeArea = 50
preParse_byteOrderMark = 4
preParse_byteOrderMark_corrupt = 5
preParse_encoding = 3
preParse_nullBytes = 2
ttml_attribute_styling_attribute = 51
ttml_document_timing = 54
ttml_document_validity = 55
ttml_element_body = 56
ttml_element_br = 57
ttml_element_head = 58
ttml_element_layout = 59
ttml_element_region = 60
ttml_element_style = 61
ttml_element_styling = 62
ttml_idref_element_applicability = 63
ttml_idref_empty = 64
ttml_idref_too_many = 65
ttml_layout_region_association = 69
ttml_metadata_actor_reference = 66
ttml_metadata_role = 68
ttml_parameter_cellResolution = 52
ttml_parameter_contentProfiles = 70
ttml_styling = 71
ttml_styling_attribute_applicability = 74
ttml_styling_reference = 72
ttml_styling_referential_chained = 73
ttml_timing_attribute_syntax = 75
unclassified = 1
validator_internal_exception = 95
xml_document_validity = 8
xml_dtd = 9
xml_encoding_decl = 6
xml_entity_decl = 7
xml_id_unique = 13
xml_id_unqualified = 14
xml_parse = 10
xml_prune = 11
xml_root_element = 15
xml_tt_namespace = 16
xml_xsd = 12

src.validationLogging.validationLogger module

class ValidationLogger(iterable=(), /)[source]

Bases: list[ValidationResult]

append(validation_result: ValidationResult)[source]

Append object to the end of the list.

collateResults(more_than: int) → Self[source]
error(location: str, message: str, code: ValidationCode = ValidationCode.unclassified)[source]
good(location: str, message: str, code: ValidationCode = ValidationCode.unclassified)[source]
info(location: str, message: str, code: ValidationCode = ValidationCode.unclassified)[source]
skip(location: str, message: str, code: ValidationCode = ValidationCode.unclassified)[source]
warn(location: str, message: str, code: ValidationCode = ValidationCode.unclassified)[source]
write_csv(stream: TextIOWrapper)[source]
write_json(stream: TextIOWrapper)[source]
write_plaintext(stream: TextIOWrapper)[source]

src.validationLogging.validationResult module

ERROR = 3

Validation status code for a failed check, content is invalid

GOOD = 0

Validation status code for a passed check, content is valid

INFO = 1

Validation status code for information generated by a check

SKIP = 4

Validation status code for skipped check

StatusStrings = {0: 'Success', 1: 'Information', 2: 'Warning', 3: 'Error', 4: 'Skip'}

Map of Validation status codes to human readable strings

class ValidationResult(status: int, location: str, message: str, code: src.validationLogging.validationCodes.ValidationCode | None = None)[source]

Bases: object

asDict() → dict[source]
asString() → str[source]
code: ValidationCode | None = None
location: str
message: str
status: int
WARN = 2

Validation status code for a warning generated by a check

src.validationLogging.validationSummariser module

class BbcPassChecker[source]

Bases: ValidationPassChecker

class DaptPassChecker[source]

Bases: ValidationPassChecker

class EbuttdPassChecker[source]

Bases: ValidationPassChecker

class TtmlPassChecker[source]

Bases: ValidationPassChecker

class ValidationPassChecker[source]

Bases: object

classmethod failuresAndWarningsAndSkips(log: ValidationLogger) → tuple[int, int, int][source]
class XmlPassChecker[source]

Bases: ValidationPassChecker

Module contents