Skip to content

Commit 21f6ee5

Browse files
Stranger6667Stranger6667
committed
feat: Rework public API
Signed-off-by: Dmitry Dygalo <[email protected]>
1 parent 513f9f7 commit 21f6ee5

File tree

24 files changed

+1015
-470
lines changed

24 files changed

+1015
-470
lines changed

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
1919
assert!(jsonschema::is_valid(&schema, &instance));
2020

2121
// Build & reuse (faster)
22-
let validator = jsonschema::compile(&schema)
22+
let validator = jsonschema::validator_for(&schema)
2323
.expect("Invalid schema");
2424

2525
// Iterate over errors

‎crates/benchmark-suite/benches/boon.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ fn bench_compile(c: &mut Criterion, name: &str, schema: &Value) {
1212
b.iter(|| {
1313
compiler
1414
.compile("schema.json", &mut Schemas::new())
15-
.expect("Failed to compiled");
15+
.expect("Failed to compile");
1616
})
1717
});
1818
}

‎crates/benchmark-suite/benches/jsonschema.rs

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,34 @@
11
use benchmark::Benchmark;
22
use criterion::{criterion_group, criterion_main, BenchmarkId, Criterion};
3-
use jsonschema::JSONSchema;
43
use serde_json::Value;
54

65
fn bench_compile(c: &mut Criterion, name: &str, schema: &Value) {
76
c.bench_function(&format!("jsonschema/{}/compile", name), |b| {
8-
b.iter(|| JSONSchema::compile(schema).expect("Valid schema"))
7+
b.iter(|| jsonschema::validator_for(schema).expect("Valid schema"))
98
});
109
}
1110

1211
fn bench_is_valid(c: &mut Criterion, name: &str, schema: &Value, instance: &Value) {
13-
let compiled = JSONSchema::compile(schema).expect("Valid schema");
12+
let validator = jsonschema::validator_for(schema).expect("Valid schema");
1413
c.bench_with_input(
1514
BenchmarkId::new(name, "is_valid"),
1615
instance,
1716
|b, instance| {
1817
b.iter(|| {
19-
let _ = compiled.is_valid(instance);
18+
let _ = validator.is_valid(instance);
2019
})
2120
},
2221
);
2322
}
2423

