Fix extras_require for the cirq metapackage setup.py (quantumlib#4246)

The tensorflow-docs requirement was in the wrong format (worked for pip install but not for extras_require).
It also adds testing to avoid these kind of failures: `dev_tools/packaging/packaging_test.sh` is now executed as part of the CI test suite.

Fixes quantumlib#4222.

.github/workflows/ci.yml

@@ -14,6 +14,19 @@ jobs:
           architecture: 'x64'
       - name: Misc
         run: check/misc
+  packaging_test:
+    name: Packaging test
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v1
+        with:
+          python-version: '3.7'
+          architecture: 'x64'
+      - name: Install dependencies
+        run: pip install -r dev_tools/requirements/deps/packaging.txt
+      - name: Run packaging test
+        run: ./dev_tools/packaging/packaging_test.sh
   format:
     name: Format check
     runs-on: ubuntu-20.04

MANIFEST.in

@@ -1,2 +1 @@
-include requirements.txt
 include LICENSE

dev_tools/modules.py

@@ -27,8 +27,10 @@
 optional arguments:
   -h, --help            show this help message and exit
   --mode {folder,package-path}
-                        'folder' to list root folder for module, 'package-path' for top level
-                        python package path
+                        'folder' to list root folder for module (e.g. cirq-google),
+                        'package-path' for top level python package path
+                            (e.g. cirq-google/cirq_google),
+                        'package' for top level python package (e.g cirq_google),
   --include-parent      whether to include the parent package or not
 """
 
@@ -41,6 +43,7 @@
 
 _FOLDER = 'folder'
 _PACKAGE_PATH = 'package-path'
+_PACKAGE = 'package'
 
 
 @dataclasses.dataclass
@@ -142,6 +145,9 @@ def _print_list_modules(mode: str, include_parent: bool = False):
         elif mode == _PACKAGE_PATH:
             for p in m.top_level_package_paths:
                 print(p, end=" ")
+        elif mode == _PACKAGE:
+            for package in m.top_level_packages:
+                print(package, end=" ")
 
 
 def main(argv: List[str]):
@@ -169,10 +175,11 @@ def _add_list_modules_cmd(subparsers):
     list_modules_cmd.add_argument(
         "--mode",
         default=_FOLDER,
-        choices=[_FOLDER, _PACKAGE_PATH],
+        choices=[_FOLDER, _PACKAGE_PATH, _PACKAGE],
         type=str,
-        help="'folder' to list root folder for module,\n"
-        "'package-path' for top level python package path",
+        help="'folder' to list root folder for module (e.g. cirq-google),\n"
+        "'package-path' for top level python package path (e.g. cirq-google/cirq_google),\n"
+        "'package' for top level python package (e.g cirq_google),\n",
     )
     list_modules_cmd.add_argument(
         "--include-parent",

dev_tools/modules_test.py

@@ -113,6 +113,10 @@ def test_main():
         modules.main(["list", "--mode", "folder", "--include-parent"])
         assert output.getvalue() == ' '.join(["mod1", "mod2", ".", ""])
 
+    with mock.patch('sys.stdout', new=StringIO()) as output:
+        modules.main(["list", "--mode", "package"])
+        assert output.getvalue() == ' '.join(["pack1", "pack2", ""])
+
 
 @chdir(target_dir=None)
 def test_error():

dev_tools/packaging/packaging_test.sh

@@ -0,0 +1,57 @@
+#!/bin/bash
+
+# Copyright 2021 The Cirq Developers
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+################################################################################
+# This script tests packaging. It creates the packages for all the cirq modules
+# `pip install`s them in a clean virtual environment and then runs some simple
+# verificiations on each of the modules, ensuring that they can be imported.
+################################################################################
+
+set -e
+
+# Temporary workspace.
+tmp_dir=$(mktemp -d)
+trap "{ rm -rf ${tmp_dir}; }" EXIT
+
+# New virtual environment
+echo "Working in a fresh virtualenv at ${tmp_dir}/env"
+virtualenv --quiet "--python=/usr/bin/python3" "${tmp_dir}/env"
+
+export CIRQ_PRE_RELEASE_VERSION=$(dev_tools/packaging/generate-dev-version-id.sh)
+out_dir=${tmp_dir}/dist
+dev_tools/packaging/produce-package.sh ${out_dir} $CIRQ_PRE_RELEASE_VERSION
+
+# test installation 
+"${tmp_dir}/env/bin/python" -m pip install ${out_dir}/*
+
+echo ===========================
+echo Testing that code executes
+echo ===========================
+
+"${tmp_dir}/env/bin/python" -c "import cirq; print(cirq.google.Foxtail)"
+"${tmp_dir}/env/bin/python" -c "import cirq_google; print(cirq_google.Foxtail)"
+"${tmp_dir}/env/bin/python" -c "import cirq; print(cirq.Circuit(cirq.CZ(*cirq.LineQubit.range(2))))"
+
+echo =======================================
+echo Testing that all modules are installed
+echo =======================================
+
+CIRQ_PACKAGES=$(env PYTHONPATH=. python dev_tools/modules.py list --mode package)
+for p in $CIRQ_PACKAGES; do
+  echo --- Testing $p -----
+  python_test="import $p; print($p); assert '${tmp_dir}' in $p.__file__, 'Package path seems invalid.'"
+  env PYTHONPATH='' "${tmp_dir}/env/bin/python" -c "$python_test" && echo -e "\033[32mPASS\033[0m"  || echo -e "\033[31mFAIL\033[0m"
+done

dev_tools/requirements/deps/dev-tools.txt

@@ -5,13 +5,10 @@
 -r protos.txt
 -r notebook.txt
 -r tensorflow-docs.txt
+-r packaging.txt
 
 # For testing and analyzing code.
 asv
-virtualenv
-
-# For uploading packages to pypi.
-twine
 
 # For verifying behavior of Quil output.
 pyquil~=2.21.0

dev_tools/requirements/deps/packaging.txt

@@ -0,0 +1,9 @@
+# for testing packaging in isolation
+virtualenv
+
+# for creating packages
+setuptools
+wheel
+
+# for uploading packages to pypi
+twine

dev_tools/requirements/deps/tensorflow-docs.txt

@@ -1,2 +1,2 @@
 # don't upgrade this just yet, anything later will require protobuf>=3.14
-git+https://github.com/tensorflow/docs@a90bcd30eb550f8d4ee335ff3daf18de5ca84b70
+tensorflow-docs@git+https://github.com/tensorflow/docs@a90bcd30eb550f8d4ee335ff3daf18de5ca84b70

setup.py

@@ -62,7 +62,7 @@
     url='http://github.com/quantumlib/cirq',
     author='The Cirq Developers',
     author_email='[email protected]',
-    python_requires=('>=3.6.0'),
+    python_requires='>=3.6.0',
     install_requires=requirements,
     extras_require={
         'dev_env': dev_requirements,