Uploaded image for project: 'Apache Airflow'
  1. Apache Airflow
  2. AIRFLOW-5497

dag_processing::list_py_file_paths method pydoc needs param added

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Minor
    • Resolution: Done
    • Affects Version/s: 1.10.6
    • Fix Version/s: 1.10.6
    • Component/s: utils
    • Labels:

      Description

      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/dag_processing.py:291

      def list_py_file_paths(directory, safe_mode=conf.getboolean('core', 'DAG_DISCOVERY_SAFE_MODE', fallback=True),
                             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] 

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                jghoman Jakob Homan
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: