make import_optional_dependency private

mscheltienne · Mar 3, 2023 · 1511cbc · 1511cbc
1 parent 806777b
commit 1511cbc
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/template/utils/_imports.py b/template/utils/_imports.py
@@ -17,7 +17,7 @@
 }
 
 
-def import_optional_dependency(
+def _import_optional_dependency(
     name: str,
     extra: str = "",
     raise_error: bool = True,

diff --git a/template/utils/tests/test_imports.py b/template/utils/tests/test_imports.py
@@ -2,23 +2,23 @@
 
 import pytest
 
-from .._imports import import_optional_dependency
+from .._imports import _import_optional_dependency
 
 
 def test_import_optional_dependency():
     """Test the import of optional dependencies."""
     # Test import of present package
-    numpy = import_optional_dependency("numpy")
+    numpy = _import_optional_dependency("numpy")
     assert isinstance(numpy.__version__, str)
 
     # Test import of absent package
     with pytest.raises(ImportError, match="Missing optional dependency"):
-        import_optional_dependency("non_existing_pkg", raise_error=True)
+        _import_optional_dependency("non_existing_pkg", raise_error=True)
 
     # Test import of absent package without raise
-    pkg = import_optional_dependency("non_existing_pkg", raise_error=False)
+    pkg = _import_optional_dependency("non_existing_pkg", raise_error=False)
     assert pkg is None
 
     # Test extra
     with pytest.raises(ImportError, match="blabla"):
-        import_optional_dependency("non_existing_pkg", extra="blabla")
+        _import_optional_dependency("non_existing_pkg", extra="blabla")