Move Aer to it's own package #840

mtreinish · 2020-07-21T15:55:36Z

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 will be coupled with a change in terra that removes the arbitrary
namespace hook points and hard coding the element namespace maps via 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.', but it also makes it explicit where we
extend the namespace. The previous method allowed any package to extend
qiskit.* and qiskit.providers.* with whatever they wanted. This commit
will need to be coordinated with the terra change to ensure we don't
block development, because while it's not breaking for end users as a
coordinated code release piecewise it's a breaking change for each
element, including Aer.

Details and comments

Depends-On: Qiskit/qiskit#4767
Fixes Qiskit/qiskit#559

mtreinish · 2020-08-31T21:22:13Z

This is failing unittests because of a weird circular import error. I originally never encountered this locally prior to merging Qiskit/qiskit#4767 but by switching to python setup.py bdist_wheel instead of pip install I have been able to recreate this failure. I have no idea on the source of it as of yet. Since this will likely take me some time to debug I'm setting this as on hold as a revert is proposed at Qiskit/qiskit#5006

chriseclectic · 2020-09-18T21:26:01Z

qiskit_aer/extensions/snapshot_density_matrix.py



-class SnapshotDensityMatrix(Snapshot):
+class SnapshotDensityMatrix(snapshot.Snapshot):


Snapshot is used in the code below, which is why the CI is giving an import error.

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 will be coupled with a change in terra that removes the arbitrary namespace hook points and hard coding the element namespace maps via 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.*', but it also makes it explicit where we extend the namespace. The previous method allowed any package to extend qiskit.* and qiskit.providers.* with whatever they wanted. This commit will need to be coordinated with the terra change to ensure we don't block development, because while it's not breaking for end users as a coordinated code release piecewise it's a breaking change for each element, including Aer. Depends-On: Qiskit/qiskit#4767 Fixes Qiskit/qiskit#559

Fix snapshot imports Remove imports of Aer in tests Replace relative imports in parent directors with imports using the full path Remove `from qiskit` imports

make GHA tutorial test run earlier Revert this commit when tests are passing

Except for the qutip_extra_lite dir

Update qiskit_aer module imports

…nto namespace-no-more

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

mtreinish · 2022-05-31T11:53:10Z

Superseded by #1526

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

mtreinish added the on hold Can not fix yet label Jul 21, 2020

mtreinish requested review from atilag and chriseclectic as code owners July 21, 2020 15:55

mtreinish force-pushed the namespace-no-more branch from 21ae8ac to f56f7b2 Compare August 31, 2020 11:50

mtreinish removed the on hold Can not fix yet label Aug 31, 2020

mtreinish added the on hold Can not fix yet label Aug 31, 2020

chriseclectic reviewed Sep 18, 2020

View reviewed changes

mtreinish force-pushed the namespace-no-more branch 3 times, most recently from 6aa1064 to 9fae0dd Compare September 18, 2020 22:18

mtreinish added 6 commits October 8, 2020 11:02

Fix avx source path

87860aa

Exclude qiskit namespace module from pylint type checks

8367943

Update gitignore

d1acf80

Add release notes

9d972c3

DNM: use terra PR branch for CI

45d4084

mtreinish force-pushed the namespace-no-more branch from 9fae0dd to 45d4084 Compare October 8, 2020 15:08

mtreinish requested a review from vvilpas as a code owner October 8, 2020 15:08

mtreinish and others added 11 commits October 8, 2020 11:12

Fix lint job

3a708e0

Fix lint

8af2fcf

Fix tox lint job

5aa3dc7

Fix lint

96caf84

Change qiskit.provider.aer module imports to qiskit_aer

d6c1937

Fix snapshot imports Remove imports of Aer in tests Replace relative imports in parent directors with imports using the full path Remove `from qiskit` imports

TEMP: Add branch to GHA for testing

ea176af

make GHA tutorial test run earlier Revert this commit when tests are passing

Fix typo in GHA

2b3b46e

Remove all relative imports (except for pulse)

3dafad5

Fix wrapper tests

114813a

Remove module imports from qiskit

ff00de3

Add qiskit_aer.exceptions

895fdff

Except for the qutip_extra_lite dir

chriseclectic and others added 14 commits October 8, 2020 16:47

Fix imports

64752e6

Fix pulse imports

03c10f0

Disable unused imports for qiskit_aer.exceptions

a50e963

Remove AerError from docs

c981544

more lint

d653e83

Fixup for tutorial

fdc00bc

Merge pull request #2 from chriseclectic/namespace-no-more

19c546c

Update qiskit_aer module imports

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

3ca7379

Fix linter path

bca2898

Fix lint

86d1223

Really fix lint

8f3ec99

Remove unused import

be01a4c

Test with terra dev branch

e7e8c39

Merge branch 'namespace-no-more' of github.com:mtreinish/qiskit-aer i…

7210249

…nto namespace-no-more

mtreinish mentioned this pull request May 18, 2022

Add namespace redirect hook for qiskit-aer Qiskit/qiskit#5089

Merged

mtreinish mentioned this pull request May 31, 2022

Move Aer to its own package #1526

Merged

mtreinish closed this May 31, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Move Aer to it's own package #840

Move Aer to it's own package #840

Uh oh!

mtreinish commented Jul 21, 2020

Uh oh!

mtreinish commented Aug 31, 2020

Uh oh!

chriseclectic Sep 18, 2020

Uh oh!

mtreinish commented May 31, 2022

Uh oh!

Uh oh!



		class SnapshotDensityMatrix(Snapshot):
		class SnapshotDensityMatrix(snapshot.Snapshot):

Move Aer to it's own package #840

Move Aer to it's own package #840

Uh oh!

Conversation

mtreinish commented Jul 21, 2020

Summary

Details and comments

Uh oh!

mtreinish commented Aug 31, 2020

Uh oh!

chriseclectic Sep 18, 2020

Choose a reason for hiding this comment

Uh oh!

mtreinish commented May 31, 2022

Uh oh!

Uh oh!