You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2022/03/13 07:17:00 UTC
[GitHub] [airflow] andyfcx opened a new pull request #22218: Fix 22152
andyfcx opened a new pull request #22218:
URL: https://github.com/apache/airflow/pull/22218
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of existing issue, reference it using one of the following:
closes: #22152
related: #22152
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
https://github.com/apache/airflow/issues/22152
I added a flag **force_string** to make sure returning will be string,
Testing code still in progress.
Need more discussion.
---
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in [UPDATING.md](https://github.com/apache/airflow/blob/main/UPDATING.md).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] uranusjr commented on a change in pull request #22218: Do not use native obj Jinja2 env to render error emails
Posted by GitBox <gi...@apache.org>.
uranusjr commented on a change in pull request #22218:
URL: https://github.com/apache/airflow/pull/22218#discussion_r825405109
##########
File path: airflow/models/abstractoperator.py
##########
@@ -115,7 +115,7 @@ def get_template_env(self) -> "jinja2.Environment":
dag = self.get_dag()
if dag:
- return dag.get_template_env()
+ return dag.get_template_env(force_string=True)
Review comment:
I don’t think this is correct though. This function is also used when the task is being executed (in `render_template_fields`), and in _that_ situation we want to use `NativeEnvironment` if `render_template_as_native_obj` is True. so this `get_template_env` also need to have a `force_string` argument, and only `get_email_subject_content` should set it to True.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] uranusjr commented on a change in pull request #22218: Do not use native obj Jinja2 env to render error emails
Posted by GitBox <gi...@apache.org>.
uranusjr commented on a change in pull request #22218:
URL: https://github.com/apache/airflow/pull/22218#discussion_r825404401
##########
File path: airflow/models/abstractoperator.py
##########
@@ -115,7 +115,7 @@ def get_template_env(self) -> "jinja2.Environment":
dag = self.get_dag()
if dag:
- return dag.get_template_env()
+ return dag.get_template_env(force_string=True)
Review comment:
Oh, right 😓
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] uranusjr edited a comment on pull request #22218: Do not use native obj Jinja2 env to render error emails
Posted by GitBox <gi...@apache.org>.
uranusjr edited a comment on pull request #22218:
URL: https://github.com/apache/airflow/pull/22218#issuecomment-1066043308
(Some context for this) I’m helping @andyfcx to work out a solution to #22152.
The main problem with #22152 is that, when you set `render_template_as_native_obj` on a DAG, it would use a `NativeEnvironment` to create a Jinja2 template object, which in turn will be able to be rendered into a native object. However, the email-sending mechanism also uses the same Jinja2 environment, but this environment cannot correctly create a template to render into the email’s content (which must be a string, obviously).
So the proposed solution here is to add an additional flag on `get_template_env` to control what environment to return. If `force_string` is True, `get_template_env` will always create a `SandboxedEnvironment` (which is rendered into a string), even if `render_template_as_native_obj` is True. A `NativeEnvironment` is used only if `render_template_as_native_obj` is True _and_ `force_string` is False.
But the implementation in the PR still needs some work. I’m also not entirely convinced this is the best solution, and any suggestions are welcomed. Also at least one test will be needed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] uranusjr commented on a change in pull request #22218: Do not use native obj Jinja2 env to render error emails
Posted by GitBox <gi...@apache.org>.
uranusjr commented on a change in pull request #22218:
URL: https://github.com/apache/airflow/pull/22218#discussion_r825405206
##########
File path: airflow/models/dag.py
##########
@@ -1278,7 +1278,10 @@ def get_template_env(self) -> jinja2.Environment:
jinja_env_options.update(self.jinja_environment_kwargs)
env: jinja2.Environment
if self.render_template_as_native_obj:
- env = airflow.templates.NativeEnvironment(**jinja_env_options)
+ if force_string:
+ env = airflow.templates.SandboxedEnvironment(**jinja_env_options)
+ else:
+ env = airflow.templates.NativeEnvironment(**jinja_env_options)
else:
env = airflow.templates.SandboxedEnvironment(**jinja_env_options)
Review comment:
Can be shortened to
```python
use_native_env = self.render_template_as_native_obj and not force_string
if use_native_env:
env = airflow.templates.NativeEnvironment(**jinja_env_options)
else:
env = airflow.templates.SandboxedEnvironment(**jinja_env_options)
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] uranusjr commented on a change in pull request #22218: Do not use native obj Jinja2 env to render error emails
Posted by GitBox <gi...@apache.org>.
uranusjr commented on a change in pull request #22218:
URL: https://github.com/apache/airflow/pull/22218#discussion_r825399731
##########
File path: airflow/models/abstractoperator.py
##########
@@ -115,7 +115,7 @@ def get_template_env(self) -> "jinja2.Environment":
dag = self.get_dag()
if dag:
- return dag.get_template_env()
+ return dag.get_template_env(force_string=True)
Review comment:
When is this False?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] andyfcx commented on a change in pull request #22218: Do not use native obj Jinja2 env to render error emails
Posted by GitBox <gi...@apache.org>.
andyfcx commented on a change in pull request #22218:
URL: https://github.com/apache/airflow/pull/22218#discussion_r825399819
##########
File path: airflow/models/abstractoperator.py
##########
@@ -115,7 +115,7 @@ def get_template_env(self) -> "jinja2.Environment":
dag = self.get_dag()
if dag:
- return dag.get_template_env()
+ return dag.get_template_env(force_string=True)
Review comment:
Default as False
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] uranusjr commented on pull request #22218: Do not use native obj Jinja2 env to render error emails
Posted by GitBox <gi...@apache.org>.
uranusjr commented on pull request #22218:
URL: https://github.com/apache/airflow/pull/22218#issuecomment-1066043308
(Some context for this) I’m helping @andyfcx to work out a solution to #22152.
The main problem with #22152 is that, when you set `render_template_as_native_obj` on a DAG, it would use a `NativeEnvironment` to create a Jinja2 template object, which in turn will be able to be rendered into a native object. However, the email-sending mechanism also uses the same Jinja2 environment, but this environment cannot correctly create a template to render into the email’s content (which must be a string, obviously).
So the proposed solution here is to add an additional flag on `get_template_env` to control what environment to return. If `force_string` is True, `get_template_env` will always create a `SandboxedEnvironment` (which is rendered into a string), even if `render_template_as_native_obj` is True. A `NativeEnvironment` is used only if `render_template_as_native_obj` is True _and_ `force_string` is False.
But the implementation in the PR still needs some work. I’m also not entirely convinced this is the best solution, and any suggestions are welcomed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on pull request #22218: Fix 22152
Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on pull request #22218:
URL: https://github.com/apache/airflow/pull/22218#issuecomment-1066042236
Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
Here are some useful points:
- Pay attention to the quality of your code (flake8, mypy and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/main/STATIC_CODE_CHECKS.rst#prerequisites-for-pre-commit-hooks) will help you with that.
- In case of a new feature add useful documentation (in docstrings or in `docs/` directory). Adding a new operator? Check this short [guide](https://github.com/apache/airflow/blob/main/docs/apache-airflow/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
- Consider using [Breeze environment](https://github.com/apache/airflow/blob/main/BREEZE.rst) for testing locally, it’s a heavy docker but it ships with a working Airflow and a lot of integrations.
- Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
- Please follow [ASF Code of Conduct](https://www.apache.org/foundation/policies/conduct) for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
- Be sure to read the [Airflow Coding style]( https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#coding-style-and-best-practices).
Apache Airflow is a community-driven project and together we are making it better 🚀.
In case of doubts contact the developers at:
Mailing List: dev@airflow.apache.org
Slack: https://s.apache.org/airflow-slack
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] andyfcx commented on a change in pull request #22218: Do not use native obj Jinja2 env to render error emails
Posted by GitBox <gi...@apache.org>.
andyfcx commented on a change in pull request #22218:
URL: https://github.com/apache/airflow/pull/22218#discussion_r825405925
##########
File path: airflow/models/dag.py
##########
@@ -1278,7 +1278,10 @@ def get_template_env(self) -> jinja2.Environment:
jinja_env_options.update(self.jinja_environment_kwargs)
env: jinja2.Environment
if self.render_template_as_native_obj:
- env = airflow.templates.NativeEnvironment(**jinja_env_options)
+ if force_string:
+ env = airflow.templates.SandboxedEnvironment(**jinja_env_options)
+ else:
+ env = airflow.templates.NativeEnvironment(**jinja_env_options)
else:
env = airflow.templates.SandboxedEnvironment(**jinja_env_options)
Review comment:
done
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org