Add deprecation info to the providers modules and classes docstring (#32536)

hussein-awala · web-flow · commit e01323635a88 · 2023-07-13T16:30:09.000+02:00
* Add deprecation info to providers modules and classes docstring

Signed-off-by: Hussein Awala &lt;hussein@awala.fr&gt;


---------

Signed-off-by: Hussein Awala &lt;hussein@awala.fr&gt;
diff --git a/airflow/providers/apache/drill/operators/drill.py b/airflow/providers/apache/drill/operators/drill.py
@@ -28,6 +28,10 @@ class DrillOperator(SQLExecuteQueryOperator):
     """
     Executes the provided SQL in the identified Drill environment.
 
+    This class is deprecated.
+
+    Please use :class:`airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator`.
+
     .. seealso::
         For more information on how to use this operator, take a look at the guide:
         :ref:`howto/operator:DrillOperator`
diff --git a/airflow/providers/apache/druid/operators/druid_check.py b/airflow/providers/apache/druid/operators/druid_check.py
@@ -27,7 +27,7 @@ class DruidCheckOperator(SQLCheckOperator):
     """
     This class is deprecated.
 
-    Please use `airflow.providers.common.sql.operators.sql.SQLCheckOperator`.
+    Please use :class:`airflow.providers.common.sql.operators.sql.SQLCheckOperator`.
     """
 
     def __init__(self, druid_broker_conn_id: str = "druid_broker_default", **kwargs):
diff --git a/airflow/providers/cncf/kubernetes/operators/kubernetes_pod.py b/airflow/providers/cncf/kubernetes/operators/kubernetes_pod.py
@@ -15,6 +15,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+"""This module is deprecated. Please use :mod:`airflow.providers.cncf.kubernetes.operators.pod` instead."""
 from __future__ import annotations
 
 import warnings
diff --git a/airflow/providers/cncf/kubernetes/triggers/kubernetes_pod.py b/airflow/providers/cncf/kubernetes/triggers/kubernetes_pod.py
@@ -15,6 +15,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+"""This module is deprecated. Please use :mod:`airflow.providers.cncf.kubernetes.triggers.pod` instead."""
 from __future__ import annotations
 
 import warnings
diff --git a/airflow/providers/elasticsearch/hooks/elasticsearch.py b/airflow/providers/elasticsearch/hooks/elasticsearch.py
@@ -142,7 +142,7 @@ class ElasticsearchHook(ElasticsearchSQLHook):
     """
     This class is deprecated and was renamed to ElasticsearchSQLHook.
 
-    Please use `airflow.providers.elasticsearch.hooks.elasticsearch.ElasticsearchSQLHook`.
+    Please use :class:`airflow.providers.elasticsearch.hooks.elasticsearch.ElasticsearchSQLHook`.
     """
 
     def __init__(self, *args, **kwargs):
diff --git a/airflow/providers/google/cloud/operators/dataflow.py b/airflow/providers/google/cloud/operators/dataflow.py
@@ -173,6 +173,7 @@ class DataflowCreateJavaJobOperator(GoogleCloudBaseOperator):
     Start a Java Cloud Dataflow batch job; the parameters of the operation will be passed to the job.
 
     This class is deprecated.
+
     Please use :class:`providers.apache.beam.operators.beam.BeamRunJavaPipelineOperator`.
 
     Example usage:
@@ -1023,6 +1024,7 @@ class DataflowCreatePythonJobOperator(GoogleCloudBaseOperator):
     for instances, project and zone information, which apply to all dataflow operators in the DAG.
 
     This class is deprecated.
+
     Please use :class:`providers.apache.beam.operators.beam.BeamRunPythonPipelineOperator`.
 
     .. seealso::
diff --git a/airflow/providers/google/cloud/sensors/bigquery.py b/airflow/providers/google/cloud/sensors/bigquery.py
@@ -256,6 +256,11 @@ class BigQueryTableExistenceAsyncSensor(BigQueryTableExistenceSensor):
     """
     Checks for the existence of a table in Google Big Query.
 
+    This class is deprecated and will be removed in a future release.
+
+    Please use :class:`airflow.providers.google.cloud.sensors.bigquery.BigQueryTableExistenceSensor`
+    and set *deferrable* attribute to *True* instead.
+
     :param project_id: The Google cloud project in which to look for the table.
        The connection supplied to the hook must provide
        access to the specified project.
@@ -291,6 +296,11 @@ class BigQueryTableExistencePartitionAsyncSensor(BigQueryTablePartitionExistence
     """
     Checks for the existence of a partition within a table in Google BigQuery.
 
+    This class is deprecated and will be removed in a future release.
+
+    Please use :class:`airflow.providers.google.cloud.sensors.bigquery.BigQueryTablePartitionExistenceSensor`
+    and set *deferrable* attribute to *True* instead.
+
     :param project_id: The Google cloud project in which to look for the table.
        The connection supplied to the hook must provide
        access to the specified project.
@@ -316,7 +326,7 @@ def __init__(self, **kwargs):
         warnings.warn(
             "Class `BigQueryTableExistencePartitionAsyncSensor` is deprecated and "
             "will be removed in a future release. "
-            "Please use `BigQueryTableExistencePartitionSensor` and "
+            "Please use `BigQueryTablePartitionExistenceSensor` and "
             "set `deferrable` attribute to `True` instead",
             AirflowProviderDeprecationWarning,
         )
diff --git a/airflow/providers/google/cloud/sensors/gcs.py b/airflow/providers/google/cloud/sensors/gcs.py
@@ -133,8 +133,10 @@ class GCSObjectExistenceAsyncSensor(GCSObjectExistenceSensor):
     """
     Checks for the existence of a file in Google Cloud Storage.
 
-    Class `GCSObjectExistenceAsyncSensor` is deprecated and will be removed in a future release.
-    Please use `GCSObjectExistenceSensor` and set `deferrable` attribute to `True` instead.
+    This class is deprecated and will be removed in a future release.
+
+    Please use :class:`airflow.providers.google.cloud.sensors.gcs.GCSObjectExistenceSensor`
+    and set *deferrable* attribute to *True* instead.
 
     :param bucket: The Google Cloud Storage bucket where the object is.
     :param object: The name of the object to check in the Google cloud storage bucket.
diff --git a/airflow/providers/jdbc/operators/jdbc.py b/airflow/providers/jdbc/operators/jdbc.py
@@ -30,6 +30,10 @@ class JdbcOperator(SQLExecuteQueryOperator):
 
     Requires jaydebeapi.
 
+    This class is deprecated.
+
+    Please use :class:`airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator` instead.
+
     .. seealso::
         For more information on how to use this operator, take a look at the guide:
         :ref:`howto/operator:JdbcOperator`
diff --git a/airflow/providers/microsoft/azure/sensors/data_factory.py b/airflow/providers/microsoft/azure/sensors/data_factory.py
@@ -127,6 +127,12 @@ class AzureDataFactoryPipelineRunStatusAsyncSensor(AzureDataFactoryPipelineRunSt
     """
     Checks the status of a pipeline run asynchronously.
 
+    This class is deprecated and will be removed in a future release.
+
+    Please use
+    :class:`airflow.providers.microsoft.azure.sensors.data_factory.AzureDataFactoryPipelineRunStatusSensor`
+    and set *deferrable* attribute to *True* instead.
+
     :param azure_data_factory_conn_id: The connection identifier for connecting to Azure Data Factory.
     :param run_id: The pipeline run identifier.
     :param resource_group_name: The resource group name.
diff --git a/airflow/providers/microsoft/azure/sensors/wasb.py b/airflow/providers/microsoft/azure/sensors/wasb.py
@@ -112,6 +112,11 @@ class WasbBlobAsyncSensor(WasbBlobSensor):
     """
     Polls asynchronously for the existence of a blob in a WASB container.
 
+    This class is deprecated and will be removed in a future release.
+
+    Please use :class:`airflow.providers.microsoft.azure.sensors.wasb.WasbBlobSensor`
+    and set *deferrable* attribute to *True* instead.
+
     :param container_name: name of the container in which the blob should be searched for
     :param blob_name: name of the blob to check existence for
     :param wasb_conn_id: the connection identifier for connecting to Azure WASB
diff --git a/airflow/providers/microsoft/azure/transfers/local_to_adls.py b/airflow/providers/microsoft/azure/transfers/local_to_adls.py
@@ -103,7 +103,8 @@ class LocalToAzureDataLakeStorageOperator(LocalFilesystemToADLSOperator):
     """
     This class is deprecated.
 
-    Please use `airflow.providers.microsoft.azure.transfers.local_to_adls.LocalFilesystemToADLSOperator`.
+    Please use
+    :class:`airflow.providers.microsoft.azure.transfers.local_to_adls.LocalFilesystemToADLSOperator`.
     """
 
     def __init__(self, *args, **kwargs):
diff --git a/airflow/providers/microsoft/mssql/operators/mssql.py b/airflow/providers/microsoft/mssql/operators/mssql.py
@@ -37,6 +37,10 @@ class MsSqlOperator(SQLExecuteQueryOperator):
     If conn_type is ``'odbc'``, then :py:class:`~airflow.providers.odbc.hooks.odbc.OdbcHook`
     is used.  Otherwise, :py:class:`~airflow.providers.microsoft.mssql.hooks.mssql.MsSqlHook` is used.
 
+    This class is deprecated.
+
+    Please use :class:`airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator`.
+
     :param sql: the sql code to be executed (templated)
     :param mssql_conn_id: reference to a specific mssql database
     :param parameters: (optional) the parameters to render the SQL query with.
diff --git a/airflow/providers/mysql/operators/mysql.py b/airflow/providers/mysql/operators/mysql.py
@@ -28,6 +28,10 @@ class MySqlOperator(SQLExecuteQueryOperator):
     """
     Executes sql code in a specific MySQL database.
 
+    This class is deprecated.
+
+    Please use :class:`airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator`.
+
     .. seealso::
         For more information on how to use this operator, take a look at the guide:
         :ref:`howto/operator:MySqlOperator`
diff --git a/airflow/providers/oracle/operators/oracle.py b/airflow/providers/oracle/operators/oracle.py
@@ -36,6 +36,10 @@ class OracleOperator(SQLExecuteQueryOperator):
     """
     Executes sql code in a specific Oracle database.
 
+    This class is deprecated.
+
+    Please use :class:`airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator`.
+
     :param sql: the sql code to be executed. Can receive a str representing a sql statement,
         a list of str (sql statements), or reference to a template file.
         Template reference are recognized by str ending in '.sql'
diff --git a/airflow/providers/postgres/operators/postgres.py b/airflow/providers/postgres/operators/postgres.py
@@ -28,6 +28,10 @@ class PostgresOperator(SQLExecuteQueryOperator):
     """
     Executes sql code in a specific Postgres database.
 
+    This class is deprecated.
+
+    Please use :class:`airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator`.
+
     :param sql: the SQL code to be executed as a single string, or
         a list of str (sql statements), or a reference to a template file.
         Template references are recognized by str ending in '.sql'
diff --git a/airflow/providers/snowflake/operators/snowflake.py b/airflow/providers/snowflake/operators/snowflake.py
@@ -42,6 +42,10 @@ class SnowflakeOperator(SQLExecuteQueryOperator):
     """
     Executes SQL code in a Snowflake database.
 
+    This class is deprecated.
+
+    Please use :class:`airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator`.
+
     .. seealso::
         For more information on how to use this operator, take a look at the guide:
         :ref:`howto/operator:SnowflakeOperator`
diff --git a/airflow/providers/sqlite/operators/sqlite.py b/airflow/providers/sqlite/operators/sqlite.py
@@ -28,6 +28,10 @@ class SqliteOperator(SQLExecuteQueryOperator):
     """
     Executes sql code in a specific Sqlite database.
 
+    This class is deprecated.
+
+    Please use :class:`airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator`.
+
     .. seealso::
         For more information on how to use this operator, take a look at the guide:
         :ref:`howto/operator:SqliteOperator`
diff --git a/airflow/providers/trino/operators/trino.py b/airflow/providers/trino/operators/trino.py
@@ -32,6 +32,10 @@ class TrinoOperator(SQLExecuteQueryOperator):
     """
     Executes sql code using a specific Trino query Engine.
 
+    This class is deprecated.
+
+    Please use :class:`airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator`.
+
     .. seealso::
         For more information on how to use this operator, take a look at the guide:
         :ref:`howto/operator:TrinoOperator`
diff --git a/airflow/providers/vertica/operators/vertica.py b/airflow/providers/vertica/operators/vertica.py
@@ -28,6 +28,10 @@ class VerticaOperator(SQLExecuteQueryOperator):
     """
     Executes sql code in a specific Vertica database.
 
+    This class is deprecated.
+
+    Please use :class:`airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator`.
+
     :param vertica_conn_id: reference to a specific Vertica database
     :param sql: the SQL code to be executed as a single string, or
         a list of str (sql statements), or a reference to a template file.
diff --git a/tests/providers/google/cloud/sensors/test_bigquery.py b/tests/providers/google/cloud/sensors/test_bigquery.py
@@ -330,7 +330,7 @@ class TestBigQueryTableExistencePartitionAsyncSensor:
     depcrecation_message = (
         "Class `BigQueryTableExistencePartitionAsyncSensor` is deprecated and "
         "will be removed in a future release. "
-        "Please use `BigQueryTableExistencePartitionSensor` and "
+        "Please use `BigQueryTablePartitionExistenceSensor` and "
         "set `deferrable` attribute to `True` instead"
     )
 
