Skip to main content

ofplang validate

CI PyPI

A validator for Object-flow Programming Language v0 — a YAML-based dataflow workflow IR with linear Object tracking. The language is defined in the ofplang/spec repository.

The validator checks that a document is well-formed portable v0: structure and types, the feature model, linear Object tracking, structured nodes, contracts, and scheduling policies. It reports findings as stable error codes rather than free text, so results are easy to consume in tests and tooling.

Install

pip install ofplang-validate

Requires Python 3.10+. The only runtime dependency is PyYAML. For development, install editable with the test extra from a clone:

pip install -e ".[test]"

Command line

ofp-validate <file>...                 # or: python -m ofplang.validate <file>...
ofp-validate --mode extension-tolerant doc.yaml
ofp-validate --format json doc.yaml

Options: --mode {strict,extension-tolerant}, --format {text,json}, -q/--quiet, --no-color.

Exit codes: 0 all valid, 1 validation errors found, 2 usage/input error.

$ ofp-validate workflow.yaml
workflow.yaml:7:15: error unknown_type  processes.main.inputs.x.type  unknown type in 'Foo'
1 error in 1 of 1 file

Diagnostics carry a file:line:col source position (an imported fragment's own file when the problem is inside an $import); --format json includes file/line/col fields.

This tool is also intended to be exposed as the validate subcommand of the umbrella ofp CLI (a separate repository in the ofplang organization).

Library

from ofplang.validate import validate

result = validate("workflow.yaml", mode="strict")
if not result.ok:
    for d in result.diagnostics:
        print(d.code, d.path, d.message)

validate(source, *, mode="strict") returns a ValidationResult with .ok and .diagnostics (each a Diagnostic(code, message, path, file, line, col)). The validator collects all independent findings rather than stopping at the first; only a YAML parse or $import resolution failure is terminal.

The package lives under the ofplang PEP 420 namespace (ofplang.validate), shared across the organization's tools.

Scope

Covers graph-time validation of portable v0. Runtime failures, and run/data-phase preflight checks, are out of scope (spec §6.2, §25). Two modes are supported: strict (portable v0) and extension-tolerant (accepts x- extension keys).

Tests

The behavior is pinned by a spec-derived conformance suite that matches on error codes (see tests/conformance/README.md).

pytest                         # run everything
OFPLANG_STRICT_TESTS=1 pytest  # full contract, no pending escapes

Download files

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

Source Distribution

ofplang_validate-0.1.2.tar.gz (100.9 kB view details)

Uploaded Source

Built Distribution

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

ofplang_validate-0.1.2-py3-none-any.whl (74.5 kB view details)

Uploaded Python 3

File details

Details for the file ofplang_validate-0.1.2.tar.gz.

File metadata

  • Download URL: ofplang_validate-0.1.2.tar.gz
  • Upload date:
  • Size: 100.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for ofplang_validate-0.1.2.tar.gz
Algorithm Hash digest
SHA256 2ff9e543276df2088a4db548570a580e6b5c934ef6d0c6c9548a0a550e7b933c
MD5 12cfb9365f70ea7827ef6efc13dad23d
BLAKE2b-256 70d98b221621ea2d1e958d2ad2ad01b7d51aea4880f9e369311618737a4962e1

See more details on using hashes here.

Provenance

The following attestation bundles were made for ofplang_validate-0.1.2.tar.gz:

Publisher: publish.yml on ofplang/validate

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

File details

Details for the file ofplang_validate-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for ofplang_validate-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cca4706dd242b235d375295fc023186a6491d570740045b3ca5008172e080f3f
MD5 5d9b52b3925ac57ab163fc29364899fb
BLAKE2b-256 b01d118700fdf6742b6f3c7290c0ef0b0f506d60579f9e43632f87f582c83fb5

See more details on using hashes here.

Provenance

The following attestation bundles were made for ofplang_validate-0.1.2-py3-none-any.whl:

Publisher: publish.yml on ofplang/validate

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

Release history Release notifications | RSS feed

0.2.1

2 files

0.2.0

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

This release

0.1.2 This release

2 files

0.1.1

2 files

0.1.0

2 files

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