Airflow 峰会 2025 将于 10 月 07-09 日举行。立即注册获取早鸟票!

airflow.secrets.base_secrets

BaseSecretsBackend

给定 conn_id 时检索 Connection 对象,或给定 key 时检索 Variable 的抽象基类。

模块内容

class airflow.secrets.base_secrets.BaseSecretsBackend[source]

Bases: abc.ABC

给定 conn_id 时检索 Connection 对象,或给定 key 时检索 Variable 的抽象基类。

static build_path(path_prefix, secret_id, sep='/')[source]

给定 conn_id,为 Secrets 后端构建路径。

参数:
  • path_prefix (str) – 获取密钥的路径前缀

  • secret_id (str) – 密钥 ID

  • sep (str) – 用于连接 connections_prefix 和 conn_id 的分隔符。默认值:“/”

abstract get_conn_value(conn_id)[source]

从 Secrets 后端检索表示 Connection 对象的字符串值。

如果您的 secrets 后端使用的客户端已返回 Python dict,则应改为覆盖 get_connection

参数:

conn_id (str) – 连接 ID

deserialize_connection(conn_id, value)[source]

给定 Airflow Connection 的序列化表示,返回一个实例。

查看第一个字符以确定如何反序列化。

参数:
  • conn_id (str) – 连接 ID

  • value (str) – Connection 对象的序列化表示

返回:

反序列化的 Connection

返回类型:

airflow.models.connection.Connection

get_connection(conn_id)[source]

返回给定 conn_id 的 connection 对象。

首先尝试 get_conn_value,如果未实现,则尝试 get_conn_uri

参数:

conn_id (str) – 连接 ID

abstract get_variable(key)[source]

返回 Airflow Variable 的值。

参数:

key (str) – Variable 键

返回:

Variable 值

返回类型:

str | None

get_config(key)[source]

返回 Airflow 配置键的值。

参数:

key (str) – 配置键

返回:

配置值

返回类型:

str | None

此条目有帮助吗?