pyrs-yaml

A high-performance Python YAML library with perfect round-trip support, built with Rust and PyO3.

Features

YAML 1.2 compliant - Uses saphyr-parser for full YAML 1.2 support
Perfect Round-Trip - Preserves comments, anchors, tags, chomping, scalar styles, and flow/block formatting
In-Place Editing - Edit parsed documents via JSONPath-style paths (doc.set("$.a.b", v)) or the Node tree API, without losing formatting
High Performance - Rust backend, see benchmarks
NumPy ndarray support - safe_dump() / safe_dumps() / from_dict() / dump_file() serialize numpy.ndarray of any dimension (0-D through N-D) with zero-copy Rust dispatch
JSON Schema validation - YamlDocument.validate(schema) validates parsed documents against JSON Schema; YamlValidateError for failures
Async I/O - safe_dumps_async / safe_dump_async / safe_loads_async / safe_load_async via asyncio.run_in_executor
Incremental re-parse - doc.source() + doc.reparse() for re-parsing stored YAML in-place with different options
JSON serialization - doc.to_json() exports documents to standard JSON
Duplicate keys - allow_duplicate_keys=True opts into last-value-wins; YamlDuplicateKeyError otherwise
Custom tag handlers - register_tag with priority-based chaining, YamlTagSkip, remove_tag/clear_tag_handlers
Pydantic models - parse_as(Model, yaml) validates parsed YAML against Pydantic v2 models
Custom AST - Extensible AST for advanced YAML manipulation
PyYAML Compatible - Drop-in replacement with safe_load/safe_dump API

Installation

pip install pyrs-yaml

Or with uv:

uv pip install pyrs-yaml

Documentation

Full documentation (English, 简体中文, 日本語, 한국어) is available at https://759401524.github.io/pyrs-yaml. See CONTRIBUTING.md for development guidelines.

Quick Start

import pyrs_yaml

# Parse YAML
doc = pyrs_yaml.parse("key: value")
print(doc.to_yaml())  # key: value

# PyYAML compatible API
data = pyrs_yaml.safe_load("key: value")
print(data)  # {'key': 'value'}

# Round-trip preserves comments
original = "# Comment\nkey: value  # inline\n"
doc = pyrs_yaml.parse(original)
assert doc.to_yaml() == original  # True

# Edit in place without losing formatting
doc.set("$.key", "edited")  # key: edited  # inline
doc.set("$.new", 1)  # add a new key
print(doc.to_yaml())

JSON Schema validation

doc = pyrs_yaml.parse("name: Alice\nage: 30")
doc.validate({"type": "object", "properties": {"name": {"type": "string"}}})
# None — validation passed

# Invalid — raises YamlValidateError
doc.validate({"type": "object", "required": ["email"]})
# pyrs_yaml.YamlValidateError: "Email" is a required property

Async serialization

import asyncio
import pyrs_yaml


async def main():
    yaml = await pyrs_yaml.safe_dumps_async({"a": 1})
    data = await pyrs_yaml.safe_loads_async(yaml)
    print(data)  # {'a': 1}


asyncio.run(main())

Incremental re-parse

doc = pyrs_yaml.parse("x: on")
print(doc.get("x"))  # "on" (core schema: string)

doc.reparse(schema="yaml1.1")
print(doc.get("x"))  # True (yaml1.1 schema: bool)

JSON export

doc = pyrs_yaml.parse("a: 1\nb: hello")
json_str = doc.to_json()  # '{"a": 1, "b": "hello"}'

NumPy ndarray support

import numpy as np
import pyrs_yaml

# 1-D array
arr = np.array([1, 2, 3], dtype="int32")
yaml_str = pyrs_yaml.safe_dump(arr)
print(yaml_str)
# - 1
# - 2
# - 3

# 2-D matrix
matrix = np.array([[1, 2], [3, 4]], dtype="float64")
yaml_str = pyrs_yaml.safe_dump(matrix)
print(yaml_str)
# -
#   - 1.0
#   - 2.0
# -
#   - 3.0
#   - 4.0

# Round-trip
loaded = pyrs_yaml.safe_load(yaml_str)
assert loaded == [[1.0, 2.0], [3.0, 4.0]]

Duplicate keys

Duplicate mapping keys raise YamlDuplicateKeyError by default:

pyrs_yaml.parse("key: first\nkey: second")
# pyrs_yaml.YamlDuplicateKeyError: duplicate key: key

Pass allow_duplicate_keys=True to keep the last value instead:

