Skip to content

3_usage_api.rst

Latest commit

 

History

History
139 lines (97 loc) · 4.44 KB

3_usage_api.rst

File metadata and controls

139 lines (97 loc) · 4.44 KB
Raw

Programmatic Validation

.. toctree::
    :maxdepth: 5
    :caption: Getting Started


.. toctree::
    :maxdepth: 5
    :caption: Resources


.. seealso::

    To resolve resources from a local cache or run validation without network
    access (the ``offline`` / ``no_cache`` settings of ``ValidationSettings``),
    see :ref:`offline_mode`.

Metadata-only Validation

In addition to full validation, which checks both metadata and data files, the library also supports metadata-only validation. This is useful when you want to ensure that the metadata conforms to the expected schema without checking the actual data files.

To perform metadata-only validation, you can use the validate_metadata_as_dict from the rocrate_validator.services module. This function takes a dictionary representing the metadata and validates it against a given validation profile.

import json
from rocrate_validator.services import validate_metadata_as_dict

settings = {
    "profile_identifier": "workflow-ro-crate-1.0"
}

with open('tests/data/crates/invalid/0_main_workflow/main_workflow_bad_type/ro-crate-metadata.json', 'r') as f:
    # load the metadata from the JSON file
    rocrate_metadata = json.load(f)

    # validate the metadata dictionary
    result = validate_metadata_as_dict(rocrate_metadata, settings=settings)

    # process the validation result as needed
    ...

Formatting Validation Results

Validation results can be rendered using different output formatters provided by the library. Two formatter types are available: text and JSON. Both rely on the rich Python library and integrate with the rocrate_validator.utils.io_helpers.output.console.Console class, which extends rich.console.Console to support custom formatter registration.

To format results, create a Console instance, register one formatter, and then print any validation output object (e.g., the full report or the aggregated statistics).

TextOutputFormatter

TextOutputFormatter renders validation reports as human-readable, styled text. It is typically used for console output, report generation, or writing results to a file.

from rocrate_validator.utils.io_helpers.output.console import Console
from rocrate_validator.utils.io_helpers.output.text import TextOutputFormatter

console = Console()
console.register_formatter(TextOutputFormatter())

# Print the main validation result
console.print(result)

# Print aggregated statistics (violations by severity, executed checks, etc.)
console.print(result.statistics)

# Write the output to a file
with open("validation_report.txt", "w") as f:
    file_console = Console(file=f)
    file_console.register_formatter(TextOutputFormatter())
    file_console.print(result.statistics)
    file_console.print(result)

JSONOutputFormatter

JSONOutputFormatter produces JSON-structured output, suitable for logging, programmatic processing, or integration with external tools.

from rocrate_validator.utils.io_helpers.output.console import Console
from rocrate_validator.utils.io_helpers.output.json import JSONOutputFormatter

console = Console()
console.register_formatter(JSONOutputFormatter())

# Print the main validation result as JSON
console.print(result)

# Print the aggregated statistics
console.print(result.statistics)

# Write the output to a file
with open("validation_report.json", "w") as f:
    file_console = Console(file=f)
    file_console.register_formatter(JSONOutputFormatter())
    file_console.print(result)