Skip to main content

Lib to modify yaml inplace

Project description

codemod-yaml

This library makes surgical edits to YAML documents, based on tree-sitter and inspired by tomlkit and pyupgrade. Preserves all whitespace and formatting on lines that don't require changes, and generally within a line as well, so you can make minimal diffs in your codemod tools.

Basic Usage

from codemod_yaml import parse
stream = parse(somepath.read_bytes())
if stream["version"] == ["2.7"]:
    stream["version"][:] = ["3.6", "3.13"]
somepath.write_bytes(stream.text)

Version Compat

Usage of this library should work back to 3.9 (because of the tree-sitter dep), but development (and mypy compatibility) only on 3.10-3.12. Linting requires 3.12+ for full fidelity.

Versioning

This library follows meanver which basically means semver along with a promise to rename when the major version changes.

License

codemod-yaml is copyright Tim Hatch, and licensed under the MIT license. See the LICENSE file for details.

Project details


Download files

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

Source Distribution

codemod_yaml-0.6.0.tar.gz (18.6 kB view details)

Uploaded Source

Built Distribution

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

codemod_yaml-0.6.0-py3-none-any.whl (13.4 kB view details)

Uploaded Python 3

File details

Details for the file codemod_yaml-0.6.0.tar.gz.

File metadata

  • Download URL: codemod_yaml-0.6.0.tar.gz
  • Upload date:
  • Size: 18.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for codemod_yaml-0.6.0.tar.gz
Algorithm Hash digest
SHA256 97f163c9b210cc8cab5ec37371956948f054720dda90c95a4b5dd30f1b180e45
MD5 779830461c037f4b9fe6ab015db76adc
BLAKE2b-256 3549b6d0b25beb1cefb12fe78b37947c705fb329c1b502b857fd6ff6db96d980

See more details on using hashes here.

Provenance

The following attestation bundles were made for codemod_yaml-0.6.0.tar.gz:

Publisher: build.yml on advice-animal/codemod-yaml

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file codemod_yaml-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: codemod_yaml-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 13.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for codemod_yaml-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c61ec988d0792272944d0e8a03cfbe1873f864c61fb5034c3ac6be1e6f6c701e
MD5 2bccded0a9e4c87095997afb4246b57d
BLAKE2b-256 bbcebb025cde5720de354bb26f9927527efebeab0e2ba86c3190239f86ef46c7

See more details on using hashes here.

Provenance

The following attestation bundles were made for codemod_yaml-0.6.0-py3-none-any.whl:

Publisher: build.yml on advice-animal/codemod-yaml

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page