Skip to content

Define __all__ for qiskit #7274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mergify merged 14 commits into from
Nov 27, 2021
Merged

Define __all__ for qiskit #7274

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
af23cd3
Remove circuit submodule from qiskit/__init__ namespace
1ucian0 Nov 16, 2021
faef0f4
Merge branch 'main' into remove_circuit_from_qiskit_init
1ucian0 Nov 20, 2021
7301ee0
__all__
1ucian0 Nov 20, 2021
09178e9
__all__
1ucian0 Nov 20, 2021
ff97746
Merge branch 'main' of github.com:Qiskit/qiskit-terra into remove_cir…
1ucian0 Nov 20, 2021
8a5097a
reno
1ucian0 Nov 25, 2021
48780c7
Merge branch 'main' of github.com:Qiskit/qiskit-terra into remove_cir…
1ucian0 Nov 25, 2021
9145a13
add __version__
1ucian0 Nov 25, 2021
6f37587
how to fix
1ucian0 Nov 25, 2021
e14df4b
Update releasenotes/notes/7274-6f57628a7995a461.yaml
1ucian0 Nov 26, 2021
76370cc
remove user_config
1ucian0 Nov 26, 2021
1436cd3
remove __version__
1ucian0 Nov 26, 2021
fa77b95
Reinstate private names defined in module
jakelishman Nov 26, 2021
7975aaa
Merge branch 'main' into remove_circuit_from_qiskit_init
jakelishman Nov 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion qiskit/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
import pkgutil
import sys
import warnings
import os

@1ucian0 1ucian0 Nov 21, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this imported by mistake?

@jakelishman jakelishman Nov 25, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We used to check some environment variables here about suppressing packaging warnings - looks like import os got left after those were removed in #5619. Pylint won't moan about unused imports in __init__ by default I think, because most names in an initialiser won't be used.


# qiskit errors operator
from qiskit.exceptions import QiskitError, MissingOptionalLibraryError
Expand Down Expand Up @@ -127,3 +126,23 @@ def __getattr__(self, attr):

Aer = AerWrapper()
IBMQ = IBMQWrapper()

__all__ = [
"Aer",
"AncillaRegister",
"BasicAer",
"ClassicalRegister",
"_config",

@jakelishman jakelishman Nov 25, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"_config",

We probably don't want to be exporting a private name by default, unless there's a really good reason to.

@1ucian0 1ucian0 Nov 26, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added because _config = _user_config.get_config() and I assumed that intentional. However, checking in the history it seems that was added by #3362 and ended up being leftovers. So I removed all the related lines in 76370cc

@jakelishman jakelishman Nov 26, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's still usable, but at the very least I'd think something like that ought to be through qualified access, so we're fine not to include it in __all__.

"IBMQ",
"MissingOptionalLibraryError",
"QiskitError",
"__qiskit_version__",
"__version__",
Comment thread
1ucian0 marked this conversation as resolved.
Outdated
"QuantumCircuit",
"QuantumRegister",
"assemble",
"execute",
"schedule",
"sequence",
"transpile",
]
Comment thread
1ucian0 marked this conversation as resolved.
8 changes: 8 additions & 0 deletions releasenotes/notes/7274-6f57628a7995a461.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
upgrade:
- |
In this version, ``from qiskit import *`` wont import submodules, but only a selected list of objects.
This might break existing code using ``from qiskit import *`` and refering to objctes that are not part of the current namespace.
As a reminder, ``import *`` is considered bad practice and it should not be used in production code.
Qiskit sets ``__all__`` in ``qiskit/__init__.py`` as a way to mitigate the effects of said bad practice.
If your code raises ``name '<something>' is not defined``, add ``from qiskit import <something>`` and try again.
Comment thread
1ucian0 marked this conversation as resolved.
Outdated