jsonschema 0.58.0

JSON schema validaton library
Documentation 
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

//! Compile-time meta-schema validators for the bundled drafts, dispatched from
//! `meta::validator_for_draft` under the `macros` feature.

use crate::{Draft, ErrorIterator, ValidationError};
use serde_json::Value;

pub(crate) type ValidateFn = for<'i> fn(&'i Value) -> Result<(), ValidationError<'i>>;
pub(crate) type IterErrorsFn = for<'i> fn(&'i Value) -> ErrorIterator<'i>;

#[jsonschema_macros::validator(path = "metaschemas/draft4.json", draft = Draft4)]
struct MetaDraft4;

#[jsonschema_macros::validator(path = "metaschemas/draft6.json", draft = Draft6)]
struct MetaDraft6;

#[jsonschema_macros::validator(path = "metaschemas/draft7.json", draft = Draft7)]
struct MetaDraft7;

#[jsonschema_macros::validator(
    path = "metaschemas/draft2019-09/schema.json",
    draft = Draft201909,
    resources = {
        "https://json-schema.org/draft/2019-09/meta/core" => { path = "metaschemas/draft2019-09/meta/core.json" },
        "https://json-schema.org/draft/2019-09/meta/applicator" => { path = "metaschemas/draft2019-09/meta/applicator.json" },
        "https://json-schema.org/draft/2019-09/meta/validation" => { path = "metaschemas/draft2019-09/meta/validation.json" },
        "https://json-schema.org/draft/2019-09/meta/meta-data" => { path = "metaschemas/draft2019-09/meta/meta-data.json" },
        "https://json-schema.org/draft/2019-09/meta/format" => { path = "metaschemas/draft2019-09/meta/format.json" },
        "https://json-schema.org/draft/2019-09/meta/content" => { path = "metaschemas/draft2019-09/meta/content.json" },
    }
)]
struct MetaDraft201909;

#[jsonschema_macros::validator(
    path = "metaschemas/draft2020-12/schema.json",
    draft = Draft202012,
    resources = {
        "https://json-schema.org/draft/2020-12/meta/core" => { path = "metaschemas/draft2020-12/meta/core.json" },
        "https://json-schema.org/draft/2020-12/meta/applicator" => { path = "metaschemas/draft2020-12/meta/applicator.json" },
        "https://json-schema.org/draft/2020-12/meta/unevaluated" => { path = "metaschemas/draft2020-12/meta/unevaluated.json" },
        "https://json-schema.org/draft/2020-12/meta/validation" => { path = "metaschemas/draft2020-12/meta/validation.json" },
        "https://json-schema.org/draft/2020-12/meta/meta-data" => { path = "metaschemas/draft2020-12/meta/meta-data.json" },
        "https://json-schema.org/draft/2020-12/meta/format-annotation" => { path = "metaschemas/draft2020-12/meta/format-annotation.json" },
        "https://json-schema.org/draft/2020-12/meta/content" => { path = "metaschemas/draft2020-12/meta/content.json" },
    }
)]
struct MetaDraft202012;

// `Draft::Unknown` and future drafts fall through to Draft 2020-12, matching `validator_for_draft`.
pub(crate) fn is_valid_fn(draft: Draft) -> fn(&Value) -> bool {
    match draft {
        Draft::Draft4 => MetaDraft4::is_valid,
        Draft::Draft6 => MetaDraft6::is_valid,
        Draft::Draft7 => MetaDraft7::is_valid,
        Draft::Draft201909 => MetaDraft201909::is_valid,
        _ => MetaDraft202012::is_valid,
    }
}

pub(crate) fn validate_fn(draft: Draft) -> ValidateFn {
    match draft {
        Draft::Draft4 => MetaDraft4::validate,
        Draft::Draft6 => MetaDraft6::validate,
        Draft::Draft7 => MetaDraft7::validate,
        Draft::Draft201909 => MetaDraft201909::validate,
        _ => MetaDraft202012::validate,
    }
}

pub(crate) fn iter_errors_fn(draft: Draft) -> IterErrorsFn {
    match draft {
        Draft::Draft4 => MetaDraft4::iter_errors,
        Draft::Draft6 => MetaDraft6::iter_errors,
        Draft::Draft7 => MetaDraft7::iter_errors,
        Draft::Draft201909 => MetaDraft201909::iter_errors,
        _ => MetaDraft202012::iter_errors,
    }
}

