123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172 |
- #
- # Licensed to the Apache Software Foundation (ASF) under one
- # or more contributor license agreements. See the NOTICE file
- # distributed with this work for additional information
- # regarding copyright ownership. The ASF licenses this file
- # to you under the Apache License, Version 2.0 (the
- # "License"); you may not use this file except in compliance
- # with the License. You may obtain a copy of the License at
- #
- # http://www.apache.org/licenses/LICENSE-2.0
- #
- # Unless required by applicable law or agreed to in writing,
- # software distributed under the License is distributed on an
- # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- # KIND, either express or implied. See the License for the
- # specific language governing permissions and limitations
- # under the License.
- """jsonschema for validating serialized DAG and operator."""
- from __future__ import annotations
- import pkgutil
- from typing import TYPE_CHECKING, Iterable
- from airflow.exceptions import AirflowException
- from airflow.settings import json
- from airflow.typing_compat import Protocol
- if TYPE_CHECKING:
- import jsonschema
- class Validator(Protocol):
- """
- This class is only used for type checking.
- A workaround for IDEs, mypy, etc. due to the way ``Draft7Validator`` is created.
- They are created or do not inherit from proper classes.
- Hence, you can not have ``type: Draft7Validator``.
- """
- def is_valid(self, instance) -> bool:
- """Check if the instance is valid under the current schema."""
- ...
- def validate(self, instance) -> None:
- """Check if the instance is valid under the current schema, raising validation error if not."""
- ...
- def iter_errors(self, instance) -> Iterable[jsonschema.exceptions.ValidationError]:
- """Lazily yield each of the validation errors in the given instance."""
- ...
- def load_dag_schema_dict() -> dict:
- """Load & return Json Schema for DAG as Python dict."""
- schema_file_name = "schema.json"
- schema_file = pkgutil.get_data(__name__, schema_file_name)
- if schema_file is None:
- raise AirflowException(f"Schema file {schema_file_name} does not exists")
- schema = json.loads(schema_file.decode())
- return schema
- def load_dag_schema() -> Validator:
- """Load & Validate Json Schema for DAG."""
- import jsonschema
- schema = load_dag_schema_dict()
- return jsonschema.Draft7Validator(schema)
|