airflow-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF subversion and git services (Jira)" <>
Subject [jira] [Commented] (AIRFLOW-5497) dag_processing::list_py_file_paths method pydoc needs param added
Date Mon, 14 Oct 2019 20:52:00 GMT


ASF subversion and git services commented on AIRFLOW-5497:

Commit bb93a7551e4f5ea88c18aebc95f69869892b690a in airflow's branch refs/heads/master from
Francisco Chiang
[;h=bb93a75 ]

[AIRFLOW-5497] Update docstring in airflow/utils/ (#6314)

> dag_processing::list_py_file_paths method pydoc needs param added
> -----------------------------------------------------------------
>                 Key: AIRFLOW-5497
>                 URL:
>             Project: Apache Airflow
>          Issue Type: Bug
>          Components: utils
>    Affects Versions: 1.10.6
>            Reporter: Jakob Homan
>            Priority: Minor
>              Labels: ccoss2019, newbie
> Note: This ticket's being created to facilitate a new contributor's workshop for Airflow.
After the workshop has completed, I'll mark these all available for anyone that might like
to take them on.
> The {{list_py_file_paths}} method pydoc is missing an entry for the {{include_examples}}
parameter.  We should add it.
> airflow/utils/
> {code:java}
> def list_py_file_paths(directory, safe_mode=conf.getboolean('core', 'DAG_DISCOVERY_SAFE_MODE',
>                        include_examples=None):
>     """
>     Traverse a directory and look for Python files.
>     :param directory: the directory to traverse
>     :type directory: unicode
>     :param safe_mode: whether to use a heuristic to determine whether a file
>         contains Airflow DAG definitions. If not provided, use the
>         core.DAG_DISCOVERY_SAFE_MODE configuration setting. If not set, default
>         to safe.
>     :return: a list of paths to Python files in the specified directory
>     :rtype: list[unicode] {code}

This message was sent by Atlassian Jira

View raw message