TRAPI Result Mapping

class reasoner_validator.trapi.mapping.MappingValidator

Bases: ValidationReporter

The Mapping Validator is a wrapper class for detecting dangling references between nodes and edges of a graph. This is more of a TRAPI expectation (that all nodes and edges identifiers refer to one another)

Methods

`add_messages`(new_messages)	Batch addition of MESSAGES_BY_TARGET messages to a ValidationReporter instance. :param new_messages: MESSAGES_BY_TARGET, messages indexed by target, test and categories: one of "information", "skipped tests", "warnings", "errors" or "critical", with code-keyed dictionaries of (structured) message parameters.
`apply_validation`(validation_method, *args, ...)	Wrapper to allow validation_methods direct access to the ValidationReporter.
`dump`([title, id_rows, msg_rows, ...])	Dump all available messages captured by the ValidationReporter, printed as formatted human-readable text, on a specified file device.
`dump_all_messages`([test, target, flat])	Dump all messages for a given test from a given target, as JSON.
`dump_critical`([test, target, flat])	Dump critical error messages as JSON.
`dump_errors`([test, target, flat])	Dump 'error' messages as JSON.
`dump_info`([test, target, flat])	Dump 'information' messages as JSON.
`dump_messages_type`(message_type[, test, ...])	Dump ValidationReporter messages of type 'message_type' as JSON.
`dump_skipped`([test, target, flat])	Dump 'skipped test' messages as JSON.
`dump_warnings`([test, target, flat])	Dump 'warning' messages as JSON.
`dumps`([id_rows, msg_rows, compact_format])	Text string version of dump(): returns all available messages captured by the ValidationReporter, as a formatted human-readable text blob.
`get_all_messages`()	Get copy of all MESSAGES_BY_TARGET as a Python data structure.
`get_all_messages_of_type`(message_type)	Get MESSAGE_PARTITION dictionary of all ValidationReporter messages of a given 'message_type', harvested from all target and test contexts.
`get_critical`([test, target])	Get copy of all recorded 'critical' error messages, for a given test from a given target.
`get_default_target`()	Returns the current target of the ValidationReporter.
`get_default_test`()	Returns the current default test identifier of the ValidationReporter.
`get_errors`([test, target])	Get copy of all recorded 'error' messages, for a given test from a given target.
`get_info`([test, target])	Get copy of all recorded 'information' messages, for a given test from a given target.
`get_message_type`(code)	Get type of message code.
`get_messages_by_target`([target])	Returns a block of MESSAGES_BY_TEST corresponding to a given or default target.
`get_messages_by_test`([test, target])	Returns MESSAGE_CATALOG corresponding to a given or default target. Note that the dictionary returned is not a copy of the original thus caution should be taken not to mutate it! :param test: str, specified test (gets current 'default' test if not given) :param target: str, specified target (gets current 'default' test if not given) :return: MESSAGES_BY_TEST corresponding to a resolved target.
`get_messages_of_type`(message_type[, test, ...])	Get Python data dictionary of ValidationReporter messages of 'message_type', for a specified (or default?) target and test.
`get_skipped`([test, target])	Get copy of all recorded 'skipped test' messages, for a given test from a given target.
`get_warnings`([test, target])	Get copy of all recorded 'warning' messages, for a given test from a given target.
`has_critical`([test, target])	Predicate to detect any recorded critical error messages.
`has_errors`([test, target])	Predicate to detect any recorded error messages.
`has_information`([test, target])	Predicate to detect any recorded information messages.
`has_message_type`(message_type[, test, target])	Predicate to detect if ValidationReporter has any non-empty messages of type 'message_type'.
`has_messages`([test, target])	Predicate to detect any recorded validation messages.
`has_skipped`([test, target])	Predicate to detect any recorded 'skipped test' messages.
`has_warnings`([test, target])	Predicate to detect any recorded warning messages.
`is_strict_validation`(graph_type[, ...])	Predicate to test if strict validation is to be applied.
`merge`(reporter)	Merge all messages and metadata from a second ValidationReporter, into the calling ValidationReporter instance.
`merge_coded_messages`(aggregated, additions)	Merge additional MESSAGE_PARTITION content into an already aggregate MESSAGE_PARTITION.
`report`(code[, test, target, source_trail])	Capture a single validation message, as per specified 'code' (with any code-specific contextual parameters). :param code: str, dot delimited validation path code :param test: str, specified test (gets current 'default' test if not given) :param target: str, specified target (gets current 'default' test if not given) :param source_trail, Optional[str], audit trail of knowledge source provenance for a given Edge, as a string. Defaults to "global" if not specified. :param message: **Dict, named parameters representing extra (str-formatted) context for the given code message :return: None (internally record the validation message).
`report_header`([title, compact_format])	Return a suitably generated report header. :param title: Optional[str], if title is None, then only the 'reasoner-validator' version is printed out in the header. If the title is an empty string (the default), then 'Validation Report' used. :param compact_format: bool, whether to print the header in compact format (default: True). Extra line feeds are otherwise provided to provide space around the header and control characters are output to underline the header. :return: str, generated header.
`reset_default_target`(name)	Resets the default target identifier of the ValidationReporter to a new string.
`reset_default_test`(name)	Resets the default test identifier of the ValidationReporter to a new string.
`test_case_has_validation_errors`(tag, case)	Check if test case has validation errors.
`to_dict`()	Export ValidationReporter message contents as a Python dictionary.

check_dangling_references
merge_identified_messages
merge_scoped_messages

check_dangling_references(graph: Dict)

default_target: str

default_test: str

messages: MESSAGES_BY_TARGET

strict_validation: bool | None

reasoner_validator.trapi.mapping.check_node_edge_mappings(graph: Dict) → MappingValidator