make AsdfExtension private

asdf/_tests/_helpers.py

@@ -412,7 +412,7 @@ def assert_extension_correctness(extension):
 
     Parameters
     ----------
-    extension : asdf.AsdfExtension
+    extension : asdf._AsdfExtension
         The extension to validate
     """
     __tracebackhide__ = True

asdf/_tests/test_extension.py

@@ -17,7 +17,7 @@
     Validator,
     get_cached_extension_manager,
 )
-from asdf.extension._legacy import AsdfExtension, BuiltinExtension, get_cached_asdf_extension_list
+from asdf.extension._legacy import BuiltinExtension, _AsdfExtension, get_cached_asdf_extension_list
 
 
 def test_builtin_extension():
@@ -172,7 +172,7 @@ def test_extension_proxy():
     proxy = ExtensionProxy(extension)
 
     assert isinstance(proxy, Extension)
-    assert isinstance(proxy, AsdfExtension)
+    assert isinstance(proxy, _AsdfExtension)
 
     assert proxy.extension_uri == "asdf://somewhere.org/extensions/minimum-1.0"
     assert proxy.legacy_class_names == set()

asdf/asdf.py

@@ -359,7 +359,7 @@ def _process_user_extensions(self, extensions):
         """
         if extensions is None:
             extensions = []
-        elif isinstance(extensions, (_legacy.AsdfExtension, Extension, ExtensionProxy)):
+        elif isinstance(extensions, (_legacy._AsdfExtension, Extension, ExtensionProxy)):
             extensions = [extensions]
         elif isinstance(extensions, _legacy.AsdfExtensionList):
             extensions = extensions.extensions

asdf/config.py

@@ -156,7 +156,7 @@ def add_extension(self, extension):
 
         Parameters
         ----------
-        extension : asdf.extension.AsdfExtension or asdf.extension.Extension
+        extension : asdf.extension.Extension
         """
         with self._lock:
             extension = ExtensionProxy.maybe_wrap(extension)
@@ -168,7 +168,7 @@ def remove_extension(self, extension=None, *, package=None):
 
         Parameters
         ----------
-        extension : asdf.extension.AsdfExtension or asdf.extension.Extension or str, optional
+        extension : asdf.extension.Extension or str, optional
             An extension instance or URI pattern to remove.
         package : str, optional
             Remove only extensions provided by this package.  If the ``extension``

asdf/extension/_extension.py

@@ -6,7 +6,7 @@
 
 from ._compressor import Compressor
 from ._converter import ConverterProxy
-from ._legacy import AsdfExtension
+from ._legacy import _AsdfExtension
 from ._tag import TagDefinition
 from ._validator import Validator
 
@@ -131,7 +131,7 @@ def validators(self):
         return []
 
 
-class ExtensionProxy(Extension, AsdfExtension):
+class ExtensionProxy(Extension, _AsdfExtension):
     """
     Proxy that wraps an extension, provides default implementations
     of optional methods, and carries additional information on the
@@ -146,7 +146,7 @@ def maybe_wrap(cls, delegate):
         return ExtensionProxy(delegate)
 
     def __init__(self, delegate, package_name=None, package_version=None):
-        if not isinstance(delegate, (Extension, AsdfExtension)):
+        if not isinstance(delegate, (Extension, _AsdfExtension)):
             msg = "Extension must implement the Extension or AsdfExtension interface"
             raise TypeError(msg)
 
@@ -156,7 +156,7 @@ def __init__(self, delegate, package_name=None, package_version=None):
 
         self._class_name = get_class_name(delegate)
 
-        self._legacy = isinstance(delegate, AsdfExtension)
+        self._legacy = isinstance(delegate, _AsdfExtension)
 
         # Sort these out up-front so that errors are raised when the extension is loaded
         # and not in the middle of the user's session.  The extension will fail to load
@@ -367,7 +367,7 @@ def class_name(self):
     @property
     def legacy(self):
         """
-        Get the extension's legacy flag.  Subclasses of ``asdf.extension.AsdfExtension``
+        Get the extension's legacy flag.  Subclasses of ``asdf.extension._AsdfExtension``
         are marked `True`.
 
         Returns

asdf/extension/_legacy.py

@@ -7,18 +7,18 @@
 from asdf._type_index import AsdfTypeIndex
 from asdf.exceptions import AsdfDeprecationWarning
 
-__all__ = ["AsdfExtension"]
+__all__ = ["_AsdfExtension"]
 
 
-class AsdfExtension(metaclass=abc.ABCMeta):
+class _AsdfExtension(metaclass=abc.ABCMeta):
     """
     Abstract base class defining a (legacy) extension to ASDF.
     New code should use `asdf.extension.Extension` instead.
     """
 
     @classmethod
     def __subclasshook__(cls, class_):
-        if cls is AsdfExtension:
+        if cls is _AsdfExtension:
             return hasattr(class_, "types") and hasattr(class_, "tag_mapping")
         return NotImplemented
 
@@ -173,7 +173,7 @@ def get_cached_asdf_extension_list(extensions):
 
     Parameters
     ----------
-    extensions : list of asdf.extension.AsdfExtension
+    extensions : list of asdf.extension._AsdfExtension
 
     Returns
     -------