Move Aer to its own package #1526

mtreinish · 2022-05-31T11:52:49Z

Summary

Namespace packages are constant source of problems for users. The python
packaging ecosystem around splitting packages across namespaces is
fragile at the best of times and can often leave a you with an
environment that isn't recoverable (especially when mixing install
methods). There is also a performance hit whenever there is a piece of
the namespace we allow external packages to extend since it requires
doing a full python path search which can be slow depending on the
backing I/O and the number of paths in sys.path for an environment. This
commit addresses the piece from the aer perspective by moving
qiskit.providers.aer to it's own package and namespace 'qiskit_aer'.

This is coupled with a custom namespace module that implements a
custom import loader at the root of the namespace. This has 2 advantages
it removes the use of namespace packages so the fragility and
performance impact are fixed since every element will be renamed to use
'qiskit_' instead of 'qiskit.' (aer being the only one remaining).

This is the second attempt at doing this namespace rename, the first
failed attempt in #840 was trying to migrate all the former qiskit
elements at the same time and was too difficult to migrate everything at
once without causing breaking api changes. This commit is mechanically
the same (renaming qiskit.providers.aer -> qiskit_aer), but how it
integrates with qiskit-terra is changed. With Qiskit/qiskit#5089
qiskit-terra, the
package which owns the 'qiskit.*' namespace, adds a metaimporter that
will redirect imports from qiskit.providers.aer to qiskit_aer. This
means before we can merge this commit Qiskit/qiskit#5089 will need
to be released first to ensure that for backwards compatibility existing
users will be able to access aer from the old namespace.

Details and comments

Depends on: Qiskit/qiskit#5089
Fixes Qiskit/qiskit#559

jakelishman

This looks like it works right to me, and both git and the build process seem to correctly locate all files. I couldn't find any instances of qiskit.providers.aer (other than in the release notes) too, and the changes look mostly easy and mechanical.

I had a couple of comments about stuff that's orthogonal to this PR and doesn't need to be in scope, and one about version requirements on Terra to support the swap.

MANIFEST.in

jakelishman · 2022-05-31T13:44:09Z

setup.py

-if not hasattr(setuptools,
-               'find_namespace_packages') or not inspect.ismethod(
-                    setuptools.find_namespace_packages):
-    print("Your setuptools version:'{}' does not support PEP 420 "
-          "(find_namespace_packages). Upgrade it to version >='40.1.0' and "
-          "repeat install.".format(setuptools.__version__))
-    sys.exit(1)
-
 VERSION_PATH = os.path.join(os.path.dirname(__file__),
-                            "qiskit", "providers", "aer", "VERSION.txt")
+                            "qiskit_aer", "VERSION.txt")


Do we want to pair this with a version bump in the required version of Terra? The current requirement is 0.19.1.

Yeah, I can. We'll need to wait until terra 0.21.0 to do this since we'll need Qiskit/qiskit#5089 with this.

I think I just made a PR that increased the version requirement to 0.20 with a release note, so that'll want updating if we make this change.

setup.py

Namespace packages are constant source of problems for users. The python packaging ecosystem around splitting packages across namespaces is fragile at the best of times and can often leave a you with an environment that isn't recoverable (especially when mixing install methods). There is also a performance hit whenever there is a piece of the namespace we allow external packages to extend since it requires doing a full python path search which can be slow depending on the backing I/O and the number of paths in sys.path for an environment. This commit addresses the piece from the aer perspective by moving qiskit.providers.aer to it's own package and namespace 'qiskit_aer'. This is coupled with a custom namespace module that implements a custom import loader at the root of the namespace. This has 2 advantages it removes the use of namespace packages so the fragility and performance impact are fixed since every element will be renamed to use 'qiskit_' instead of 'qiskit.' (aer being the only one remaining). This is the second attempt at doing this namespace rename, the first failed attempt in Qiskit#840 was trying to migrate all the former qiskit elements at the same time and was too difficult to migrate everything at once without causing breaking api changes. This commit is mechanically the same (renaming qiskit.providers.aer -> qiskit_aer), but how it integrates with qiskit-terra is changed. With Qiskit/qiskit#5089 qiskit-terra, the package which owns the 'qiskit.*' namespace, adds a metaimporter that will redirect imports from qiskit.providers.aer to qiskit_aer. This means before we can merge this commit Qiskit/qiskit#5089 will need to be released first to ensure that for backwards compatibility existing users will be able to access aer from the old namespace. Fixes Qiskit/qiskit#559

