Skip to main content

XMLGenerator

Rust Crates.io Version Python PyPI Version XML GitHub GitHub Release uv Pytest GitHub Actions Test Rust Test Python Coverage Upload Read the Docs Documentation Status CodeCov Coverage Coffee License: MIT No AI

This project provides a Python package pyxmlgenerator, which generates XML instances matching the provided XML Schema (XSD) input. The package is written in Rust with PyO3 Python bindings allowing direct use from Python. The pyxmlgenerator package is a wrapper for the xmlgenerator Rust crate, which generates the XML from a given schema.

The project includes several additional Cargo crates to achieve this goal:

Additionally, the project also includes a Python wrapper for the xsdtestdata crate - pyxsdtestdata. This allows the test data to be accessed directly from Python.

Dependencies

System requirements:

  • Cargo - Installed via Rustup
  • libxml2-rs - Rust bindings for the libxml2 C library
  • Python - Required for Python bindings pyxmlgenerator
  • uv - Recommended for installation of Python packages (Optional)

Build

To build the Rust xmlgenerator library, simply run:

cargo build

To run the Rust test suite, use:

cargo test

To build the Python wrapper pyxmlgenerator, run:

uv sync --package pyxmlgenerator

To run the Python test suite, use:

uv run pytest

Usage

The library can be used either from Python or Rust. Here are examples of each:

Python

The following example illustrates a similar workflow in Python, using the built-in argparse and pathlib libraries to read and validate command-line input.

import pathlib
import argparse
import pyxmlgenerator

from xmlschema importXMLSchema

parser = argparse.ArgumentParser()
parser.add_argument("filepaths", type=pathlib.Path, nargs='+')

args = parser.parse_args()

paths = args.filepaths

xml_generator = pyxmlgeneratorXMLGenerator()

for path in paths:
    path_str = str(path)

    # Validate file
    try:
        xml_generator.validate(path_str)
    except pyxmlgenerator.XSDValidatorError:
        print(f"Invalid file: {path}")
        exit(0)

    print(f"Valid file: {path}")
    try:
        output = xml_generator.generate()
    except:
        print("Error running generator")
        exit(0)

    print("Output generated!")

    # Generate sc
    schema =XMLSchema(path_str)

    if schema.is_valid(output):
        print("Output is valid")
    else:
        print("Output does not match input schema")

This example uses Python's xmlschema library to validate output XML strings.

Rust

The following is an example of a simplified program which reads a list of filepaths from command-line arguments and generates example XML output strings for each valid XSD.

use std::env;
use std::path::PathBuf;
use std::str::FromStr;
use xmlgenerator:XMLGenerator;

fn main() {
    let generator =XMLGenerator::new();
    let args: Vec<String> = env::args().collect();
    if args.is_empty() {
        println!("No files provided!");
        println!("Usage: ./example [files] ...");
        return;
    }

    println!("Reading {} input files...", args.len());
    for arg in args {
        let path = PathBuf::from_str(arg.as_str()).unwrap();

        // Validate file
        if let Err(error) = generator.validate(&path) {
            println!("Invalid file: {}", path);
            return;
        }

        println!("Valid input file: {}", path);
        let output = match generator.generate(&path, None) {
            Ok(out) => out,
            Err(e) => {
                eprintln!("Error running generator: {}", path);
                eprintln!("Error: {}", e);
                return;
            }
        };

        println!("Output generated!");
        println!("Output:");
        println!(output);
    }
}

NOTE: Only a single XMLGenerator` should be created. Multiple instances of this class cause undefined behaviour.

Limitations

Not all features of the XSD specification have been implemented, if these features are encountered, an unimplemented error is thrown.

Metadata

Release files for pyxsdtestdata 0.2.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for pyxsdtestdata 0.2.4
File Interpreter ABI Platform Actions
pyxsdtestdata-0.2.4-cp310-abi3-win_arm64.whl CPython 3.10 abi3 Windows ARM64 Details for pyxsdtestdata-0.2.4-cp310-abi3-win_arm64.whl

Release files / pyxsdtestdata-0.2.4-cp310-abi3-win_arm64.whl

Download URL pyxsdtestdata-0.2.4-cp310-abi3-win_arm64.whl
Size 1.6 MB
Tags CPython 3.10 Windows ARM64 abi3
SHA-256 checksum
How to use checksums
4ad2ed0f67337e99b1afe632af5d09cab2928e0ebeb192cdeca74c849143974c
BLAKE2b-256 checksum
How to use checksums
7b9e17241dd97a923bb86e91cb70a7f7510a6c001f3f5cf4fea5100f17ed8319
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for pyxsdtestdata 0.2.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.4 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page