Skip to content

Commit 9d2290c

Browse files
committed
Initial commit
0 parents  commit 9d2290c

File tree

10 files changed

+828
-0
lines changed

10 files changed

+828
-0
lines changed

.gitignore

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
target/
76+
77+
# Jupyter Notebook
78+
.ipynb_checkpoints
79+
80+
# IPython
81+
profile_default/
82+
ipython_config.py
83+
84+
# pyenv
85+
.python-version
86+
87+
# pipenv
88+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
90+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
91+
# install all needed dependencies.
92+
#Pipfile.lock
93+
94+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
95+
__pypackages__/
96+
97+
# Celery stuff
98+
celerybeat-schedule
99+
celerybeat.pid
100+
101+
# SageMath parsed files
102+
*.sage.py
103+
104+
# Environments
105+
.env
106+
.venv
107+
env/
108+
venv/
109+
ENV/
110+
env.bak/
111+
venv.bak/
112+
113+
# JetBrains project settings
114+
.idea
115+
116+
# Spyder project settings
117+
.spyderproject
118+
.spyproject
119+
120+
# Rope project settings
121+
.ropeproject
122+
123+
# mkdocs documentation
124+
/site
125+
126+
# mypy
127+
.mypy_cache/
128+
.dmypy.json
129+
dmypy.json
130+
131+
# Pyre type checker
132+
.pyre/

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 Diogo de Campos
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# yaml-patch

main.py

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
import sys
2+
3+
import click
4+
from ruamel.yaml import YAML
5+
6+
from yaml_patch import patch
7+
8+
9+
@click.command(
10+
help="""
11+
Applies patches to a yaml string, keeping most of the formatting and comments.
12+
13+
\b
14+
Some formatting is not kept due to underlying yaml library limitations:
15+
- Indentation will be forced to two spaces
16+
- Spacing before sequence dashes will be forced to two spaces
17+
- Empty lines at the start of the string will be removed
18+
19+
You can pass any number of patches to be applied, they use the following syntax options:
20+
21+
\b
22+
Patch a single value:
23+
<field>.<subfield>=<value>
24+
Example:
25+
spec.replicas=2
26+
27+
\b
28+
Patch a value inside a single list item:
29+
<field>.[<position]>.<subfield>=<value>
30+
Example:
31+
spec.template.containers.[0].image="mycontainer:latest"
32+
33+
\b
34+
Patch a value inside all list items:
35+
<field>.[].<subfield>=<value>
36+
Example:
37+
spec.template.containers.[].image="mycontainer:latest"
38+
39+
\b
40+
When calling this tool from a command line, it's higly recommended that you quote all patches arguments to avoid terminal issues.
41+
Example:
42+
yaml-patch -f test.yml 'spec.template.containers.[0].image="mycontainer:latest"'
43+
""",
44+
)
45+
@click.option(
46+
"--file", "-f", type=click.File("r"), default=sys.stdin, help="Path to yaml file being patched. Defaults to stdin."
47+
)
48+
@click.option(
49+
"--output", "-o", type=click.File("w"), default=sys.stdout, help="Path to output patched file. Defaults to stdout."
50+
)
51+
@click.argument("patches", nargs=-1)
52+
def cli(file, output, patches):
53+
# Split each patch into key+value separated by `=`. Use YAML to load the values coming from command line to ensure
54+
# they are parsed into yaml syntax equivalents (automatically detect strings, ints, bools, etc).
55+
yaml = YAML()
56+
dict_patches = dict()
57+
for p in patches:
58+
k, v = p.split("=")
59+
dict_patches[k] = yaml.load(v)
60+
61+
patched = patch(file.read(), dict_patches)
62+
output.write(patched)
63+
64+
65+
if __name__ == "__main__":
66+
cli()

0 commit comments

Comments
 (0)