You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "simond (via GitHub)" <gi...@apache.org> on 2024/01/04 12:34:23 UTC

[I] Incorrect docstring for apply_wildcard parameter in S3ListOperator [airflow]

simond opened a new issue, #36593:
URL: https://github.com/apache/airflow/issues/36593

   ### What do you see as an issue?
   
   The docstring for the S3ListOperator is incorrect for the `apply_wildcard` parameter:
   
   ```
   :param apply_wildcard: whether to treat '*' as a wildcard or a plain symbol in the prefix.
           By default SSL certificates are verified.
           You can provide the following values:
   
   
           - ``False``: do not validate SSL certificates. SSL will still be used
                    (unless use_ssl is False), but SSL certificates will not be
                    verified.
           - ``path/to/cert/bundle.pem``: A filename of the CA cert bundle to uses.
                    You can specify this argument if you want to use a different
                    CA cert bundle than the one used by botocore.
   ```
   
   
   
   
   ### Solving the problem
   
   It looks as though most of the docstring should actually be part of the `verify` and not the `apply_wildcard` one. Moving the following lines up under the `verify` parameter should resolve:
   
   ```   
           By default SSL certificates are verified.
           You can provide the following values:
   
   
           - ``False``: do not validate SSL certificates. SSL will still be used
                    (unless use_ssl is False), but SSL certificates will not be
                    verified.
           - ``path/to/cert/bundle.pem``: A filename of the CA cert bundle to uses.
                    You can specify this argument if you want to use a different
                    CA cert bundle than the one used by botocore.
   ```
   
   ### Anything else
   
   _No response_
   
   ### Are you willing to submit PR?
   
   - [ ] Yes I am willing to submit a PR!
   
   ### Code of Conduct
   
   - [X] I agree to follow this project's [Code of Conduct](https://github.com/apache/airflow/blob/main/CODE_OF_CONDUCT.md)
   


-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] Incorrect docstring for apply_wildcard parameter in S3ListOperator [airflow]

Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on issue #36593:
URL: https://github.com/apache/airflow/issues/36593#issuecomment-1877806339

   Feel free to open PR for it @simond . It seems that creating PR for one would take less time than describing it in an issue.


-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] Incorrect docstring for apply_wildcard parameter in S3ListOperator [airflow]

Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on issue #36593:
URL: https://github.com/apache/airflow/issues/36593#issuecomment-1877026700

   Thanks for opening your first issue here! Be sure to follow the issue template! If you are willing to raise PR to address this issue please do so, no need to wait for approval.
   


-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] Incorrect docstring for apply_wildcard parameter in S3ListOperator [airflow]

Posted by "simond (via GitHub)" <gi...@apache.org>.
simond commented on issue #36593:
URL: https://github.com/apache/airflow/issues/36593#issuecomment-1877812184

   I would normally agree but last time, I checked, setting up the development environment for Airflow to do a PR with tests etc was quite a lot of work. 


-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] Incorrect docstring for apply_wildcard parameter in S3ListOperator [airflow]

Posted by "josh-fell (via GitHub)" <gi...@apache.org>.
josh-fell closed issue #36593: Incorrect docstring for apply_wildcard parameter in S3ListOperator
URL: https://github.com/apache/airflow/issues/36593


-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] Incorrect docstring for apply_wildcard parameter in S3ListOperator [airflow]

Posted by "josh-fell (via GitHub)" <gi...@apache.org>.
josh-fell commented on issue #36593:
URL: https://github.com/apache/airflow/issues/36593#issuecomment-1886209361

   Closed via #36679.


-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] Incorrect docstring for apply_wildcard parameter in S3ListOperator [airflow]

Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on issue #36593:
URL: https://github.com/apache/airflow/issues/36593#issuecomment-1877824238

   > I would normally agree but, last time I checked, setting up the development environment for Airflow to do a PR with tests etc was quite a lot of work.
   
   Well. It's ~ 15 minutes - mosty to pull images -  to run Breeze (after installing Docker + Docker Compose + pipx basically) so I think it's not as difficult as you might think. And yes. Improvements to installing local environment (including using Hatch which manages Python installations and virtualenvs is coming sooon - See  https://github.com/apache/airflow/pull/36537 - so you might want to re-check it back when it's merged if you do not want to 
   
   Maube comment in the PR to get notified when it gets merged so that you can try it then ?


-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] Incorrect docstring for apply_wildcard parameter in S3ListOperator [airflow]

Posted by "simond (via GitHub)" <gi...@apache.org>.
simond commented on issue #36593:
URL: https://github.com/apache/airflow/issues/36593#issuecomment-1877851063

   > > I would normally agree but, last time I checked, setting up the development environment for Airflow to do a PR with tests etc was quite a lot of work.
   > 
   > Well. It's ~ 15 minutes - mosty to pull images -  to run Breeze (after installing Docker + Docker Compose + pipx basically) so I think it's not as difficult as you might think. And yes. Improvements to installing local environment (including using Hatch which manages Python installations and virtualenvs is coming sooon - See  https://github.com/apache/airflow/pull/36537 - so you might want to re-check it back when it's merged if you do not want to use Docker.
   > 
   > Maybe comment in the PR to get notified when it gets merged so that you can try it then ?
   
   
   I'll take another look as it sounds like it has changed since I looked last, thanks! 


-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org