Source code for airflow.exceptions

# -*- coding: utf-8 -*-
#
# 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.
#
# Note: Any AirflowException raised is expected to cause the TaskInstance
#       to be marked in an ERROR state
"""Exceptions used by Airflow"""
from collections import namedtuple

from airflow.utils.code_utils import prepare_code_snippet
from airflow.utils.platform import is_tty


[docs]class AirflowException(Exception): """ Base class for all Airflow's errors. Each custom exception should be derived from this class """
[docs] status_code = 500
[docs]class AirflowBadRequest(AirflowException): """Raise when the application or server cannot handle the request"""
[docs] status_code = 400
[docs]class AirflowNotFoundException(AirflowException): """Raise when the requested object/resource is not available in the system"""
[docs] status_code = 404
[docs]class AirflowConfigException(AirflowException):
"""Raise when there is configuration problem"""
[docs]class AirflowSensorTimeout(AirflowException):
"""Raise when there is a timeout on sensor polling"""
[docs]class AirflowRescheduleException(AirflowException): """ Raise when the task should be re-scheduled at a later time. :param reschedule_date: The date when the task should be rescheduled :type reschedule_date: datetime.datetime """ def __init__(self, reschedule_date): self.reschedule_date = reschedule_date
[docs]class AirflowTaskTimeout(AirflowException):
"""Raise when the task execution times-out"""
[docs]class AirflowWebServerTimeout(AirflowException):
"""Raise when the web server times out"""
[docs]class AirflowSkipException(AirflowException):
"""Raise when the task should be skipped"""
[docs]class AirflowFailException(AirflowException):
"""Raise when the task should be failed without retrying"""
[docs]class AirflowDagCycleException(AirflowException):
"""Raise when there is a cycle in Dag definition"""
[docs]class DagNotFound(AirflowNotFoundException):
"""Raise when a DAG is not available in the system"""
[docs]class DagCodeNotFound(AirflowNotFoundException):
"""Raise when a DAG code is not available in the system"""
[docs]class DagRunNotFound(AirflowNotFoundException):
"""Raise when a DAG Run is not available in the system"""
[docs]class DagRunAlreadyExists(AirflowBadRequest):
"""Raise when creating a DAG run for DAG which already has DAG run entry"""
[docs]class DagFileExists(AirflowBadRequest):
"""Raise when a DAG ID is still in DagBag i.e., DAG file is in DAG folder"""
[docs]class TaskNotFound(AirflowNotFoundException):
"""Raise when a Task is not available in the system"""
[docs]class TaskInstanceNotFound(AirflowNotFoundException):
"""Raise when a Task Instance is not available in the system"""
[docs]class PoolNotFound(AirflowNotFoundException):
"""Raise when a Pool is not available in the system"""
[docs]class NoAvailablePoolSlot(AirflowException):
"""Raise when there is not enough slots in pool"""
[docs]class DagConcurrencyLimitReached(AirflowException):
"""Raise when DAG concurrency limit is reached"""
[docs]class TaskConcurrencyLimitReached(AirflowException):
"""Raise when task concurrency limit is reached"""
[docs]file_syntax_error = namedtuple('FileSyntaxError', 'line_no message')
"""Information about a single error in a file."""
[docs]class AirflowFileParseException(AirflowException): """ Raises when connection or variable file can not be parsed :param msg: The human-readable description of the exception :param file_path: A processed file that contains errors :param parse_errors: File syntax errors """ def __init__(self, msg, file_path, parse_errors): super(AirflowException, self).__init__(msg) self.msg = msg self.file_path = file_path self.parse_errors = parse_errors
[docs] def __str__(self): result = self.msg + "\nFilename: " + self.file_path + "\n\n" for error_no, parse_error in enumerate(self.parse_errors, 1): result += "=" * 20 + " Parse error {error_no:3} ".format(error_no=error_no) + "=" * 20 + "\n" result += parse_error.message + "\n" if parse_error.line_no: result += "Line number: {}\n".format(parse_error.line_no) if parse_error.line_no and is_tty(): result += "\n" + prepare_code_snippet(self.file_path, parse_error.line_no) + "\n" return result