__qiskit_version__ deprecation #10242

1ucian0 · 2023-06-07T15:08:35Z

This PR deprecates qiskit.__qiskit_version__ in favor of qiskit.__version__

The %qiskit_version_table now does not depend on qiskit.__qiskit_version__. I also extended to list in the table all the modules/packages that include the word qiskit to have this output:

qiskit-bot · 2023-06-07T15:08:38Z

One or more of the the following people are requested to review this:

@Qiskit/terra-core

coveralls · 2023-06-10T19:55:43Z

Pull Request Test Coverage Report for Build 5604152404

4 of 19 (21.05%) changed or added relevant lines in 2 files are covered.
22 unchanged lines in 2 files lost coverage.
Overall coverage decreased (-0.03%) to 86.054%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
qiskit/tools/jupyter/version_table.py	0	15	0.0%

Files with Coverage Reduction	New Missed Lines	%
crates/qasm2/src/lex.rs	4	91.14%
crates/qasm2/src/parse.rs	18	96.65%

Totals
Change from base Build 5603596398:	-0.03%
Covered Lines:	72611
Relevant Lines:	84378

💛 - Coveralls

mtreinish

Overall I'm fine with this, it's a little weird to do the packages with qiskit in the name like that for the magic. But since it's isolated to just the widget it's a reasonable tradeoff for people that like the table in notebooks. Just a couple small inline comments.

mtreinish · 2023-07-12T14:03:02Z

qiskit/tools/jupyter/version_table.py

@@ -14,6 +14,8 @@
 """A module for monitoring backends."""

 import time
+from sys import modules
+from collections import OrderedDict


Do you need an ordered dict? For all our supported versions of Python all dicts are insertion ordered now.

Fixed in d0d8588

mtreinish · 2023-07-12T14:06:26Z

qiskit/version.py

