Skip to main content

Object-flow programming language v0 validator

Project description

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

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

ofplang_validate-0.1.0.tar.gz (96.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.0-py3-none-any.whl (73.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ofplang_validate-0.1.0.tar.gz
  • Upload date:
  • Size: 96.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.0.tar.gz
Algorithm Hash digest
SHA256 36893796d49b876abaabdbe35fd0eab5b96b258d39aadf644248164cc88929d6
MD5 c5951b3a5b3c4e7142b754c08d9f12f5
BLAKE2b-256 2d58aa5ac5844f6419681a376ff9672ab129e2f0ee507018ab6312f84028d462

See more details on using hashes here.

Provenance

The following attestation bundles were made for ofplang_validate-0.1.0.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.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ofplang_validate-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bc04c8c9f9605c2f89d916b7270402648d9d301629489803d1c0119707b8de05
MD5 4de0031c179678f8229f044d4834f1e7
BLAKE2b-256 816634a82f1229813c19374eebde3fa466bcf2c7cd09f1e5d5872dfc07173ad3

See more details on using hashes here.

Provenance

The following attestation bundles were made for ofplang_validate-0.1.0-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.

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