Skip to content
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

[AIRFLOW-4833] Allow to set Jinja env options in DAG declaration #5943

Conversation

galak75
Copy link
Contributor

@galak75 galak75 commented Aug 29, 2019

Make sure you have checked all steps below.

Jira

  • [ x ] My PR addresses the following Airflow Jira issues and references them in the PR title. For example, "[AIRFLOW-XXX] My Airflow PR"
    • https://issues.apache.org/jira/browse/AIRFLOW-4833
    • In case you are fixing a typo in the documentation you can prepend your commit with [AIRFLOW-XXX], code changes always need a Jira issue.
    • In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal (AIP).
    • In case you are adding a dependency, check if the license complies with the ASF 3rd Party License Policy.

Description

  • [ x ]
  • Issue was : a trailing newline in a template string is dropped by Jinja2 (default behavior)
  • This is fixed by allowing to set options to jinja2.Environment object by defining these options at the DAG level (see AIRFLOW-4833 for more information)

Tests

  • [ x ] My PR adds the following unit tests OR does not need testing for this extremely good reason:

Commits

  • [ x ] My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "How to write a good git commit message":
    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters (not including Jira issue reference)
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body wraps at 72 characters
    6. Body explains "what" and "why", not "how"

Documentation

  • [ x ] In case of new functionality, my PR adds documentation that describes how to use it.
    • All the public functions and the classes in the PR contain docstrings that explain what it does
    • If you implement backwards incompatible changes, please leave a note in the Updating.md so we can assign it to a appropriate release

Code Quality

  • [ x ] Passes flake8

@galak75
Copy link
Contributor Author

galak75 commented Aug 29, 2019

@kaxil @BasPH : This PR relates to this thread on slack. Maybe you can review it? ;-)

@@ -205,6 +205,7 @@ def __init__(
params: Optional[Dict] = None,
access_control: Optional[Dict] = None,
is_paused_upon_creation: Optional[bool] = None,
jinja_environment_kwargs: Optional[Dict] = None
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add this parameter in docstring of DAG class please?

Copy link
Member

@kaxil kaxil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Can you please add the parameter in docstring and also copy the example you have in docs/concepts.rst in the docstring

@galak75
Copy link
Contributor Author

galak75 commented Aug 29, 2019

LGTM. Can you please add the parameter in docstring and also copy the example you have in docs/concepts.rst in the docstring

Sure! My bad... I forgot it.
It's done, build is in queue in Travis

@kaxil kaxil merged commit 3d14a51 into apache:master Aug 29, 2019
@galak75 galak75 deleted the feature/AIRFLOW-4833-jinja-templating-drops-trailing-newline-SQUASHED branch August 29, 2019 19:37
Jerryguo pushed a commit to Jerryguo/airflow that referenced this pull request Sep 2, 2019
ashb pushed a commit to ashb/airflow that referenced this pull request Oct 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants