msgspec-yaml 1.0.2

Simple YAML loader for msgspec.Struct

msgspec-yaml

Simple YAML loader for msgspec.Struct.

Installation

uv

uv add msgspec-yaml

pip

pip install msgspec-yaml

poetry

poetry add msgspec-yaml

Usage

import msgspec

import msgspec_yaml


class Config(msgspec.Struct):
    host: str
    port: int


config = msgspec_yaml.load("config.yml", Config)

print(config.host)
print(config.port)

Example YAML file:

host: localhost
port: 8000

API

msgspec_yaml.load(path, struct, encoding="utf-8")

Load a YAML file and convert its contents into a msgspec.Struct.

Parameters

• path (str | pathlib.Path) — path to the YAML file.
• struct (type[msgspec.Struct]) — target structure class.
• encoding (str) — file encoding. Defaults to utf-8.

Returns

An instance of the provided msgspec.Struct.

Raises

• FileNotFoundError — file does not exist.
• yaml.YAMLError — invalid YAML file or unsupported file extension.
• msgspec.ValidationError — data validation failed during conversion.

Why?

Instead of writing:

import msgspec
import yaml


class Config:
    host: str
    port: int


with open("config.yml") as f:
    data = yaml.safe_load(f)

config = msgspec.convert(data, type=Config)

you can simply write:

import msgspec_yaml


class Config:
    host: str
    port: int

config = msgspec_yaml.load("config.yml", Config)