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-XXX] Raise ValueError rather than assert in skip logic #5875

Merged
merged 1 commit into from
Aug 21, 2019

Conversation

AetherUnbound
Copy link
Contributor

@AetherUnbound AetherUnbound commented Aug 20, 2019

Jira

  • 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-XXX
    • 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

This PR replaces an assert statement that exists in the SkipMixin class with raising a ValueError instead. The rationale for this is that assert statements should generally be reserved for testing and shouldn't exist in production logic, because they can be ignored in certain cases (specifically with the PYTHONOPTIMIZE environment variable or -O CLI flag.

Tests

  • My PR adds the following unit tests OR does not need testing for this extremely good reason:
    Tests already exist for this functionality.

Commits

  • 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

  • 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

  • Passes flake8

@ashb ashb merged commit aa8a300 into apache:master Aug 21, 2019
@AetherUnbound AetherUnbound deleted the bugfix/skip-remove-assert branch August 21, 2019 13:25
Jerryguo pushed a commit to Jerryguo/airflow that referenced this pull request Sep 2, 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.

None yet

2 participants