+        warnings.warn(
+            "qiskit.__qiskit_version__ is deprecated since "
+            "Qiskit Terra 0.25.0, and will be removed 3 months or more later. "
+            "Instead, you should use qiskit.__version__.",


You might want to mention that for other packages that used to be in __qiskit_version__ those packages should have a __version__ attribute too.

good point. done in a846ffe

mtreinish · 2023-07-12T14:07:00Z

releasenotes/notes/qiskit_version-956916f7b8d7bbb9.yaml

+    The magic ``%qiskit_version_table`` from ``qiskit.tools.jupyter`` now includes all
+    the modules with ``'qiskit`` in the name.


Maybe say "all imported packages with qiskit in the name"?

reworded in bab5901

qiskit/tools/jupyter/version_table.py

mtreinish · 2023-07-13T19:51:35Z

qiskit/tools/jupyter/version_table.py

+        qiskit_modules = {module.split(".")[0] for module in modules.keys() if "qiskit" in module}
+        for qiskit_module in qiskit_modules:
+            try:
+                packages[metadata(qiskit_module)["Name"]] = metadata(qiskit_module)["Version"]
+            except PackageNotFoundError:
+                packages["qiskit"] = None


Looking at this with fresh eyes my concern here is that the module name in sys.modules isn't necessarily going to be the package name that importlib.metadata will find. The best example of this is actually qiskit, if you just have terra installed you would need to call metadata("qiskit-terra") not metadata("qiskit") to get the installed package version for the qiskit module in sys.modules.

I think it might be better to do:

Suggested change

qiskit_modules = {module.split(".")[0] for module in modules.keys() if "qiskit" in module}

for qiskit_module in qiskit_modules:

try:

packages[metadata(qiskit_module)["Name"]] = metadata(qiskit_module)["Version"]

except PackageNotFoundError:

packages["qiskit"] = None

qiskit_modules = {module.split(".")[0] for module in modules.keys() if "qiskit" in module}

for qiskit_module in qiskit_modules:

packages[qiskit_module] = getattr(sys.modules[qiskit_module], "__version__", None)

so it just uses the version reported in the __version__ attribute.

mtreinish · 2023-07-13T19:52:12Z

qiskit/tools/jupyter/version_table.py

+        qiskit_modules = {module.split(".")[0] for module in modules.keys() if "qiskit" in module}
+        for qiskit_module in qiskit_modules:
+            try:
+                packages[metadata(qiskit_module)["Name"]] = metadata(qiskit_module)["Version"]
+            except PackageNotFoundError:
+                packages["qiskit"] = None


This should probably be qiskit_module right, because if a version can't be found for qiskit_module you don't want to invalidate the qiskit package versio.

Co-authored-by: Matthew Treinish <[email protected]>

qiskit/tools/jupyter/version_table.py

mtreinish

LGTM, thanks for the update

qiskit/version.py

One more comment

qiskit-bot · 2023-07-19T21:13:08Z

One or more of the the following people are requested to review this:

@Qiskit/terra-core

* __qiskit_version__ deprecation * reno * reno feature * PackageNotFoundError * revert stacklevel=2 * revert change in test * remove OrderedDict * other qiskit.__qiskit_version__ packages have their own __version__ * wording in the reno * lint * Update qiskit/tools/jupyter/version_table.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/tools/jupyter/version_table.py * Restore removed version checks --------- Co-authored-by: Matthew Treinish <[email protected]>

1ucian0 added 2 commits June 7, 2023 17:03

__qiskit_version__ deprecation

3b97cf3

reno

251c13b

1ucian0 requested review from a team and woodsp-ibm as code owners June 7, 2023 15:08

1ucian0 added 5 commits June 7, 2023 17:13

reno feature

2100746

Merge branch 'main' of github.com:Qiskit/qiskit-terra into fixes/9753/1

c527232

PackageNotFoundError

d30025c

revert stacklevel=2

6764115

revert change in test

db99e1d

1ucian0 added the priority: high label Jun 12, 2023

1ucian0 added this to the 0.25.0 milestone Jun 12, 2023

1ucian0 assigned mtreinish Jun 22, 2023

mtreinish reviewed Jul 12, 2023

View reviewed changes

1ucian0 added 4 commits July 13, 2023 10:28

Merge branch 'main' of github.com:Qiskit/qiskit-terra into fixes/9753/1

c32a965

remove OrderedDict

d0d8588

other qiskit.__qiskit_version__ packages have their own __version__

a846ffe

wording in the reno

bab5901

1ucian0 mentioned this pull request Jul 13, 2023

qiskit-terra == qiskit, in version libraries #10425

Merged

lint

51aa73a

mtreinish added the Changelog: Deprecation Include in "Deprecated" section of changelog label Jul 13, 2023

mtreinish reviewed Jul 13, 2023

View reviewed changes

Update qiskit/tools/jupyter/version_table.py

783ef27

Co-authored-by: Matthew Treinish <[email protected]>

mtreinish reviewed Jul 18, 2023

View reviewed changes

qiskit/tools/jupyter/version_table.py Outdated Show resolved Hide resolved

Update qiskit/tools/jupyter/version_table.py

2fa746e

mtreinish previously approved these changes Jul 18, 2023

View reviewed changes

mtreinish enabled auto-merge July 18, 2023 19:00

mtreinish disabled auto-merge July 18, 2023 19:02

mtreinish reviewed Jul 18, 2023

View reviewed changes

qiskit/version.py Outdated Show resolved Hide resolved

1ucian0 marked this pull request as draft July 19, 2023 11:28

mtreinish added 2 commits July 19, 2023 17:09

Merge remote-tracking branch 'origin/main' into fixes/9753/1

ef07de4

Restore removed version checks

3d39cdb

mtreinish approved these changes Jul 19, 2023

View reviewed changes

mtreinish marked this pull request as ready for review July 19, 2023 21:13

mtreinish enabled auto-merge July 19, 2023 21:13

mtreinish added this pull request to the merge queue Jul 19, 2023

Merged via the queue into Qiskit:main with commit d97f805 Jul 20, 2023

1ucian0 mentioned this pull request Jul 20, 2023

Improve %qiskit_version_table Jupyter magic #10452

Merged

1ucian0 deleted the fixes/9753/1 branch July 24, 2023 11:23

mtreinish mentioned this pull request Aug 10, 2023

Update Jupyter Version Table #10608

Closed

jakelishman mentioned this pull request Aug 22, 2023

Fix warning on __qiskit_version__ #10686

Merged

1ucian0 mentioned this pull request Nov 23, 2023

Remove __qiskit_version__ (deprecated in Qiskit Terra 0.25) #11305

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

__qiskit_version__ deprecation #10242

__qiskit_version__ deprecation #10242

1ucian0 commented Jun 7, 2023 •

edited

Loading

qiskit-bot commented Jun 7, 2023

coveralls commented Jun 10, 2023 •

edited

Loading

mtreinish left a comment

mtreinish Jul 12, 2023

1ucian0 Jul 13, 2023 •

edited

Loading

mtreinish Jul 12, 2023

1ucian0 Jul 13, 2023 •

edited

Loading

mtreinish Jul 12, 2023

1ucian0 Jul 13, 2023 •

edited

Loading

mtreinish Jul 13, 2023

mtreinish Jul 13, 2023

mtreinish left a comment

qiskit-bot commented Jul 19, 2023

		The magic ``%qiskit_version_table`` from ``qiskit.tools.jupyter`` now includes all
		the modules with ``'qiskit`` in the name.

__qiskit_version__ deprecation #10242

__qiskit_version__ deprecation #10242

Conversation

1ucian0 commented Jun 7, 2023 • edited Loading

qiskit-bot commented Jun 7, 2023

coveralls commented Jun 10, 2023 • edited Loading

Pull Request Test Coverage Report for Build 5604152404

💛 - Coveralls

mtreinish left a comment

Choose a reason for hiding this comment

mtreinish Jul 12, 2023

Choose a reason for hiding this comment

1ucian0 Jul 13, 2023 • edited Loading

Choose a reason for hiding this comment

mtreinish Jul 12, 2023

Choose a reason for hiding this comment

1ucian0 Jul 13, 2023 • edited Loading

Choose a reason for hiding this comment

mtreinish Jul 12, 2023

Choose a reason for hiding this comment

1ucian0 Jul 13, 2023 • edited Loading

Choose a reason for hiding this comment

mtreinish Jul 13, 2023

Choose a reason for hiding this comment

mtreinish Jul 13, 2023

Choose a reason for hiding this comment

mtreinish left a comment

Choose a reason for hiding this comment

qiskit-bot commented Jul 19, 2023

1ucian0 commented Jun 7, 2023 •

edited

Loading

coveralls commented Jun 10, 2023 •

edited

Loading

1ucian0 Jul 13, 2023 •

edited

Loading

1ucian0 Jul 13, 2023 •

edited

Loading

1ucian0 Jul 13, 2023 •

edited

Loading