This reverts commit 4fa5bc9.

hhorii · 2022-08-29T15:51:53Z

tox.ini

@@ -4,11 +4,13 @@ envlist = py37, py38, py39, py310, lint
 skipsdist = True

 [testenv]
+usedevelop=True


Is this necessary? When I take it, docs test passed some errors (but finally failed with sphinx errors...)

hhorii · 2022-08-29T17:11:23Z

setup.py

@@ -112,7 +104,7 @@ def install_needed_req(import_name, package_name=None, min_version=None, max_ver
 setup(
    name=PACKAGE_NAME,
    version=VERSION,
-    packages=setuptools.find_namespace_packages(include=['qiskit.*']),
+    packages=setuptools.find_packages(include=['qiskit_aer.*']),


I guess that this copies packages in qiskit_aer/ but not files in qiskit (qiskit_aer/__init__.py, qiskit_aer/aererror.py, qiskit_aer/aerprovider.py and qiskit_aer/version.py).

This commit fixes some issues in the new package configuration to tweak how find_package() call to ensure it is finding the full list of modules for the new qiskit_aer package and that things are installed correctly in CI. After this all the code should be installed with the package and the only remaining step is fixing how we run tests to avoid a conflict between $CWD/qiskit_aer and the installed qiskit_aer package. Co-authored-by: Hiroshi Horii <horii@jp.ibm.com>

mtreinish · 2022-08-30T17:53:43Z

I think this is finally good to go! Thanks @hhorii for doing last minute testing and fixes to get this working.

In the recently merged Qiskit#1526 we moved the qiskit-aer package to move it's python namespace from qiskit.providers.aer to qiskit_aer. However, in that PR a release note was missing. This commit adds the missing release note to document the upgrade implications about the change. We should also mention this in the release notes prelude section, but that will occur in the release PR.

* Add release note for namespace migration In the recently merged #1526 we moved the qiskit-aer package to move it's python namespace from qiskit.providers.aer to qiskit_aer. However, in that PR a release note was missing. This commit adds the missing release note to document the upgrade implications about the change. We should also mention this in the release notes prelude section, but that will occur in the release PR. * Apply suggestions from code review Co-authored-by: Jake Lishman <jake@binhbar.com> Co-authored-by: Jake Lishman <jake@binhbar.com>

See Qiskit/qiskit-aer#1526 Closes qiskit-community#912

Update test imports for qiskit-aer 0.11 See Qiskit/qiskit-aer#1526

* Backend timing helper for experiments (#860) Added `BackendTiming` class with methods for helping round delay and pulse durations to match backend timing constraints. Co-authored-by: Naoki Kanazawa <nkanazawa1989@gmail.com> * Update test imports for qiskit-aer 0.11 (#913) Update test imports for qiskit-aer 0.11 See Qiskit/qiskit-aer#1526 Co-authored-by: Will Shanks <willshanks@us.ibm.com> Co-authored-by: Naoki Kanazawa <nkanazawa1989@gmail.com>

Update test imports for qiskit-aer 0.11 See Qiskit/qiskit-aer#1526

mtreinish added the Changelog: API Change Include in the Changed section of the changelog label May 31, 2022

mtreinish added this to the Aer 0.11.0 milestone May 31, 2022

mtreinish mentioned this pull request May 31, 2022

Move Aer to it's own package #840

Closed

jakelishman reviewed May 31, 2022

View reviewed changes

jakelishman changed the title ~~Move Aer to it's own package~~ Move Aer to its own package May 31, 2022

1ucian0 mentioned this pull request Jun 2, 2022

Aer needs its own documentation page Qiskit/qiskit-metapackage#1508

Closed

mtreinish force-pushed the namespace-no-more-v2 branch from d717552 to b0189c9 Compare June 14, 2022 13:18

mtreinish added 3 commits July 26, 2022 10:52

Remove outdated MANIFEST.in entries

6ee9a33

Update package spec in setup.py

ec49a11

mtreinish force-pushed the namespace-no-more-v2 branch from b0189c9 to ec49a11 Compare July 26, 2022 14:52

mtreinish added 8 commits July 26, 2022 10:56

Bump minimum terra version to 0.21.0

e8e8d13

Simplify build system

4fa5bc9

Update primitives import path in test

cd9ad24

Update tox config

5593107

Move primitives package under qiskit_aer

c312ec5

Use develop mode for neko tests

4bf52e5

Revert "Simplify build system"

067bb08

This reverts commit 4fa5bc9.

Merge remote-tracking branch 'origin/main' into namespace-no-more-v2

f77c27c

mtreinish mentioned this pull request Aug 15, 2022

qiskit namespace conflicts with Qiskit Terra in Jupyter environment #1580

Closed

HuangJunye mentioned this pull request Aug 16, 2022

QuantumCircuit has no attribute 'save_statevector' Qiskit/qiskit#6346

Closed

mtreinish added 2 commits August 22, 2022 16:37

Merge remote-tracking branch 'origin/main' into namespace-no-more-v2

47f88ae

Add legacy editable mode to tox config

61f22f7

hhorii reviewed Aug 29, 2022

View reviewed changes

hhorii mentioned this pull request Aug 29, 2022

[Do Not Merge] Namespace no more v3 #1587

Closed

hhorii reviewed Aug 29, 2022

View reviewed changes

mtreinish and others added 3 commits August 30, 2022 10:35

Tweak test running to avoid conflicting repo with installed package

b5dcafe

Just remove aer dir

f002742

hhorii approved these changes Aug 31, 2022

View reviewed changes

hhorii merged commit 13937fd into Qiskit:main Aug 31, 2022

mtreinish deleted the namespace-no-more-v2 branch August 31, 2022 22:05

mtreinish mentioned this pull request Sep 1, 2022

Add release note for namespace migration #1593

Merged

wshanks mentioned this pull request Sep 16, 2022

Fix broken tests using deprecated matplotlib function from 3.6.0 (closes #909) qiskit-community/qiskit-experiments#910

Merged

wshanks added a commit to wshanks/qiskit-experiments that referenced this pull request Sep 16, 2022

Update test imports for qiskit-aer 0.11

06a57f4

See Qiskit/qiskit-aer#1526 Closes qiskit-community#912

wshanks mentioned this pull request Sep 16, 2022

Update test imports for qiskit-aer 0.11 qiskit-community/qiskit-experiments#913

Merged

wshanks added a commit to qiskit-community/qiskit-experiments that referenced this pull request Sep 22, 2022

Update test imports for qiskit-aer 0.11 (#913)

d42cb84

Update test imports for qiskit-aer 0.11 See Qiskit/qiskit-aer#1526

nkanazawa1989 pushed a commit to nkanazawa1989/qiskit-experiments that referenced this pull request Sep 29, 2022

Update test imports for qiskit-aer 0.11 (qiskit-community#913)

b0d5793

Update test imports for qiskit-aer 0.11 See Qiskit/qiskit-aer#1526

wshanks added a commit to thaddeus-pellegrini/qiskit-experiments that referenced this pull request Oct 14, 2022

Update test imports for qiskit-aer 0.11 (qiskit-community#913)

27b4bbb

Update test imports for qiskit-aer 0.11 See Qiskit/qiskit-aer#1526

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move Aer to its own package #1526

Move Aer to its own package #1526

mtreinish commented May 31, 2022

jakelishman left a comment

jakelishman May 31, 2022

mtreinish Jun 14, 2022

jakelishman Jun 27, 2022

hhorii Aug 29, 2022

hhorii Aug 29, 2022

mtreinish commented Aug 30, 2022

Move Aer to its own package #1526

Move Aer to its own package #1526

Conversation

mtreinish commented May 31, 2022

Summary

Details and comments

jakelishman left a comment

Choose a reason for hiding this comment

jakelishman May 31, 2022

Choose a reason for hiding this comment

mtreinish Jun 14, 2022

Choose a reason for hiding this comment

jakelishman Jun 27, 2022

Choose a reason for hiding this comment

hhorii Aug 29, 2022

Choose a reason for hiding this comment

hhorii Aug 29, 2022

Choose a reason for hiding this comment

mtreinish commented Aug 30, 2022