v0.6.0

create writes a plan. Nested directory overrides merge. exists_opt(None) is None.

• Write
  relative_to, create, root, format, parse, put
  Creating with schemas

  • relative_to fills paths. create writes that plan and does not check the tree.
    quickstart
  • create on a bound schema raises TypeError: use root().
  • dir.create() makes that directory and required child directories. No files, no optional directories, no collection members.
  • None leaves an optional child absent. An unknown alias raises KeyError.
  • A collection takes a filename-to-body map, or a list of (captures, payload) pairs. Keys that are capture names are rejected.
    delivery
  • A file collection whose captures were set by format takes the body alone. A directory collection does not.
    one member
  • A missing capture raises TypeError and names it. Two values for one capture raise ValueError.
  • put replaces the path in one step. No body writes an empty file. Body: bytes, text, a file to copy, save, or a dataclass as JSON.
    Reading and writing

• Declare
  Schema, File, Dir
  Inheritance and replacement

  • A nested directory override merges children with the base. A file override replaces that file.
  • On the class, a file or a collection exposes alias, fmt, match, min, max. Coincident.parts.match.
  • An exact directory with a schema class is that class. Parent.child.file.match.
  • A directory collection exposes fmt and match on the collection, not the child schema's fields.

• Bind
  Schema.bind, exists_opt, MismatchErr
  Applying schemas

  • bind takes a string, a Path, or any __fspath__ value, including a schema node. A planned root binds itself.
  • exists_opt(None) returns None.
    Fixed directories and files
  • A wrong collection count names dangling symlinks that matched: (dangling: gone.png).
  • Read follows a live symlink. put replaces a symlink at that path and does not write through it.

• Read
  Integrations

  • glom is no longer installed with the package. Navigation examples are in the docs.

v0.4.6

v0.4.6

First public. Alpha. import fs_schema as fss. Python 3.10–3.14.

• Declare — mapping; name | fmt | match; counts, alias, sort; one-base inherit/replace.
  Schema, Layout, File, Dir, FILES, dt
  Defining schemas
• Bind — first failure; extras ignored.
  Schema.bind, SchemaRoot.bind, MismatchErr, is_mismatch, raise_mismatch
  Applying schemas
• Read — attr/item access; PathLike.
  Located, Match, exists_opt, .path, __fspath__, .exists, .read_bytes, .read_text, .args, .kwargs, .filter, .find, .where, .get
  Using schemas
• Write — plan then bind; JSON dataclasses via extras mashumaro, orjson.
  Schema.relative_to, SchemaRoot, .format, .root, .put, .load, put, raise_exn
  Creating with schemas
• Types — generated child attrs; dynamic names stay a union.
  SchemaRoot[S], __version__
  Static typing

v0.4.5

Full Changelog: https://github.com/HeyEntropyYield/fs-schema/commits/v0.4.5