เขียน Document ใน Airflow โดยใช้ doc_md

ใน Airflow เราสามารถเขียนอธิบาย DAG หรือ Task ของเราได้นะ โดยใช้ Python Docstring ครับ ลองดูตัวอย่างโค้ดกัน

"""
### My Example DAG using Taskflow API
This document will show on the Tree View, Graph View, and Calendar View.
"""
# Some imports here

@task.python
def sum():
    return 1 + 1


@dag(...)
def example_pipeline():

    start = DummyOperator(task_id="start")
    start.doc_md = """
    This task is a starting point. It will show on the Task Instance Details.
    """

    sum_result = sum()
    sum_result.doc_md = """
    Compute the sum of 1 and 1.
    """

    # Some more tasks here

dag = example_pipeline()
dag.doc_md = __doc__

สังเกตตรง Task start กับ sum ผมจะใส่ doc_md ไว้ และบรรทัดสุดท้ายที่ DAG object ผมใส่ doc_md ไว้เช่นกัน

ที่หน้า DAG เราจะเห็นสิ่งที่เราเขียนไว้ตรงนี้

ส่วนที่หน้า Task Instance เราจะเห็นประมาณนี้

ทีนี้เวลาใครมาดู DAG ของเราเค้าก็จะพอรู้แล้วล่ะครับว่า DAG นี้เอาไว้ทำอะไร ประมาณไหน :sunglasses:

ปล. ตามอ่านแบบเต็มๆ ได้ที่