Skip to content

Commit cb3de6a

Browse files
committed
Actually deprecate trio.__version__
1 parent feeea39 commit cb3de6a

3 files changed

Lines changed: 12 additions & 2 deletions

File tree

newsfragments/3190.deprecated.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Deprecate ``trio.__version__`` in favor of `importlib.metadata.version`.

src/trio/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@
104104
sleep_forever as sleep_forever,
105105
sleep_until as sleep_until,
106106
)
107-
from ._version import __version__ as __version__
107+
from ._version import __version__ as trio_version
108108

109109
# Not imported by default, but mentioned here so static analysis tools like
110110
# pylint will know that it exists.
@@ -117,7 +117,7 @@
117117

118118
__deprecated_attributes__: dict[str, _deprecate.DeprecatedAttribute] = {
119119
"__version__": _deprecate.DeprecatedAttribute(
120-
__version__, "0.29.0", issue=None, instead='importlib.metadata.version("trio")'
120+
trio_version, "0.29.0", issue=None, instead='importlib.metadata.version("trio")'
121121
)
122122
}
123123

src/trio/_tests/test_trio.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,12 @@ def test_trio_import() -> None:
66
del sys.modules[module]
77

88
import trio # noqa: F401
9+
10+
11+
def test_trio_version_deprecated() -> None:
12+
import pytest
13+
14+
import trio
15+
16+
with pytest.warns(DeprecationWarning, match="^trio.__version__ is deprecated"):
17+
_ = trio.__version__

0 commit comments

Comments
 (0)