Add back information about current context to the docs #18868
Merged
+64
−0
Conversation
This file contains 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
ashb
requested changes
Oct 11, 2021
potiuk
force-pushed
the
add-current-context-to-docs
branch
from
28b0fcb
to
da0b307
Compare
potiuk
force-pushed
the
add-current-context-to-docs
branch
2 times, most recently
from
c1b2c80
to
426b545
Compare
There were many questions recently along the line of "How do I access context from TaskFlow task". Surprisingly, the paragraph about accessing current context was removed from the "Concepts" (where it was there for Airflow 2.0.0) but was never added to the "TaskFlow Tutorial" where it actually belongs. Also Python Operator's description about passing context variables as kwargs have been removed when `provide_context` parameter was removed (it was only present in the docstring of `provide_context` and you could likely deduce this behaviour from several examples, but it was not mentioned anywhere. This PR adds the description with examples to the Python operator as well as adds similar description in TaskFlow tutorial, including the possibility of using `get_current_context` deep down the stack to retrieve the context variables even if they are not passed via kwargs.
potiuk
force-pushed
the
add-current-context-to-docs
branch
from
426b545
to
96af814
Compare
ashb
approved these changes
Oct 11, 2021
github-actions
bot
added
the
full tests needed
|
The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest main at your convenience, or amend the last commit of the PR, and push it with --force-with-lease. |
|
Nice one! |
kaxil
approved these changes
Oct 11, 2021
yan-hic
reviewed
Dec 2, 2021
| .. code-block:: python | ||
|
|
||
| @task | ||
| def my_python_callable(ti, next_ds): |
There was a problem hiding this comment.
Thought: can user-defined-macros (i.e. defined at dag-level) be passed too ?
jedcunningham
pushed a commit
that referenced
this pull request
Dec 7, 2021
There were many questions recently along the line of "How do I access context from TaskFlow task". Surprisingly, the paragraph about accessing current context was removed from the "Concepts" (where it was there for Airflow 2.0.0) but was never added to the "TaskFlow Tutorial" where it actually belongs. Also Python Operator's description about passing context variables as kwargs have been removed when `provide_context` parameter was removed (it was only present in the docstring of `provide_context` and you could likely deduce this behaviour from several examples, but it was not mentioned anywhere. This PR adds the description with examples to the Python operator as well as adds similar description in TaskFlow tutorial, including the possibility of using `get_current_context` deep down the stack to retrieve the context variables even if they are not passed via kwargs. (cherry picked from commit d6c8730)
potiuk
added a commit
that referenced
this pull request
Jan 23, 2022
There were many questions recently along the line of "How do I access context from TaskFlow task". Surprisingly, the paragraph about accessing current context was removed from the "Concepts" (where it was there for Airflow 2.0.0) but was never added to the "TaskFlow Tutorial" where it actually belongs. Also Python Operator's description about passing context variables as kwargs have been removed when `provide_context` parameter was removed (it was only present in the docstring of `provide_context` and you could likely deduce this behaviour from several examples, but it was not mentioned anywhere. This PR adds the description with examples to the Python operator as well as adds similar description in TaskFlow tutorial, including the possibility of using `get_current_context` deep down the stack to retrieve the context variables even if they are not passed via kwargs. (cherry picked from commit d6c8730)
jedcunningham
pushed a commit
that referenced
this pull request
Jan 27, 2022
There were many questions recently along the line of "How do I access context from TaskFlow task". Surprisingly, the paragraph about accessing current context was removed from the "Concepts" (where it was there for Airflow 2.0.0) but was never added to the "TaskFlow Tutorial" where it actually belongs. Also Python Operator's description about passing context variables as kwargs have been removed when `provide_context` parameter was removed (it was only present in the docstring of `provide_context` and you could likely deduce this behaviour from several examples, but it was not mentioned anywhere. This PR adds the description with examples to the Python operator as well as adds similar description in TaskFlow tutorial, including the possibility of using `get_current_context` deep down the stack to retrieve the context variables even if they are not passed via kwargs. (cherry picked from commit d6c8730)
|
(Kicking this back to the 2.2.3 milestone as that's when this landed in a release) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 were many questions recently along the line of
"How do I access context from TaskFlow task". Surprisingly,
the paragraph about accessing current context was removed from
the "Concepts" (where it was there for Airflow 2.0.0) but was
never added to the "TaskFlow Tutorial" where it actually belongs.
This PR adds the paragraph back.
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in UPDATING.md.