New CI

Change-Id: I46059d89717c8eca89b427576264f6d060179c9d

Author: mpharrigan

.github/workflows/pythonpackage.yml

@@ -20,48 +20,46 @@ on:
     branches: [ master ]
 
 jobs:
-  build:
+  pytest:
+    name: Pytest
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.7, 3.8]
-
+        cirq-version: [ 'previous', 'current', 'next' ]
+      fail-fast: false
     steps:
-    - uses: actions/checkout@v2
-
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
-      with:
-        python-version: ${{ matrix.python-version }}
-
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install -r requirements.txt
-        pip install -e .
-
-    - name: Lint with flake8
-      run: |
-        pip install flake8
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.9'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python dev_tools/write-ci-requirements.py --relative-cirq-version=${{ matrix.cirq-version }} --all-extras
+          pip install -r ci-requirements.txt
+          pip install --no-deps -e .
 
-    - name: Test with pytest
-      run: |
-        pip install pytest
-        # RECIRQ_CHESS_TEST_SEED: make quantum_chess tests determnistic
-        RECIRQ_CHESS_TEST_SEED=789 pytest -v
+      - name: Lint with flake8
+        run: |
+          pip install flake8
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
 
+      - name: Test with pytest
+        run: |
+          pip install pytest
+          # RECIRQ_CHESS_TEST_SEED: make quantum_chess tests determnistic
+          # RECIRQ_IGNORE_PYTKET: for 'next' cirq version, skip pytket tests
+          RECIRQ_CHESS_TEST_SEED=789 RECIRQ_IGNORE_PYTKET=y pytest -v
   nbformat:
     name: Notebook formatting
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-python@v1
+      - uses: actions/setup-python@v2
         with:
-          python-version: '3.7'
-          architecture: 'x64'
+          python-version: '3.9'
       - name: Doc check
         run: dev_tools/nbfmt

dev_tools/write-ci-requirements.py

@@ -0,0 +1,107 @@
+import pathlib
+import re
+import sys
+from argparse import ArgumentParser
+from typing import Any, Dict, List
+
+REPO_DIR = pathlib.Path(__file__).parent.parent.resolve()
+print('Repo dir:', REPO_DIR)
+
+CIRQ_VERSIONS = {
+    'previous': '==0.12.0',
+    'current': '==0.13.0',
+    'next': '>=0.14.0.dev',
+}
+"""Give names to relative Cirq versions so CI can have consistent names while versions 
+get incremented."""
+
+
+def _parse_requirements(path: pathlib.Path):
+    """Read and strip comments from a requirements.txt-like file. """
+    lines = [line.strip() for line in path.read_text().splitlines() if line]
+    return [line for line in lines if not line.startswith('#')]
+
+
+def _remove_version_spec(req: str) -> str:
+    """Remove a version specifier like ==1.3 from a requirements.txt line."""
+    components = re.split(r'>=|~=|<=|==', req)
+    return components[0]
+
+
+def _set_cirq_version(core_reqs: List[str], relative_cirq_version: str) -> List[str]:
+    """Return a new version of `core_reqs` that pins cirq-like packages to the desired version."""
+    cirq_version = CIRQ_VERSIONS[relative_cirq_version]
+    to_change = 'cirq', 'cirq-google', 'cirq-core'
+
+    new_reqs = []
+    for req in core_reqs:
+        without_spec = _remove_version_spec(req)
+        if without_spec in to_change:
+            new_reqs.append(f'{without_spec}{cirq_version}')
+        else:
+            new_reqs.append(req)
+
+    return new_reqs
+
+
+def _set_qaoa_hacks(qaoa_reqs: List[str], relative_cirq_version: str) -> List[str]:
+    """Pytket pins to a specific cirq version and doesn't work with cirq "next".
+    """
+    if relative_cirq_version != 'next':
+        return qaoa_reqs
+
+    new_reqs = []
+    for req in qaoa_reqs:
+        without_spec = _remove_version_spec(req)
+        if without_spec == 'pytket-cirq':
+            continue
+        else:
+            new_reqs.append(req)
+
+    return new_reqs
+
+
+def main(*, out_fn: str = 'ci-requirements.txt', relative_cirq_version: str = 'current',
+         all_extras: bool = False):
+    """Write a requirements.txt file for CI installation and testing.
+
+    Args:
+         out_fn: The output filename
+         relative_cirq_version: Pin the desired cirq version to either "current", "previous",
+            or "next" version.
+        all_extras: Whether to include all the extras_require dependencies.
+    """
+    core_reqs = _parse_requirements(REPO_DIR / 'requirements.txt')
+    core_reqs = _set_cirq_version(core_reqs, relative_cirq_version)
+
+    extras_require = [
+        'otoc', 'qaoa', 'optimize', 'hfvqe', 'fermi_hubbard', 'qml_lfe'
+    ]
+    extras_require = {
+        r: _parse_requirements(pathlib.Path(REPO_DIR / f'recirq/{r}/extra-requirements.txt'))
+        for r in extras_require
+    }
+    extras_require['qaoa'] = _set_qaoa_hacks(extras_require['qaoa'], relative_cirq_version)
+
+    lines = ['# Core requirements'] + core_reqs
+    if all_extras:
+        for name, reqs in extras_require.items():
+            lines += ['', f'# {name}']
+            lines += reqs
+    lines += ['']
+
+    out = '\n'.join(lines)
+    sys.stdout.write(out)
+    (REPO_DIR / out_fn).write_text(out)
+
+
+def parse() -> Dict[str, Any]:
+    parser = ArgumentParser()
+    parser.add_argument('--out-fn', default='ci-requirements.txt')
+    parser.add_argument('--relative-cirq-version', default='current')
+    parser.add_argument('--all-extras', action='store_true', default=False)
+    return vars(parser.parse_args())
+
+
+if __name__ == '__main__':
+    main(**parse())

recirq/fermi_hubbard/extra-requirements.txt

@@ -1 +1 @@
-openfermion
+openfermion>=1.2.0

recirq/hfvqe/extra-requirements.txt

@@ -1,3 +1,3 @@
 # fix bug with openfermionpyscf https://github.com/quantumlib/ReCirq/issues/200#issuecomment-923203883
 h5py~=3.2.1
-openfermion~=1.2.0
+openfermion>=1.2.0

recirq/qaoa/extra-requirements.txt

@@ -1 +1 @@
-pytket-cirq~=0.16.0
+pytket-cirq>=0.16

requirements.txt

@@ -1,9 +1,5 @@
-
-# We'd like to only depend on cirq-core and cirq-google, but pip's dependency resolver
-# chokes since pytket depends on the cirq metapackage.
-cirq~=0.12.0
-cirq-core~=0.12.0
-cirq-google~=0.12.0
+cirq-core>=0.12.0
+cirq-google>=0.12.0
 seaborn
 sphinx
 ipython