#[cfg(feature = "pyo3")]
pub(crate) mod pyo3 {
    use crate::{Draft, ValidationError};
    use ::pyo3::{types::PyAny, Bound, PyResult};

    pub type IsValidFn = fn(&Bound<'_, PyAny>) -> PyResult<bool>;
    pub type ValidateFn =
        for<'i> fn(&'i Bound<'i, PyAny>) -> PyResult<Result<(), ValidationError<'i>>>;

    #[jsonschema_macros::validator(path = "metaschemas/draft4.json", draft = Draft4, backend = Pyo3)]
    struct MetaDraft4;

    #[jsonschema_macros::validator(path = "metaschemas/draft6.json", draft = Draft6, backend = Pyo3)]
    struct MetaDraft6;

    #[jsonschema_macros::validator(path = "metaschemas/draft7.json", draft = Draft7, backend = Pyo3)]
    struct MetaDraft7;

    #[jsonschema_macros::validator(
        path = "metaschemas/draft2019-09/schema.json",
        draft = Draft201909,
        backend = Pyo3,
        resources = {
            "https://json-schema.org/draft/2019-09/meta/core" => { path = "metaschemas/draft2019-09/meta/core.json" },
            "https://json-schema.org/draft/2019-09/meta/applicator" => { path = "metaschemas/draft2019-09/meta/applicator.json" },
            "https://json-schema.org/draft/2019-09/meta/validation" => { path = "metaschemas/draft2019-09/meta/validation.json" },
            "https://json-schema.org/draft/2019-09/meta/meta-data" => { path = "metaschemas/draft2019-09/meta/meta-data.json" },
            "https://json-schema.org/draft/2019-09/meta/format" => { path = "metaschemas/draft2019-09/meta/format.json" },
            "https://json-schema.org/draft/2019-09/meta/content" => { path = "metaschemas/draft2019-09/meta/content.json" },
        }
    )]
    struct MetaDraft201909;

    #[jsonschema_macros::validator(
        path = "metaschemas/draft2020-12/schema.json",
        draft = Draft202012,
        backend = Pyo3,
        resources = {
            "https://json-schema.org/draft/2020-12/meta/core" => { path = "metaschemas/draft2020-12/meta/core.json" },
            "https://json-schema.org/draft/2020-12/meta/applicator" => { path = "metaschemas/draft2020-12/meta/applicator.json" },
            "https://json-schema.org/draft/2020-12/meta/unevaluated" => { path = "metaschemas/draft2020-12/meta/unevaluated.json" },
            "https://json-schema.org/draft/2020-12/meta/validation" => { path = "metaschemas/draft2020-12/meta/validation.json" },
            "https://json-schema.org/draft/2020-12/meta/meta-data" => { path = "metaschemas/draft2020-12/meta/meta-data.json" },
            "https://json-schema.org/draft/2020-12/meta/format-annotation" => { path = "metaschemas/draft2020-12/meta/format-annotation.json" },
            "https://json-schema.org/draft/2020-12/meta/content" => { path = "metaschemas/draft2020-12/meta/content.json" },
        }
    )]
    struct MetaDraft202012;

    /// The meta-schema `draft` is checked against, reading the schema as a Python object.
    ///
    /// `Draft::Unknown` and future drafts fall through to Draft 2020-12, matching the
    /// serde-backed dispatch above.
    #[must_use]
    pub fn is_valid_fn(draft: Draft) -> IsValidFn {
        match draft {
            Draft::Draft4 => MetaDraft4::is_valid,
            Draft::Draft6 => MetaDraft6::is_valid,
            Draft::Draft7 => MetaDraft7::is_valid,
            Draft::Draft201909 => MetaDraft201909::is_valid,
            _ => MetaDraft202012::is_valid,
        }
    }

    /// The first meta-schema error, reading the schema as a Python object.
    #[must_use]
    pub fn validate_fn(draft: Draft) -> ValidateFn {
        match draft {
            Draft::Draft4 => MetaDraft4::validate,
            Draft::Draft6 => MetaDraft6::validate,
            Draft::Draft7 => MetaDraft7::validate,
            Draft::Draft201909 => MetaDraft201909::validate,
            _ => MetaDraft202012::validate,
        }
    }
}