2524
fn bench_validate(c: &mut Criterion, name: &str, schema: &Value, instance: &Value) {
26-
let compiled = JSONSchema::compile(schema).expect("Valid schema");
25+
let validator = jsonschema::validator_for(schema).expect("Valid schema");
2726
c.bench_with_input(
2827
BenchmarkId::new(name, "validate"),
2928
instance,
3029
|b, instance| {
3130
b.iter(|| {
32-
let _ = compiled.validate(instance);
31+
let _ = validator.validate(instance);
3332
})
3433
},
3534
);

‎crates/benchmark-suite/benches/valico.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ fn bench_compile(c: &mut Criterion, name: &str, schema: &Value) {
1616

1717
fn bench_validate(c: &mut Criterion, name: &str, schema: &Value, instance: &Value) {
1818
let mut scope = json_schema::Scope::new();
19-
let compiled = scope
19+
let validator = scope
2020
.compile_and_return(schema.clone(), false)
2121
.expect("Valid schema");
2222
c.bench_with_input(
2323
BenchmarkId::new(name, "validate"),
2424
instance,
2525
|b, instance| {
2626
b.iter(|| {
27-
compiled.validate(instance).is_valid();
27+
validator.validate(instance).is_valid();
2828
})
2929
},
3030
);

‎crates/jsonschema-cli/src/main.rs

+3-4
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ use std::{
77
};
88

99
use clap::Parser;
10-
use jsonschema::JSONSchema;
1110

1211
#[derive(Parser)]
1312
#[command(name = "jsonschema")]
@@ -40,11 +39,11 @@ fn validate_instances(
4039
let mut success = true;
4140

4241
let schema_json = read_json(schema_path)??;
43-
match JSONSchema::compile(&schema_json) {
44-
Ok(schema) => {
42+
match jsonschema::validator_for(&schema_json) {
43+
Ok(validator) => {
4544
for instance in instances {
4645
let instance_json = read_json(instance)??;
47-
let validation = schema.validate(&instance_json);
46+
let validation = validator.validate(&instance_json);
4847
let filename = instance.to_string_lossy();
4948
match validation {
5049
Ok(()) => println!("{filename} - VALID"),

‎crates/jsonschema-py/src/lib.rs

+20-20
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ fn make_options(
126126
draft: Option<u8>,
127127
formats: Option<&Bound<'_, PyDict>>,
128128
) -> PyResult<jsonschema::CompilationOptions> {
129-
let mut options = jsonschema::JSONSchema::options();
129+
let mut options = jsonschema::options();
130130
if let Some(raw_draft_version) = draft {
131131
options.with_draft(get_draft(raw_draft_version)?);
132132
}
@@ -166,14 +166,14 @@ fn make_options(
166166

167167
fn iter_on_error(
168168
py: Python<'_>,
169-
compiled: &jsonschema::JSONSchema,
169+
validator: &jsonschema::JSONSchema,
170170
instance: &Bound<'_, PyAny>,
171171
) -> PyResult<ValidationErrorIter> {
172172
let instance = ser::to_value(instance)?;
173173
let mut pyerrors = vec![];
174174

175175
panic::catch_unwind(AssertUnwindSafe(|| {
176-
if let Err(errors) = compiled.validate(&instance) {
176+
if let Err(errors) = validator.validate(&instance) {
177177
for error in errors {
178178
pyerrors.push(into_py_err(py, error)?);
179179
}
@@ -188,11 +188,11 @@ fn iter_on_error(
188188

189189
fn raise_on_error(
190190
py: Python<'_>,
191-
compiled: &jsonschema::JSONSchema,
191+
validator: &jsonschema::JSONSchema,
192192
instance: &Bound<'_, PyAny>,
193193
) -> PyResult<()> {
194194
let instance = ser::to_value(instance)?;
195-
let result = panic::catch_unwind(AssertUnwindSafe(|| compiled.validate(&instance)))
195+
let result = panic::catch_unwind(AssertUnwindSafe(|| validator.validate(&instance)))
196196
.map_err(handle_format_checked_panic)?;
197197
let error = result
198198
.err()
@@ -277,9 +277,9 @@ fn is_valid(
277277
let options = make_options(draft, formats)?;
278278
let schema = ser::to_value(schema)?;
279279
match options.compile(&schema) {
280-
Ok(compiled) => {
280+
Ok(validator) => {
281281
let instance = ser::to_value(instance)?;
282-
panic::catch_unwind(AssertUnwindSafe(|| Ok(compiled.is_valid(&instance))))
282+
panic::catch_unwind(AssertUnwindSafe(|| Ok(validator.is_valid(&instance))))
283283
.map_err(handle_format_checked_panic)?
284284
}
285285
Err(error) => Err(into_py_err(py, error)?),
@@ -311,7 +311,7 @@ fn validate(
311311
let options = make_options(draft, formats)?;
312312
let schema = ser::to_value(schema)?;
313313
match options.compile(&schema) {
314-
Ok(compiled) => raise_on_error(py, &compiled, instance),
314+
Ok(validator) => raise_on_error(py, &validator, instance),
315315
Err(error) => Err(into_py_err(py, error)?),
316316
}
317317
}
@@ -340,17 +340,17 @@ fn iter_errors(
340340
let options = make_options(draft, formats)?;
341341
let schema = ser::to_value(schema)?;
342342
match options.compile(&schema) {
343-
Ok(compiled) => iter_on_error(py, &compiled, instance),
343+
Ok(validator) => iter_on_error(py, &validator, instance),
344344
Err(error) => Err(into_py_err(py, error)?),
345345
}
346346
}
347347

348348
/// JSONSchema(schema, draft=None, with_meta_schemas=False)
349349
///
350-
/// JSON Schema compiled into a validation tree.
350+
/// A JSON Schema validator.
351351
///
352-
/// >>> compiled = JSONSchema({"minimum": 5})
353-
/// >>> compiled.is_valid(3)
352+
/// >>> validator = JSONSchema({"minimum": 5})
353+
/// >>> validator.is_valid(3)
354354
/// False
355355
///
356356
/// By default Draft 7 will be used for compilation.
@@ -409,7 +409,7 @@ impl JSONSchema {
409409
///
410410
/// Create `JSONSchema` from a serialized JSON string.
411411
///
412-
/// >>> compiled = JSONSchema.from_str('{"minimum": 5}')
412+
/// >>> validator = JSONSchema.from_str('{"minimum": 5}')
413413
///
414414
/// Use it if you have your schema as a string and want to utilize Rust JSON parsing.
415415
#[classmethod]
@@ -451,10 +451,10 @@ impl JSONSchema {
451451

452452
/// is_valid(instance)
453453
///
454-
/// Perform fast validation against the compiled schema.
454+
/// Perform fast validation against the schema.
455455
///
456-
/// >>> compiled = JSONSchema({"minimum": 5})
457-
/// >>> compiled.is_valid(3)
456+
/// >>> validator = JSONSchema({"minimum": 5})
457+
/// >>> validator.is_valid(3)
458458
/// False
459459
///
460460
/// The output is a boolean value, that indicates whether the instance is valid or not.
@@ -469,8 +469,8 @@ impl JSONSchema {
469469
///
470470
/// Validate the input instance and raise `ValidationError` in the error case
471471
///
472-
/// >>> compiled = JSONSchema({"minimum": 5})
473-
/// >>> compiled.validate(3)
472+
/// >>> validator = JSONSchema({"minimum": 5})
473+
/// >>> validator.validate(3)
474474
/// ...
475475
/// ValidationError: 3 is less than the minimum of 5
476476
///
@@ -484,8 +484,8 @@ impl JSONSchema {
484484
///
485485
/// Iterate the validation errors of the input instance
486486
///
487-
/// >>> compiled = JSONSchema({"minimum": 5})
488-
/// >>> next(compiled.iter_errors(3))
487+
/// >>> validator = JSONSchema({"minimum": 5})
488+
/// >>> next(validator.iter_errors(3))
489489
/// ...
490490
/// ValidationError: 3 is less than the minimum of 5
491491
#[pyo3(text_signature = "(instance)")]

‎crates/jsonschema/benches/jsonschema.rs

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,34 @@
11
use benchmark::Benchmark;
22
use codspeed_criterion_compat::{criterion_group, criterion_main, BenchmarkId, Criterion};
3-
use jsonschema::JSONSchema;
43
use serde_json::Value;
54

65
fn bench_compile(c: &mut Criterion, name: &str, schema: &Value) {
76
c.bench_function(&format!("{}/compile", name), |b| {
8-
b.iter(|| JSONSchema::compile(schema).expect("Valid schema"))
7+
b.iter(|| jsonschema::validator_for(schema).expect("Valid schema"))
98
});
109
}
1110

1211
fn bench_is_valid(c: &mut Criterion, name: &str, schema: &Value, instance: &Value) {
13-
let compiled = JSONSchema::compile(schema).expect("Valid schema");
12+
let validator = jsonschema::validator_for(schema).expect("Valid schema");
1413
c.bench_with_input(
1514
BenchmarkId::new(name, "is_valid"),
1615
instance,
1716
|b, instance| {
1817
b.iter(|| {
19-
let _ = compiled.is_valid(instance);
18+
let _ = validator.is_valid(instance);
2019
})
2120
},
2221
);
2322
}
2423

2524
fn bench_validate(c: &mut Criterion, name: &str, schema: &Value, instance: &Value) {
26-
let compiled = JSONSchema::compile(schema).expect("Valid schema");
25+
let validator = jsonschema::validator_for(schema).expect("Valid schema");
2726
c.bench_with_input(
2827
BenchmarkId::new(name, "validate"),
2928
instance,
3029
|b, instance| {
3130
b.iter(|| {
32-
let _ = compiled.validate(instance);
31+
let _ = validator.validate(instance);
3332
})
3433
},
3534
);

‎crates/jsonschema/benches/keywords.rs

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,34 @@
11
use benchmark::run_keyword_benchmarks;
22
use criterion::{criterion_group, criterion_main, BenchmarkId, Criterion};
3-
use jsonschema::JSONSchema;
43
use serde_json::Value;
54

65
fn bench_keyword_compile(c: &mut Criterion, name: &str, schema: &Value) {
76
c.bench_function(&format!("keyword/{}/compile", name), |b| {
8-
b.iter(|| JSONSchema::compile(schema).expect("Valid schema"))
7+
b.iter(|| jsonschema::validator_for(schema).expect("Valid schema"))
98
});
109
}
1110

1211
fn bench_keyword_is_valid(c: &mut Criterion, name: &str, schema: &Value, instance: &Value) {
13-
let compiled = JSONSchema::compile(schema).expect("Valid schema");
12+
let validator = jsonschema::validator_for(schema).expect("Valid schema");
1413
c.bench_with_input(
1514
BenchmarkId::new(format!("keyword/{}", name), "is_valid"),
1615
instance,
1716
|b, instance| {
1817
b.iter(|| {
19-
let _ = compiled.is_valid(instance);
18+
let _ = validator.is_valid(instance);
2019
})
2120
},
2221
);
2322
}
2423

2524
fn bench_keyword_validate(c: &mut Criterion, name: &str, schema: &Value, instance: &Value) {
26-
let compiled = JSONSchema::compile(schema).expect("Valid schema");
25+
let validator = jsonschema::validator_for(schema).expect("Valid schema");
2726
c.bench_with_input(
2827
BenchmarkId::new(format!("keyword/{}", name), "validate"),
2928
instance,
3029
|b, instance| {
3130
b.iter(|| {
32-
let _ = compiled.validate(instance);
31+
let _ = validator.validate(instance);
3332
})
3433
},
3534
);

0 commit comments

Comments
 (0)