|
| 1 | +# openapi_spec_validator/schemas/rust_adapters.py |
| 2 | +""" |
| 3 | +Proof-of-Concept: jsonschema-rs adapter for openapi-spec-validator. |
| 4 | +
|
| 5 | +This module provides a compatibility layer between jsonschema-rs (Rust) |
| 6 | +and the existing jsonschema (Python) validator interface. |
| 7 | +""" |
| 8 | + |
| 9 | +from typing import Any |
| 10 | +from typing import Iterator |
| 11 | +from typing import TYPE_CHECKING |
| 12 | +from typing import cast |
| 13 | + |
| 14 | +if TYPE_CHECKING: |
| 15 | + class ValidationErrorBase(Exception): |
| 16 | + def __init__(self, *args: Any, **kwargs: Any) -> None: ... |
| 17 | + |
| 18 | +else: |
| 19 | + from jsonschema.exceptions import ValidationError as ValidationErrorBase |
| 20 | + |
| 21 | +# Try to import jsonschema-rs |
| 22 | +try: |
| 23 | + import jsonschema_rs |
| 24 | + |
| 25 | + HAS_JSONSCHEMA_RS = True |
| 26 | +except ImportError: |
| 27 | + HAS_JSONSCHEMA_RS = False |
| 28 | + jsonschema_rs = None # type: ignore |
| 29 | + |
| 30 | + |
| 31 | +class RustValidatorError(ValidationErrorBase): |
| 32 | + """ValidationError compatible with jsonschema, but originating from Rust validator.""" |
| 33 | + |
| 34 | + pass |
| 35 | + |
| 36 | + |
| 37 | +class RustValidatorWrapper: |
| 38 | + """ |
| 39 | + Wrapper that makes jsonschema-rs validator compatible with jsonschema interface. |
| 40 | +
|
| 41 | + This allows drop-in replacement while maintaining the same API surface. |
| 42 | + """ |
| 43 | + |
| 44 | + def __init__(self, schema: dict[str, Any], validator: Any): |
| 45 | + """ |
| 46 | + Initialize Rust validator wrapper. |
| 47 | +
|
| 48 | + Args: |
| 49 | + schema: JSON Schema to validate against |
| 50 | + cls: JSON Schema validator |
| 51 | + """ |
| 52 | + if not HAS_JSONSCHEMA_RS: |
| 53 | + raise ImportError( |
| 54 | + "jsonschema-rs is not installed. Install it with: " |
| 55 | + "pip install jsonschema-rs" |
| 56 | + ) |
| 57 | + |
| 58 | + self.schema = schema |
| 59 | + self._rs_validator = validator |
| 60 | + |
| 61 | + def iter_errors(self, instance: Any) -> Iterator[ValidationErrorBase]: |
| 62 | + """ |
| 63 | + Validate instance and yield errors in jsonschema format. |
| 64 | +
|
| 65 | + This method converts jsonschema-rs errors to jsonschema ValidationError |
| 66 | + format for compatibility with existing code. |
| 67 | + """ |
| 68 | + # Try to validate - jsonschema-rs returns ValidationError on failure |
| 69 | + result = self._rs_validator.validate(instance) |
| 70 | + |
| 71 | + if result is not None: |
| 72 | + # result contains validation errors |
| 73 | + # jsonschema-rs returns an iterator of errors |
| 74 | + for error in self._rs_validator.iter_errors(instance): |
| 75 | + yield self._convert_rust_error(error, instance) |
| 76 | + |
| 77 | + def validate(self, instance: Any) -> None: |
| 78 | + """ |
| 79 | + Validate instance and raise ValidationError if invalid. |
| 80 | +
|
| 81 | + Compatible with jsonschema Validator.validate() method. |
| 82 | + """ |
| 83 | + try: |
| 84 | + self._rs_validator.validate(instance) |
| 85 | + except jsonschema_rs.ValidationError as e: |
| 86 | + # Convert and raise as Python ValidationError |
| 87 | + py_error = self._convert_rust_error_exception(e, instance) |
| 88 | + raise py_error from e |
| 89 | + |
| 90 | + def is_valid(self, instance: Any) -> bool: |
| 91 | + """Check if instance is valid against schema.""" |
| 92 | + return cast(bool, self._rs_validator.is_valid(instance)) |
| 93 | + |
| 94 | + def _convert_rust_error( |
| 95 | + self, rust_error: Any, instance: Any |
| 96 | + ) -> ValidationErrorBase: |
| 97 | + """ |
| 98 | + Convert jsonschema-rs error format to jsonschema ValidationError. |
| 99 | +
|
| 100 | + jsonschema-rs error structure: |
| 101 | + - message: str |
| 102 | + - instance_path: list |
| 103 | + - schema_path: list (if available) |
| 104 | + """ |
| 105 | + message = str(rust_error) |
| 106 | + |
| 107 | + # Extract path information if available |
| 108 | + # Note: jsonschema-rs error format may differ - adjust as needed |
| 109 | + instance_path = getattr(rust_error, "instance_path", []) |
| 110 | + schema_path = getattr(rust_error, "schema_path", []) |
| 111 | + |
| 112 | + return RustValidatorError( |
| 113 | + message=message, |
| 114 | + path=list(instance_path) if instance_path else [], |
| 115 | + schema_path=list(schema_path) if schema_path else [], |
| 116 | + instance=instance, |
| 117 | + schema=self.schema, |
| 118 | + ) |
| 119 | + |
| 120 | + def _convert_rust_error_exception( |
| 121 | + self, rust_error: "jsonschema_rs.ValidationError", instance: Any |
| 122 | + ) -> ValidationErrorBase: |
| 123 | + """Convert jsonschema-rs ValidationError exception to Python format.""" |
| 124 | + message = str(rust_error) |
| 125 | + |
| 126 | + return RustValidatorError( |
| 127 | + message=message, |
| 128 | + instance=instance, |
| 129 | + schema=self.schema, |
| 130 | + ) |
| 131 | + |
| 132 | + |
| 133 | +def create_validator( |
| 134 | + schema: dict[str, Any], draft: str = "draft202012" |
| 135 | +) -> RustValidatorWrapper: |
| 136 | + """ |
| 137 | + Factory function to create Rust-backed validator. |
| 138 | +
|
| 139 | + Args: |
| 140 | + schema: JSON Schema to validate against |
| 141 | + draft: JSON Schema draft version |
| 142 | +
|
| 143 | + Returns: |
| 144 | + RustValidatorWrapper instance |
| 145 | + """ |
| 146 | + |
| 147 | + # Create appropriate Rust validator based on draft |
| 148 | + validator: Any |
| 149 | + if draft == "draft4": |
| 150 | + validator = jsonschema_rs.Draft4Validator(schema) |
| 151 | + elif draft == "draft7": |
| 152 | + validator = jsonschema_rs.Draft7Validator(schema) |
| 153 | + elif draft == "draft201909": |
| 154 | + validator = jsonschema_rs.Draft201909Validator(schema) |
| 155 | + elif draft == "draft202012": |
| 156 | + validator = jsonschema_rs.Draft202012Validator(schema) |
| 157 | + else: |
| 158 | + raise ValueError(f"Unsupported draft: {draft}") |
| 159 | + |
| 160 | + return RustValidatorWrapper(schema, validator=validator) |
| 161 | + |
| 162 | + |
| 163 | +# Convenience function to check if Rust validators are available |
| 164 | +def has_jsonschema_rs_validators() -> bool: |
| 165 | + """Check if jsonschema-rs is available.""" |
| 166 | + return HAS_JSONSCHEMA_RS |
| 167 | + |
| 168 | + |
| 169 | +def get_validator_backend() -> str: |
| 170 | + """Get current validator backend (rust or python).""" |
| 171 | + if HAS_JSONSCHEMA_RS: |
| 172 | + return "rust (jsonschema-rs)" |
| 173 | + return "python (jsonschema)" |
0 commit comments