doc = pyrs_yaml.parse("key: first\nkey: second", allow_duplicate_keys=True)
doc.get("key")  # "second"

The flag is available on parse, safe_load, safe_loads, parse_file, parse_all_docs, and YAML(allow_duplicate_keys=True). In round-trip mode, serializing a document with allowed duplicate keys emits the last occurrence.

Serialization options

to_yaml_with_options() controls indentation and line wrapping:

yaml_str = doc.to_yaml_with_options(
    indent_size=2,  # legacy base indent (used when the per-type options are omitted)
    width=80,  # line-wrap width; 0 disables wrapping
    indent_mapping=4,  # indent per block-mapping level
    indent_sequence=2,  # indent per block-sequence level
    indent_offset=0,  # base offset applied to the whole document
)

indent_mapping / indent_sequence / indent_offset default to indent_size / 0 when omitted, so indent_size=4 still indents everything by 4.

Tag handlers

import pyrs_yaml


# Decorator form
@pyrs_yaml.register_tag("!custom")
def custom_handler(node):
    return f"custom:{node}"


# Imperative form
pyrs_yaml.register_tag("!custom", lambda node: node.upper())

doc = pyrs_yaml.parse("name: !custom value")
doc.get("name")  # "custom:value"

Multiple handlers per tag run in ascending priority order; raising YamlTagSkip passes control to the next handler.
A handler must return a string — anything else raises YamlTagError.
remove_tag("!custom") and clear_tag_handlers() unregister handlers.

Pydantic models

Parse YAML directly into a Pydantic v2 model:

from pydantic import BaseModel
import pyrs_yaml


class Config(BaseModel):
    name: str
    age: int


cfg = pyrs_yaml.parse_as(Config, "name: Alice\nage: 30")
cfg.name  # "Alice"

parse_as raises TypeError for non-BaseModel targets and propagates Pydantic's ValidationError when the YAML does not match the model.

Features Supported

Feature	Support
YAML 1.2	Full
Comments (standalone + inline)	Preserved
Anchors (`&`) and aliases (`*`)	Preserved
Tags (`!!str`, `!!int`, etc.)	Preserved
Chomping (`\|-`, `\|+`, `>-`, `>+`)	Preserved
Complex keys (sequence/mapping as key)	Supported
Escape sequences (`\n`, `\t`, `\uXXXX`)	Supported
Flow collections (`{}`, `[]`)	Preserved
Block scalars (`\|`, `>`)	Preserved
Merge keys (`<<: *alias`)	Resolved (opt-out via `resolve_merges=False`)
NumPy ndarray	Full (0-D through N-D)
JSON Schema validation	Full
Async I/O	Full
Incremental re-parse	Full
JSON export	Full
Duplicate keys	Configurable (`YamlDuplicateKeyError` / last-wins)
Custom tag handlers	Priority-chained `register_tag`
Pydantic models	`parse_as()` validation

API Reference

Core Functions

# Parse YAML string (accepts str or bytes)
doc = pyrs_yaml.parse(yaml_str)
doc = pyrs_yaml.parse(yaml_bytes)

# Parse with options
doc = pyrs_yaml.parse(yaml_str, resolve_merges=False)

# Parse YAML file
doc = pyrs_yaml.parse_file("config.yaml")

# Parse multiple YAML documents
docs = pyrs_yaml.parse_all_docs(yaml_str)

# Convert to YAML string (with options)
yaml_str = doc.to_yaml()
yaml_str = doc.to_yaml_with_options(indent_size=4, explicit_start=True, sort_keys=True)

# Get value by key (with default)
value = doc.get("key")
value = doc.get("missing_key", "default")

# Get root type
doc.root_type()  # "mapping", "sequence", "scalar", "null"

# Check containment and length
"key" in doc
len(doc)

# Iterate
for key in doc:
    print(key, doc[key])

PyYAML Compatible API

# Load YAML to dict
data = pyrs_yaml.safe_load(yaml_str)

# Load multiple documents
docs = pyrs_yaml.safe_loads(yaml_str)

# Dump dict to YAML
yaml_str = pyrs_yaml.safe_dump(data)

# Convert dict to YAML
yaml_str = pyrs_yaml.from_dict(data)

# Convert JSON to YAML
yaml_str = pyrs_yaml.from_json(json_str)

# Dump to file
pyrs_yaml.dump_file(data, "output.yaml")

# Extract YAML frontmatter from markdown
frontmatter, content = pyrs_yaml.read_markdown("post.md")
frontmatter, content = pyrs_yaml.read_markdown_str(markdown_text)

