mivot_validator package

Subpackages

• mivot_validator.instance_checking package
  • Subpackages
    • mivot_validator.instance_checking.builder package
      • Module contents
    • mivot_validator.instance_checking.xml_interpreter package
      • Submodules
      • mivot_validator.instance_checking.xml_interpreter.annotation_seeker module
      • mivot_validator.instance_checking.xml_interpreter.att_utils module
      • mivot_validator.instance_checking.xml_interpreter.dynamic_reference module
      • mivot_validator.instance_checking.xml_interpreter.exceptions module
      • mivot_validator.instance_checking.xml_interpreter.join_operator module
      • mivot_validator.instance_checking.xml_interpreter.model_viewer module
      • mivot_validator.instance_checking.xml_interpreter.resource_seeker module
      • mivot_validator.instance_checking.xml_interpreter.static_reference_resolver module
      • mivot_validator.instance_checking.xml_interpreter.table_iterator module
      • mivot_validator.instance_checking.xml_interpreter.vocabulary module
      • Module contents
  • Submodules
  • mivot_validator.instance_checking.inheritance_checker module
    • InheritanceChecker
      • InheritanceChecker.check_inheritance()
      • InheritanceChecker.get_inheritance()
      • InheritanceChecker.inherits_from()
  • mivot_validator.instance_checking.instance_checker module
    • CheckFailedException
    • InstanceChecker
      • InstanceChecker.check_instance_validity()
      • InstanceChecker.inheritence_tree
      • InstanceChecker.reset()
    • raise_check_failed_exception()
  • mivot_validator.instance_checking.instance_snippet_builder module
    • BColors
      • BColors.BOLD
      • BColors.ENDC
      • BColors.GRAY
      • BColors.OKBLUE
      • BColors.OKCYAN
      • BColors.OKGREEN
      • BColors.RED
      • BColors.UNDERLINE
      • BColors.WARNING
    • InstanceSnippetBuilder
      • InstanceSnippetBuilder.add_abstract_classes()
      • InstanceSnippetBuilder.ask_for_collection()
      • InstanceSnippetBuilder.build()
      • InstanceSnippetBuilder.clean()
      • InstanceSnippetBuilder.get_dm_role()
      • InstanceSnippetBuilder.get_dm_type()
      • InstanceSnippetBuilder.get_instance()
      • InstanceSnippetBuilder.insert_dm_roles()
      • InstanceSnippetBuilder.output_result()
      • InstanceSnippetBuilder.populate_choices()
      • InstanceSnippetBuilder.remove_instance()
    • add_value()
    • remove_value()
    • setup_elements()
  • mivot_validator.instance_checking.model_snippets_builder module
    • ModelBuilder
      • ModelBuilder.build()
      • ModelBuilder.build_object()
  • mivot_validator.instance_checking.snippet_builder module
    • Builder
      • Builder.CACHE
      • Builder.RECORD
      • Builder.RECORD_ON
      • Builder.addAttribute()
      • Builder.addComposition()
      • Builder.addExtend()
      • Builder.addReference()
      • Builder.build()
      • Builder.build_object()
      • Builder.get_concrete_type_by_ref()
      • Builder.get_object_by_ref()
      • Builder.get_vodmlid()
      • Builder.include_file()
      • Builder.is_abstract()
      • Builder.write_out()
    • Constraints
      • Constraints.add_constraint()
      • Constraints.get_contraint()
      • Constraints.get_superclass_contraint()
  • Module contents
• mivot_validator.launchers package
  • Submodules
  • mivot_validator.launchers.instance_checking_launcher module
    • main()
  • mivot_validator.launchers.instance_snippet_launcher module
    • check_concrete_classes()
    • main()
  • mivot_validator.launchers.mivot_launcher module
    • main()
  • mivot_validator.launchers.model_snippets_launcher module
    • check_args()
    • main()
  • mivot_validator.launchers.typesandroles_launcher module
    • main()
  • mivot_validator.launchers.votable_launcher module
    • main()
  • Module contents
