Move IBMQ provider to its own package

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.ibmq to it's own package and namespace 'qiskit_ibmq_provider'. 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 the IBMQ provider. Depends-On: Qiskit/qiskit#4767 Fixes Qiskit/qiskit#559
mtreinish · Jul 21, 2020 · bf28022 · bf28022
1 parent 63c0fa0
commit bf28022
Show file tree

Hide file tree

Showing 79 changed files with 4 additions and 16 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,3 +1,3 @@
 include LICENSE.txt README.md
-include qiskit/providers/ibmq/VERSION.txt
+include qiskit_ibmq_provider/VERSION.txt
 recursive-include test *.py
diff --git a/qiskit/providers/ibmq/VERSION.txt → qiskit_ibmq_provider/VERSION.txt b/qiskit/providers/ibmq/VERSION.txt → qiskit_ibmq_provider/VERSION.txt
diff --git a/qiskit/providers/ibmq/__init__.py → qiskit_ibmq_provider/__init__.py b/qiskit/providers/ibmq/__init__.py → qiskit_ibmq_provider/__init__.py
diff --git a/qiskit/providers/ibmq/accountprovider.py → qiskit_ibmq_provider/accountprovider.py b/qiskit/providers/ibmq/accountprovider.py → qiskit_ibmq_provider/accountprovider.py
diff --git a/qiskit/providers/ibmq/api/__init__.py → qiskit_ibmq_provider/api/__init__.py b/qiskit/providers/ibmq/api/__init__.py → qiskit_ibmq_provider/api/__init__.py
diff --git a/...it/providers/ibmq/api/clients/__init__.py → qiskit_ibmq_provider/api/clients/__init__.py b/...it/providers/ibmq/api/clients/__init__.py → qiskit_ibmq_provider/api/clients/__init__.py
diff --git a/qiskit/providers/ibmq/api/clients/account.py → qiskit_ibmq_provider/api/clients/account.py b/qiskit/providers/ibmq/api/clients/account.py → qiskit_ibmq_provider/api/clients/account.py
diff --git a/qiskit/providers/ibmq/api/clients/auth.py → qiskit_ibmq_provider/api/clients/auth.py b/qiskit/providers/ibmq/api/clients/auth.py → qiskit_ibmq_provider/api/clients/auth.py
diff --git a/qiskit/providers/ibmq/api/clients/base.py → qiskit_ibmq_provider/api/clients/base.py b/qiskit/providers/ibmq/api/clients/base.py → qiskit_ibmq_provider/api/clients/base.py
diff --git a/qiskit/providers/ibmq/api/clients/version.py → qiskit_ibmq_provider/api/clients/version.py b/qiskit/providers/ibmq/api/clients/version.py → qiskit_ibmq_provider/api/clients/version.py
diff --git a/...t/providers/ibmq/api/clients/websocket.py → ...it_ibmq_provider/api/clients/websocket.py b/...t/providers/ibmq/api/clients/websocket.py → ...it_ibmq_provider/api/clients/websocket.py
diff --git a/qiskit/providers/ibmq/api/exceptions.py → qiskit_ibmq_provider/api/exceptions.py b/qiskit/providers/ibmq/api/exceptions.py → qiskit_ibmq_provider/api/exceptions.py
diff --git a/qiskit/providers/ibmq/api/rest/__init__.py → qiskit_ibmq_provider/api/rest/__init__.py b/qiskit/providers/ibmq/api/rest/__init__.py → qiskit_ibmq_provider/api/rest/__init__.py
diff --git a/qiskit/providers/ibmq/api/rest/auth.py → qiskit_ibmq_provider/api/rest/auth.py b/qiskit/providers/ibmq/api/rest/auth.py → qiskit_ibmq_provider/api/rest/auth.py
diff --git a/qiskit/providers/ibmq/api/rest/backend.py → qiskit_ibmq_provider/api/rest/backend.py b/qiskit/providers/ibmq/api/rest/backend.py → qiskit_ibmq_provider/api/rest/backend.py
diff --git a/qiskit/providers/ibmq/api/rest/base.py → qiskit_ibmq_provider/api/rest/base.py b/qiskit/providers/ibmq/api/rest/base.py → qiskit_ibmq_provider/api/rest/base.py
diff --git a/qiskit/providers/ibmq/api/rest/job.py → qiskit_ibmq_provider/api/rest/job.py b/qiskit/providers/ibmq/api/rest/job.py → qiskit_ibmq_provider/api/rest/job.py
diff --git a/qiskit/providers/ibmq/api/rest/root.py → qiskit_ibmq_provider/api/rest/root.py b/qiskit/providers/ibmq/api/rest/root.py → qiskit_ibmq_provider/api/rest/root.py
diff --git a/...providers/ibmq/api/rest/utils/__init__.py → ..._ibmq_provider/api/rest/utils/__init__.py b/...providers/ibmq/api/rest/utils/__init__.py → ..._ibmq_provider/api/rest/utils/__init__.py
diff --git a/...viders/ibmq/api/rest/utils/data_mapper.py → ...mq_provider/api/rest/utils/data_mapper.py b/...viders/ibmq/api/rest/utils/data_mapper.py → ...mq_provider/api/rest/utils/data_mapper.py
diff --git a/...providers/ibmq/api/rest/version_finder.py → ..._ibmq_provider/api/rest/version_finder.py b/...providers/ibmq/api/rest/version_finder.py → ..._ibmq_provider/api/rest/version_finder.py
diff --git a/qiskit/providers/ibmq/api/session.py → qiskit_ibmq_provider/api/session.py b/qiskit/providers/ibmq/api/session.py → qiskit_ibmq_provider/api/session.py
diff --git a/qiskit/providers/ibmq/apiconstants.py → qiskit_ibmq_provider/apiconstants.py b/qiskit/providers/ibmq/apiconstants.py → qiskit_ibmq_provider/apiconstants.py
diff --git a/qiskit/providers/ibmq/backendjoblimit.py → qiskit_ibmq_provider/backendjoblimit.py b/qiskit/providers/ibmq/backendjoblimit.py → qiskit_ibmq_provider/backendjoblimit.py
diff --git a/...it/providers/ibmq/credentials/__init__.py → qiskit_ibmq_provider/credentials/__init__.py b/...it/providers/ibmq/credentials/__init__.py → qiskit_ibmq_provider/credentials/__init__.py
diff --git a/...it/providers/ibmq/credentials/configrc.py → qiskit_ibmq_provider/credentials/configrc.py b/...it/providers/ibmq/credentials/configrc.py → qiskit_ibmq_provider/credentials/configrc.py
diff --git a/...providers/ibmq/credentials/credentials.py → ..._ibmq_provider/credentials/credentials.py b/...providers/ibmq/credentials/credentials.py → ..._ibmq_provider/credentials/credentials.py
diff --git a/qiskit/providers/ibmq/credentials/environ.py → qiskit_ibmq_provider/credentials/environ.py b/qiskit/providers/ibmq/credentials/environ.py → qiskit_ibmq_provider/credentials/environ.py
diff --git a/.../providers/ibmq/credentials/exceptions.py → ...t_ibmq_provider/credentials/exceptions.py b/.../providers/ibmq/credentials/exceptions.py → ...t_ibmq_provider/credentials/exceptions.py
diff --git a/...iders/ibmq/credentials/hubgroupproject.py → ...q_provider/credentials/hubgroupproject.py b/...iders/ibmq/credentials/hubgroupproject.py → ...q_provider/credentials/hubgroupproject.py
diff --git a/qiskit/providers/ibmq/credentials/qconfig.py → qiskit_ibmq_provider/credentials/qconfig.py b/qiskit/providers/ibmq/credentials/qconfig.py → qiskit_ibmq_provider/credentials/qconfig.py
diff --git a/qiskit/providers/ibmq/credentials/updater.py → qiskit_ibmq_provider/credentials/updater.py b/qiskit/providers/ibmq/credentials/updater.py → qiskit_ibmq_provider/credentials/updater.py
diff --git a/qiskit/providers/ibmq/exceptions.py → qiskit_ibmq_provider/exceptions.py b/qiskit/providers/ibmq/exceptions.py → qiskit_ibmq_provider/exceptions.py
diff --git a/qiskit/providers/ibmq/ibmqbackend.py → qiskit_ibmq_provider/ibmqbackend.py b/qiskit/providers/ibmq/ibmqbackend.py → qiskit_ibmq_provider/ibmqbackend.py
diff --git a/qiskit/providers/ibmq/ibmqbackendservice.py → qiskit_ibmq_provider/ibmqbackendservice.py b/qiskit/providers/ibmq/ibmqbackendservice.py → qiskit_ibmq_provider/ibmqbackendservice.py
diff --git a/qiskit/providers/ibmq/ibmqfactory.py → qiskit_ibmq_provider/ibmqfactory.py b/qiskit/providers/ibmq/ibmqfactory.py → qiskit_ibmq_provider/ibmqfactory.py
diff --git a/qiskit/providers/ibmq/job/__init__.py → qiskit_ibmq_provider/job/__init__.py b/qiskit/providers/ibmq/job/__init__.py → qiskit_ibmq_provider/job/__init__.py
diff --git a/qiskit/providers/ibmq/job/exceptions.py → qiskit_ibmq_provider/job/exceptions.py b/qiskit/providers/ibmq/job/exceptions.py → qiskit_ibmq_provider/job/exceptions.py
diff --git a/qiskit/providers/ibmq/job/ibmqjob.py → qiskit_ibmq_provider/job/ibmqjob.py b/qiskit/providers/ibmq/job/ibmqjob.py → qiskit_ibmq_provider/job/ibmqjob.py
diff --git a/qiskit/providers/ibmq/job/job_monitor.py → qiskit_ibmq_provider/job/job_monitor.py b/qiskit/providers/ibmq/job/job_monitor.py → qiskit_ibmq_provider/job/job_monitor.py
diff --git a/qiskit/providers/ibmq/job/queueinfo.py → qiskit_ibmq_provider/job/queueinfo.py b/qiskit/providers/ibmq/job/queueinfo.py → qiskit_ibmq_provider/job/queueinfo.py
diff --git a/qiskit/providers/ibmq/job/utils.py → qiskit_ibmq_provider/job/utils.py b/qiskit/providers/ibmq/job/utils.py → qiskit_ibmq_provider/job/utils.py
diff --git a/qiskit/providers/ibmq/jupyter/__init__.py → qiskit_ibmq_provider/jupyter/__init__.py b/qiskit/providers/ibmq/jupyter/__init__.py → qiskit_ibmq_provider/jupyter/__init__.py
diff --git a/...it/providers/ibmq/jupyter/backend_info.py → qiskit_ibmq_provider/jupyter/backend_info.py b/...it/providers/ibmq/jupyter/backend_info.py → qiskit_ibmq_provider/jupyter/backend_info.py
diff --git a/...t/providers/ibmq/jupyter/config_widget.py → ...it_ibmq_provider/jupyter/config_widget.py b/...t/providers/ibmq/jupyter/config_widget.py → ...it_ibmq_provider/jupyter/config_widget.py
diff --git a/...viders/ibmq/jupyter/dashboard/__init__.py → ...mq_provider/jupyter/dashboard/__init__.py b/...viders/ibmq/jupyter/dashboard/__init__.py → ...mq_provider/jupyter/dashboard/__init__.py
diff --git a/.../ibmq/jupyter/dashboard/backend_update.py → ...vider/jupyter/dashboard/backend_update.py b/.../ibmq/jupyter/dashboard/backend_update.py → ...vider/jupyter/dashboard/backend_update.py
diff --git a/.../ibmq/jupyter/dashboard/backend_widget.py → ...vider/jupyter/dashboard/backend_widget.py b/.../ibmq/jupyter/dashboard/backend_widget.py → ...vider/jupyter/dashboard/backend_widget.py
diff --git a/...iders/ibmq/jupyter/dashboard/dashboard.py → ...q_provider/jupyter/dashboard/dashboard.py b/...iders/ibmq/jupyter/dashboard/dashboard.py → ...q_provider/jupyter/dashboard/dashboard.py
diff --git a/...ers/ibmq/jupyter/dashboard/job_widgets.py → ...provider/jupyter/dashboard/job_widgets.py b/...ers/ibmq/jupyter/dashboard/job_widgets.py → ...provider/jupyter/dashboard/job_widgets.py
diff --git a/...bmq/jupyter/dashboard/provider_buttons.py → ...der/jupyter/dashboard/provider_buttons.py b/...bmq/jupyter/dashboard/provider_buttons.py → ...der/jupyter/dashboard/provider_buttons.py
diff --git a/...providers/ibmq/jupyter/dashboard/utils.py → ..._ibmq_provider/jupyter/dashboard/utils.py b/...providers/ibmq/jupyter/dashboard/utils.py → ..._ibmq_provider/jupyter/dashboard/utils.py
diff --git a/...ibmq/jupyter/dashboard/watcher_monitor.py → ...ider/jupyter/dashboard/watcher_monitor.py b/...ibmq/jupyter/dashboard/watcher_monitor.py → ...ider/jupyter/dashboard/watcher_monitor.py
diff --git a/...it/providers/ibmq/jupyter/gates_widget.py → qiskit_ibmq_provider/jupyter/gates_widget.py b/...it/providers/ibmq/jupyter/gates_widget.py → qiskit_ibmq_provider/jupyter/gates_widget.py
diff --git a/qiskit/providers/ibmq/jupyter/jobs_widget.py → qiskit_ibmq_provider/jupyter/jobs_widget.py b/qiskit/providers/ibmq/jupyter/jobs_widget.py → qiskit_ibmq_provider/jupyter/jobs_widget.py
diff --git a/...t/providers/ibmq/jupyter/qubits_widget.py → ...it_ibmq_provider/jupyter/qubits_widget.py b/...t/providers/ibmq/jupyter/qubits_widget.py → ...it_ibmq_provider/jupyter/qubits_widget.py
diff --git a/qiskit/providers/ibmq/managed/__init__.py → qiskit_ibmq_provider/managed/__init__.py b/qiskit/providers/ibmq/managed/__init__.py → qiskit_ibmq_provider/managed/__init__.py
diff --git a/qiskit/providers/ibmq/managed/exceptions.py → qiskit_ibmq_provider/managed/exceptions.py b/qiskit/providers/ibmq/managed/exceptions.py → qiskit_ibmq_provider/managed/exceptions.py
diff --git a/.../providers/ibmq/managed/ibmqjobmanager.py → ...t_ibmq_provider/managed/ibmqjobmanager.py b/.../providers/ibmq/managed/ibmqjobmanager.py → ...t_ibmq_provider/managed/ibmqjobmanager.py
diff --git a/qiskit/providers/ibmq/managed/managedjob.py → qiskit_ibmq_provider/managed/managedjob.py b/qiskit/providers/ibmq/managed/managedjob.py → qiskit_ibmq_provider/managed/managedjob.py
diff --git a/...t/providers/ibmq/managed/managedjobset.py → ...it_ibmq_provider/managed/managedjobset.py b/...t/providers/ibmq/managed/managedjobset.py → ...it_ibmq_provider/managed/managedjobset.py
diff --git a/.../providers/ibmq/managed/managedresults.py → ...t_ibmq_provider/managed/managedresults.py b/.../providers/ibmq/managed/managedresults.py → ...t_ibmq_provider/managed/managedresults.py
diff --git a/qiskit/providers/ibmq/managed/utils.py → qiskit_ibmq_provider/managed/utils.py b/qiskit/providers/ibmq/managed/utils.py → qiskit_ibmq_provider/managed/utils.py
diff --git a/qiskit/providers/ibmq/utils/__init__.py → qiskit_ibmq_provider/utils/__init__.py b/qiskit/providers/ibmq/utils/__init__.py → qiskit_ibmq_provider/utils/__init__.py
diff --git a/qiskit/providers/ibmq/utils/converters.py → qiskit_ibmq_provider/utils/converters.py b/qiskit/providers/ibmq/utils/converters.py → qiskit_ibmq_provider/utils/converters.py
diff --git a/qiskit/providers/ibmq/utils/json_decoder.py → qiskit_ibmq_provider/utils/json_decoder.py b/qiskit/providers/ibmq/utils/json_decoder.py → qiskit_ibmq_provider/utils/json_decoder.py
diff --git a/qiskit/providers/ibmq/utils/json_encoder.py → qiskit_ibmq_provider/utils/json_encoder.py b/qiskit/providers/ibmq/utils/json_encoder.py → qiskit_ibmq_provider/utils/json_encoder.py
diff --git a/qiskit/providers/ibmq/utils/qobj_utils.py → qiskit_ibmq_provider/utils/qobj_utils.py b/qiskit/providers/ibmq/utils/qobj_utils.py → qiskit_ibmq_provider/utils/qobj_utils.py
diff --git a/qiskit/providers/ibmq/utils/utils.py → qiskit_ibmq_provider/utils/utils.py b/qiskit/providers/ibmq/utils/utils.py → qiskit_ibmq_provider/utils/utils.py
diff --git a/qiskit/providers/ibmq/version.py → qiskit_ibmq_provider/version.py b/qiskit/providers/ibmq/version.py → qiskit_ibmq_provider/version.py
diff --git a/.../providers/ibmq/visualization/__init__.py → ...t_ibmq_provider/visualization/__init__.py b/.../providers/ibmq/visualization/__init__.py → ...t_ibmq_provider/visualization/__init__.py
diff --git a/...providers/ibmq/visualization/colormaps.py → ..._ibmq_provider/visualization/colormaps.py b/...providers/ibmq/visualization/colormaps.py → ..._ibmq_provider/visualization/colormaps.py
diff --git a/...ders/ibmq/visualization/device_layouts.py → ..._provider/visualization/device_layouts.py b/...ders/ibmq/visualization/device_layouts.py → ..._provider/visualization/device_layouts.py
diff --git a/...roviders/ibmq/visualization/exceptions.py → ...ibmq_provider/visualization/exceptions.py b/...roviders/ibmq/visualization/exceptions.py → ...ibmq_provider/visualization/exceptions.py
diff --git a/...bmq/visualization/interactive/__init__.py → ...der/visualization/interactive/__init__.py b/...bmq/visualization/interactive/__init__.py → ...der/visualization/interactive/__init__.py
diff --git a/...mq/visualization/interactive/error_map.py → ...er/visualization/interactive/error_map.py b/...mq/visualization/interactive/error_map.py → ...er/visualization/interactive/error_map.py
diff --git a/...bmq/visualization/interactive/gate_map.py → ...der/visualization/interactive/gate_map.py b/...bmq/visualization/interactive/gate_map.py → ...der/visualization/interactive/gate_map.py
diff --git a/...sualization/interactive/plotly_wrapper.py → ...sualization/interactive/plotly_wrapper.py b/...sualization/interactive/plotly_wrapper.py → ...sualization/interactive/plotly_wrapper.py
diff --git a/setup.py b/setup.py
@@ -14,7 +14,7 @@
 
 import os
 