# i18n language management
pyrs_yaml.set_language("zh-CN")
pyrs_yaml.get_language()  # "zh-CN"
pyrs_yaml.list_languages()  # ["en", "zh-CN"]
pyrs_yaml.detect_language()  # auto-detect from environment
pyrs_yaml.negotiate_language(["zh-CN", "en"], "en")  # "zh-CN"

Performance

Criterion benchmarks in benches/yaml_bench.rs (Rust) + pytest-codspeed in tests/test_benchmark_crosslib.py (Python). See benchmarks docs for the full cross-library comparison against PyYAML and ruamel.yaml:

Operation	Time
Parse (small, ~2 keys)	~1.7 µs
Parse (medium, ~30 keys)	~12 µs
Parse (large, ~60 keys)	~38 µs
Serialize (small)	~4.4 µs
Serialize (medium)	~4.7 µs
Serialize (large)	~5.5 µs
Roundtrip (small)	~5.9 µs
Roundtrip (large)	~45 µs

Development

# Install dependencies
uv sync

# Build Python extension
uv run maturin develop --release

# Run tests (Rust: cargo nextest; Python: uv run pytest)
cargo nextest run --all
uv run pytest tests/ -v --ignore=tests/benchmark_compare.py

# Lint and format (Rust + Python)
cargo clippy -- -D warnings
cargo fmt
uv run ruff check .
uv run ruff format .

# Run benchmarks (Rust)
cargo bench

# Run benchmarks (Python)
uv run pytest tests/test_benchmark_crosslib.py tests/test_benchmark_api.py --codspeed

# Performance sanity checks
uv run pytest tests/test_performance.py -v

# Git hooks
prek install --prepare-hooks
prek run --all-files

License

Licensed under either of:

at your option.

Download files

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

Source Distribution

pyrs_yaml-0.11.5.tar.gz (518.8 kB view details)

Uploaded Aug 4, 2026 Source

Built Distributions

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

pyrs_yaml-0.11.5-cp314-cp314t-win_arm64.whl (553.3 kB view details)

Uploaded Aug 4, 2026 CPython 3.14tWindows ARM64

pyrs_yaml-0.11.5-cp314-cp314t-win_amd64.whl (580.7 kB view details)

Uploaded Aug 4, 2026 CPython 3.14tWindows x86-64

pyrs_yaml-0.11.5-cp314-cp314t-win32.whl (537.5 kB view details)

Uploaded Aug 4, 2026 CPython 3.14tWindows x86

pyrs_yaml-0.11.5-cp314-cp314t-macosx_11_0_arm64.whl (590.7 kB view details)

Uploaded Aug 4, 2026 CPython 3.14tmacOS 11.0+ ARM64

pyrs_yaml-0.11.5-cp314-cp314t-macosx_10_12_x86_64.whl (629.0 kB view details)

Uploaded Aug 4, 2026 CPython 3.14tmacOS 10.12+ x86-64

pyrs_yaml-0.11.5-cp38-abi3-win_arm64.whl (567.6 kB view details)

Uploaded Aug 4, 2026 CPython 3.8+Windows ARM64

pyrs_yaml-0.11.5-cp38-abi3-win_amd64.whl (597.5 kB view details)

Uploaded Aug 4, 2026 CPython 3.8+Windows x86-64

pyrs_yaml-0.11.5-cp38-abi3-win32.whl (551.5 kB view details)

Uploaded Aug 4, 2026 CPython 3.8+Windows x86

pyrs_yaml-0.11.5-cp38-abi3-musllinux_1_2_x86_64.whl (859.1 kB view details)

Uploaded Aug 4, 2026 CPython 3.8+musllinux: musl 1.2+ x86-64

pyrs_yaml-0.11.5-cp38-abi3-musllinux_1_2_i686.whl (887.0 kB view details)

Uploaded Aug 4, 2026 CPython 3.8+musllinux: musl 1.2+ i686

pyrs_yaml-0.11.5-cp38-abi3-musllinux_1_2_aarch64.whl (793.3 kB view details)

Uploaded Aug 4, 2026 CPython 3.8+musllinux: musl 1.2+ ARM64

pyrs_yaml-0.11.5-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (646.4 kB view details)

Uploaded Aug 4, 2026 CPython 3.8+manylinux: glibc 2.17+ x86-64

pyrs_yaml-0.11.5-cp38-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl (680.9 kB view details)

