Merge pull request #1440 from braingram/deprecate/tests_helpers

deprecate asdf.tests.helpers
asdf-format · Feb 23, 2023 · 81ab02d · 81ab02d
2 parents effb92a + f8bc027
commit 81ab02d
Show file tree

Hide file tree

Showing 35 changed files with 569 additions and 520 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -33,6 +33,7 @@ The ASDF Standard is at v1.6.0
 - move asdf.types.format_tag to asdf.testing.helpers.format_tag [#1433]
 - Deprecate AsdfExtenion, AsdfExtensionList, BuiltinExtension [#1429]
 - Add AsdfDeprecationWarning to asdf_extensions entry point [#1361]
+- Deprecate asdf.tests.helpers [#1440]
 
 2.14.3 (2022-12-15)
 -------------------

diff --git a/asdf/commands/tests/test_defragment.py b/asdf/commands/tests/test_defragment.py
@@ -6,7 +6,7 @@
 import asdf
 from asdf import AsdfFile
 from asdf.commands import main
-from asdf.tests.helpers import assert_tree_match, get_file_sizes
+from asdf.tests._helpers import assert_tree_match, get_file_sizes
 
 
 def _test_defragment(tmpdir, codec):

diff --git a/asdf/commands/tests/test_diff.py b/asdf/commands/tests/test_diff.py
@@ -4,7 +4,7 @@
 import pytest
 
 from asdf.commands import diff, main
-from asdf.tests import helpers
+from asdf.tests import _helpers as helpers
 
 from . import data as test_data
 

diff --git a/asdf/commands/tests/test_exploded.py b/asdf/commands/tests/test_exploded.py
@@ -5,7 +5,7 @@
 import asdf
 from asdf import AsdfFile
 from asdf.commands import main
-from asdf.tests.helpers import assert_tree_match, get_file_sizes
+from asdf.tests._helpers import assert_tree_match, get_file_sizes
 
 
 def test_explode_then_implode(tmpdir):

diff --git a/asdf/commands/tests/test_extract.py b/asdf/commands/tests/test_extract.py
@@ -14,7 +14,7 @@
         del sys.modules["asdf.fits_embed"]
     import asdf.fits_embed
 
-from asdf.tests.helpers import assert_tree_match
+from asdf.tests._helpers import assert_tree_match
 
 
 def test_extract(tmpdir):

diff --git a/asdf/commands/tests/test_info.py b/asdf/commands/tests/test_info.py
@@ -3,7 +3,7 @@
 import pytest
 
 from asdf.commands import main
-from asdf.tests import helpers
+from asdf.tests import _helpers as helpers
 
 from . import data as test_data
 

diff --git a/asdf/commands/tests/test_to_yaml.py b/asdf/commands/tests/test_to_yaml.py
@@ -5,7 +5,7 @@
 import asdf
 from asdf import AsdfFile
 from asdf.commands import main
-from asdf.tests.helpers import assert_tree_match, get_file_sizes
+from asdf.tests._helpers import assert_tree_match, get_file_sizes
 
 
 def test_to_yaml(tmpdir):

diff --git a/asdf/conftest.py b/asdf/conftest.py
@@ -7,7 +7,7 @@
 
 from asdf.tests.httpserver import HTTPServer, RangeHTTPServer
 
-collect_ignore = ["asdftypes.py", "fits_embed.py", "resolver.py", "type_index.py", "types.py"]
+collect_ignore = ["asdftypes.py", "fits_embed.py", "resolver.py", "type_index.py", "types.py", "tests/helpers.py"]
 
 
 @pytest.fixture()

diff --git a/asdf/entry_points.py b/asdf/entry_points.py
@@ -80,14 +80,18 @@ def _handle_error(e):
                             category=AsdfDeprecationWarning,
                             message="BuiltinExtension is deprecated",
                         )
+                        warnings.filterwarnings(
+                            "ignore",
+                            category=AsdfDeprecationWarning,
+                            message="asdf.tests.helpers is deprecated",
+                        )
                     elif entry_point.name != "builtin":
                         warnings.warn(
                             f"{package_name} uses the deprecated entry point {LEGACY_EXTENSIONS_GROUP}. "
                             f"Please use the new extension api and entry point {EXTENSIONS_GROUP}: "
                             "https://asdf.readthedocs.io/en/stable/asdf/extending/extensions.html",
                             AsdfDeprecationWarning,
                         )
-
                 elements = entry_point.load()()
 
         except Exception as e:  # noqa: BLE001

diff --git a/asdf/tags/core/tests/test_complex.py b/asdf/tags/core/tests/test_complex.py
@@ -3,7 +3,7 @@
 import pytest
 
 import asdf
-from asdf.tests import helpers
+from asdf.tests import _helpers as helpers
 
 
 def make_complex_asdf(string):

diff --git a/asdf/tags/core/tests/test_extension_metadata.py b/asdf/tags/core/tests/test_extension_metadata.py
@@ -1,5 +1,5 @@
 import asdf
-from asdf.tests import helpers
+from asdf.tests import _helpers as helpers
 
 
 def test_extra_properties():

diff --git a/asdf/tags/core/tests/test_external_reference.py b/asdf/tags/core/tests/test_external_reference.py
@@ -1,5 +1,5 @@
 from asdf.tags.core.external_reference import ExternalArrayReference
-from asdf.tests import helpers
+from asdf.tests import _helpers as helpers
 
 
 def test_roundtrip_external_array(tmpdir):

diff --git a/asdf/tags/core/tests/test_history.py b/asdf/tags/core/tests/test_history.py
@@ -10,8 +10,8 @@
 from asdf import util
 from asdf.exceptions import AsdfDeprecationWarning, AsdfWarning
 from asdf.tags.core import HistoryEntry
-from asdf.tests import helpers
-from asdf.tests.helpers import assert_no_warnings, yaml_to_asdf
+from asdf.tests import _helpers as helpers
+from asdf.tests._helpers import assert_no_warnings, yaml_to_asdf
 
 SCHEMA_PATH = os.path.join(os.path.dirname(helpers.__file__), "data")
 

diff --git a/asdf/tags/core/tests/test_integer.py b/asdf/tags/core/tests/test_integer.py
@@ -4,7 +4,7 @@
 
 import asdf
 from asdf import IntegerType
-from asdf.tests import helpers
+from asdf.tests import _helpers as helpers
 
 # Make sure tests are deterministic
 random.seed(0)

diff --git a/asdf/tags/core/tests/test_ndarray.py b/asdf/tags/core/tests/test_ndarray.py
@@ -14,7 +14,7 @@
 from asdf import util
 from asdf.exceptions import AsdfDeprecationWarning
 from asdf.tags.core import ndarray
-from asdf.tests import helpers
+from asdf.tests import _helpers as helpers
 from asdf.tests.objects import CustomTestType
 
 from . import data as test_data