Coverage for /pythoncovmergedfiles/medio/medio/src/airflow/airflow/secrets/environment_variables.py: 75%
16 statements
« prev ^ index » next coverage.py v7.0.1, created at 2022-12-25 06:11 +0000
« prev ^ index » next coverage.py v7.0.1, created at 2022-12-25 06:11 +0000
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"""Objects relating to sourcing connections from environment variables."""
19from __future__ import annotations
21import os
22import warnings
24from airflow.exceptions import RemovedInAirflow3Warning
25from airflow.secrets import BaseSecretsBackend
27CONN_ENV_PREFIX = "AIRFLOW_CONN_"
28VAR_ENV_PREFIX = "AIRFLOW_VAR_"
31class EnvironmentVariablesBackend(BaseSecretsBackend):
32 """Retrieves Connection object and Variable from environment variable."""
34 def get_conn_uri(self, conn_id: str) -> str | None:
35 """
36 Return URI representation of Connection conn_id.
37 :param conn_id: the connection id
38 :return: deserialized Connection
39 """
40 warnings.warn(
41 "This method is deprecated. Please use "
42 "`airflow.secrets.environment_variables.EnvironmentVariablesBackend.get_conn_value`.",
43 RemovedInAirflow3Warning,
44 stacklevel=2,
45 )
46 return self.get_conn_value(conn_id)
48 def get_conn_value(self, conn_id: str) -> str | None:
49 return os.environ.get(CONN_ENV_PREFIX + conn_id.upper())
51 def get_variable(self, key: str) -> str | None:
52 """
53 Get Airflow Variable from Environment Variable.
55 :param key: Variable Key
56 :return: Variable Value
57 """
58 return os.environ.get(VAR_ENV_PREFIX + key.upper())