Uploaded Aug 4, 2026 CPython 3.8+manylinux: glibc 2.17+ s390x

pyrs_yaml-0.11.5-cp38-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (702.7 kB view details)

Uploaded Aug 4, 2026 CPython 3.8+manylinux: glibc 2.17+ ppc64le

pyrs_yaml-0.11.5-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (614.6 kB view details)

Uploaded Aug 4, 2026 CPython 3.8+manylinux: glibc 2.17+ ARM64

pyrs_yaml-0.11.5-cp38-abi3-manylinux_2_5_i686.manylinux1_i686.whl (675.5 kB view details)

Uploaded Aug 4, 2026 CPython 3.8+manylinux: glibc 2.5+ i686

pyrs_yaml-0.11.5-cp38-abi3-macosx_11_0_arm64.whl (604.8 kB view details)

Uploaded Aug 4, 2026 CPython 3.8+macOS 11.0+ ARM64

pyrs_yaml-0.11.5-cp38-abi3-macosx_10_12_x86_64.whl (633.6 kB view details)

Uploaded Aug 4, 2026 CPython 3.8+macOS 10.12+ x86-64

File details

Details for the file pyrs_yaml-0.11.5.tar.gz.

File metadata

Download URL: pyrs_yaml-0.11.5.tar.gz
Upload date: Aug 4, 2026
Size: 518.8 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: uv/0.12.1 {"installer":{"name":"uv","version":"0.12.1","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}

File hashes

Hashes for pyrs_yaml-0.11.5.tar.gz
Algorithm	Hash digest
SHA256	`5720fe90782e61e1bc10fac85b80ce5d91ec5f77cb953e7ed49a393416ba28a1`
MD5	`cfeb89bb80ceddf39c3bd381a4682440`
BLAKE2b-256	`1d2e97b69e744e274711e73ffbd97da461cf9fe6b4206b124db80c89678b12b4`

Algorithm	Hash digest
SHA256	`1cfab4298610baf961b32cf800534697b27826f99f4ea4ed9aed374ec42943ad`
MD5	`f795455c6a7d19e40a0359d3e4975a44`
BLAKE2b-256	`a9ead8414c524cb3fca9628263f0acdf596721e28873d09118b7db1fb18b7084`

Algorithm	Hash digest
SHA256	`1b1f6affde47921b655bd71bd37698a8c53d688d6b1b0b95f4b396b66f62556c`
MD5	`18b3cd3eb649eb9d085fe26e872e9f32`
BLAKE2b-256	`4ac44b13c4ade8104544063b9007c9d6524799f7f581d78b3ac2eee2a5bc993b`

Algorithm	Hash digest
SHA256	`6e128a759e8ef39298e2c3082d2dbf2dd753d95bf3c81276cddea03b4d679f58`
MD5	`9bf4c7517af2ff56d332abfce0995bac`
BLAKE2b-256	`1be368cb6c3cda41ee4847e70570e8d402ec6a36ffa3dec27a1c5e45e2b2d60f`

Algorithm	Hash digest
SHA256	`02cc14d9361d1f776229587b3a87f757629b14a0ad6d05a933176217113e951a`
MD5	`3f569c05666bfc264729b6f931a84f88`
BLAKE2b-256	`022ffc4fc2ead76af6526e50870f6f12bf538b6f2595d1d8ea519f54d93071e1`

Algorithm	Hash digest
SHA256	`9a44373157208668eea3dd9dbc2867ec99e837d24b4add92bb9b6ce6456cd29e`
MD5	`56da96a520e13ef17a552d6c183a8d67`
BLAKE2b-256	`747bd3a2fdd8c86127fa09312c770b48bbc6278d79e3172ceae2dfa702f2fd26`

Algorithm	Hash digest
SHA256	`b6a25d359f989aafdb8cb2fbe4a70e9c76d1fa5e8f97d377dbe900996beae23e`
MD5	`a114c84bf149bf479b2987014fbb218e`
BLAKE2b-256	`2e3979db848075ed825cb5663641dd9076c456c7fd2a8342a5807a79929fc60c`

Algorithm	Hash digest
SHA256	`57716387ba06c4c01a9e88dd0ad063ca551b35ddc9bfde58d7c2df4f9b5953ab`
MD5	`6dadeaee9953ef5bcdb984681c57895e`
BLAKE2b-256	`d81c22596f88e319cfc8766127229c6a7996f459e6a15e85a7ffd37bde64c78a`

Algorithm	Hash digest
SHA256	`7d37882e0daa44b18d95d931a96fda3f88983f6a325607d69a60d52678798848`
MD5	`ea6028035880199cf891e18f795a691e`
BLAKE2b-256	`d7c0688b7a83fb7f4d3d4c1d9a131eeb785d55f79d417deca08e5daa4d78092f`

Algorithm	Hash digest
SHA256	`67d3440b824eb255517ddae35523e344c2f066e2f1f20f1e6570aaa2e40d5566`
MD5	`ed775ef1400c0b55304ed9973588b6c6`
BLAKE2b-256	`eb98fb86a7c5eded801d3eb41c846f7a5e30f83e6f731601d8bfbe8fc658c625`

Algorithm	Hash digest
SHA256	`4979285fb323baa5ad1b174e24549becae2c9fdf637fd50bf5cb3bbed790d457`
MD5	`9ffff8a051f2fd8449fc65d0a50f872e`
BLAKE2b-256	`9200df4db49b01f3231b72ee5e0e3ba78eb89843e40060fb63de53056b9a2c55`

Algorithm	Hash digest
SHA256	`84ee293018285c2233fe36fde56a0cf8ca5713a70f842119e52f9371ceb05d6e`
MD5	`13aadcda0e6f60fed9f6093e491d5da7`
BLAKE2b-256	`462eec665a71fa7947938032756ba10b2e466509dc96876cae00f2f65857acb5`

Algorithm	Hash digest
SHA256	`880ce71ea0d4d0ecfcd57e3f289750bf4064ca128704de5e83f7bb9e48bab5eb`
MD5	`7abb1e7e59b354516e560d540ca65abe`
BLAKE2b-256	`545084b6986ed8a90febcea76675c0b10872d889a0f1edc6160cb437ad38bdad`

Algorithm	Hash digest
SHA256	`9db034fe0f78a6ee1ab951fc9573013b56e73ff74004d98681f498b3b984d60b`
MD5	`3db32bf418bb97e49f6eaf5bbe264ef7`
BLAKE2b-256	`16dc10048e5b353c3e9f92da83480aa5e60896e8b7172d1b60dbbcdffda1dd97`

Algorithm	Hash digest
SHA256	`7e7189689304f76f129c3d4384dbfb2301ae099824566cf909c40cb61e91a51a`
MD5	`7bfb1319c275c16f164ef46ff8ab5ab3`
BLAKE2b-256	`eaca6900fae369ad195ee39bb093ff85164ce6f09b41273b6160c8f3419daca1`

Algorithm	Hash digest
SHA256	`e01063024e5fc7481fe8bcc398d4ebae092304b05d95d571be6d5c17195c404f`
MD5	`ace9aee72a371c1e093786a4de0e76a7`
BLAKE2b-256	`a5938d010827ddbaf054108aed260c2a0560443403667975a62960ac317e2749`

Algorithm	Hash digest
SHA256	`63cebf8f05015fafef6b3e1aa1bd95860509abe382b0a93ad55e820e7e328390`
MD5	`9a873768a7f44c10d8e83117f3bba9aa`
BLAKE2b-256	`b1c99c593fa7988540b011aaa94e36a0eb1bf1f80d400c7fcf0fadbc1f3496a8`

Algorithm	Hash digest
SHA256	`5ab71e6dc4b97df4a16f43afe837388fbf2a520a547d0ff9a2db5d5bafb25a74`
MD5	`808c20a626c587b9fed0fd6ca71da7f7`
BLAKE2b-256	`b0e490de2f79da8991f72f64aa0dac5c1057e0733eb3e9c05fab55a50beaf9f9`

Algorithm	Hash digest
SHA256	`0e4f4eb293a971ed2ab348ba3e1b14c795c9380d27fabe35c75f86a9bc40bf9d`
MD5	`c83005cbf0d8e192019ec7ad6d5e28d3`
BLAKE2b-256	`26bbd8fcebaa6b7bebdcbfb54ca8b676b0f5e437d18c124eae5828e0468327f5`

pyrs-yaml 0.11.5

pyrs-yaml

Features

Installation

Documentation

Quick Start

JSON Schema validation

Async serialization

Incremental re-parse

JSON export

NumPy ndarray support

Duplicate keys

Serialization options

Tag handlers

Pydantic models

Features Supported

API Reference

Core Functions

PyYAML Compatible API

Performance

Development

License

Project links

Key dates

1 maintainer

Credits

GitHub Statistics

License

Requires

Provides Extra

Tags

Classifiers

Download files

Source Distribution

Built Distributions

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes