• Stars
    star
    2,587
  • Rank 17,718 (Top 0.4 %)
  • Language
    Python
  • License
    Apache License 2.0
  • Created almost 8 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Command-line YAML, XML, TOML processor - jq wrapper for YAML/XML/TOML documents

yq: Command-line YAML/XML/TOML processor - jq wrapper for YAML, XML, TOML documents

Installation

pip install yq

Before using yq, you also have to install its dependency, jq. See the jq installation instructions for details and directions specific to your platform.

On macOS, yq is also available on Homebrew: use brew install python-yq.

Synopsis

yq takes YAML input, converts it to JSON, and pipes it to jq:

cat input.yml | yq .foo.bar

Like in jq, you can also specify input filename(s) as arguments:

yq .foo.bar input.yml

By default, no conversion of jq output is done. Use the --yaml-output/-y option to convert it back into YAML:

cat input.yml | yq -y .foo.bar

Mapping key order is preserved. By default, custom YAML tags and styles in the input are ignored. Use the --yaml-roundtrip/-Y option to preserve YAML tags and styles by representing them as extra items in their enclosing mappings and sequences while in JSON:

yq -Y .foo.bar input.yml

yq can be called as a module if needed. With -y/-Y, files can be edited in place like with sed -i:

python -m yq -Y --indentless --in-place '.["current-context"] = "staging-cluster"' ~/.kube/config

Use the --width/-w option to pass the line wrap width for string literals. Use --explicit-start/--explicit-end to emit YAML start/end markers even when processing a single document. All other command line arguments are forwarded to jq. yq forwards the exit code jq produced, unless there was an error in YAML parsing, in which case the exit code is 1. See the jq manual for more details on jq features and options.

Because YAML treats JSON as a dialect of YAML, you can use yq to convert JSON to YAML: yq -y . < in.json > out.yml.

Preserving tags and styles using the -Y (--yaml-roundtrip) option

The -Y option helps preserve custom string styles and tags in your document. For example, consider the following document (an AWS CloudFormation template fragment):

Resources:
  ElasticLoadBalancer:
    Type: 'AWS::ElasticLoadBalancing::LoadBalancer'
    Properties:
      AvailabilityZones: !GetAZs ''
      Instances:
        - !Ref Ec2Instance1
        - !Ref Ec2Instance2
      Description: >-
        Load balancer for Big Important Service.

        Good thing it's managed by this template.

Passing this document through yq -y .Resources.ElasticLoadBalancer will drop custom tags, such as !Ref, and styles, such as the folded style of the Description field:

Type: AWS::ElasticLoadBalancing::LoadBalancer
Properties:
  AvailabilityZones: ''
  Instances:
    - Ec2Instance1
    - Ec2Instance2
  Description: 'Load balancer for Big Important Service.

    Good thing it''s managed by this template.'

By contrast, passing it through yq -Y .Resources.ElasticLoadBalancer will preserve tags and styles:

Type: 'AWS::ElasticLoadBalancing::LoadBalancer'
Properties:
  AvailabilityZones: !GetAZs ''
  Instances:
    - !Ref 'Ec2Instance1'
    - !Ref 'Ec2Instance2'
  Description: >-
    Load balancer for Big Important Service.

    Good thing it's managed by this template.

To accomplish this in -Y mode, yq carries extra metadata (mapping pairs and sequence values) in the JSON representation of your document for any custom tags or styles that it finds. When converting the JSON back into YAML, it parses this metadata, re-applies the tags and styles, and discards the extra pairs and values.

yq does not support passing YAML comments into the JSON representation used by jq, or roundtripping such comments.

XML support

