Source code for airflow.secrets.environment_variables

#
# 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.
"""Objects relating to sourcing connections from environment variables"""

import os
import warnings
from typing import Optional

from airflow.secrets import BaseSecretsBackend

[docs]CONN_ENV_PREFIX = "AIRFLOW_CONN_"
[docs]VAR_ENV_PREFIX = "AIRFLOW_VAR_"


[docs]class EnvironmentVariablesBackend(BaseSecretsBackend):
    """Retrieves Connection object and Variable from environment variable."""

[docs]    def get_conn_uri(self, conn_id: str) -> Optional[str]:
        """
        Return URI representation of Connection conn_id
        :param conn_id: the connection id
        :return: deserialized Connection
        """
        warnings.warn(
            "This method is deprecated. Please use "
            "`airflow.secrets.environment_variables.EnvironmentVariablesBackend.get_conn_value`.",
            PendingDeprecationWarning,
            stacklevel=2,
        )
        return self.get_conn_value(conn_id)

[docs]    def get_conn_value(self, conn_id: str) -> Optional[str]:
        return os.environ.get(CONN_ENV_PREFIX + conn_id.upper())

[docs]    def get_variable(self, key: str) -> Optional[str]:
        """
        Get Airflow Variable from Environment Variable

        :param key: Variable Key
        :return: Variable Value
        """
        return os.environ.get(VAR_ENV_PREFIX + key.upper())