1# Licensed to the Apache Software Foundation (ASF) under one
2# or more contributor license agreements. See the NOTICE file
3# distributed with this work for additional information
4# regarding copyright ownership. The ASF licenses this file
5# to you under the Apache License, Version 2.0 (the
6# "License"); you may not use this file except in compliance
7# with the License. You may obtain a copy of the License at
8#
9# http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing,
12# software distributed under the License is distributed on an
13# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14# KIND, either express or implied. See the License for the
15# specific language governing permissions and limitations
16# under the License.
17from __future__ import annotations
18
19from airflow.sdk.bases.xcom import BaseXCom
20from airflow.sdk.configuration import conf
21
22
23def resolve_xcom_backend():
24 """
25 Resolve custom XCom class.
26
27 :returns: returns the custom XCom class if configured.
28 """
29 clazz = conf.getimport("core", "xcom_backend", fallback="airflow.sdk.bases.xcom.BaseXCom")
30 if not clazz:
31 return BaseXCom
32 if not issubclass(clazz, BaseXCom):
33 raise TypeError(
34 f"Your custom XCom class `{clazz.__name__}` is not a subclass of `{BaseXCom.__name__}`."
35 )
36 return clazz
37
38
39XCom = resolve_xcom_backend()