1#
2# Licensed to the Apache Software Foundation (ASF) under one
3# or more contributor license agreements. See the NOTICE file
4# distributed with this work for additional information
5# regarding copyright ownership. The ASF licenses this file
6# to you under the Apache License, Version 2.0 (the
7# "License"); you may not use this file except in compliance
8# with the License. You may obtain a copy of the License at
9#
10# http://www.apache.org/licenses/LICENSE-2.0
11#
12# Unless required by applicable law or agreed to in writing,
13# software distributed under the License is distributed on an
14# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15# KIND, either express or implied. See the License for the
16# specific language governing permissions and limitations
17# under the License.
18"""
19The Secrets framework provides a means of getting connection objects from various sources.
20
21The following sources are available:
22
23* Environment variables
24* Metastore database
25* Local Filesystem Secrets Backend
26"""
27
28from __future__ import annotations
29
30from airflow.utils.deprecation_tools import add_deprecated_classes
31
32__all__ = ["BaseSecretsBackend", "DEFAULT_SECRETS_SEARCH_PATH"]
33
34from airflow.secrets.base_secrets import BaseSecretsBackend
35
36DEFAULT_SECRETS_SEARCH_PATH = [
37 "airflow.secrets.environment_variables.EnvironmentVariablesBackend",
38 "airflow.secrets.metastore.MetastoreBackend",
39]
40
41
42__deprecated_classes = {
43 "cache": {
44 "SecretCache": "airflow.sdk.execution_time.cache.SecretCache",
45 },
46}
47add_deprecated_classes(__deprecated_classes, __name__)
48
49
50def __getattr__(name):
51 if name == "DEFAULT_SECRETS_SEARCH_PATH_WORKERS":
52 import warnings
53
54 from airflow.utils.deprecation_tools import DeprecatedImportWarning
55
56 warnings.warn(
57 "airflow.secrets.DEFAULT_SECRETS_SEARCH_PATH_WORKERS is moved to the Task SDK. "
58 "Use airflow.sdk.execution_time.secrets.DEFAULT_SECRETS_SEARCH_PATH_WORKERS instead.",
59 DeprecatedImportWarning,
60 stacklevel=2,
61 )
62 try:
63 from airflow.sdk.execution_time.secrets import DEFAULT_SECRETS_SEARCH_PATH_WORKERS
64
65 return DEFAULT_SECRETS_SEARCH_PATH_WORKERS
66 except (ImportError, AttributeError):
67 # Back-compat for older Task SDK clients
68 return [
69 "airflow.secrets.environment_variables.EnvironmentVariablesBackend",
70 ]
71
72 raise AttributeError(f"module '{__name__}' has no attribute '{name}'")