[GitHub] [airflow] ashb commented on a change in pull request #16617: Rename test_cycle to check_cycle

[GitBox <gi...@apache.org>]

ashb commented on a change in pull request #16617:
URL: https://github.com/apache/airflow/pull/16617#discussion_r657794512



##########
File path: airflow/utils/dag_cycle_tester.py
##########
@@ -25,6 +25,17 @@
 
 
 def test_cycle(dag):
+    """
+    A wrapper function of `check_cycle` for backward compatibility purpose.
+    New code should use `check_cycle` instead since this function name `test_cycle` starts with 'test_' and
+    will be considered as a unit test by pytest, resulting in failure.
+    """
+    from warnings import warn
+    warn("Deprecated, please use `check_cycle` at the same module instead.", DeprecationWarning)

Review comment:
       ```suggestion
       warn(
           "Deprecated, please use `check_cycle` at the same module instead.",
           DeprecationWarning,
           stacklevel=2,
       )
   ```




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