assert_deprecated improvements #3919
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
balopat
added
kind/deprecation
and removed
cla: yes
viathor
approved these changes
Mar 15, 2021
balopat
added
the
automerge
CirqBot
added
the
front_of_queue_automerge
CirqBot
removed
automerge
CirqBot
pushed a commit
that referenced
this pull request
Mar 19, 2021
Introduces deprecated module reference.
We are coming up to a couple of module refactors, e.g. `cirq.experiments` -> `cirq.qcvv` and `cirq.google` -> `cirq_google`.
With the functionality introduced here, we can achieve backwards compatible reference by adding a similar snippet to the one below to the original parent module's `__init__.py` file:
```
from cirq import _compat
_compat.deprecated_submodule(
new_module_name="cirq.experiments",
old_parent="cirq",
old_child="qcvv",
deadline="v0.20",
create_attribute=True,
)
```
Callers of all types will get a single deprecation warning.
Design doc: https://tinyurl.com/cirq-deep-aliasing
Extensive testing was done on the full `cirq.google` extraction - all the interesting edge cases were captured as unit tests here.
Disclaimers:
- the tests need to run in a separate subprocess to ensure that the import system is unaffected (I tried resetting sys.modules, and all the other entry points as a pytest fixture, but it didn't really work due to some side-effects I couldn't figure out) - thus I rolled a mechanism that plays nicely within pytest, using multiprocessing.
- there is a g3 specific problem with par files as there is a specific Loader used internally for which the wrapping had to be adjusted (see _compat.py:358) - testing this proved to be hard as one would have to create a legacy module loader which provenly works - but I couldn't. So here, the testing is internal only...
- while user code will still execute, PyCharm and other IDEs will likely not recognize the deprecated module references - the deprecated submodules won't show up in code completion and will look like they don't exist.
Beyond maintainer review, I will also get some python experts to look at this PR and provide feedback to get a bit more confidence that this is not completely unrecommended.
TODO:
- [x] fix CI (coverage needs to be worked out with the subprocess separation)
- [x] split out improvements to the `cirq.testing.assert_deprecated` and `_warn_or_error` method to a separate PR (done #3919)
- [x] get python expert review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Deprecates the
allow_multiple_warningsparameter for explicitcount.Context: this is split out from #3917.
===== Release note ======
cirq.testing.assert_deprecateparameterallow_multiple_warningsis now deprecated and will be removed in Cirq v0.12. Please use insteadcount. Forallow_multiple_warningsTrue, you can just usecount=None, forFalse,count=1which is the default value.======================