Taragolis commented on code in PR #35397: URL: https://github.com/apache/airflow/pull/35397#discussion_r1382547115
########## airflow/providers/atlassian/jira/notifications/jira.py: ########## @@ -0,0 +1,83 @@ +# 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +from __future__ import annotations + +from functools import cached_property +from typing import Any + +from airflow.exceptions import AirflowOptionalProviderFeatureException +from airflow.providers.atlassian.jira.hooks.jira import JiraHook + +try: + from airflow.notifications.basenotifier import BaseNotifier +except ImportError: + raise AirflowOptionalProviderFeatureException( + "Failed to import BaseNotifier. This feature is only available in Airflow versions >= 2.6.0" + ) + + +class JiraNotifier(BaseNotifier): + """ + Jira notifier for creating Jira issues upon failures. + + :param jira_conn_id: The HTTP connection ID for the Jira instance. + :param description: The content for the body of the issue Review Comment: ```suggestion :param proxies: Proxies to make the Jira REST API call. Optional :param description: The content for the body of the issue ``` ########## docs/apache-airflow-providers-atlassian-jira/notifications/jira-notifier-howto-guide.rst: ########## @@ -0,0 +1,65 @@ + + .. 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 + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +How-to guide for Atlassian Jira notifications +============================================= + +Introduction +------------ +The Atlassian Jira notifier (:class:`airflow.providers.atlassian.jira.notifications.jira.JiraNotifier`) allows users to create +issues in a Jira instance using the various ``on_*_callbacks`` available at both the DAG level and Task level + +Example Code +------------ + +.. code-block:: python + + from datetime import datetime + from airflow import DAG + from airflow.operators.bash import BashOperator + from airflow.providers.atlassian.jira.notifications.jira import send_jira_notification + + with DAG( + "test-dag", + start_date=datetime(2023, 11, 3), + on_failure_callback=[ + send_jira_notification( + jira_conn_id="my-jira-conn", + description="Failure in the DAG", Review Comment: Let's add templates into the example ```suggestion description="Failure in the DAG {{ dag.dag_id }}", ``` ########## airflow/providers/atlassian/jira/notifications/jira.py: ########## @@ -0,0 +1,83 @@ +# 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +from __future__ import annotations + +from functools import cached_property +from typing import Any + +from airflow.exceptions import AirflowOptionalProviderFeatureException +from airflow.providers.atlassian.jira.hooks.jira import JiraHook + +try: + from airflow.notifications.basenotifier import BaseNotifier +except ImportError: + raise AirflowOptionalProviderFeatureException( + "Failed to import BaseNotifier. This feature is only available in Airflow versions >= 2.6.0" + ) + + +class JiraNotifier(BaseNotifier): + """ + Jira notifier for creating Jira issues upon failures. + + :param jira_conn_id: The HTTP connection ID for the Jira instance. + :param description: The content for the body of the issue + :param summary: The title of the issue + :param project_id: The ID of the project under which the issue will be created + :param issue_type_id: The ID of the issue category + :param labels: The labels to be applied to the issue + """ + + template_fields = ("description", "summary", "project_id", "issue_type_id", "labels") + + def __init__( + self, + *, + jira_conn_id: str = JiraHook.default_conn_name, + proxies: Any | None = None, + description: str, + summary: str, + project_id: int, + issue_type_id: int, + labels: list[str] = [], + ): + super().__init__() + self.jira_conn_id = jira_conn_id + self.proxies = proxies + self.description = description + self.summary = summary + self.project_id = project_id + self.issue_type_id = issue_type_id + self.labels = labels Review Comment: ```suggestion self.labels = labels or [] ``` ########## docs/apache-airflow-providers-atlassian-jira/notifications/index.rst: ########## @@ -0,0 +1,27 @@ + + .. 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 + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +Atlassian Jira Notifications +============================ + Review Comment: Let's add information that it is not available in Airflow below 2.6 ```suggestion .. important:: This feature is only available in Airflow versions >= 2.6.0 ``` ########## docs/apache-airflow-providers-atlassian-jira/notifications/jira-notifier-howto-guide.rst: ########## @@ -0,0 +1,65 @@ + + .. 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 + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +How-to guide for Atlassian Jira notifications +============================================= + +Introduction +------------ +The Atlassian Jira notifier (:class:`airflow.providers.atlassian.jira.notifications.jira.JiraNotifier`) allows users to create +issues in a Jira instance using the various ``on_*_callbacks`` available at both the DAG level and Task level + +Example Code +------------ + +.. code-block:: python + + from datetime import datetime + from airflow import DAG + from airflow.operators.bash import BashOperator + from airflow.providers.atlassian.jira.notifications.jira import send_jira_notification + + with DAG( + "test-dag", + start_date=datetime(2023, 11, 3), + on_failure_callback=[ + send_jira_notification( + jira_conn_id="my-jira-conn", + description="Failure in the DAG", + summary="Airflow DAG Issue", + project_id=10000, + issue_type_id=10003, + labels=["airflow-dag-failure"], + ) + ], + ): + BashOperator( + task_id="mytask", + on_failure_callback=[ + send_jira_notification( + jira_conn_id="my-jira-conn", + description="The task failed", Review Comment: ```suggestion description="The task {{ ti.task_id }} failed", ``` ########## airflow/providers/atlassian/jira/notifications/jira.py: ########## @@ -0,0 +1,83 @@ +# 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +from __future__ import annotations + +from functools import cached_property +from typing import Any + +from airflow.exceptions import AirflowOptionalProviderFeatureException +from airflow.providers.atlassian.jira.hooks.jira import JiraHook + +try: + from airflow.notifications.basenotifier import BaseNotifier +except ImportError: + raise AirflowOptionalProviderFeatureException( + "Failed to import BaseNotifier. This feature is only available in Airflow versions >= 2.6.0" + ) + + +class JiraNotifier(BaseNotifier): + """ + Jira notifier for creating Jira issues upon failures. + + :param jira_conn_id: The HTTP connection ID for the Jira instance. + :param description: The content for the body of the issue + :param summary: The title of the issue + :param project_id: The ID of the project under which the issue will be created + :param issue_type_id: The ID of the issue category + :param labels: The labels to be applied to the issue + """ + + template_fields = ("description", "summary", "project_id", "issue_type_id", "labels") + + def __init__( + self, + *, + jira_conn_id: str = JiraHook.default_conn_name, + proxies: Any | None = None, + description: str, + summary: str, + project_id: int, + issue_type_id: int, + labels: list[str] = [], Review Comment: Better avoid assign mutable as default arguments ```suggestion labels: list[str] | None = None, ``` Usual it is edge cases, however better to avoid it, some example about side effect ```python from __future__ import annotations class DefaultMutable: def __init__(self, a: list[str] = []): self.a = a class DefaultNone: def __init__(self, a: list[str] | None = None): self.a = a or [] x1 = DefaultMutable() x2 = DefaultMutable() x3 = DefaultNone() x4 = DefaultNone() assert x1 is not x2 x1.a.append("42") assert x1.a == ["42"] assert x2.a == ["42"] assert x3 is not x4 x3.a.append("42") assert x3.a == ["42"] assert x4.a == [] ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@airflow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
