XD-DENG opened a new pull request #3674: [AIRFLOW-2836] Minor improvement of 
contrib.sensors.FileSensor
URL: https://github.com/apache/incubator-airflow/pull/3674
 
 
   ### 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-2836
     - 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.
   
   ### Description
   
   - [x] Here are some details about my PR, including screenshots of any UI 
changes:
   
   #### Background
   
   The default `fs_conn_id` in `contrib.sensors.FileSensor` is 'fs_default2'. 
However, when we initiate the database 
(https://github.com/apache/incubator-airflow/blob/master/airflow/utils/db.py#L88),
 there isn't such an entry. It doesn't exist anywhere else.
   
   #### Issue
   
   The purpose of `contrib.sensors.FileSensor` is mainly for checking local 
file system (of course can also be used for NAS). Then the path ("/") from 
default connection 'fs_default' would suffice.
   
   However, given the default value for fs_conn_id in 
contrib.sensors.FileSensor is "fs_default2" (a value doesn't exist), it will 
make the situation much more complex. 
   
   When users intend to check local file system only, they should be able to 
leave fs_conn_id default directly, instead of going setting up another 
connection separately.
   
   #### Proposal
   
   Change default value for `fs_conn_id` in `contrib.sensors.FileSensor` from 
"fs_default2" to "fs_default" (actually in the related test, the `fs_conn_id` 
are all specified to be "fs_default").
   
   ### Tests
   
   - [ ] 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.
     - When adding new operators/hooks/sensors, the autoclass documentation 
generation needs to be added.
   
   ### Code Quality
   
   - [ ] Passes `git diff upstream/master -u -- "*.py" | flake8 --diff`
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
[email protected]


With regards,
Apache Git Services

Reply via email to