yaml-edit 0.1.0__tar.gz

yaml_edit-0.1.0/Cargo.lock

@@ -0,0 +1,233 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "autocfg"
+version = "1.5.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53"
+
+[[package]]
+name = "base64"
+version = "0.22.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6"
+
+[[package]]
+name = "cfg-if"
+version = "1.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801"
+
+[[package]]
+name = "countme"
+version = "3.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7704b5fdd17b18ae31c4c1da5a2e0305a2bf17b5249300a9ee9ed7b72114c636"
+
+[[package]]
+name = "hashbrown"
+version = "0.14.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e5274423e17b7c9fc20b6e7e208532f9b19825d82dfd615708b70edd83df41f1"
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "indoc"
+version = "2.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "79cf5c93f93228cf8efb3ba362535fb11199ac548a09ce117c9b1adc3030d706"
+dependencies = [
+ "rustversion",
+]
+
+[[package]]
+name = "libc"
+version = "0.2.186"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "68ab91017fe16c622486840e4c83c9a37afeff978bd239b5293d61ece587de66"
+
+[[package]]
+name = "memoffset"
+version = "0.9.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "portable-atomic"
+version = "1.13.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c33a9471896f1c69cecef8d20cbe2f7accd12527ce60845ff44c153bb2a21b49"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.106"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7778bffd85cf38175ac1f545509665d0b9b92a198ca7941f131f85f7a4f9a872"
+dependencies = [
+ "cfg-if",
+ "indoc",
+ "libc",
+ "memoffset",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+ "unindent",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "94f6cbe86ef3bf18998d9df6e0f3fc1050a8c5efa409bf712e661a4366e010fb"
+dependencies = [
+ "once_cell",
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e9f1b4c431c0bb1c8fb0a338709859eed0d030ff6daa34368d3b152a63dfdd8d"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fbc2201328f63c4710f68abdf653c89d8dbc2858b88c5d88b0ff38a75288a9da"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.23.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fca6726ad0f3da9c9de093d6f116a93c1a38e417ed73bf138472cf4064f72028"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "pyo3-build-config",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.45"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rowan"
+version = "0.16.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "417a3a9f582e349834051b8a10c8d71ca88da4211e4093528e36b9845f6b5f21"
+dependencies = [
+ "countme",
+ "hashbrown",
+ "rustc-hash",
+ "text-size",
+]
+
+[[package]]
+name = "rustc-hash"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "08d43f7aa6b08d49f382cde6a7982047c3426db949b1424bc4b7ec9ae12c6ce2"
+
+[[package]]
+name = "rustversion"
+version = "1.0.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
+
+[[package]]
+name = "syn"
+version = "2.0.117"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.12.16"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "61c41af27dd6d1e27b1b16b489db798443478cef1f06a660c96db617ba5de3b1"
+
+[[package]]
+name = "text-size"
+version = "1.1.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f18aa187839b2bdb1ad2fa35ead8c4c2976b64e4363c386d45ac0f7ee85c9233"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
+
+[[package]]
+name = "unindent"
+version = "0.2.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7264e107f553ccae879d21fbea1d6724ac785e8c3bfc762137959b5802826ef3"
+
+[[package]]
+name = "yaml-edit"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5c249044401e064d1f4d7ec0937c343b283e9da13de92298435ff6bf0ad53552"
+dependencies = [
+ "base64",
+ "rowan",
+]
+
+[[package]]
+name = "yaml-edit-py"
+version = "0.1.0"
+dependencies = [
+ "pyo3",
+ "yaml-edit",
+]

yaml_edit-0.1.0/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "yaml-edit-py"
+version = "0.1.0"
+edition = "2021"
+authors = ["Jelmer Vernooij <jelmer@debian.org>"]
+license = "Apache-2.0"
+description = "Python bindings for the yaml-edit lossless YAML parser and editor"
+repository = "https://github.com/jelmer/yaml-edit-py"
+publish = false
+
+[lib]
+name = "_yaml_edit"
+crate-type = ["cdylib"]
+
+[dependencies]
+pyo3 = { version = "0.23", features = ["extension-module"] }
+yaml-edit = "0.2.1"

yaml_edit-0.1.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include Cargo.toml
+include Cargo.lock
+recursive-include src *.rs

yaml_edit-0.1.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: yaml-edit
+Version: 0.1.0
+Summary: Lossless YAML parser and editor that preserves formatting, comments, and whitespace
+Author-email: Jelmer Vernooij <jelmer@debian.org>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/jelmer/yaml-edit-py
+Project-URL: Repository, https://github.com/jelmer/yaml-edit-py
+Keywords: yaml,parser,lossless,edit
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Text Processing :: Markup
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# yaml-edit
+
+Python bindings for the [yaml-edit](https://github.com/jelmer/yaml-edit) Rust
+crate: a lossless YAML parser and editor that preserves formatting, comments,
+and whitespace.
+
+Unlike most YAML libraries, yaml-edit does not round-trip through a plain data
+model. It keeps the original syntax tree, so edits change only the parts you
+touch and leave everything else - indentation, comment placement, quoting style,
+blank lines - exactly as it was.
+
+## Installation
+
+```console
+$ pip install yaml-edit
+```
+
+A Rust toolchain is required to build from source.
+
+## Usage
+
+```python
+from yaml_edit import Document
+
+doc = Document.parse("name: old-project\nversion: 1.0.0\n")
+doc.set("name", "new-project")
+doc.set("version", "2.0.0")
+print(doc, end="")
+# name: new-project
+# version: 2.0.0
+```
+
+Edits preserve surrounding formatting and comments:
+
+```python
+doc = Document.parse(
+    "# project config\n"
+    "name: demo   # the name\n"
+    "tags:\n"
+    "  - a\n"
+    "  - b\n"
+)
+mapping = doc.as_mapping()
+mapping.set("name", "renamed")
+print(doc, end="")
+# # project config
+# name: renamed   # the name
+# tags:
+#   - a
+#   - b
+```
+
+Working with nested structures:
+
+```python
+doc = Document.parse("servers:\n  - web\n  - db\n")
+servers = doc.as_mapping().get_sequence("servers")
+servers.push("cache")
+print(doc, end="")
+# servers:
+#   - web
+#   - db
+#   - cache
+```
+
+Multi-document streams:
+
+```python
+from yaml_edit import YamlFile
+
+stream = YamlFile.parse("a: 1\n---\nb: 2\n")
+for document in stream.documents():
+    print(document.keys())
+# ['a']
+# ['b']
+```
+
+## Supported value types
+
+Scalar values passed to `set`, `push`, and `insert` may be `str`, `int`,
+`float`, or `bool`. `None` is rejected because the underlying editor has no way
+to emit a YAML null scalar.
+
+## License
+
+Apache-2.0

yaml_edit-0.1.0/README.md

@@ -0,0 +1,86 @@
+# yaml-edit
+
+Python bindings for the [yaml-edit](https://github.com/jelmer/yaml-edit) Rust
+crate: a lossless YAML parser and editor that preserves formatting, comments,
+and whitespace.
+
+Unlike most YAML libraries, yaml-edit does not round-trip through a plain data
+model. It keeps the original syntax tree, so edits change only the parts you
+touch and leave everything else - indentation, comment placement, quoting style,
+blank lines - exactly as it was.
+
+## Installation
+
+```console
+$ pip install yaml-edit
+```
+
+A Rust toolchain is required to build from source.
+
+## Usage
+
+```python
+from yaml_edit import Document
+
+doc = Document.parse("name: old-project\nversion: 1.0.0\n")
+doc.set("name", "new-project")
+doc.set("version", "2.0.0")
+print(doc, end="")
+# name: new-project
+# version: 2.0.0
+```
+
+Edits preserve surrounding formatting and comments:
+
+```python
+doc = Document.parse(
+    "# project config\n"
+    "name: demo   # the name\n"
+    "tags:\n"
+    "  - a\n"
+    "  - b\n"
+)
+mapping = doc.as_mapping()
+mapping.set("name", "renamed")
+print(doc, end="")
+# # project config
+# name: renamed   # the name
+# tags:
+#   - a
+#   - b
+```
+
+Working with nested structures:
+
+```python
+doc = Document.parse("servers:\n  - web\n  - db\n")
+servers = doc.as_mapping().get_sequence("servers")
+servers.push("cache")
+print(doc, end="")
+# servers:
+#   - web
+#   - db
+#   - cache
+```
+
+Multi-document streams:
+
+```python
+from yaml_edit import YamlFile
+
+stream = YamlFile.parse("a: 1\n---\nb: 2\n")
+for document in stream.documents():
+    print(document.keys())
+# ['a']
+# ['b']
+```
+
+## Supported value types
+
+Scalar values passed to `set`, `push`, and `insert` may be `str`, `int`,
+`float`, or `bool`. `None` is rejected because the underlying editor has no way
+to emit a YAML null scalar.
+
+## License
+
+Apache-2.0

yaml_edit-0.1.0/pyproject.toml

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["setuptools>=77", "setuptools-rust>=1.7"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "yaml-edit"
+version = "0.1.0"
+description = "Lossless YAML parser and editor that preserves formatting, comments, and whitespace"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+authors = [{ name = "Jelmer Vernooij", email = "jelmer@debian.org" }]
+keywords = ["yaml", "parser", "lossless", "edit"]
+classifiers = [
+	"Development Status :: 4 - Beta",
+	"Intended Audience :: Developers",
+	"Programming Language :: Python :: 3",
+	"Programming Language :: Rust",
+	"Topic :: Software Development :: Libraries",
+	"Topic :: Text Processing :: Markup",
+]
+
+[project.urls]
+Homepage = "https://github.com/jelmer/yaml-edit-py"
+Repository = "https://github.com/jelmer/yaml-edit-py"
+
+[tool.setuptools.packages.find]
+where = ["python"]
+
+[[tool.setuptools-rust.ext-modules]]
+target = "yaml_edit._yaml_edit"
+path = "Cargo.toml"
+binding = "PyO3"
+
+[tool.setuptools.package-data]
+yaml_edit = ["py.typed", "*.pyi"]

yaml_edit-0.1.0/python/yaml_edit/__init__.py

@@ -0,0 +1,32 @@
+"""Lossless YAML parser and editor.
+
+Parse YAML while preserving formatting, comments, and whitespace, then make
+targeted edits that leave the rest of the document untouched.
+
+    >>> from yaml_edit import Document
+    >>> doc = Document.parse("name: old\\nversion: 1.0\\n")
+    >>> doc.set("name", "new")
+    >>> print(doc, end="")
+    name: new
+    version: 1.0
+"""
+
+from ._yaml_edit import (
+    Document,
+    Entry,
+    Mapping,
+    Node,
+    Scalar,
+    Sequence,
+    YamlFile,
+)
+
+__all__ = [
+    "Document",
+    "Entry",
+    "Mapping",
+    "Node",
+    "Scalar",
+    "Sequence",
+    "YamlFile",
+]

yaml_edit-0.1.0/python/yaml_edit/_yaml_edit.pyi

@@ -0,0 +1,146 @@
+"""Type stubs for the yaml-edit native extension."""
+
+from typing import Iterator, Optional, Union
+
+ScalarValue = Union[str, int, float, bool]
+
+class Node:
+    """A YAML node returned from a getter."""
+
+    @property
+    def kind(self) -> str: ...
+    def is_scalar(self) -> bool: ...
+    def is_mapping(self) -> bool: ...
+    def is_sequence(self) -> bool: ...
+    def as_scalar(self) -> Optional[Scalar]: ...
+    def as_mapping(self) -> Optional[Mapping]: ...
+    def as_sequence(self) -> Optional[Sequence]: ...
+    def as_int(self) -> Optional[int]: ...
+    def as_float(self) -> Optional[float]: ...
+    def as_bool(self) -> Optional[bool]: ...
+    def __str__(self) -> str: ...
+
+class Scalar:
+    """A scalar YAML value (string, number, boolean)."""
+
+    def value(self) -> str:
+        """The raw scalar text, preserving any surrounding quotes."""
+
+    def as_string(self) -> str:
+        """The scalar's value with quotes stripped if present."""
+    def is_quoted(self) -> bool: ...
+    def unquoted_value(self) -> str: ...
+    def is_null(self) -> bool: ...
+    def as_int(self) -> Optional[int]: ...
+    def as_float(self) -> Optional[float]: ...
+    def as_bool(self) -> Optional[bool]: ...
+    def set_value(self, value: str) -> None: ...
+    def __str__(self) -> str: ...
+
+class Entry:
+    """A single key/value entry in a mapping.
+
+    The fine-grained handle for mappings with repeated keys: each occurrence is
+    a distinct entry that can be inspected and mutated individually.
+    """
+
+    def key(self) -> Optional[Node]: ...
+    def value(self) -> Optional[Node]: ...
+    def key_matches(self, key: str) -> bool: ...
+    def set_value(self, value: ScalarValue) -> None: ...
+    def remove(self) -> None: ...
+
+class Mapping:
+    """A YAML mapping (key/value block)."""
+
+    def __len__(self) -> int: ...
+    def is_empty(self) -> bool: ...
+    def is_flow_style(self) -> bool: ...
+    def contains_key(self, key: str) -> bool: ...
+    def __contains__(self, key: str) -> bool: ...
+    def get(self, key: str) -> Optional[Node]: ...
+    def __getitem__(self, key: str) -> Node: ...
+    def get_mapping(self, key: str) -> Optional[Mapping]: ...
+    def get_sequence(self, key: str) -> Optional[Sequence]: ...
+    def set(self, key: str, value: ScalarValue) -> None: ...
+    def __setitem__(self, key: str, value: ScalarValue) -> None: ...
+    def remove(self, key: str) -> bool: ...
+    def __delitem__(self, key: str) -> None: ...
+    def rename_key(self, old_key: str, new_key: str) -> bool: ...
+    def clear(self) -> None: ...
+    def keys(self) -> list[str]: ...
+    def values(self) -> list[Node]: ...
+    def items(self) -> list[tuple[str, Node]]: ...
+    def __iter__(self) -> Iterator[str]: ...
+    def entries(self) -> list[Entry]: ...
+    def find_entry(self, key: str) -> Optional[Entry]: ...
+    def find_all_entries(self, key: str) -> list[Entry]: ...
+    def count_key(self, key: str) -> int: ...
+    def remove_nth(self, key: str, n: int) -> bool: ...
+    def __str__(self) -> str: ...
+
+class Sequence:
+    """A YAML sequence (list)."""
+
+    def __len__(self) -> int: ...
+    def is_empty(self) -> bool: ...
+    def is_flow_style(self) -> bool: ...
+    def get(self, index: int) -> Optional[Node]: ...
+    def __getitem__(self, index: int) -> Node: ...
+    def first(self) -> Optional[Node]: ...
+    def last(self) -> Optional[Node]: ...
+    def push(self, value: ScalarValue) -> None: ...
+    def insert(self, index: int, value: ScalarValue) -> None: ...
+    def set(self, index: int, value: ScalarValue) -> bool: ...
+    def __setitem__(self, index: int, value: ScalarValue) -> None: ...
+    def __delitem__(self, index: int) -> None: ...
+    def remove(self, index: int) -> Optional[Node]: ...
+    def pop(self) -> Optional[Node]: ...
+    def clear(self) -> None: ...
+    def values(self) -> list[Node]: ...
+    def __iter__(self) -> Iterator[Node]: ...
+    def __str__(self) -> str: ...
+
+class Document:
+    """A single YAML document."""
+
+    def __init__(self) -> None: ...
+    @staticmethod
+    def parse(text: str) -> Document: ...
+    @staticmethod
+    def from_file(path: str) -> Document: ...
+    def to_file(self, path: str) -> None: ...
+    def is_empty(self) -> bool: ...
+    def as_mapping(self) -> Optional[Mapping]: ...
+    def as_sequence(self) -> Optional[Sequence]: ...
+    def as_scalar(self) -> Optional[Scalar]: ...
+    def contains_key(self, key: str) -> bool: ...
+    def __contains__(self, key: str) -> bool: ...
+    def get(self, key: str) -> Optional[Node]: ...
+    def __getitem__(self, key: str) -> Node: ...
+    def get_string(self, key: str) -> Optional[str]: ...
+    def set(self, key: str, value: ScalarValue) -> None: ...
+    def __setitem__(self, key: str, value: ScalarValue) -> None: ...
+    def remove(self, key: str) -> bool: ...
+    def __delitem__(self, key: str) -> None: ...
+    def rename_key(self, old_key: str, new_key: str) -> bool: ...
+    def keys(self) -> list[str]: ...
+    def __str__(self) -> str: ...
+
+class YamlFile:
+    """A YAML stream, which may hold multiple documents and directives."""
+
+    def __init__(self) -> None: ...
+    @staticmethod
+    def parse(text: str) -> YamlFile: ...
+    @staticmethod
+    def from_file(path: str) -> YamlFile: ...
+    def __len__(self) -> int: ...
+    def is_empty(self) -> bool: ...
+    def documents(self) -> list[Document]: ...
+    def document(self) -> Optional[Document]: ...
+    def ensure_document(self) -> Document: ...
+    def push_document(self, document: Document) -> None: ...
+    def directives(self) -> list[str]: ...
+    def add_directive(self, directive_text: str) -> None: ...
+    def __str__(self) -> str: ...