This is an automated email from the ASF dual-hosted git repository.
taragolis pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new faa32f23e8 Slack: use default_conn_name by default (#34548)
faa32f23e8 is described below
commit faa32f23e824ec8dd00b296ce9d8bd239ac0437f
Author: Igor Khrol <[email protected]>
AuthorDate: Sat Sep 23 01:48:38 2023 +0300
Slack: use default_conn_name by default (#34548)
* Slack: use default_conn_name by default
It's convenient not to define connection name if there is only one global
or default connection.
This is what is usually done in other hooks like `HttpHook`
* Populate default in other places
---
airflow/providers/slack/hooks/slack.py | 2 +-
airflow/providers/slack/notifications/slack.py | 2 +-
airflow/providers/slack/operators/slack.py | 2 +-
airflow/providers/slack/transfers/sql_to_slack.py | 2 +-
docs/apache-airflow-providers-slack/connections/slack.rst | 7 ++-----
tests/providers/slack/hooks/test_slack.py | 4 ++++
6 files changed, 10 insertions(+), 9 deletions(-)
diff --git a/airflow/providers/slack/hooks/slack.py
b/airflow/providers/slack/hooks/slack.py
index aa868d34b4..5b3a89579c 100644
--- a/airflow/providers/slack/hooks/slack.py
+++ b/airflow/providers/slack/hooks/slack.py
@@ -112,7 +112,7 @@ class SlackHook(BaseHook):
def __init__(
self,
*,
- slack_conn_id: str,
+ slack_conn_id: str = default_conn_name,
base_url: str | None = None,
timeout: int | None = None,
proxy: str | None = None,
diff --git a/airflow/providers/slack/notifications/slack.py
b/airflow/providers/slack/notifications/slack.py
index 3cbbd9be0c..f2359b6fcb 100644
--- a/airflow/providers/slack/notifications/slack.py
+++ b/airflow/providers/slack/notifications/slack.py
@@ -53,7 +53,7 @@ class SlackNotifier(BaseNotifier):
def __init__(
self,
*,
- slack_conn_id: str = "slack_api_default",
+ slack_conn_id: str = SlackHook.default_conn_name,
text: str = "This is a default message",
channel: str = "#general",
username: str = "Airflow",
diff --git a/airflow/providers/slack/operators/slack.py
b/airflow/providers/slack/operators/slack.py
index d19dbafe31..1b4d765ea4 100644
--- a/airflow/providers/slack/operators/slack.py
+++ b/airflow/providers/slack/operators/slack.py
@@ -43,7 +43,7 @@ class SlackAPIOperator(BaseOperator):
def __init__(
self,
*,
- slack_conn_id: str,
+ slack_conn_id: str = SlackHook.default_conn_name,
method: str | None = None,
api_params: dict | None = None,
**kwargs,
diff --git a/airflow/providers/slack/transfers/sql_to_slack.py
b/airflow/providers/slack/transfers/sql_to_slack.py
index 213a9026d4..f79f89eea6 100644
--- a/airflow/providers/slack/transfers/sql_to_slack.py
+++ b/airflow/providers/slack/transfers/sql_to_slack.py
@@ -237,7 +237,7 @@ class SqlToSlackApiFileOperator(BaseSqlToSlackOperator):
sql_conn_id: str,
sql_hook_params: dict | None = None,
parameters: Iterable | Mapping[str, Any] | None = None,
- slack_conn_id: str,
+ slack_conn_id: str = SlackHook.default_conn_name,
slack_filename: str,
slack_channels: str | Sequence[str] | None = None,
slack_initial_comment: str | None = None,
diff --git a/docs/apache-airflow-providers-slack/connections/slack.rst
b/docs/apache-airflow-providers-slack/connections/slack.rst
index d4953fac1c..ade26756bb 100644
--- a/docs/apache-airflow-providers-slack/connections/slack.rst
+++ b/docs/apache-airflow-providers-slack/connections/slack.rst
@@ -30,13 +30,10 @@ Authenticating to Slack
Authenticate to Slack using a `Slack API token
<https://slack.com/help/articles/215770388-Create-and-regenerate-API-tokens>`_.
-Default Connection IDs
+Default Connection ID
----------------------
-.. warning::
-
- The SlackHook and community provided operators not intend to use any Slack
API Connection by default right now.
- It might change in the future to ``slack_api_default``.
+ The default Slack API Connection ID is ``slack_api_default``.
Configuring the Connection
--------------------------
diff --git a/tests/providers/slack/hooks/test_slack.py
b/tests/providers/slack/hooks/test_slack.py
index 2156fdaa18..a97ca2591e 100644
--- a/tests/providers/slack/hooks/test_slack.py
+++ b/tests/providers/slack/hooks/test_slack.py
@@ -483,3 +483,7 @@ class TestSlackHook:
params = hook._get_conn_params()
assert "proxy" not in params
assert "base_url" not in params
+
+ def test_default_conn_name(self):
+ hook = SlackHook()
+ assert hook.slack_conn_id == SlackHook.default_conn_name
