Merge pull request #126 from Infleqtion/update-checks

Use `ruff` for formatting and linting

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ on:
 
 jobs:
  format:
- name: Format check
+ name: Formatting check
  if: github.event.pull_request.draft == false
  runs-on: ubuntu-latest
  timeout-minutes: 3
@@ -37,7 +37,7 @@ jobs:
  checks/format_.py
 
  lint:
- name: Lint check
+ name: Linting check
  if: github.event.pull_request.draft == false
  runs-on: ubuntu-latest
  timeout-minutes: 3
@@ -55,32 +55,9 @@ jobs:
  run: |
  python3 -m pip install --upgrade pip
  python3 -m pip install '.[dev]'
- - name: Pylint
+ - name: Lint
  run: |
- checks/pylint_.py --all
-
- flake8:
- name: Flake8 check
- if: github.event.pull_request.draft == false
- runs-on: ubuntu-latest
- timeout-minutes: 3
- steps:
- - uses: actions/checkout@v4
- - name: Set up Python 3.11
- uses: actions/setup-python@v5
- with:
- python-version: '3.11'
- - uses: actions/cache@v4
- with:
- path: ${{ env.pythonLocation }}
- key: ${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}
- - name: Install dependencies
- run: |
- python3 -m pip install --upgrade pip
- python3 -m pip install '.[dev]'
- - name: Flake8
- run: |
- checks/flake8_.py
+ checks/lint_.py
 
  mypy:
  name: Type check
@@ -106,7 +83,7 @@ jobs:
  checks/mypy_.py
 
  coverage:
- name: Pytest and Coverage check
+ name: Pytest and coverage check
  if: github.event.pull_request.draft == false
  runs-on: ubuntu-latest
  timeout-minutes: 3

checks/all_.py

@@ -4,5 +4,5 @@
 import checks_superstaq
 
 if __name__ == "__main__":
- skip_args = ["--skip", "requirements", "--"]
+ skip_args = ["--ruff", "--skip", "requirements", "--"]
  exit(checks_superstaq.all_.run(*skip_args, *sys.argv[1:], sphinx_paths=["../qldpc"]))

checks/format_.py

@@ -4,4 +4,4 @@
 import checks_superstaq
 
 if __name__ == "__main__":
- exit(checks_superstaq.format_.run(*sys.argv[1:]))
+ exit(checks_superstaq.ruff_format_.run(*sys.argv[1:]))

checks/flake8_.py → checks/lint_.py

@@ -4,4 +4,4 @@
 import checks_superstaq
 
 if __name__ == "__main__":
- exit(checks_superstaq.flake8_.run(*sys.argv[1:]))
+ exit(checks_superstaq.ruff_lint_.run(*sys.argv[1:]))

experiments/bivariate_bicycle/collect_results.py

@@ -1,19 +1,19 @@
 #!/usr/bin/env python3
 """Script to save bivariate bicycle code search results to data files
 
- Copyright 2023 The qLDPC Authors and Infleqtion Inc.
+Copyright 2023 The qLDPC Authors and Infleqtion Inc.
 
- 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
+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
 
-  http://www.apache.org/licenses/LICENSE-2.0
+ http://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.
+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.
 """
 
 from __future__ import annotations

experiments/bivariate_bicycle/run_search.py

@@ -1,19 +1,19 @@
 #!/usr/bin/env python3
 """Script to perform a brute-force search for bivariate bicycle codes
 
- Copyright 2023 The qLDPC Authors and Infleqtion Inc.
+Copyright 2023 The qLDPC Authors and Infleqtion Inc.
 
- 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
+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
 
-  http://www.apache.org/licenses/LICENSE-2.0
+ http://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.
+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.
 """
 
 from __future__ import annotations
