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 2020/01/25 22:40:47 UTC
[GitHub] [airflow] mustafagok opened a new pull request #7263:
[AIRFLOW-XXXX] Improve docstring of AwsHook
mustafagok opened a new pull request #7263: [AIRFLOW-XXXX] Improve docstring of AwsHook
URL: https://github.com/apache/airflow/pull/7263
Add documentation for verify parameter.
---
Issue link: WILL BE INSERTED BY [boring-cyborg](https://github.com/kaxil/boring-cyborg)
Make sure to mark the boxes below before creating PR: [x]
- [x] Description above provides context of the change
- [x] Commit message/PR title starts with `[AIRFLOW-NNNN]`. AIRFLOW-NNNN = JIRA ID<sup>*</sup>
- [x] Unit tests coverage for changes (not needed for documentation changes)
- [x] Commits follow "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)"
- [x] Relevant documentation is updated including usage instructions.
- [x] I will engage committers as explained in [Contribution Workflow Example](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#contribution-workflow-example).
<sup>*</sup> For document-only changes commit message can start with `[AIRFLOW-XXXX]`.
---
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/master/UPDATING.md).
Read the [Pull Request Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines) for more information.
----------------------------------------------------------------
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
With regards,
Apache Git Services
[GitHub] [airflow] nuclearpinguin commented on a change in pull request
#7263: [AIRFLOW-XXXX] Improve docstring of AwsHook
Posted by GitBox <gi...@apache.org>.
nuclearpinguin commented on a change in pull request #7263: [AIRFLOW-XXXX] Improve docstring of AwsHook
URL: https://github.com/apache/airflow/pull/7263#discussion_r371010966
##########
File path: airflow/contrib/hooks/aws_hook.py
##########
@@ -40,10 +40,14 @@ class AwsHook(BaseHook):
Interact with AWS.
This class is a thin wrapper around the boto3 python library.
- :param str aws_conn_id: The Airflow connection used for AWS credentials.
- If this is None then the default boto3 behaviour is used. If running Airflow
- in a distributed manner and aws_conn_id is None, then default boto3 configuration
- would be used (and must be maintained on each worker node).
+ :param aws_conn_id: The Airflow connection used for AWS credentials.
+ If this is None then the default boto3 behaviour is used. If running Airflow
+ in a distributed manner and aws_conn_id is None, then default boto3 configuration
+ would be used (and must be maintained on each worker node).
+ :type aws_conn_id: str
+ :param verify: Whether or not to verify SSL certificates.
+ https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html
+ :type verify: str or bool
Review comment:
Hm, this type looks strange 🤔
----------------------------------------------------------------
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
With regards,
Apache Git Services
[GitHub] [airflow] mustafagok commented on a change in pull request #7263:
[AIRFLOW-XXXX] Improve docstring of AwsHook
Posted by GitBox <gi...@apache.org>.
mustafagok commented on a change in pull request #7263: [AIRFLOW-XXXX] Improve docstring of AwsHook
URL: https://github.com/apache/airflow/pull/7263#discussion_r372640341
##########
File path: airflow/contrib/hooks/aws_hook.py
##########
@@ -40,10 +40,14 @@ class AwsHook(BaseHook):
Interact with AWS.
This class is a thin wrapper around the boto3 python library.
- :param str aws_conn_id: The Airflow connection used for AWS credentials.
- If this is None then the default boto3 behaviour is used. If running Airflow
- in a distributed manner and aws_conn_id is None, then default boto3 configuration
- would be used (and must be maintained on each worker node).
+ :param aws_conn_id: The Airflow connection used for AWS credentials.
+ If this is None then the default boto3 behaviour is used. If running Airflow
+ in a distributed manner and aws_conn_id is None, then default boto3 configuration
+ would be used (and must be maintained on each worker node).
+ :type aws_conn_id: str
+ :param verify: Whether or not to verify SSL certificates.
+ https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html
+ :type verify: str or bool
Review comment:
I am open for suggestions :)
boto3 docs: verify (boolean/string)
it could be `Union[str, bool]`, also PyCharm quick documentation (ctrl+q) renders `str or bool` as `Union[str, bool]`
![image](https://user-images.githubusercontent.com/18196182/73398937-68279000-42f7-11ea-9d5f-50e2508d23f4.png)
----------------------------------------------------------------
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
With regards,
Apache Git Services
[GitHub] [airflow] potiuk commented on issue #7263: [AIRFLOW-XXXX] Improve
docstring of AwsHook
Posted by GitBox <gi...@apache.org>.
potiuk commented on issue #7263: [AIRFLOW-XXXX] Improve docstring of AwsHook
URL: https://github.com/apache/airflow/pull/7263#issuecomment-578560668
Thanks @mustafagok
----------------------------------------------------------------
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
With regards,
Apache Git Services
[GitHub] [airflow] codecov-io edited a comment on issue #7263:
[AIRFLOW-XXXX] Improve docstring of AwsHook
Posted by GitBox <gi...@apache.org>.
codecov-io edited a comment on issue #7263: [AIRFLOW-XXXX] Improve docstring of AwsHook
URL: https://github.com/apache/airflow/pull/7263#issuecomment-578452382
# [Codecov](https://codecov.io/gh/apache/airflow/pull/7263?src=pr&el=h1) Report
> Merging [#7263](https://codecov.io/gh/apache/airflow/pull/7263?src=pr&el=desc) into [master](https://codecov.io/gh/apache/airflow/commit/6584e0d887a6fbc98ab21ba062a03e30cac2923f?src=pr&el=desc) will **increase** coverage by `52.09%`.
> The diff coverage is `n/a`.
[![Impacted file tree graph](https://codecov.io/gh/apache/airflow/pull/7263/graphs/tree.svg?width=650&token=WdLKlKHOAU&height=150&src=pr)](https://codecov.io/gh/apache/airflow/pull/7263?src=pr&el=tree)
```diff
@@ Coverage Diff @@
## master #7263 +/- ##
===========================================
+ Coverage 32.96% 85.05% +52.09%
===========================================
Files 791 791
Lines 40137 40137
===========================================
+ Hits 13231 34140 +20909
+ Misses 26906 5997 -20909
```
| [Impacted Files](https://codecov.io/gh/apache/airflow/pull/7263?src=pr&el=tree) | Coverage Δ | |
|---|---|---|
| [airflow/contrib/hooks/aws\_hook.py](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9jb250cmliL2hvb2tzL2F3c19ob29rLnB5) | `77.31% <ø> (+63.86%)` | :arrow_up: |
| [airflow/kubernetes/volume\_mount.py](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3ZvbHVtZV9tb3VudC5weQ==) | `44.44% <0%> (-55.56%)` | :arrow_down: |
| [airflow/kubernetes/volume.py](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3ZvbHVtZS5weQ==) | `52.94% <0%> (-47.06%)` | :arrow_down: |
| [airflow/kubernetes/pod\_launcher.py](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3BvZF9sYXVuY2hlci5weQ==) | `45.25% <0%> (-43.8%)` | :arrow_down: |
| [airflow/kubernetes/refresh\_config.py](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3JlZnJlc2hfY29uZmlnLnB5) | `50.98% <0%> (-23.53%)` | :arrow_down: |
| [...viders/cncf/kubernetes/operators/kubernetes\_pod.py](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9wcm92aWRlcnMvY25jZi9rdWJlcm5ldGVzL29wZXJhdG9ycy9rdWJlcm5ldGVzX3BvZC5weQ==) | `76.47% <0%> (-21.18%)` | :arrow_down: |
| [airflow/bin/airflow](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9iaW4vYWlyZmxvdw==) | `84.61% <0%> (ø)` | :arrow_up: |
| [airflow/plugins\_manager.py](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9wbHVnaW5zX21hbmFnZXIucHk=) | `87.57% <0%> (+0.62%)` | :arrow_up: |
| [airflow/bin/cli.py](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9iaW4vY2xpLnB5) | `94.73% <0%> (+2.1%)` | :arrow_up: |
| [airflow/exceptions.py](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9leGNlcHRpb25zLnB5) | `100% <0%> (+3.57%)` | :arrow_up: |
| ... and [646 more](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree-more) | |
------
[Continue to review full report at Codecov](https://codecov.io/gh/apache/airflow/pull/7263?src=pr&el=continue).
> **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta)
> `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
> Powered by [Codecov](https://codecov.io/gh/apache/airflow/pull/7263?src=pr&el=footer). Last update [6584e0d...d2c299f](https://codecov.io/gh/apache/airflow/pull/7263?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).
----------------------------------------------------------------
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
With regards,
Apache Git Services
[GitHub] [airflow] potiuk merged pull request #7263: [AIRFLOW-XXXX] Improve
docstring of AwsHook
Posted by GitBox <gi...@apache.org>.
potiuk merged pull request #7263: [AIRFLOW-XXXX] Improve docstring of AwsHook
URL: https://github.com/apache/airflow/pull/7263
----------------------------------------------------------------
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
With regards,
Apache Git Services
[GitHub] [airflow] codecov-io commented on issue #7263: [AIRFLOW-XXXX]
Improve docstring of AwsHook
Posted by GitBox <gi...@apache.org>.
codecov-io commented on issue #7263: [AIRFLOW-XXXX] Improve docstring of AwsHook
URL: https://github.com/apache/airflow/pull/7263#issuecomment-578452382
# [Codecov](https://codecov.io/gh/apache/airflow/pull/7263?src=pr&el=h1) Report
> Merging [#7263](https://codecov.io/gh/apache/airflow/pull/7263?src=pr&el=desc) into [master](https://codecov.io/gh/apache/airflow/commit/6584e0d887a6fbc98ab21ba062a03e30cac2923f?src=pr&el=desc) will **increase** coverage by `52.09%`.
> The diff coverage is `n/a`.
[![Impacted file tree graph](https://codecov.io/gh/apache/airflow/pull/7263/graphs/tree.svg?width=650&token=WdLKlKHOAU&height=150&src=pr)](https://codecov.io/gh/apache/airflow/pull/7263?src=pr&el=tree)
```diff
@@ Coverage Diff @@
## master #7263 +/- ##
===========================================
+ Coverage 32.96% 85.05% +52.09%
===========================================
Files 791 791
Lines 40137 40137
===========================================
+ Hits 13231 34140 +20909
+ Misses 26906 5997 -20909
```
| [Impacted Files](https://codecov.io/gh/apache/airflow/pull/7263?src=pr&el=tree) | Coverage Δ | |
|---|---|---|
| [airflow/contrib/hooks/aws\_hook.py](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9jb250cmliL2hvb2tzL2F3c19ob29rLnB5) | `77.31% <ø> (+63.86%)` | :arrow_up: |
| [airflow/kubernetes/volume\_mount.py](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3ZvbHVtZV9tb3VudC5weQ==) | `44.44% <0%> (-55.56%)` | :arrow_down: |
| [airflow/kubernetes/volume.py](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3ZvbHVtZS5weQ==) | `52.94% <0%> (-47.06%)` | :arrow_down: |
| [airflow/kubernetes/pod\_launcher.py](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3BvZF9sYXVuY2hlci5weQ==) | `45.25% <0%> (-43.8%)` | :arrow_down: |
| [airflow/kubernetes/refresh\_config.py](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3JlZnJlc2hfY29uZmlnLnB5) | `50.98% <0%> (-23.53%)` | :arrow_down: |
| [...viders/cncf/kubernetes/operators/kubernetes\_pod.py](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9wcm92aWRlcnMvY25jZi9rdWJlcm5ldGVzL29wZXJhdG9ycy9rdWJlcm5ldGVzX3BvZC5weQ==) | `76.47% <0%> (-21.18%)` | :arrow_down: |
| [airflow/bin/airflow](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9iaW4vYWlyZmxvdw==) | `84.61% <0%> (ø)` | :arrow_up: |
| [airflow/plugins\_manager.py](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9wbHVnaW5zX21hbmFnZXIucHk=) | `87.57% <0%> (+0.62%)` | :arrow_up: |
| [airflow/bin/cli.py](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9iaW4vY2xpLnB5) | `94.73% <0%> (+2.1%)` | :arrow_up: |
| [airflow/exceptions.py](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree#diff-YWlyZmxvdy9leGNlcHRpb25zLnB5) | `100% <0%> (+3.57%)` | :arrow_up: |
| ... and [646 more](https://codecov.io/gh/apache/airflow/pull/7263/diff?src=pr&el=tree-more) | |
------
[Continue to review full report at Codecov](https://codecov.io/gh/apache/airflow/pull/7263?src=pr&el=continue).
> **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta)
> `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
> Powered by [Codecov](https://codecov.io/gh/apache/airflow/pull/7263?src=pr&el=footer). Last update [6584e0d...d2c299f](https://codecov.io/gh/apache/airflow/pull/7263?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).
----------------------------------------------------------------
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
With regards,
Apache Git Services