#[cfg(feature = "magnus")]
pub(crate) mod magnus {
    use crate::{Draft, ValidationError};
    use ::magnus::{Error, Value};

    pub type IsValidFn = fn(&Value) -> Result<bool, Error>;
    pub type ValidateFn = for<'i> fn(&'i Value) -> Result<Result<(), ValidationError<'i>>, Error>;

    #[jsonschema_macros::validator(path = "metaschemas/draft4.json", draft = Draft4, backend = Magnus)]
    struct MetaDraft4;

    #[jsonschema_macros::validator(path = "metaschemas/draft6.json", draft = Draft6, backend = Magnus)]
    struct MetaDraft6;

    #[jsonschema_macros::validator(path = "metaschemas/draft7.json", draft = Draft7, backend = Magnus)]
    struct MetaDraft7;

    #[jsonschema_macros::validator(
        path = "metaschemas/draft2019-09/schema.json",
        draft = Draft201909,
        backend = Magnus,
        resources = {
            "https://json-schema.org/draft/2019-09/meta/core" => { path = "metaschemas/draft2019-09/meta/core.json" },
            "https://json-schema.org/draft/2019-09/meta/applicator" => { path = "metaschemas/draft2019-09/meta/applicator.json" },
            "https://json-schema.org/draft/2019-09/meta/validation" => { path = "metaschemas/draft2019-09/meta/validation.json" },
            "https://json-schema.org/draft/2019-09/meta/meta-data" => { path = "metaschemas/draft2019-09/meta/meta-data.json" },
            "https://json-schema.org/draft/2019-09/meta/format" => { path = "metaschemas/draft2019-09/meta/format.json" },
            "https://json-schema.org/draft/2019-09/meta/content" => { path = "metaschemas/draft2019-09/meta/content.json" },
        }
    )]
    struct MetaDraft201909;

    #[jsonschema_macros::validator(
        path = "metaschemas/draft2020-12/schema.json",
        draft = Draft202012,
        backend = Magnus,
        resources = {
            "https://json-schema.org/draft/2020-12/meta/core" => { path = "metaschemas/draft2020-12/meta/core.json" },
            "https://json-schema.org/draft/2020-12/meta/applicator" => { path = "metaschemas/draft2020-12/meta/applicator.json" },
            "https://json-schema.org/draft/2020-12/meta/unevaluated" => { path = "metaschemas/draft2020-12/meta/unevaluated.json" },
            "https://json-schema.org/draft/2020-12/meta/validation" => { path = "metaschemas/draft2020-12/meta/validation.json" },
            "https://json-schema.org/draft/2020-12/meta/meta-data" => { path = "metaschemas/draft2020-12/meta/meta-data.json" },
            "https://json-schema.org/draft/2020-12/meta/format-annotation" => { path = "metaschemas/draft2020-12/meta/format-annotation.json" },
            "https://json-schema.org/draft/2020-12/meta/content" => { path = "metaschemas/draft2020-12/meta/content.json" },
        }
    )]
    struct MetaDraft202012;

    /// The meta-schema `draft` is checked against, reading the schema as a Ruby object.
    ///
    /// `Draft::Unknown` and future drafts fall through to Draft 2020-12, matching the
    /// serde-backed dispatch above.
    #[must_use]
    pub fn is_valid_fn(draft: Draft) -> IsValidFn {
        match draft {
            Draft::Draft4 => MetaDraft4::is_valid,
            Draft::Draft6 => MetaDraft6::is_valid,
            Draft::Draft7 => MetaDraft7::is_valid,
            Draft::Draft201909 => MetaDraft201909::is_valid,
            _ => MetaDraft202012::is_valid,
        }
    }

    /// The first meta-schema error, reading the schema as a Ruby object.
    #[must_use]
    pub fn validate_fn(draft: Draft) -> ValidateFn {
        match draft {
            Draft::Draft4 => MetaDraft4::validate,
            Draft::Draft6 => MetaDraft6::validate,
            Draft::Draft7 => MetaDraft7::validate,
            Draft::Draft201909 => MetaDraft201909::validate,
            _ => MetaDraft202012::validate,
        }
    }
}