@@ -120,7 +120,6 @@ def redundant_or_trivial(dims: tuple[int, int], exponents: tuple[int, int, int,
 
  # run multiple jobs in parallel
  with concurrent.futures.ProcessPoolExecutor(max_workers=max_concurrent_jobs) as executor:
-
  for dim_y in range(MIN_ORDER, dim_x + 1):
  dims = (dim_x, dim_y)
  for exponents in itertools.product(

experiments/quantum_tanner/collect_results.py

@@ -1,19 +1,19 @@
 #!/usr/bin/env python3
 """Script to collect search results into a local database
 
- Copyright 2023 The qLDPC Authors and Infleqtion Inc.
+Copyright 2023 The qLDPC Authors and Infleqtion Inc.
 
- 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
+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
 
-  http://www.apache.org/licenses/LICENSE-2.0
+ http://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.
+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.
 """
 
 from __future__ import annotations

experiments/quantum_tanner/run_randomized_search.py

@@ -1,19 +1,19 @@
 #!/usr/bin/env python3
 """Script to perform a randomized search for quantum Tanner codes
 
- Copyright 2023 The qLDPC Authors and Infleqtion Inc.
+Copyright 2023 The qLDPC Authors and Infleqtion Inc.
 
- 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
+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
 
-  http://www.apache.org/licenses/LICENSE-2.0
+ http://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.
+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.
 """
 
 from __future__ import annotations
@@ -139,12 +139,10 @@ def run_and_save(
 
  # run multiple jobs in parallel
  with concurrent.futures.ProcessPoolExecutor(max_workers=max_concurrent_jobs) as executor:
-
  # iterate over all combinations of group, base code, and sample index
  for group_order, group_index in get_small_groups():
  for base_code, base_code_id in get_base_codes():
  for sample in range(NUM_SAMPLES):
-
  # submit this job to the job queue
  executor.submit(
  run_and_save,

experiments/quantum_tanner/verify_codes.py

@@ -1,19 +1,19 @@
 #!/usr/bin/env python3
 """Script to verify the reproducibility of saved quantum Tanner codes
 
- Copyright 2023 The qLDPC Authors and Infleqtion Inc.
+Copyright 2023 The qLDPC Authors and Infleqtion Inc.
 
- 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
+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
 
-  http://www.apache.org/licenses/LICENSE-2.0
+ http://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.
+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.
 """
 
 from __future__ import annotations

pyproject.toml

@@ -38,7 +38,7 @@ platformdirs = ">=4.0.0"
 pymatching = ">=2.1.0"
 sympy = ">=1.12"
 
-checks-superstaq = { version = ">=0.5.22", optional = true }
+checks-superstaq = { version = ">=0.5.23", optional = true }
 
 [tool.poetry.extras]
 dev = ["checks-superstaq"]
@@ -53,6 +53,9 @@ filterwarnings = [
  "ignore::PendingDeprecationWarning:ruamel.yaml.main",
 ]
 
+[tool.ruff]
+line-length = 100
+
 [tool.black]
 color = true
 line_length = 100
@@ -146,7 +149,7 @@ enable = [
  "no-value-for-parameter",
  "nonexistent-operator",
  "not-in-loop",
- # "parameter_documentation", # REPO-SPECIFIC CONFIG
+ "parameter_documentation",
  "pointless-statement",
  "redefined-builtin",
  "relative-beyond-top-level",

qldpc/abstract_test.py

@@ -1,18 +1,18 @@
 """Unit tests for abstract.py
 
- Copyright 2023 The qLDPC Authors and Infleqtion Inc.
+Copyright 2023 The qLDPC Authors and Infleqtion Inc.
 
- 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
+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
 
-  http://www.apache.org/licenses/LICENSE-2.0
+ http://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.
+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.
 """
 
 from __future__ import annotations

qldpc/cache.py

@@ -1,18 +1,18 @@
 """Helper function(s) for caching results
 
- Copyright 2023 The qLDPC Authors and Infleqtion Inc.
+Copyright 2023 The qLDPC Authors and Infleqtion Inc.
 
- 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
+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
 
-  http://www.apache.org/licenses/LICENSE-2.0
+ http://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.
+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.
 """
 
 from __future__ import annotations
@@ -39,10 +39,8 @@ def use_disk_cache(
  """Decorator to cache results to disk."""
 
  def decorator(function: Callable[..., Any]) -> Callable[..., Any]:
-
  @functools.wraps(function)
  def function_with_cache(*args: Hashable, **kwargs: Hashable) -> Any:
-
  # retrieve results from cache, if available
  cache = get_disk_cache(cache_name, cache_dir=cache_dir)
  key = args + tuple(kwargs.items())

qldpc/cache_test.py

@@ -1,18 +1,18 @@
 """Unit tests for cache.py
 
- Copyright 2023 The qLDPC Authors and Infleqtion Inc.
+Copyright 2023 The qLDPC Authors and Infleqtion Inc.
 
- 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
+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
 
-  http://www.apache.org/licenses/LICENSE-2.0
+ http://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.
+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.
 """
 
 from __future__ import annotations