[py][nfc] imports clean up.
#2590
Conversation
boschmitt
force-pushed
the
nfc_python_cleanup
branch
2 times, most recently
from
e997d80 to
77ba55a
Compare
|
CUDA Quantum Docs Bot: A preview of the documentation can be found here. |
boschmitt
force-pushed
the
nfc_python_cleanup
branch
from
77ba55a to
2dbc748
Compare
|
CUDA Quantum Docs Bot: A preview of the documentation can be found here. |
Cleans up imports throughout the python runtime. I trie following the principles in PEP8 (https://peps.python.org/pep-0008/#imports). The changes include: * Grouping imports two blocks: external and internal, w.r.t cudaq. * Not using relative paths when the module is in a parent dir (`..`) * Not using wildcard imports * Removing unused ones Signed-off-by: boschmitt <[email protected]>
boschmitt
force-pushed
the
nfc_python_cleanup
branch
from
2dbc748 to
952d1e5
Compare
|
CUDA Quantum Docs Bot: A preview of the documentation can be found here. |
| @@ -6,20 +6,36 @@ | |||
| # the terms of the Apache License 2.0 which accompanies this distribution. # | |||
| # ============================================================================ # | |||
| import ast | |||
There was a problem hiding this comment.
nit: I think we are inconsistent with a blank line after the copyright banner and fist import.
There was a problem hiding this comment.
Indeed, we don't seem to have any guideline regarding these things.
| from typing import get_origin | ||
| import sys | ||
| import traceback | ||
| import numpy as np |
There was a problem hiding this comment.
Q: Are the external imports sorted alphabetically?
There was a problem hiding this comment.
I was going for that but it's really an arbitrary decision. The only exception being from __future__ which is required to be the first.
| from .schedule import Schedule | ||
| from .expressions import Operator | ||
| from ..mlir._mlir_libs._quakeDialects import cudaq_runtime | ||
| from cudaq.mlir._mlir_libs._quakeDialects import cudaq_runtime |
There was a problem hiding this comment.
Q: Is there relative ordering for the . imports and named internal imports?
There was a problem hiding this comment.
It should have. The idea was to have project imports followed by relative imports. Also, I did change things in a way that relative imports are only for modules within the same directory (so moving the whole directory wouldn't require changing the imports)
|
@boschmitt : In case you used a tool / script for this, can you share. Perhaps we can add that as part of CI ? |
I did it by hand while studying the code, so it is really a best-effort sort of thing and is not really free of inconsistencies. Thanks for the review (: |
Description
Cleans up imports throughout the python runtime. I trie following the principles in PEP8.
The changes include:
..)