Skip to content

deprecate arbitrary parameter passing to RDS hook #32352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ferruzzi merged 2 commits into from
Jul 4, 2023
Merged

deprecate arbitrary parameter passing to RDS hook #32352

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
315932d
deprecate arbitrary parameter passing to RDS hook
vandonr-amz Jul 4, 2023
b9c35ab
add url to PR
vandonr-amz Jul 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion airflow/providers/amazon/aws/operators/rds.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,13 @@
from __future__ import annotations

import json
import warnings
from datetime import timedelta
from typing import TYPE_CHECKING, Sequence

from mypy_boto3_rds.type_defs import TagTypeDef

from airflow.exceptions import AirflowException
from airflow.exceptions import AirflowException, AirflowProviderDeprecationWarning
from airflow.models import BaseOperator
from airflow.providers.amazon.aws.hooks.rds import RdsHook
from airflow.providers.amazon.aws.triggers.rds import RdsDbInstanceTrigger
Expand All @@ -42,6 +43,15 @@ class RdsBaseOperator(BaseOperator):
ui_fgcolor = "#ffffff"

def __init__(self, *args, aws_conn_id: str = "aws_conn_id", hook_params: dict | None = None, **kwargs):
if hook_params is not None:
warnings.warn(
"The parameter hook_params is deprecated and will be removed. "
"If you were using it, please get in touch either on airflow slack, "
"or by opening a github issue on the project. "
Copy link
Contributor

@Adaverse Adaverse Jul 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very informative deprecation message. Just a small suggestion -

Suggested change
"or by opening a github issue on the project. "
"or by opening a Github issue on the project. "

"You can mention https://github.com/apache/airflow/pull/32352",
AirflowProviderDeprecationWarning,
stacklevel=3, # 2 is in the operator's init, 3 is in the user code creating the operator
)
self.hook_params = hook_params or {}
self.hook = RdsHook(aws_conn_id=aws_conn_id, **self.hook_params)
super().__init__(*args, **kwargs)
Expand Down