1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
|
"""
The ``jsonschema`` command line.
"""
from __future__ import absolute_import
from textwrap import dedent
import argparse
import json
import sys
import attr
from jsonschema import __version__
from jsonschema._reflect import namedAny
from jsonschema.compat import JSONDecodeError
from jsonschema.exceptions import SchemaError
from jsonschema.validators import validator_for
@attr.s
class _PrettyOutputFormatter(object):
_ERROR_MSG = dedent(
"""\
===[{error.__class__.__name__}]===({path})===
{error}
-----------------------------
""",
)
_SUCCESS_MSG = "===[SUCCESS]===({path})===\n"
def parsing_error(self, path, error):
return self._ERROR_MSG.format(path=path, error=error)
def validation_error(self, instance_path, error):
return self._ERROR_MSG.format(path=instance_path, error=error)
def validation_success(self, instance_path):
return self._SUCCESS_MSG.format(path=instance_path)
@attr.s
class _PlainOutputFormatter(object):
_error_format = attr.ib()
def parsing_error(self, path, error):
return (
"Failed to parse {path}. Got the following error: {error}\n"
).format(path=path, error=error)
def validation_error(self, instance_path, error):
return self._error_format.format(file_name=instance_path, error=error)
def validation_success(self, instance_path):
return ""
def _namedAnyWithDefault(name):
if "." not in name:
name = "jsonschema." + name
return namedAny(name)
parser = argparse.ArgumentParser(
description="JSON Schema Validation CLI",
)
parser.add_argument(
"-i", "--instance",
action="append",
dest="instances",
help=(
"A path to a JSON instance (i.e. filename.json) "
"to validate (may be specified multiple times). "
"If this option is not used, an instance can be given through stdin. "
"If neither -i nor stdin is given, only the schema is checked."
),
)
parser.add_argument(
"-F", "--error-format",
help=(
"The format to use for each error output message, specified in "
"a form suitable for passing to str.format, which will be called "
"with 'error' for each error. This is only used when --output=plain "
"(default)."
),
)
parser.add_argument(
"-o", "--output",
choices=["plain", "pretty"],
default="plain",
help=(
"Select the output format. "
"'plain': one line per error, minimum text. "
"'pretty': human-readable output with multiline details. "
),
)
parser.add_argument(
"-V", "--validator",
type=_namedAnyWithDefault,
help=(
"the fully qualified object name of a validator to use, or, for "
"validators that are registered with jsonschema, simply the name "
"of the class."
),
)
parser.add_argument(
"--version",
action="version",
version=__version__,
)
parser.add_argument(
"schema",
help="Path to the JSON Schema to validate with (i.e. schema.json)",
)
def _load_json_file(path):
with open(path) as file:
return json.load(file)
def parse_args(args):
arguments = vars(parser.parse_args(args=args or ["--help"]))
if arguments["validator"] is None:
arguments["validator"] = validator_for(arguments["schema"])
if arguments["instances"] is None:
arguments["instances"] = []
if arguments["output"] != "plain" and arguments["error_format"]:
raise parser.error(
"--error-format can only be used with --output plain"
)
if arguments["output"] == "plain" and arguments["error_format"] is None:
arguments["error_format"] = "{error.instance}: {error.message}\n"
return arguments
def _make_validator(schema_path, Validator, formatter, stderr):
try:
schema_obj = _load_json_file(schema_path)
except (ValueError, IOError) as error:
stderr.write(
formatter.parsing_error(path=schema_path, error=error),
)
raise error
try:
validator = Validator(schema=schema_obj)
validator.check_schema(schema_obj)
except SchemaError as error:
stderr.write(
formatter.validation_error(
instance_path=schema_path,
error=error,
),
)
raise error
return validator
def _validate_instance(
instance_path,
instance,
validator,
formatter,
stdout,
stderr,
):
invalid = False
for error in validator.iter_errors(instance):
invalid = True
stderr.write(
formatter.validation_error(
instance_path=instance_path,
error=error,
),
)
if not invalid:
stdout.write(formatter.validation_success(instance_path=instance_path))
return invalid
def main(args=sys.argv[1:]):
sys.exit(run(arguments=parse_args(args=args)))
def run(arguments, stdout=sys.stdout, stderr=sys.stderr, stdin=sys.stdin):
if arguments["output"] == "plain":
formatter = _PlainOutputFormatter(arguments["error_format"])
elif arguments["output"] == "pretty":
formatter = _PrettyOutputFormatter()
try:
validator = _make_validator(
schema_path=arguments["schema"],
Validator=arguments["validator"],
formatter=formatter,
stderr=stderr,
)
except (IOError, ValueError, SchemaError):
return True
invalid = []
if arguments["instances"]:
for instance_path in arguments["instances"]:
try:
instance = _load_json_file(instance_path)
except JSONDecodeError as error:
stderr.write(
formatter.parsing_error(path=instance_path, error=error),
)
invalid.append(True)
else:
invalid.append(
_validate_instance(
instance_path=instance_path,
instance=instance,
validator=validator,
formatter=formatter,
stdout=stdout,
stderr=stderr,
),
)
elif (
stdin is sys.stdin and not sys.stdin.isatty()
or stdin is not sys.stdin and stdin is not None
):
try:
instance = json.load(stdin)
except JSONDecodeError as error:
stderr.write(
formatter.parsing_error(path="<stdin>", error=error),
)
invalid.append(True)
else:
invalid.append(
_validate_instance(
instance_path="<stdin>",
instance=instance,
validator=validator,
formatter=formatter,
stdout=stdout,
stderr=stderr,
),
)
return any(invalid)
|
