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/10/10 08:34:16 UTC

[GitHub] [airflow] hweecat opened a new pull request #11391: Add CustomOperatorUsesMetaclassRule (#11038)

hweecat opened a new pull request #11391:
URL: https://github.com/apache/airflow/pull/11391


   closes: #11038 
   related: #8765
   
   Added CustomOperatorUsesMetaclassRule which corresponds to
   
   > BaseOperator uses metaclass
   
   entry in UPDATING.md. This rule should allow users to check if their current configuration needs any adjusting
   before migration to Airflow 2.0.
   
   ---
   
   Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/master/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/master/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.

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

[GitHub] [airflow] ashb commented on pull request #11391: Add CustomOperatorUsesMetaclassRule (#11038)

Posted by GitBox <gi...@apache.org>.

ashb commented on pull request #11391:
URL: https://github.com/apache/airflow/pull/11391#issuecomment-735304639


   Done in #12629, sorry.


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

[GitHub] [airflow] mik-laj commented on a change in pull request #11391: Add CustomOperatorUsesMetaclassRule (#11038)

Posted by GitBox <gi...@apache.org>.

mik-laj commented on a change in pull request #11391:
URL: https://github.com/apache/airflow/pull/11391#discussion_r508009221



##########
File path: airflow/models/dagbag.py
##########
@@ -423,8 +423,6 @@ def collect_dags(
 
         dag_folder = correct_maybe_zipped(dag_folder)
 
-        dags_by_name = {}

Review comment:
       Can you tell more about it?




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

[GitHub] [airflow] turbaszek commented on pull request #11391: Add CustomOperatorUsesMetaclassRule (#11038)

Posted by GitBox <gi...@apache.org>.

turbaszek commented on pull request #11391:
URL: https://github.com/apache/airflow/pull/11391#issuecomment-721032244


   @hweecat I cleaned up the PR. Would you mind taking look at the comments from me and @mik-laj ?


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

[GitHub] [airflow] turbaszek removed a comment on pull request #11391: Add CustomOperatorUsesMetaclassRule (#11038)

Posted by GitBox <gi...@apache.org>.

turbaszek removed a comment on pull request #11391:
URL: https://github.com/apache/airflow/pull/11391#issuecomment-716125123


   @hweecat would you mind rebasing and changing the target base due to https://github.com/apache/airflow/pull/11719#issuecomment-714258732


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

[GitHub] [airflow] turbaszek commented on a change in pull request #11391: Add CustomOperatorUsesMetaclassRule (#11038)

Posted by GitBox <gi...@apache.org>.

turbaszek commented on a change in pull request #11391:
URL: https://github.com/apache/airflow/pull/11391#discussion_r502778668



##########
File path: airflow/upgrade/rules/customoperator_uses_metaclass.py
##########
@@ -0,0 +1,39 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from __future__ import absolute_import
+
+from airflow.models import BaseOperator
+from airflow.models.baseoperator import BaseOperatorMeta
+from airflow.upgrade.rules.base_rule import BaseRule
+
+
+class CustomOperatorUsesMetaclassRule(BaseRule):
+
+    title = "BaseOperator uses metaclass"
+
+    description = """\
+BaseOperator class uses a BaseOperatorMeta as a metaclass. This metaclass is based on abc.ABCMeta.
+
+If your custom operator uses different metaclass then you will have to adjust it."""
+
+    def check(self):
+        if not isinstance(BaseOperator, BaseOperatorMeta):

Review comment:
       I'm afraid that `BaseOperatorMeta` is not available in Airflow 1.10.X so we cannot use it like that. 
   
   Approaches that comes to my mind:
   - create a dagbag of users DAGs and then iterate over the tasks and check if any of them is using metaclass (any of them as Python allow users using only a single metaclass)
   - find all import statements in users DAGs and analyze those classes that inherit from `BaseOperator`
   
   We can also just rise this as a warning without any check as using metaclass is rather an edge case imho. @kaxil @mik-laj what do you think?




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

[GitHub] [airflow] boring-cyborg[bot] commented on pull request #11391: Add CustomOperatorUsesMetaclassRule (#11038)

Posted by GitBox <gi...@apache.org>.

boring-cyborg[bot] commented on pull request #11391:
URL: https://github.com/apache/airflow/pull/11391#issuecomment-706512370

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst)
Here are some useful points:
- Pay attention to the quality of your code (flake8, pylint and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/master/STATIC_CODE_CHECKS.rst#prerequisites-for-pre-commit-hooks) will help you with that.
- In case of a new feature add useful documentation (in docstrings or in `docs/` directory). Adding a new operator? Check this short [guide](https://github.com/apache/airflow/blob/master/docs/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
- Consider using [Breeze environment](https://github.com/apache/airflow/blob/master/BREEZE.rst) for testing locally, it’s a heavy docker but it ships with a working Airflow and a lot of integrations.
- Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
- Please follow [ASF Code of Conduct](https://www.apache.org/foundation/policies/conduct) for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
- Be sure to read the [Airflow Coding style]( https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#coding-style-and-best-practices).
Apache Airflow is a community-driven project and together we are making it better 🚀.
In case of doubts contact the developers at:
Mailing List: dev@airflow.apache.org
Slack: https://s.apache.org/airflow-slack

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

[GitHub] [airflow] ashb closed pull request #11391: Add CustomOperatorUsesMetaclassRule (#11038)

Posted by GitBox <gi...@apache.org>.

ashb closed pull request #11391:
URL: https://github.com/apache/airflow/pull/11391


   


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

[GitHub] [airflow] turbaszek commented on pull request #11391: Add CustomOperatorUsesMetaclassRule (#11038)

Posted by GitBox <gi...@apache.org>.

turbaszek commented on pull request #11391:
URL: https://github.com/apache/airflow/pull/11391#issuecomment-716125123


   @hweecat would you mind rebasing and changing the target base due to https://github.com/apache/airflow/pull/11719#issuecomment-714258732


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

[GitHub] [airflow] mik-laj commented on a change in pull request #11391: Add CustomOperatorUsesMetaclassRule (#11038)

Posted by GitBox <gi...@apache.org>.

mik-laj commented on a change in pull request #11391:
URL: https://github.com/apache/airflow/pull/11391#discussion_r508009471



##########
File path: airflow/models/skipmixin.py
##########
@@ -122,7 +121,8 @@ def skip_all_except(
         """
         self.log.info("Following branch %s", branch_task_ids)
         if isinstance(branch_task_ids, six.string_types):
-            branch_task_ids = [branch_task_ids]
+            branch_task_ids = {branch_task_ids}
+        branch_task_ids = set(branch_task_ids)

Review comment:
       Can you tell more about it?




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

[GitHub] [airflow] turbaszek commented on pull request #11391: Add CustomOperatorUsesMetaclassRule (#11038)

Posted by GitBox <gi...@apache.org>.

turbaszek commented on pull request #11391:
URL: https://github.com/apache/airflow/pull/11391#issuecomment-716125267


   @hweecat would you mind rebasing and changing the target base due to https://github.com/apache/airflow/pull/11719#issuecomment-714258732


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

[GitHub] [airflow] mik-laj commented on a change in pull request #11391: Add CustomOperatorUsesMetaclassRule (#11038)

Posted by GitBox <gi...@apache.org>.

mik-laj commented on a change in pull request #11391:
URL: https://github.com/apache/airflow/pull/11391#discussion_r508001453



##########
File path: airflow/upgrade/rules/customoperator_uses_metaclass.py
##########
@@ -0,0 +1,39 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from __future__ import absolute_import
+
+from airflow.models import BaseOperator
+from airflow.models.baseoperator import BaseOperatorMeta
+from airflow.upgrade.rules.base_rule import BaseRule
+
+
+class CustomOperatorUsesMetaclassRule(BaseRule):
+
+    title = "BaseOperator uses metaclass"
+
+    description = """\
+BaseOperator class uses a BaseOperatorMeta as a metaclass. This metaclass is based on abc.ABCMeta.
+
+If your custom operator uses different metaclass then you will have to adjust it."""
+
+    def check(self):
+        if not isinstance(BaseOperator, BaseOperatorMeta):

Review comment:
       I do not think this is an edge case. Many users use the ABC of the metaclass. This may not be common in this project, but people who know Jave (previously used Spark) and then started writing operators may be overusing abstract classes.




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