Skip to main content

In-process Python bindings for vastlint VAST XML validation

Project description

vastlint (Python)

High-performance, in-process VAST XML validation for Python backends.

Rule reference: vastlint.org/docs/rules · Web validator: vastlint.org/validate

This package wraps the stable vastlint-ffi C API, backed by the same Rust core used by the CLI, Go binding, Ruby gem, Erlang NIF, MCP server, and web validator. The intended use case is a DSP, SSP, ad server, or trafficking backend that needs to validate VAST XML and return structured linting results to a frontend.

Why this shape

  • No subprocess management in your Python app
  • No network hop to an external validation service
  • Stable JSON-compatible result shape for backend-to-frontend responses
  • Same rule coverage and behavior as the rest of the vastlint ecosystem

Install

The package bundles a platform-matched libvastlint shared library inside the wheel, so no compiler or Rust toolchain is needed at install time.

pip install vastlint

You can also point the package at an explicit shared library with VASTLINT_LIB_PATH:

export VASTLINT_LIB_PATH=/absolute/path/to/libvastlint.dylib

For development in this monorepo, it automatically falls back to the sibling vastlint/target/debug and vastlint/target/release outputs.

Usage

import vastlint

result = vastlint.validate(vast_xml)

if result.valid:
    print("clean tag")
else:
    print(result.summary.errors)
    print(result.issues[0].message)

print(result.to_json())

FastAPI / Flask example

from fastapi import FastAPI
from pydantic import BaseModel
import vastlint

app = FastAPI()


class ValidateRequest(BaseModel):
    xml: str
    wrapper_depth: int = 0
    max_wrapper_depth: int = 5
    rule_overrides: dict[str, str] | None = None


@app.post("/validate")
def validate(req: ValidateRequest):
    result = vastlint.validate(
        req.xml,
        wrapper_depth=req.wrapper_depth,
        max_wrapper_depth=req.max_wrapper_depth,
        rule_overrides=req.rule_overrides,
    )
    return result.to_dict()

The response shape is stable and frontend-friendly:

{
  "version": "4.2",
  "issues": [
    {
      "id": "VAST-2.0-inline-impression",
      "severity": "error",
      "message": "<InLine> must contain at least one <Impression>",
      "path": "/VAST/Ad[0]/InLine",
      "spec_ref": "IAB VAST 2.0 §2.2.1",
      "line": 4,
      "col": 3
    }
  ],
  "summary": { "errors": 1, "warnings": 0, "infos": 0, "valid": false }
}

API

vastlint.validate(xml, *, wrapper_depth=0, max_wrapper_depth=5, rule_overrides=None) -> Result
vastlint.version() -> str

xml accepts str or bytes. rule_overrides maps rule IDs to severity levels:

result = vastlint.validate(
    vast_xml,
    rule_overrides={
        "VAST-2.0-mediafile-https": "error",
        "VAST-4.1-mezzanine-recommended": "off",
    },
)

Result exposes .version, .issues (list of Issue), .summary (Summary), .valid, .to_dict(), and .to_json(). All result types are frozen dataclasses.

Native library layout

Vendored release libraries live at:

  • src/vastlint/native/darwin_arm64/libvastlint.dylib
  • src/vastlint/native/darwin_amd64/libvastlint.dylib
  • src/vastlint/native/linux_arm64/libvastlint.so
  • src/vastlint/native/linux_amd64/libvastlint.so

They come from the vastlint-ffi-* tarballs attached to each vastlint GitHub Release. Refresh them with:

./scripts/fetch-libs.sh v0.4.14

License

Apache 2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vastlint-0.4.14.tar.gz (1.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vastlint-0.4.14-py3-none-any.whl (1.8 MB view details)

Uploaded Python 3

File details

Details for the file vastlint-0.4.14.tar.gz.

File metadata

  • Download URL: vastlint-0.4.14.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for vastlint-0.4.14.tar.gz
Algorithm Hash digest
SHA256 92525104b0a9d6a683f2e7e3933c610e3e2d052acb9481d3ba6d21e49b91a191
MD5 51e2e08af7664219f5e6efa564cfab10
BLAKE2b-256 26e6df5cd66227a4e1520343b008dec2b6feda64b2b9503f56126edebddc8795

See more details on using hashes here.

Provenance

The following attestation bundles were made for vastlint-0.4.14.tar.gz:

Publisher: publish-pypi.yml on aleksUIX/vastlint-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vastlint-0.4.14-py3-none-any.whl.

File metadata

  • Download URL: vastlint-0.4.14-py3-none-any.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for vastlint-0.4.14-py3-none-any.whl
Algorithm Hash digest
SHA256 66395ea53d1271b9657a5159bd1df0dbc089a78b3c0a6792291a7ccb8e203f0b
MD5 a98315ded7367efa79d6c17447fec972
BLAKE2b-256 9bc6411b6a5c2605324f6e51073751800b3997358fe1b389aa7200d86502d120

See more details on using hashes here.

Provenance

The following attestation bundles were made for vastlint-0.4.14-py3-none-any.whl:

Publisher: publish-pypi.yml on aleksUIX/vastlint-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page