yq also supports XML. The yq package installs an executable, xq, which transcodes XML to JSON using xmltodict and pipes it to jq. Roundtrip transcoding is available with the xq --xml-output/xq -x option. Multiple XML documents can be passed in separate files/streams as xq a.xml b.xml. Use --xml-item-depth to descend into large documents, streaming their contents without loading the full doc into memory (for example, stream a Wikipedia database dump with cat enwiki-*.xml.bz2 | bunzip2 | xq . --xml-item-depth=2). Entity expansion and DTD resolution is disabled to avoid XML parsing vulnerabilities. Use python -m yq.xq if you want to ensure a specific Python runtime.

TOML support

yq supports TOML as well. The yq package installs an executable, tomlq, which uses the tomlkit library to transcode TOML to JSON, then pipes it to jq. Roundtrip transcoding is available with the tomlq --toml-output/tomlq -t option. Use python -m yq.tomlq if you want to ensure a specific Python runtime.

Compatibility note

This package's release series available on PyPI begins with version 2.0.0. Versions of yq prior to 2.0.0 are distributed by https://github.com/abesto/yq and are not related to this package. No guarantees of compatibility are made between abesto/yq and kislyuk/yq. This package follows the Semantic Versioning 2.0.0 standard. To ensure proper operation, declare dependency version ranges according to SemVer.

Authors

  • Andrey Kislyuk

Bugs

Please report bugs, issues, feature requests, etc. on GitHub.

License

Licensed under the terms of the Apache License, Version 2.0.

image

image

image

image

More Repositories

1

argcomplete

Python and tab completion, better together.
Python
1,410
star
2

watchtower

Python CloudWatch Logging: Log Analytics and Application Intelligence
Python
778
star
3

keymaker

Lightweight SSH key management on AWS EC2
Python
223
star
4

ensure

Validate conditions, Python style.
Python
149
star
5

aegea

Amazon Web Services Operator Interface
Python
68
star
6

eight

Python 2 to the power of 3
Python
47
star
7

rehash

Resumable hashlib: a picklable interface to CPython's OpenSSL-based hashlib standard library
Python
37
star
8

tweak

Python application configuration engine
Python
15
star
9

node-complexify

node.js port of jquery.complexify.js
JavaScript
14
star
10

likelybin

Unsupervised binning of metagenomes using MCMC.
C
4
star
11

gs

A minimalistic Google Storage client
Python
3
star
12

encryptxml

Python XML Encryption library
Python
3
star
13

hstspreload

HSTS and HPKP support for Python HTTP clients - This repository has moved to:
Makefile
3
star
14

roof

Friendly Python test coverage reporting
Python
3
star
15

katalin

A GitHub action that generates LLM-assisted suggestions for improving Python code in PRs
Python
3
star
16

ftp_fetcher

Shell
2
star
17

dx-falcon

DNAnexus Falcon app prototype
Python
2
star
18

dmtk

DNA Modification Toolkit
Python
2
star
19

tractorbeam

File I/O staging for JSON documents with Amazon S3 URLs
Python
2
star
20

hipston

High Performance Storage Object Namespace
Python
2
star
21

httpnext

Next Generation HTTP for Python
Python
2
star
22

dynamoq

A DynamoDB Command Line Interface with JSON I/O
Python
2
star
23

roslyn

Old mirror of Microsoft .NET Compiler Platform, now at:
C#
1
star
24

dnanexus-oauth2-demo

CSS
1
star
25

xbcf

eXtensible Block Compression Format
Python
1
star
26

everytab

A Chrome tab manager extension that doesn't suck
JavaScript
1
star
27

akutils

1
star
28

kislyuk.com

Personal page
Ruby
1
star
29

simpleyaml

1
star
30

aosp-de

1
star
31

thermos

Deploy Flask applications on AWS Lambda
1
star
32

dxca

DNAnexus Celera Assembler integration
Shell
1
star
33

kislyuk.github.io

HTML
1
star
34

kislyuk

1
star
35

carta-playbooks

Ansible playbooks for cartographer.us
Shell
1
star
36

cartographer

Map the soul.
Python
1
star
37

urchin

1
star