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 2021/12/31 12:52:20 UTC

[GitHub] [airflow] potiuk opened a new pull request #20608: Even more typing in operators (template_fields/ext)

potiuk opened a new pull request #20608:
URL: https://github.com/apache/airflow/pull/20608


   There were few more places where I missed adding Sequence
   typing - including examples (also converted to tuples) and
   also template_ext. Also in a few places iterable was left
   
   <!--
   Thank you for contributing! Please make sure that your code changes
   are covered with tests. And in case of new features or big changes
   remember to adjust the documentation.
   
   Feel free to ping committers for the review!
   
   In case of existing issue, reference it using one of the following:
   
   closes: #ISSUE
   related: #ISSUE
   
   How to write a good git commit message:
   http://chris.beams.io/posts/git-commit/
   -->
   
   ---
   **^ Add meaningful description above**
   
   Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
   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/main/UPDATING.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

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



[GitHub] [airflow] github-actions[bot] commented on pull request #20608: Even more typing in operators (template_fields/ext)

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #20608:
URL: https://github.com/apache/airflow/pull/20608#issuecomment-1003389723


   The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest main at your convenience, or amend the last commit of the PR, and push it with --force-with-lease.


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



[GitHub] [airflow] turbaszek commented on a change in pull request #20608: Even more typing in operators (template_fields/ext)

Posted by GitBox <gi...@apache.org>.
turbaszek commented on a change in pull request #20608:
URL: https://github.com/apache/airflow/pull/20608#discussion_r777014805



##########
File path: airflow/decorators/python.py
##########
@@ -39,12 +39,12 @@ class _PythonDecoratedOperator(DecoratedOperator, PythonOperator):
     :type multiple_outputs: bool
     """
 
-    template_fields = ('op_args', 'op_kwargs')
+    template_fields: Sequence[str] = ('op_args', 'op_kwargs')

Review comment:
       Won't `Tuple[str, ...]` be more proper type?
   > To specify a variable-length tuple of homogeneous type, use literal ellipsis, e.g. Tuple[int, ...]. 
   
   To me `Sequence` is ambiguous type.  Not sure if that's necessary but maybe we can consider introducing `TemplateFields = Tuple[int, ...]` type so we don't have to repeat ourselves? 




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



[GitHub] [airflow] turbaszek commented on a change in pull request #20608: Even more typing in operators (template_fields/ext)

Posted by GitBox <gi...@apache.org>.
turbaszek commented on a change in pull request #20608:
URL: https://github.com/apache/airflow/pull/20608#discussion_r777014805



##########
File path: airflow/decorators/python.py
##########
@@ -39,12 +39,12 @@ class _PythonDecoratedOperator(DecoratedOperator, PythonOperator):
     :type multiple_outputs: bool
     """
 
-    template_fields = ('op_args', 'op_kwargs')
+    template_fields: Sequence[str] = ('op_args', 'op_kwargs')

Review comment:
       Won't `Tuple[str, ...]` be more proper type?
   > To specify a variable-length tuple of homogeneous type, use literal ellipsis, e.g. Tuple[int, ...]. 
   
   To me `Sequence` is ambiguous type. 




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



[GitHub] [airflow] potiuk merged pull request #20608: Even more typing in operators (template_fields/ext)

Posted by GitBox <gi...@apache.org>.
potiuk merged pull request #20608:
URL: https://github.com/apache/airflow/pull/20608


   


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



[GitHub] [airflow] potiuk commented on a change in pull request #20608: Even more typing in operators (template_fields/ext)

Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #20608:
URL: https://github.com/apache/airflow/pull/20608#discussion_r777026311



##########
File path: airflow/decorators/python.py
##########
@@ -39,12 +39,12 @@ class _PythonDecoratedOperator(DecoratedOperator, PythonOperator):
     :type multiple_outputs: bool
     """
 
-    template_fields = ('op_args', 'op_kwargs')
+    template_fields: Sequence[str] = ('op_args', 'op_kwargs')

Review comment:
       The problem with TemplateFields as type is that we will have to import it from somewhere in Providers (and that would either make them incompatible with pre-Airlfow 2.3 or we will have to `quote` those and add if TYPE_CHECKING trick as we as we did with Context. In this case Sequence[str] sounds like good compromise (especially that till recently we recommended Lists in our examples and Tuple would make anyone's custom operator immediately failing MyPy check (which is not really good in "mass").  I think our intent is a bit different:
   
   * we still accept LIst[] (which is a Sequence as well)
   * but in our operators we implement this always as a Tuple for its immutability
   * so if you want in your custom operator you can still use List if you want
   




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