Deprecate Cirq-Rigetti

[pavoljuhas]

• Add helper module cirq_rigetti.deprecation
• Add deprecation warnings for public functions and classes
• Let deprecation wrappers detect cirq_rigetti tests
• Suppress Cirq-Rigetti deprecation warnings in cirq_rigetti tests
• Add deprecation note to the Cirq-Rigetti README

Partially implements #7058

[mhucka]

LGTM with a trivial typo in the readme and a question in setup.py.

[mhucka]

The closing ** seems to be missing. Was it meant to go after the word "deprecated"?

[pavoljuhas]

It was not supposed to be there at all, thanks for catching that. The table was also not rendering correctly on GH. Should be fixed by 295cb65.

[mhucka]

Is this removed because we will not provide a cirq-rigetti package on PyPI with the Cirq 1.5 release?

(If there will still be a cirq-rigetti, maybe it would be best to include a notice about deprecation here instead?)

[pavoljuhas]

This notice goes to dev releases of cirq-rigetti and gets inserted to the beginning of their README. It would be confusing for those releases to state "This is a development version" followed by "Cirq-Rigetti is deprecated". This just leaves it with the deprecation notice every time.

[mhucka]

Also, thank you for doing this PR.

[mhucka]

In trying to run check/doctest after creating a virtualenv using dev_tools/requirements/dev-np2.env.txt, I found I had to modify check/doctest to make it ignore the rigetti module:

diff --git a/dev_tools/docs/run_doctest.py b/dev_tools/docs/run_doctest.py
index 903f8f46..e4bac541 100755
--- a/dev_tools/docs/run_doctest.py
+++ b/dev_tools/docs/run_doctest.py
@@ -228,6 +228,7 @@ def main():
     file_names = glob.glob('cirq**/cirq**/**/*.py', recursive=True)
     assert file_names
     excluded = [
+        'cirq-rigetti/',
         'cirq-google/cirq_google/api/',
         'cirq-google/cirq_google/cloud/',
         'cirq-web/cirq_ts/node_modules/',

Is there a way to conditionalize this using the deprecation classes you created?

[pavoljuhas]

In trying to run check/doctest after creating a virtualenv using dev_tools/requirements/dev-np2.env.txt, I found I had to modify check/doctest to make it ignore the rigetti module:
...
Is there a way to conditionalize this using the deprecation classes you created?

cirq-rigetti does not define any doctest so we can hardcode it. Done in fac1c4b, thanks for the suggestion!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.13%. Comparing base (71c3cf1) to head (b53ea3e).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff            @@
##             main    #7176    +/-   ##
========================================
  Coverage   98.13%   98.13%            
========================================
  Files        1095     1096     +1     
  Lines       95649    95806   +157     
========================================
+ Hits        93867    94024   +157     
  Misses       1782     1782            

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.