airflow.providers.google.common.deprecated

模块内容

类

AirflowDeprecationAdapter

根据包装的对象类型和其他提供的详细信息构建详细的弃用消息。

函数

deprecated(*args[, planned_removal_date, ...])

标记类、方法或函数为已弃用。
class airflow.providers.google.common.deprecated.AirflowDeprecationAdapter(planned_removal_date=None, planned_removal_release=None, use_instead=None, reason=None, instructions=None, category=DeprecationWarning, **kwargs)[源代码]

基类: deprecated.classic.ClassicAdapter

根据包装的对象类型和其他提供的详细信息构建详细的弃用消息。

参数

  • planned_removal_date (str | None) – 应该删除已弃用对象的日期。建议的日期是今天起六个月后。预期的日期格式为 Month DD, YYYY，例如： August 22, 2024。如果未设置 planned_removal_release 参数，则此参数是必需的。

  • planned_removal_release (str | None) – 预期删除已弃用对象的包名称和版本。 预期的格式为 <package_name>==<package_version>，例如 apache-airflow==2.10.0 或 apache-airflow-providers-google==10.22.0。 如果未设置 planned_removal_date 参数，则此参数是必需的。

  • use_instead (str | None) – 可选。已弃用对象的替代项。

  • reason (str | None) – 可选。已弃用对象的详细原因。

  • instructions (str | None) – 可选。从已弃用对象迁移的详细说明。

  • category (type[DeprecationWarning]) – 可选。用于弃用警告的警告类别。

get_deprecated_msg(wrapped, instance)[源代码]

为包装的可调用对象生成弃用消息。

参数

  • wrapped (Callable) – 已弃用的实体。

  • instance (Any) – 可调用对象所属的实例。（未使用）

返回

包含所有详细信息的格式化弃用消息。

static entity_type(entity)[源代码]
static entity_path(entity)[源代码]
sunset_message()[源代码]
replacement_message()[源代码]
airflow.providers.google.common.deprecated.deprecated(*args, planned_removal_date=None, planned_removal_release=None, use_instead=None, reason=None, instructions=None, adapter_cls=AirflowDeprecationAdapter, **kwargs)[源代码]

标记类、方法或函数为已弃用。

参数

  • planned_removal_date (str | None) – 应该删除已弃用对象的日期。建议的日期是今天起六个月后。预期的日期格式为 Month DD, YYYY，例如： August 22, 2024。如果未设置 planned_removal_release 参数，则此参数是必需的。

  • planned_removal_release (str | None) – 预期删除已弃用对象的包名称和版本。 预期的格式为 <package_name>==<package_version>，例如 apache-airflow==2.10.0 或 apache-airflow-providers-google==10.22.0。 如果未设置 planned_removal_date 参数，则此参数是必需的。

  • use_instead (str | None) – 可选。已弃用对象的替代项。

  • reason (str | None) – 可选。已弃用对象的详细原因。

  • instructions (str | None) – 可选。从已弃用对象迁移的详细说明。

  • adapter_cls (type[AirflowDeprecationAdapter]) – 可选。用于获取弃用消息的适配器类。这应该是 AirflowDeprecationAdapter 的子类。

此条目是否有帮助？