You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "ASF GitHub Bot (Jira)" <ji...@apache.org> on 2019/11/18 17:10:00 UTC

[jira] [Commented] (AIRFLOW-6010) The "from airflow import settings" is used far too often

    [ https://issues.apache.org/jira/browse/AIRFLOW-6010?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16976707#comment-16976707 ] 

ASF GitHub Bot commented on AIRFLOW-6010:
-----------------------------------------

potiuk commented on pull request #6601: [AIRFLOW-6010] Do not import airflow settings directly
URL: https://github.com/apache/airflow/pull/6601
 
 
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [x] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
     - https://issues.apache.org/jira/browse/AIRFLOW-6010
   
   ### Description
   
   - [x] Here are some details about my PR, including screenshots of any UI changes:
   
   In many places "from airflow import settings" is used only to get the latest set value of one or few settings or when single method from settings is going to be called.
   
   Settings loads a lot of dependencies on its own and having it imported at the top of the file often causes many transitive/implicit dependencies which might cause circular imports.
   
   Therefore in many places the settings should be imported as local imports. This causes lasy-loading of settings in case of tests but also it makes sure that even if the values in settings are overridden by some other initialisation, we will always use latest version of settings.
   
   This test not only changes that but also has pre-commit check to avoid this in the future.
   
   ## Tests
   
   - [x] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
   
   ### 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](http://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. 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](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
   
 
----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> The "from airflow import settings" is used far too often
> --------------------------------------------------------
>
>                 Key: AIRFLOW-6010
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-6010
>             Project: Apache Airflow
>          Issue Type: Sub-task
>          Components: core
>    Affects Versions: 2.0.0
>            Reporter: Jarek Potiuk
>            Priority: Major
>
> In many places "from airflow import settings" is used only to get the latest set value of one or few settings or when single method from settings is going to be called.
> Settings loads a lot of dependencies on its own and having it imported at the top of the file often causes many transitive/implicit dependencies which might cause circular imports.
> Therefore in many places the settings should be imported as local imports. This causes lasy-loading of settings in case of tests but also it makes sure that even if the values in settings are overridden by some other initialisation, we will always use latest version of settings.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)