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."""

from __future__ import annotations

import os
import re

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_value(self, conn_id: str, team_name: str | None = None) -> str | None:
        if self._is_team_specific_accessed_as_global(conn_id, team_name):
            return None

        if team_name and (
            team_var := os.environ.get(f"{CONN_ENV_PREFIX}_{team_name.upper()}___" + conn_id.upper())
        ):
            # Format to set a team specific connection: AIRFLOW_CONN__<TEAM_ID>___<CONN_ID>
            return team_var

        return os.environ.get(CONN_ENV_PREFIX + conn_id.upper())



[docs]
    def get_variable(self, key: str, team_name: str | None = None) -> str | None:
        """
        Get Airflow Variable from Environment Variable.

        :param key: Variable Key
        :param team_name: Team name associated to the task trying to access the variable (if any)
        :return: Variable Value
        """
        if self._is_team_specific_accessed_as_global(key, team_name):
            return None

        if team_name and (
            team_var := os.environ.get(f"{VAR_ENV_PREFIX}_{team_name.upper()}___" + key.upper())
        ):
            # Format to set a team specific variable: AIRFLOW_VAR__<TEAM_ID>___<VAR_KEY>
            return team_var

        return os.environ.get(VAR_ENV_PREFIX + key.upper())


    @staticmethod
    def _is_team_specific_accessed_as_global(secret_id: str, team_name: str | None = None) -> bool:
        return team_name is None and bool(re.fullmatch(r"_[^_]+___.+", secret_id))