airflow-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF subversion and git services (Jira)" <j...@apache.org>
Subject [jira] [Commented] (AIRFLOW-5640) BaseOperator email parameter is wrongly typed and not documented
Date Mon, 16 Dec 2019 11:19:00 GMT

    [ https://issues.apache.org/jira/browse/AIRFLOW-5640?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16997182#comment-16997182
] 

ASF subversion and git services commented on AIRFLOW-5640:
----------------------------------------------------------

Commit b9ba7191329144a8d7a5441288a2db21f0699a80 in airflow's branch refs/heads/v1-10-test
from Martin Winkel
[ https://gitbox.apache.org/repos/asf?p=airflow.git;h=b9ba719 ]

[AIRFLOW-5640] Document and test `email` parameters of BaseOperator (#6315)

* Refactored get_email_address_list to have a better
  separation between string handling and other iterables.
* Explicitely casting get_email_address_list argument
  to a list in case the argument was an iterable. This
  enables direct support for tuples, sets or the like.
* Fixed type annotation of email parameter of
  BaseOperator to show that iterables are directly
  supported.
* Added docstring entries for email, email_on_retry,
  email_on_failure and queue in BaseOperator.

(cherry picked from commit 9ec562f88ef8e690f0b17526878b46847f0422e7)


> BaseOperator email parameter is wrongly typed and not documented
> ----------------------------------------------------------------
>
>                 Key: AIRFLOW-5640
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-5640
>             Project: Apache Airflow
>          Issue Type: Bug
>          Components: operators
>    Affects Versions: 1.10.5
>            Reporter: Cedrik Neumann
>            Assignee: Martin Winkel
>            Priority: Major
>             Fix For: 1.10.7
>
>
> The {{email}} field is not documented in BaseOperator and furthermore the type annotation
{{str}} is wrong [here|https://github.com/apache/airflow/blob/master/airflow/models/baseoperator.py#L273].
> The method {{get_email_address_list}} clearly accepts lists of strings as well as comma
and semicolon delimited lists: [here|https://github.com/apache/airflow/blob/88989200a66291580088188f06a6db503ac823e2/airflow/utils/email.py#L123]



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Mime
View raw message