• mivot_validator.utils package
  • Submodules
  • mivot_validator.utils.dict_utils module
    • DictUtils
      • DictUtils.find_item_by_key()
      • DictUtils.get_fatal_value()
      • DictUtils.get_optional_value()
      • DictUtils.get_permanent_object()
      • DictUtils.get_permanent_string()
      • DictUtils.get_prefixed_keys_dict()
      • DictUtils.get_pretty_json()
      • DictUtils.get_required_value()
      • DictUtils.print_pretty_json()
      • DictUtils.read_dict_from_file()
      • DictUtils.read_dict_from_url()
      • DictUtils.remove_comment()
      • DictUtils.write_dict_from_file()
  • mivot_validator.utils.json_encoder module
    • MyEncoder
      • MyEncoder.default()
  • mivot_validator.utils.json_tools module
    • JsonTools
      • JsonTools.is_join()
      • JsonTools.remove_dict_key()
      • JsonTools.remove_key()
      • JsonTools.remove_list_key()
  • mivot_validator.utils.logger_setup module
    • LoggerSetup
      • LoggerSetup.get_logger()
      • LoggerSetup.restore_default_level()
      • LoggerSetup.set_debug_level()
      • LoggerSetup.set_default_format()
      • LoggerSetup.set_error_level()
      • LoggerSetup.set_info_level()
      • LoggerSetup.set_warning_level()
  • mivot_validator.utils.quantity_converter module
    • QuantityConverter
      • QuantityConverter.parallax_to_distance()
  • mivot_validator.utils.xml_utils module
    • XmlUtils
      • XmlUtils.assertXmltreeEquals()
      • XmlUtils.assertXmltreeEqualsFile()
      • XmlUtils.get_attribute_by_role()
      • XmlUtils.get_attribute_value_by_role()
      • XmlUtils.get_instance_by_role()
      • XmlUtils.get_instance_by_type()
      • XmlUtils.pretty_print()
      • XmlUtils.pretty_string()
      • XmlUtils.set_column_indices()
      • XmlUtils.set_column_units()
      • XmlUtils.xmltree_from_file()
      • XmlUtils.xmltree_to_file()
  • Module contents

Submodules

mivot_validator.annotated_votable_validator module

Created on 2022/07/01

@author: laurentmichel

class mivot_validator.annotated_votable_validator.AnnotatedVOTableValidator

Bases: object

Validate tool for annotated VOTable Operate 2 separate validations - One for the VOTable - One for the MIVOT annotations

See the mivot_launcher to get how to use it

defaut_votable_schema = 'http://www.ivoa.net/xml/VOTable/v1.3'

validate(data_path)

Validate the content of data_path. If data_path is a directory, all its direct content is evaluated and the method returns false at the first XML file not validating :param data_path: file or directory path to be evaluated :type data_path: string :return: true all files validate :rtype: boolean

validate_mivot(file_path)

Validate MIVOT block in one XML file. :param file_path: file to be evaluated :type file_path: string :return: true all files validate :rtype: boolean

vodml_validator = <mivot_validator.xml_validator.XMLValidator object>

votable_validator = None

mivot_validator.dmtypes_and_role_checker module

Created on 2 Feb 2023

@author: laurentmichel

class mivot_validator.dmtypes_and_role_checker.DmTypesAndRolesChecker(session)

Bases: object

This module checks that all dmroles and dmtypes used a referenced in the mapped models This is a prototype - Only meas/coord/ivoa are checked, the other models are ignored - The checking is based on the vodml-id whatever their context in the vodml files

all errors are reported in the self.message list. The validation is considered as successful if the message list is empty at the end of the process

validate(file_path)

Validate that all dmroles and types found in the mapping block are part of the declared models. the method returns false if at least one error message has been collected :param file_path: file path to be evaluated :type file_path: string :return: true if the file is valid :rtype: boolean

mivot_validator.xml_validator module

Created on 2021/07/01

@author: laurentmichel

class mivot_validator.xml_validator.XMLValidator(xsd_path)

Bases: object

Convenient wrapper for the xmlschema validator TODO: managing the verbosity

validate_file(xml_path: str, verbose=False) → bool

Validate one file

validate_string(xml_string: str, verbose=False) → bool

Validate one XML string

Module contents