Actually deprecate trio.__version__

python-trio · Jan 21, 2025 · cb3de6a · cb3de6a
1 parent feeea39
commit cb3de6a
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/newsfragments/3190.deprecated.rst b/newsfragments/3190.deprecated.rst
@@ -0,0 +1 @@
+Deprecate ``trio.__version__`` in favor of `importlib.metadata.version`.
diff --git a/src/trio/__init__.py b/src/trio/__init__.py
@@ -104,7 +104,7 @@
     sleep_forever as sleep_forever,
     sleep_until as sleep_until,
 )
-from ._version import __version__ as __version__
+from ._version import __version__ as trio_version
 
 # Not imported by default, but mentioned here so static analysis tools like
 # pylint will know that it exists.
@@ -117,7 +117,7 @@
 
 __deprecated_attributes__: dict[str, _deprecate.DeprecatedAttribute] = {
     "__version__": _deprecate.DeprecatedAttribute(
-        __version__, "0.29.0", issue=None, instead='importlib.metadata.version("trio")'
+        trio_version, "0.29.0", issue=None, instead='importlib.metadata.version("trio")'
     )
 }
 

diff --git a/src/trio/_tests/test_trio.py b/src/trio/_tests/test_trio.py
@@ -6,3 +6,12 @@ def test_trio_import() -> None:
             del sys.modules[module]
 
     import trio  # noqa: F401
+
+
+def test_trio_version_deprecated() -> None:
+    import pytest
+
+    import trio
+
+    with pytest.warns(DeprecationWarning, match="^trio.__version__ is deprecated"):
+        _ = trio.__version__
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Deprecate ``trio.__version__`` in favor of `importlib.metadata.version`.