XDI-Validator

What is it?

XDI-Validator is a standalone JSON Schema based validator for XDI files. XDI (*.xdi) is a format used to save XAS data. This validator aim to be fully compliant with the XDI/1.0 specification, as detailed in the documents XAS Data Interchange Format Draft Specification, version 1.0 and Dictionary of XAS Data Interchange Metadata.

Usage

As simple as it gets :

# import the functionality from the module
from xdi_validator import validate, XDIEndOfHeaderMissingError

# open the xdi file
with open('filename.xdi', 'r') as xdi_document:
    
    # Validate the file. If there is no end-of-header token
    # an exception is raised
    try:
        xdi_errors, xdi_dict = validate(xdi_document)
    except XDIEndOfHeaderMissingError as ex:
        print(ex.message)
        
    # check if there are errors
    if xdi_errors:
        print('XDI is invalid!')
        print(xdi_errors)
    else:
        print('XDI is valid!')
        print(xdi_dict)
    

Basically, the method xdi_validator.validate() the *.xdi file-like object and will return a dictionary with the found errors per each field, and a representation of the contents of the *.xdi as a dictionary. The dictionary of errors is organized in the following way. The keys are the path (Namespace.tag) of the invalid field, and the corresponding value is the list of errors.

Note: Sure, users can also to use the library for parsing and converting XDI files into json representation.

Additionally, it is possible to convert a dictionary to XDI format and write it to file using the xdi_validator.write_xdi() function. Look the example below for a possible use case for this functionality:

# import the functionality from the module
from xdi_validator import validate, write_xdi, XDIEndOfHeaderMissingError

# open the xdi file
xdi
with open('filename.xdi', 'r') as xdi_document:
    
    # Validate the file. If there is no end-of-header token
    # an exception is raised
    try:
        xdi_errors, xdi_dict = validate(xdi_document)
    except XDIEndOfHeaderMissingError as ex:
        print(ex.message)
        
# check if there are errors
if xdi_errors:
    print('XDI is invalid!')
    # use the information in xdi_errors to correct the data
    # in the generated xdi_dict 
    ...
    # write the corrected data to file
    errors = write_xdi('corrected_file.xdi', xdi_dict)
    if not errors:
        print('Corrected file saved.')
    else:
        print(errors)
else:
    print('XDI is valid!')
    print(xdi_dict)

How to install?

XDI-Validator is available in PyPI. The project page is https://pypi.org/project/xdi-validator/. To install XDI-Validator on your development environment, just issue the command:

 pip install xdi-validator

To build and install from the source code do:

1. Clone the repository: git clone https://github.com/AAAlvesJr/XDI-Validator.git
2. Go the project directory: cd XDI-Validator
3. Build the package: python3 -m build
4. Install the wheel: pip install dist/xdi_validator-{VERSION}-py3-none-any.whl

where VERSION is the package version.

Source code

Access to the source code is granted via the project GitHub repository at the url https://github.com/AAAlvesJr/XDI-Validator.

Dependencies

XDI-Validator's only external dependency is jsonschema package.

How to contribute

Please, submit a pull request. PR adding new features should implement the correspondind unit test. Aside that, please, feel free to open issues for bugs and features requests.

License

XDI-Validator is available under the MIT license. See the LICENSE file for more info.