potiuk commented on code in PR #37075: URL: https://github.com/apache/airflow/pull/37075#discussion_r1484435260
########## docs/apache-airflow-providers/core-extensions/deprecations.rst: ########## @@ -0,0 +1,57 @@ + .. 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. + + +Deprecations +========================================== + +This is a summary of deprecated objects in Apache Airflow Providers Packages. + +.. note:: + At the moment we only show deprecations for classes, functions, methods, properties etc. + Support for an argument deprecation or an argument value deprecation will be added in the future. + + +.. important:: + Only deprecations made with @deprecated decorator are included in this docs. + If You use warnings.warn in function/method body it will not show up in this documentation. + Make sure to use @deprecated decorator as shown in the below example: Review Comment: Yes. You are right it's tricky for providers to use new features imported from common airlfow code. I thought about it and there is a way, though rather complex-ish - we could release another common provider (`common.utils` for the lack of better name though I hate generic utils) where we could put such `never-backwards-incompatible` base classes that could be imported by providers. Similar to common.io. That would remove the dependency on airflow core and your https://github.com/apache/airflow/pull/36952 could land there, rather than in airflow core (or at least the part of it that is going to be used in providers). And this is probably the only way we can implement decorators that we will be able to use in providers immediately (assuming that the `common.utils` will never be incompatible. Maybe that's the right approach ? -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
