ContextQMD
Back to Airflow

Setup your project

contributing-docs/quick-start-ide/contributors_quick_start_vscode.rst

3.2.16.2 KB
Original Source

.. 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.

.. contents:: Table of Contents :depth: 2 :local:

Setup your project ##################

  1. Open your IDE or source code editor and select the option to clone the repository

    .. raw:: html

    <div align="center" style="padding-bottom:10px"> </div>

  2. Paste the copied clone link in the URL field and submit.

    .. raw:: html

    <div align="center" style="padding-bottom:10px"> </div>

  3. If you use official Python plugin you also have to add "tests" directly of each provider you want to develop as "Extra Paths". This way respective provider tests code can be addressed in imports as from unit.postgres.hooks.test_postgres import ... This is important in Airflow 3.0 we split providers to be separate distributions - each with separate pyproject.toml file. This might improve and might be better automated in the future, but for now you need to do it for each provider separately.

    To do this, open File -> Preferences -> Settings

    .. raw:: html

    <div align="center" style="padding-bottom:10px"> </div>

    In Settings tab navigate to Workspace (this will set extra paths only for this project) and go to Extensions -> Pylance section. At Python -> Analysis: Extra Paths add the path to the tests directory of the provider you want to develop.

    .. raw:: html

    <div align="center" style="padding-bottom:10px"> </div>

    NB: if you use pyright as LSP with other editor you can set extraPaths the same way in pyrightconfig.json, see |pyright_conf_md|.

    .. |pyright_conf_md| raw:: html

    <a href="https://github.com/microsoft/pyright/blob/main/docs/configuration.md" target="_blank">pyright configuration docs</a>

  4. Once step 3 is done it is recommended to restart VS Code.

Setting up debugging ####################

  1. Configuring Airflow database connection

  • Airflow is by default configured to use SQLite database. Configuration can be seen on local machine ~/airflow/airflow.cfg under sql_alchemy_conn.

  • Installing required dependency for MySQL connection in airflow-env on local machine.

    .. code-block:: bash

    $ pyenv activate airflow-env $ pip install PyMySQL

  • Now set sql_alchemy_conn = mysql+pymysql://root:@127.0.0.1:23306/airflow?charset=utf8mb4 in file ~/airflow/airflow.cfg on local machine.

  1. Debugging an example Dag

  • In Visual Studio Code open Airflow project, directory /files/dags of local machine is by default mounted to docker machine when breeze Airflow is started. So any Dag file present in this directory will be picked automatically by scheduler running in docker machine and same can be seen on http://127.0.0.1:28080.

  • Copy any example Dag present in the /airflow/example_dags directory to /files/dags/.

  • Add a __main__ block at the end of your Dag file to make it runnable. It will run a back_fill job:

    .. code-block:: python

    if name == "main": dag.test()

  • Add "AIRFLOW__CORE__EXECUTOR": "LocalExecutor" to the "env" field of Debug configuration.

    • Using the Run view click on Create a launch.json file

      .. raw:: html

      <div align="center" style="padding-bottom:10px">
  
  
  
</div>

    • Change "program" to point to an example dag and add "env" and "python" fields to the new Python configuration

      .. code-block:: json

      { "configurations": [ "program": "${workspaceFolder}/files/dags/example_bash_operator.py", "env": { "PYTHONUNBUFFERED": "1", "AIRFLOW__CORE__EXECUTOR": "LocalExecutor" }, "python": "${env:HOME}/.pyenv/versions/airflow/bin/python" ] }

      .. raw:: html

      <div align="center" style="padding-bottom:10px">
  
</div>

  • Now Debug an example dag and view the entries in tables such as dag_run, xcom etc in mysql workbench.

Creating a branch #################

  1. Click on the branch symbol in the status bar

    .. raw:: html

    <div align="center" style="padding-bottom:10px"> </div>

  2. Give a name to a branch and checkout

    .. raw:: html

    <div align="center" style="padding-bottom:10px"> </div>

Follow the Quick start <../03b_contributors_quick_start_seasoned_developers.rst>_ for typical development tasks.