-
Notifications
You must be signed in to change notification settings - Fork 17.1k
Apply textwrap.dedent() to task docstrings #66561
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jlaportebot
wants to merge
5
commits into
apache:main
Choose a base branch
from
jlaportebot:fix-issue-66477-dedent-task-docstrings
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+185
−1
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
397bbfa
Apply textwrap.dedent() to task docstrings
jlaportebot 5c7ea04
fix: strip whitespace from dedented docstring to remove leading/trail…
jlaportebot 7541598
test: add test for dedented task docstrings
jlaportebot a7d25d3
test: add test for already-dedented docstrings (no-op case)
jlaportebot 57ed797
fix: remove unused pytest import and fix docstring formatting for ruf…
jlaportebot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
184 changes: 184 additions & 0 deletions
184
task-sdk/tests/task_sdk/definitions/decorators/test_task_docstring.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,184 @@ | ||
| # | ||
| # 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. | ||
| from __future__ import annotations | ||
|
|
||
| import pendulum | ||
|
|
||
| from airflow.sdk import dag, task | ||
|
|
||
|
|
||
| def test_task_docstring_dedent_applied(): | ||
| """Test that task docstring is dedented when passed via function docstring.""" | ||
|
|
||
| @dag(schedule=None, start_date=pendulum.datetime(2022, 1, 1)) | ||
| def pipeline(): | ||
| @task | ||
| def my_task(): | ||
| """ | ||
| This task does something important. | ||
|
|
||
| In case of error you should do the following: | ||
| 1. Check the logs | ||
| 2. Verify the configuration | ||
| 3. Contact support | ||
| """ | ||
|
|
||
| return my_task() | ||
|
|
||
| dag_obj = pipeline() | ||
| task_obj = dag_obj.task_dict["my_task"] | ||
|
|
||
| # Verify that the docstring is dedented (no leading whitespace on each line) | ||
| expected_doc = """This task does something important. | ||
|
|
||
| In case of error you should do the following: | ||
| 1. Check the logs | ||
| 2. Verify the configuration | ||
| 3. Contact support""" | ||
| assert task_obj.doc_md == expected_doc | ||
|
|
||
|
|
||
| def test_task_docstring_dedent_with_explicit_doc_md(): | ||
| """Test that explicit doc_md is not overridden by function docstring.""" | ||
|
|
||
| @dag(schedule=None, start_date=pendulum.datetime(2022, 1, 1)) | ||
| def pipeline(): | ||
| @task(doc_md="Explicit documentation") | ||
| def my_task(): | ||
| """ | ||
| This is the function docstring. | ||
| """ | ||
|
|
||
| return my_task() | ||
|
|
||
| dag_obj = pipeline() | ||
| task_obj = dag_obj.task_dict["my_task"] | ||
|
|
||
| # Verify that explicit doc_md is used | ||
| assert task_obj.doc_md == "Explicit documentation" | ||
|
|
||
|
|
||
| def test_task_docstring_dedent_with_multiline_indentation(): | ||
| """Test that task docstring with complex indentation is properly dedented.""" | ||
|
|
||
| @dag(schedule=None, start_date=pendulum.datetime(2022, 1, 1)) | ||
| def pipeline(): | ||
| @task | ||
| def my_task(): | ||
| """ | ||
| Task description. | ||
|
|
||
| This is a more complex example with nested indentation: | ||
|
|
||
| - First level | ||
| - Second level | ||
| - Third level | ||
|
|
||
| And some code: | ||
|
|
||
| ```python | ||
| def example(): | ||
| return "value" | ||
| ``` | ||
| """ | ||
|
|
||
| return my_task() | ||
|
|
||
| dag_obj = pipeline() | ||
| task_obj = dag_obj.task_dict["my_task"] | ||
|
|
||
| # Verify that the docstring is dedented properly | ||
| expected_doc = """Task description. | ||
|
|
||
| This is a more complex example with nested indentation: | ||
|
|
||
| - First level | ||
| - Second level | ||
| - Third level | ||
|
|
||
| And some code: | ||
|
|
||
| ```python | ||
| def example(): | ||
| return "value" | ||
| ```""" | ||
| assert task_obj.doc_md == expected_doc | ||
|
|
||
|
|
||
| def test_task_no_docstring(): | ||
| """Test that task without docstring has no doc_md.""" | ||
|
|
||
| @dag(schedule=None, start_date=pendulum.datetime(2022, 1, 1)) | ||
| def pipeline(): | ||
| @task | ||
| def my_task(): | ||
| pass | ||
|
|
||
| return my_task() | ||
|
|
||
| dag_obj = pipeline() | ||
| task_obj = dag_obj.task_dict["my_task"] | ||
|
|
||
| # Verify that doc_md is None when there's no docstring | ||
| assert task_obj.doc_md is None | ||
|
|
||
|
|
||
| def test_task_docstring_dedent_simple(): | ||
| """Test that a simple indented docstring is dedented and stripped correctly.""" | ||
|
|
||
| @dag(schedule=None, start_date=pendulum.datetime(2022, 1, 1)) | ||
| def pipeline(): | ||
| @task | ||
| def my_task(): | ||
| """My task description.""" | ||
|
|
||
| return my_task() | ||
|
|
||
| dag_obj = pipeline() | ||
| task_obj = dag_obj.task_dict["my_task"] | ||
|
|
||
| # Verify leading/trailing whitespace is stripped | ||
| assert task_obj.doc_md == "My task description." | ||
|
|
||
|
|
||
| def test_task_docstring_already_dedented(): | ||
| """Test that already-dedented docstrings are handled as a no-op by textwrap.dedent. | ||
|
|
||
| When a docstring has no common leading whitespace, textwrap.dedent should | ||
| return it unchanged and .strip() only removes surrounding whitespace. | ||
| """ | ||
| import textwrap | ||
|
|
||
| # Verify textwrap.dedent behavior on non-indented strings | ||
| raw_doc = "This docstring has no leading indentation." | ||
| assert textwrap.dedent(raw_doc).strip() == "This docstring has no leading indentation." | ||
|
|
||
| # With a simple one-liner docstring (no common indent to strip) | ||
| @dag(schedule=None, start_date=pendulum.datetime(2022, 1, 1)) | ||
| def pipeline(): | ||
| @task | ||
| def my_task(): | ||
| """This docstring has no leading indentation.""" | ||
|
|
||
| return my_task() | ||
|
|
||
| dag_obj = pipeline() | ||
| task_obj = dag_obj.task_dict["my_task"] | ||
|
|
||
| # The docstring should be unchanged after dedent + strip | ||
| assert task_obj.doc_md == "This docstring has no leading indentation." | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Test coverage is solid. One additional edge case that may be worth covering is an already-dedented docstring to verify the transformation is effectively a no-op when no common indentation exists. Right now the tests only cover indented inputs.