-from setuptools import setup
+from setuptools import setup, find_packages
 
 REQUIREMENTS = [
     "nest-asyncio>=1.0.0,!=1.1.0",
@@ -30,7 +30,7 @@
 
 # Handle version.
 VERSION_PATH = os.path.join(os.path.dirname(__file__),
-                            "qiskit", "providers", "ibmq", "VERSION.txt")
+                            "qiskit_ibmq_provider", "VERSION.txt")
 with open(VERSION_PATH, "r") as version_file:
     VERSION = version_file.read().strip()
 
@@ -68,19 +68,7 @@
         "Topic :: Scientific/Engineering",
     ],
     keywords="qiskit sdk quantum api ibmq",
-    packages=['qiskit.providers.ibmq',
-              'qiskit.providers.ibmq.api',
-              'qiskit.providers.ibmq.api.clients',
-              'qiskit.providers.ibmq.api.rest',
-              'qiskit.providers.ibmq.api.rest.utils',
-              'qiskit.providers.ibmq.credentials',
-              'qiskit.providers.ibmq.job',
-              'qiskit.providers.ibmq.managed',
-              'qiskit.providers.ibmq.utils',
-              'qiskit.providers.ibmq.visualization',
-              'qiskit.providers.ibmq.visualization.interactive',
-              'qiskit.providers.ibmq.jupyter',
-              'qiskit.providers.ibmq.jupyter.dashboard'],
+    packages=find_packages(exclude=['test*']),
     install_requires=REQUIREMENTS,
     include_package_data=True,
     python_requires=">=3.5",