Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

plain-parser

Python parser for ***plain specification files.

Reads a .plain module with its import / requires chain and its test plain files, resolves Liquid templates, validates concepts and linked resources, and returns the marshalled specification tree of every module in the chain, with the test scenarios of each functionality merged in.

Install

pip install plain-parser

Command line

plain-parser check <file.plain> [--template-dir DIR] [--tests-folder DIR]... [--config-name NAME]
plain-parser parse <file.plain> [--template-dir DIR] [--tests-folder DIR]... [--config-name NAME]

Both commands parse the module and its requires chain, bind the test plain files under the tests folders to the functionalities, check that every linked resource is an existing file (not a directory), and walk the module's functionalities. They stop at the first error.

check

Validates the module. In addition to the steps above it reads every linked file and rejects binary files and files holding a large base64 blob. When the config file names a conformance-tests-script, every functionality of every module in the chain needs a test plain file bound to it; the sections of the file may be empty.

$ plain-parser check my_spec.plain
my_spec.plain: OK

Exit 0 when the module is valid. On an error, Error: … is written to stderr and the exit code is 1. The message names the file and the line where known. The previous syntax (- bullets instead of # <func-id> headings in ***functional specs***, an ***acceptance tests*** section in a spec plain file) is reported as not supported. A functionality without a test plain file names the add-test-scenarios skill.

parse

Prints the parse result as one UTF-8 JSON document on stdout. Linked files are located but not read.

$ plain-parser parse my_spec.plain
{
  "format_version": 2,
  "modules": [{"module": "...", "tree": {...}}, ...],
  "resources": {...},
  "test_plain_files": {...}
}
  • format_version: 2.
  • modules: every module in the requires chain, in build order: deepest ancestor first, the module itself last. Each entry has the module name and its specification tree, in the shape described under Python below.
  • resources: every linked-resource target in the chain and its test plain files, as written in the spec, mapped to the path it resolves to, relative to the entry module's directory, with / as separator: notes.md when found next to the module, ../tpl/notes.md when found in a template directory. The directory part is lexical (symlinks not resolved) and the target is appended as written (.. kept), so joining the value onto the entry module's directory names the file the parser matched. When no relative path exists (another drive on Windows) the value is the absolute path, still with /. Two spellings of one file (notes.md, ./notes.md) are two keys.
  • test_plain_files: every test plain file read, by its path relative to the entry module's directory with / as separator, mapped to {"module": ..., "func_id": ...}, the functionality it binds to.

Exit 0 on success. On a parser error the JSON is {"format_version": 2, "type": "<error class>", "message": "…"} and the exit code is 1.

Options and exit codes

Modules and {% include %} templates are looked up in the .plain file's directory, then in --template-dir. When --template-dir is not given, it is read from the template-dir key of config.yaml (or the file named by --config-name), found next to the .plain file or in the working directory. Finding it in both is a usage error. The config file is read even when --template-dir is given, so a malformed one fails the run either way.

Test plain files are the .plain files under the tests folders: those given with --tests-folder (repeat the option for more than one), else the tests-folder key of the config file (a string or a list). Without both, no test plain files are read, and a config file that names a conformance-tests-script makes that a usage error. A test directory that does not exist is skipped. Linked resources in a scenario are looked up as in a module. The conformance-tests-script key of the config file turns on the check that every functionality has a test plain file. Other config keys are ignored.

Exit code Meaning
0 Success
1 The module, its chain, a test plain file, or a linked resource is invalid
2 Usage error, including an ambiguous or malformed config file
130 Interrupted

Python

from plain_parser import plain_file_parser, project

module_name, plain_source_tree, required_modules = plain_file_parser("my_spec.plain", ["."])

result = project.parse_project("my_spec.plain", ["."], ["tests"], require_test_plain_files=True)
chain = result.chain  # (module name, plain source tree) pairs, deepest ancestor first, the module itself last

plain_source_tree is a dict keyed by section. definitions, implementation reqs and test reqs are lists of {"markdown": ..., "linked_resources": [...]} entries. functional specs is a list of {"id", "markdown", "linked_resources", "conformance_tests", "acceptance_tests"} entries, one per # <func-id> heading in file order; each test entry is {"id", "text", "linked_resources"} with the scenario text as written. plain_parser.plain_spec has helpers for walking functionalities by func-id (get_frids, get_specifications_for_frid, collect_linked_resources).

Development

uv venv --python 3.11 && source .venv/bin/activate
uv pip install -e ".[dev]"
pytest
black . --check && isort . --check-only && flake8 . && mypy src

License

MIT, see LICENSE.

Metadata

Release files for plain-parser 0.1.5.dev19

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

Source distribution (sdist)

Source distribution for plain-parser 0.1.5.dev19
File Size Uploaded Provenance Actions
plain_parser-0.1.5.dev19.tar.gz 101.6 kB With provenance Details for plain_parser-0.1.5.dev19.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for plain-parser 0.1.5.dev19
File Interpreter ABI Platform Actions
plain_parser-0.1.5.dev19-py3-none-any.whl Python 3 none any Details for plain_parser-0.1.5.dev19-py3-none-any.whl

Total release size: 138.9 kB

Release files / plain_parser-0.1.5.dev19.tar.gz

Download URL plain_parser-0.1.5.dev19.tar.gz
Size 101.6 kB
Tags Source
SHA-256 checksum
How to use checksums
b84c076dd2c70e7405b7f8c4d10ade87a26c9355433070e0c0e37f2d1d6dc942
BLAKE2b-256 checksum
How to use checksums
8aa124a09dfbf2a1872f72ee7683d572c1b4e7781c139672ca45f15ceaf6da62
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.

Transparency log

Release files / plain_parser-0.1.5.dev19-py3-none-any.whl

Download URL plain_parser-0.1.5.dev19-py3-none-any.whl
Size 37.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
39f7b024dbe24b10dce02ca50c22dde11ead4efe47758b67114cb2b577732920
BLAKE2b-256 checksum
How to use checksums
8b9436f023df4b8cabed6203d4329e9b58a084cc5204131228b6665904429dd7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.

Transparency log

Security for plain-parser 0.1.5.dev19

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for plain_parser-0.1.5.dev19.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.

Transparency log

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
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