This is an automated email from the ASF dual-hosted git repository.
husseinawala pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 68e9e0e440 Add deprecation info to the Airflow modules and classes
docstring (#32635)
68e9e0e440 is described below
commit 68e9e0e440c19479996f79b81395289f402b7b25
Author: Hussein Awala <[email protected]>
AuthorDate: Tue Jul 18 23:54:48 2023 +0200
Add deprecation info to the Airflow modules and classes docstring (#32635)
---
airflow/api/common/experimental/delete_dag.py | 1 +
airflow/api/common/experimental/mark_tasks.py | 2 +-
airflow/api/common/experimental/trigger_dag.py | 1 +
airflow/contrib/secrets/__init__.py | 2 +-
airflow/contrib/task_runner/__init__.py | 2 +-
airflow/contrib/utils/__init__.py | 2 +-
airflow/contrib/utils/log/__init__.py | 2 +-
airflow/hooks/dbapi.py | 1 +
airflow/operators/subdag.py | 4 ++--
9 files changed, 10 insertions(+), 7 deletions(-)
diff --git a/airflow/api/common/experimental/delete_dag.py
b/airflow/api/common/experimental/delete_dag.py
index 821b80aa9a..42dd8a9048 100644
--- a/airflow/api/common/experimental/delete_dag.py
+++ b/airflow/api/common/experimental/delete_dag.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.api.common.delete_dag`
instead."""
from __future__ import annotations
import warnings
diff --git a/airflow/api/common/experimental/mark_tasks.py
b/airflow/api/common/experimental/mark_tasks.py
index 303c9f98ee..7341e00934 100644
--- a/airflow/api/common/experimental/mark_tasks.py
+++ b/airflow/api/common/experimental/mark_tasks.py
@@ -15,7 +15,7 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-"""Task Instance APIs."""
+"""Task Instance APIs. This module is deprecated. Please use
:mod:`airflow.api.common.mark_tasks` instead."""
from __future__ import annotations
import warnings
diff --git a/airflow/api/common/experimental/trigger_dag.py
b/airflow/api/common/experimental/trigger_dag.py
index 123b09cb1c..4bcbf11fcb 100644
--- a/airflow/api/common/experimental/trigger_dag.py
+++ b/airflow/api/common/experimental/trigger_dag.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.api.common.trigger_dag`
instead."""
from __future__ import annotations
import warnings
diff --git a/airflow/contrib/secrets/__init__.py
b/airflow/contrib/secrets/__init__.py
index 9e2b4c74ab..72df9f6543 100644
--- a/airflow/contrib/secrets/__init__.py
+++ b/airflow/contrib/secrets/__init__.py
@@ -15,7 +15,7 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-"""This package is deprecated. Please use `airflow.secrets` or
`airflow.providers.*.secrets`."""
+"""This package is deprecated. Please use :mod:`airflow.secrets` or
`airflow.providers.*.secrets`."""
from __future__ import annotations
import warnings
diff --git a/airflow/contrib/task_runner/__init__.py
b/airflow/contrib/task_runner/__init__.py
index 82bd6bf041..d956469e0c 100644
--- a/airflow/contrib/task_runner/__init__.py
+++ b/airflow/contrib/task_runner/__init__.py
@@ -15,7 +15,7 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-"""This package is deprecated. Please use `airflow.task.task_runner`."""
+"""This package is deprecated. Please use :mod:`airflow.task.task_runner`."""
from __future__ import annotations
import warnings
diff --git a/airflow/contrib/utils/__init__.py
b/airflow/contrib/utils/__init__.py
index 4057f36868..0facd9b77c 100644
--- a/airflow/contrib/utils/__init__.py
+++ b/airflow/contrib/utils/__init__.py
@@ -15,7 +15,7 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-"""This package is deprecated. Please use `airflow.utils`."""
+"""This package is deprecated. Please use :mod:`airflow.utils`."""
from __future__ import annotations
import warnings
diff --git a/airflow/contrib/utils/log/__init__.py
b/airflow/contrib/utils/log/__init__.py
index baf3a48185..e4a188cf0f 100644
--- a/airflow/contrib/utils/log/__init__.py
+++ b/airflow/contrib/utils/log/__init__.py
@@ -14,7 +14,7 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-"""This package is deprecated. Please use `airflow.utils.log`."""
+"""This package is deprecated. Please use :mod:`airflow.utils.log`."""
from __future__ import annotations
import warnings
diff --git a/airflow/hooks/dbapi.py b/airflow/hooks/dbapi.py
index b4cd1be667..f3f28c40e0 100644
--- a/airflow/hooks/dbapi.py
+++ b/airflow/hooks/dbapi.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.common.sql.hooks.sql`."""
from __future__ import annotations
import warnings
diff --git a/airflow/operators/subdag.py b/airflow/operators/subdag.py
index 0f242c09f3..680497217d 100644
--- a/airflow/operators/subdag.py
+++ b/airflow/operators/subdag.py
@@ -16,7 +16,7 @@
# specific language governing permissions and limitations
# under the License.
"""
-This module is deprecated, please use :mod:`airflow.utils.task_group`.
+This module is deprecated. Please use :mod:`airflow.utils.task_group`.
The module which provides a way to nest your DAGs and so your levels of
complexity.
"""
@@ -50,7 +50,7 @@ class SkippedStatePropagationOptions(Enum):
class SubDagOperator(BaseSensorOperator):
"""
- This class is deprecated, please use `airflow.utils.task_group.TaskGroup`.
+ This class is deprecated, please use
:class:`airflow.utils.task_group.TaskGroup`.
This runs a sub dag. By convention, a sub dag's dag_id
should be prefixed by its parent and a dot. As in `parent.child`.
