Source code for airflow.secrets.base_secrets

# 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
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

import warnings
from abc import ABC
from typing import TYPE_CHECKING, List, Optional

    from airflow.models.connection import Connection

[docs]class BaseSecretsBackend(ABC): """Abstract base class to retrieve Connection object given a conn_id or Variable given a key""" def __init__(self, **kwargs): pass @staticmethod
[docs] def build_path(path_prefix: str, secret_id: str, sep: str = "/") -> str: """ Given conn_id, build path for Secrets Backend :param path_prefix: Prefix of the path to get secret :type path_prefix: str :param secret_id: Secret id :type secret_id: str :param sep: separator used to concatenate connections_prefix and conn_id. Default: "/" :type sep: str """ return f"{path_prefix}{sep}{secret_id}"
[docs] def get_conn_uri(self, conn_id: str) -> Optional[str]: """ Get conn_uri from Secrets Backend :param conn_id: connection id :type conn_id: str """ raise NotImplementedError()
[docs] def get_connection(self, conn_id: str) -> Optional['Connection']: """ Return connection object with a given ``conn_id``. :param conn_id: connection id :type conn_id: str """ from airflow.models.connection import Connection conn_uri = self.get_conn_uri(conn_id=conn_id) if not conn_uri: return None conn = Connection(conn_id=conn_id, uri=conn_uri) return conn
[docs] def get_connections(self, conn_id: str) -> List['Connection']: """ Return connection object with a given ``conn_id``. :param conn_id: connection id :type conn_id: str """ warnings.warn( "This method is deprecated. Please use " "`airflow.secrets.base_secrets.BaseSecretsBackend.get_connection`.", PendingDeprecationWarning, stacklevel=2, ) conn = self.get_connection(conn_id=conn_id) if conn: return [conn] return []
[docs] def get_variable(self, key: str) -> Optional[str]: """ Return value for Airflow Variable :param key: Variable Key :type key: str :return: Variable Value """ raise NotImplementedError()
[docs] def get_config(self, key: str) -> Optional[str]: """ Return value for Airflow Config Key :param key: Config Key :return: Config Value """ return None

Was this entry helpful?