Add an --unsafe option to check-yaml

This commit is contained in:
Anthony Sottile 2018-03-19 09:28:18 -07:00
parent e80813e7e9
commit a21def36e3
3 changed files with 59 additions and 6 deletions

View file

@ -1,6 +1,7 @@
from __future__ import print_function
import argparse
import collections
import sys
import yaml
@ -11,24 +12,52 @@ except ImportError: # pragma: no cover (no libyaml-dev / pypy)
Loader = yaml.SafeLoader
def _exhaust(gen):
for _ in gen:
pass
def _parse_unsafe(*args, **kwargs):
_exhaust(yaml.parse(*args, **kwargs))
def _load_all(*args, **kwargs):
# need to exhaust the generator
return tuple(yaml.load_all(*args, **kwargs))
_exhaust(yaml.load_all(*args, **kwargs))
Key = collections.namedtuple('Key', ('multi', 'unsafe'))
LOAD_FNS = {
Key(multi=False, unsafe=False): yaml.load,
Key(multi=False, unsafe=True): _parse_unsafe,
Key(multi=True, unsafe=False): _load_all,
Key(multi=True, unsafe=True): _parse_unsafe,
}
def check_yaml(argv=None):
parser = argparse.ArgumentParser()
parser.add_argument(
'-m', '--allow-multiple-documents', dest='yaml_load_fn',
action='store_const', const=_load_all, default=yaml.load,
'-m', '--multi', '--allow-multiple-documents', action='store_true',
)
parser.add_argument(
'--unsafe', action='store_true',
help=(
'Instead of loading the files, simply parse them for syntax. '
'A syntax-only check enables extensions and unsafe contstructs '
'which would otherwise be forbidden. Using this option removes '
'all guarantees of portability to other yaml implementations. '
'Implies --allow-multiple-documents'
),
)
parser.add_argument('filenames', nargs='*', help='Yaml filenames to check.')
args = parser.parse_args(argv)
load_fn = LOAD_FNS[Key(multi=args.multi, unsafe=args.unsafe)]
retval = 0
for filename in args.filenames:
try:
args.yaml_load_fn(open(filename), Loader=Loader)
load_fn(open(filename), Loader=Loader)
except yaml.YAMLError as exc:
print(exc)
retval = 1