Skip to content

Commit

Permalink
Show deprecation status of operators and sensors on the docs operator…
Browse files Browse the repository at this point in the history
… list page
  • Loading branch information
pankajkoti committed Aug 19, 2024
1 parent cc1c04e commit 0fb130f
Show file tree
Hide file tree
Showing 30 changed files with 244 additions and 16 deletions.
3 changes: 3 additions & 0 deletions astronomer/providers/amazon/aws/operators/batch.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ class BatchOperatorAsync(BatchOperator):
and set `deferrable` param to `True` instead.
"""

is_deprecated = True
post_deprecation_replacement = "from airflow.providers.amazon.aws.operators.batch import BatchOperator"

def __init__(self, *args: Any, **kwargs: Any) -> None:
warnings.warn(
(
Expand Down
5 changes: 5 additions & 0 deletions astronomer/providers/amazon/aws/operators/emr.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ class EmrContainerOperatorAsync(EmrContainerOperator):
Please use :class: `~airflow.providers.amazon.aws.operators.emr.EmrContainerOperator`.
"""

is_deprecated = True
post_deprecation_replacement = (
"from airflow.providers.amazon.aws.operators.emr import EmrContainerOperator"
)

def __init__(self, *args, **kwargs): # type: ignore[no-untyped-def]
warnings.warn(
(
Expand Down
15 changes: 15 additions & 0 deletions astronomer/providers/amazon/aws/operators/redshift_cluster.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ class RedshiftDeleteClusterOperatorAsync(RedshiftDeleteClusterOperator):
Please use :class: `~airflow.providers.amazon.aws.operators.redshift_cluster.RedshiftDeleteClusterOperator`.
"""

is_deprecated = True
post_deprecation_replacement = (
"from airflow.providers.amazon.aws.operators.redshift_cluster import RedshiftDeleteClusterOperator"
)

def __init__(self, *args, **kwargs): # type: ignore[no-untyped-def]
warnings.warn(
(
Expand All @@ -32,6 +37,11 @@ class RedshiftResumeClusterOperatorAsync(RedshiftResumeClusterOperator):
Please use :class: `~airflow.providers.amazon.aws.operators.redshift_cluster.RedshiftResumeClusterOperator`.
"""

is_deprecated = True
post_deprecation_replacement = (
"from airflow.providers.amazon.aws.operators.redshift_cluster import RedshiftResumeClusterOperator"
)

def __init__(self, *args, **kwargs): # type: ignore[no-untyped-def]
warnings.warn(
(
Expand All @@ -51,6 +61,11 @@ class RedshiftPauseClusterOperatorAsync(RedshiftPauseClusterOperator):
Please use :class: `~airflow.providers.amazon.aws.operators.redshift_cluster.RedshiftPauseClusterOperator`.
"""

is_deprecated = True
post_deprecation_replacement = (
"from airflow.providers.amazon.aws.operators.redshift_cluster import RedshiftPauseClusterOperator"
)

def __init__(self, *args, **kwargs): # type: ignore[no-untyped-def]
warnings.warn(
(
Expand Down
5 changes: 5 additions & 0 deletions astronomer/providers/amazon/aws/operators/redshift_data.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ class RedshiftDataOperatorAsync(RedshiftDataOperator):
and set `deferrable` param to `True` instead.
"""

is_deprecated = True
post_deprecation_replacement = (
"from airflow.providers.amazon.aws.operators.redshift_data import RedshiftDataOperator"
)

def __init__(
self,
**kwargs: Any,
Expand Down
15 changes: 15 additions & 0 deletions astronomer/providers/amazon/aws/operators/sagemaker.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ class SageMakerProcessingOperatorAsync(SageMakerProcessingOperator):
and set `deferrable` param to `True` instead.
"""

is_deprecated = True
post_deprecation_replacement = (
"from airflow.providers.amazon.aws.operators.sagemaker import SageMakerProcessingOperator"
)

def __init__(self, **kwargs: Any) -> None:
warnings.warn(
(
Expand All @@ -44,6 +49,11 @@ class SageMakerTransformOperatorAsync(SageMakerTransformOperator):
and set `deferrable` param to `True` instead.
"""

is_deprecated = True
post_deprecation_replacement = (
"from airflow.providers.amazon.aws.operators.sagemaker import SageMakerTransformOperator"
)

def __init__(self, **kwargs: Any) -> None:
warnings.warn(
(
Expand All @@ -64,6 +74,11 @@ class SageMakerTrainingOperatorAsync(SageMakerTrainingOperator):
and set `deferrable` param to `True` instead.
"""

is_deprecated = True
post_deprecation_replacement = (
"from airflow.providers.amazon.aws.operators.sagemaker import SageMakerTrainingOperator"
)

def __init__(self, **kwargs: Any) -> None:
warnings.warn(
(
Expand Down
3 changes: 3 additions & 0 deletions astronomer/providers/amazon/aws/sensors/batch.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ class BatchSensorAsync(BatchSensor):
Please use :class: `~airflow.providers.amazon.aws.sensors.batch.BatchSensor`.
"""

is_deprecated = True
post_deprecation_replacement = "from airflow.providers.amazon.aws.sensors.batch import BatchSensor"

def __init__(self, *args, **kwargs) -> None: # type: ignore[no-untyped-def]
warnings.warn(
(
Expand Down
9 changes: 9 additions & 0 deletions astronomer/providers/amazon/aws/sensors/emr.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ class EmrContainerSensorAsync(EmrContainerSensor):
Please use :class: `~airflow.providers.amazon.aws.sensors.emr.EmrContainerSensor`.
"""

is_deprecated = True
post_deprecation_replacement = "from airflow.providers.amazon.aws.sensors.emr import EmrContainerSensor"

def __init__(self, *args, **kwargs) -> None: # type: ignore[no-untyped-def]
poll_interval = kwargs.pop("poll_interval")
if poll_interval:
Expand Down Expand Up @@ -44,6 +47,9 @@ class EmrStepSensorAsync(EmrStepSensor):
Please use :class: `~airflow.providers.amazon.aws.sensors.emr.EmrStepSensor`.
"""

is_deprecated = True
post_deprecation_replacement = "from airflow.providers.amazon.aws.sensors.emr import EmrStepSensor"

def __init__(self, *args, **kwargs) -> None: # type: ignore[no-untyped-def]
warnings.warn(
(
Expand All @@ -63,6 +69,9 @@ class EmrJobFlowSensorAsync(EmrJobFlowSensor):
Please use :class: `~airflow.providers.amazon.aws.sensors.emr.EmrJobFlowSensor`.
"""

is_deprecated = True
post_deprecation_replacement = "from airflow.providers.amazon.aws.sensors.emr import EmrJobFlowSensor"

def __init__(self, *args, **kwargs) -> None: # type: ignore[no-untyped-def]
warnings.warn(
(
Expand Down
5 changes: 5 additions & 0 deletions astronomer/providers/amazon/aws/sensors/redshift_cluster.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ class RedshiftClusterSensorAsync(RedshiftClusterSensor):
and set `deferrable` param to `True` instead.
"""

is_deprecated = True
post_deprecation_replacement = (
"from airflow.providers.amazon.aws.sensors.redshift_cluster import RedshiftClusterSensor"
)

def __init__(
self,
**kwargs: Any,
Expand Down
20 changes: 16 additions & 4 deletions astronomer/providers/amazon/aws/sensors/s3.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ class S3KeySensorAsync(S3KeySensor):
and set `deferrable` param to `True` instead.
"""

is_deprecated = True
post_deprecation_replacement = "from airflow.providers.amazon.aws.sensors.s3 import S3KeySensor"

def __init__(self, **kwargs: Any) -> None:
warnings.warn(
(
Expand All @@ -30,9 +33,12 @@ def __init__(self, **kwargs: Any) -> None:
class S3KeySizeSensorAsync(S3KeySensorAsync):
"""
This class is deprecated.
Please use :class: `~astronomer.providers.amazon.aws.sensor.s3.S3KeySensorAsync`.
Please use :class: `~airflow.providers.amazon.aws.sensors.s3.S3KeySensor`.
"""

is_deprecated = True
post_deprecation_replacement = "from airflow.providers.amazon.aws.sensors.s3 import S3KeySensor"

def __init__(
self,
*,
Expand All @@ -42,7 +48,7 @@ def __init__(
warnings.warn(
"""
S3KeySizeSensorAsync is deprecated.
Please use `astronomer.providers.amazon.aws.sensor.s3.S3KeySensorAsync`.
Please use `airflow.providers.amazon.aws.sensors.s3.S3KeySensor`.
""",
DeprecationWarning,
stacklevel=2,
Expand All @@ -57,6 +63,9 @@ class S3KeysUnchangedSensorAsync(S3KeysUnchangedSensor):
Please use :class: `~airflow.providers.amazon.aws.sensors.s3.S3KeysUnchangedSensor`.
"""

is_deprecated = True
post_deprecation_replacement = "from airflow.providers.amazon.aws.sensors.s3 import S3KeysUnchangedSensor"

def __init__(self, *args, **kwargs): # type: ignore[no-untyped-def]
warnings.warn(
(
Expand All @@ -73,9 +82,12 @@ def __init__(self, *args, **kwargs): # type: ignore[no-untyped-def]
class S3PrefixSensorAsync(BaseSensorOperator):
"""
This class is deprecated.
Please use :class: `~astronomer.providers.amazon.aws.sensor.s3.S3KeySensorAsync`.
Please use :class: `~airflow.providers.amazon.aws.sensors.s3.S3KeySensor`.
"""

is_deprecated = True
post_deprecation_replacement = "from airflow.providers.amazon.aws.sensors.s3 import S3KeySensor"

def __init__(
self,
*,
Expand All @@ -89,7 +101,7 @@ def __init__(
warnings.warn(
"""
S3PrefixSensor is deprecated.
Please use `astronomer.providers.amazon.aws.sensor.s3.S3KeySensorAsync`.
Please use `airflow.providers.amazon.aws.sensors.s3.S3KeySensor`.
""",
DeprecationWarning,
stacklevel=2,
Expand Down
3 changes: 3 additions & 0 deletions astronomer/providers/apache/livy/operators/livy.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ class LivyOperatorAsync(LivyOperator):
and set `deferrable` param to `True` instead.
"""

is_deprecated = True
post_deprecation_replacement = "from airflow.providers.apache.livy.operators.livy import LivyOperator"

def __init__(self, *args: Any, **kwargs: Any) -> None:
warnings.warn(
"This class is deprecated. "
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ class KubernetesPodOperatorAsync(KubernetesPodOperator):
and set `deferrable` param to `True` instead.
"""

is_deprecated = True
post_deprecation_replacement = (
"from airflow.providers.cncf.kubernetes.operators.pod import KubernetesPodOperator"
)

def __init__(self, **kwargs: Any):
warnings.warn(
(
Expand Down
3 changes: 3 additions & 0 deletions astronomer/providers/core/sensors/external_task.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@


class ExternalTaskSensorAsync(ExternalTaskSensor): # noqa: D101
is_deprecated = True
post_deprecation_replacement = "from airflow.sensors.external_task import ExternalTaskSensor"

def __init__(
self,
poke_interval: float = 5.0,
Expand Down
3 changes: 3 additions & 0 deletions astronomer/providers/core/sensors/filesystem.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ class FileSensorAsync(FileSensor):
``**`` in glob filepath parameter. Defaults to ``False``.
"""

is_deprecated = True
post_deprecation_replacement = "from airflow.sensors.filesystem import FileSensor"

def __init__(self, *args: Any, **kwargs: Any) -> None:
warnings.warn(
(
Expand Down
10 changes: 10 additions & 0 deletions astronomer/providers/databricks/operators/databricks.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ class DatabricksSubmitRunOperatorAsync(DatabricksSubmitRunOperator):
`deferrable` param to `True` instead.
"""

is_deprecated = True
post_deprecation_replacement = (
"from airflow.providers.databricks.operators.databricks import DatabricksSubmitRunOperator"
)

def __init__(self, *args: Any, **kwargs: Any) -> None:
warnings.warn(
"This class is deprecated."
Expand All @@ -32,6 +37,11 @@ class DatabricksRunNowOperatorAsync(DatabricksRunNowOperator):
`deferrable` param to `True` instead.
"""

is_deprecated = True
post_deprecation_replacement = (
"from airflow.providers.databricks.operators.databricks import DatabricksRunNowOperator"
)

def __init__(self, *args: Any, **kwargs: Any) -> None:
warnings.warn(
"This class is deprecated."
Expand Down
5 changes: 5 additions & 0 deletions astronomer/providers/dbt/cloud/operators/dbt.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ class DbtCloudRunJobOperatorAsync(DbtCloudRunJobOperator):
and set `deferrable` param to `True` instead.
"""

is_deprecated = True
post_deprecation_replacement = (
"from airflow.providers.dbt.cloud.operators.dbt import DbtCloudRunJobOperator"
)

def __init__(self, *args: Any, **kwargs: Any) -> None:
warnings.warn(
(
Expand Down
3 changes: 3 additions & 0 deletions astronomer/providers/dbt/cloud/sensors/dbt.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ class DbtCloudJobRunSensorAsync(DbtCloudJobRunSensor):
and set `deferrable` param to `True` instead.
"""

is_deprecated = True
post_deprecation_replacement = "from airflow.providers.dbt.cloud.sensors import DbtCloudJobRunSensor"

def __init__(self, *args: Any, **kwargs: Any) -> None:
warnings.warn(
(
Expand Down
15 changes: 15 additions & 0 deletions astronomer/providers/google/cloud/operators/bigquery.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ class BigQueryInsertJobOperatorAsync(BigQueryInsertJobOperator):
and set `deferrable` param to `True` instead.
"""

is_deprecated = True
post_deprecation_replacement = "from google.cloud.operators.bigquery import BigQueryInsertJobOperator"

def __init__(self, *args: Any, **kwargs: Any) -> None:
warnings.warn(
(
Expand All @@ -45,6 +48,9 @@ class BigQueryCheckOperatorAsync(BigQueryCheckOperator):
and set `deferrable` param to `True` instead.
"""

is_deprecated = True
post_deprecation_replacement = "from google.cloud.operators.bigquery import BigQueryCheckOperator"

def __init__(self, *args: Any, **kwargs: Any) -> None:
warnings.warn(
(
Expand All @@ -65,6 +71,9 @@ class BigQueryGetDataOperatorAsync(BigQueryGetDataOperator):
and set `deferrable` param to `True` instead.
"""

is_deprecated = True
post_deprecation_replacement = "from google.cloud.operators.bigquery import BigQueryGetDataOperator"

def __init__(self, *args: Any, use_legacy_sql: bool = False, **kwargs: Any) -> None:
warnings.warn(
(
Expand All @@ -86,6 +95,9 @@ class BigQueryIntervalCheckOperatorAsync(BigQueryIntervalCheckOperator):
and set `deferrable` param to `True` instead.
"""

is_deprecated = True
post_deprecation_replacement = "from google.cloud.operators.bigquery import BigQueryIntervalCheckOperator"

def __init__(self, *args: Any, **kwargs: Any) -> None:
warnings.warn(
(
Expand All @@ -106,6 +118,9 @@ class BigQueryValueCheckOperatorAsync(BigQueryValueCheckOperator):
and set `deferrable` param to `True` instead.
"""

is_deprecated = True
post_deprecation_replacement = "from google.cloud.operators.bigquery import BigQueryValueCheckOperator"

def __init__(self, *args: Any, **kwargs: Any) -> None:
warnings.warn(
(
Expand Down
Loading

0 comments on commit 0fb130f

Please sign in to comment.