qcs 0.26.0

High level interface for running Quil on a QPU
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184

[env]
RUST_BACKTRACE = 0
CARGO_MAKE_CARGO_BUILD_TEST_FLAGS = "--features libquil,_insecure-issuer-validation,stubs"  # Disable --all-features to avoid manual tests in CI for now

[tasks.pre-test]
command = "docker"
args = ["compose", "up", "-d"]

[tasks.post-test]
command = "docker"
args = ["compose", "down"]

[tasks.serve-docs]
command = "cargo"
args = ["doc", "--open"]

[tasks.manual]
env = {CARGO_MAKE_CARGO_BUILD_TEST_FLAGS = "--all-features"}
run_task = [{name = "test-flow"}]

[tasks.lint]
dependencies = ["clippy-flow"]

[tasks.examples]
dependencies = ["examples-libquil", "examples-experimental"]

[tasks.examples-libquil]
command = "cargo"
args = ["build", "--examples", "--features", "libquil"]

[tasks.examples-experimental]
command = "cargo"
args = ["build", "--examples", "--features", "experimental"]

[tasks.deny]
install_crate = "cargo-deny"
command = "cargo"
args = ["deny", "--exclude-dev", "--all-features", "check"]

[tasks.pre-ci-flow]
dependencies = ["deny", "lint"]

[tasks.ci-flow]
dependencies = ["test-flow"]

# ----

[tasks.install-python-deps]
description = "Install python dependencies using poetry."
command = "poetry"
args = ["install", "--with", "dev", "--no-root"]

# NOTE: if using `uv`, you may need to set `PYTHONHOME` to the root of the virtual environment:
#
#   export PYTHONHOME=$(python3 -c "import sys; print(sys.base_prefix)")
[tasks.generate-stubs]
description = "Generate Python stub files."
command = "cargo"
args = ["run", "-p", "qcs", "--features", "stubs", "--bin", "stub_gen"]
install_crate = false

[tasks.package-python]
description = "Build a release version of the Python package to the active virtual environment."
dependencies = ["install-python-deps", "generate-stubs"]
command = "poetry"
args = ["run", "maturin", "build", "--release"]

[tasks.install-python-package]
description = "Build the Python package and install to the active virtual environment."
dependencies = ["install-python-deps"]
command = "poetry"
args = ["run", "maturin", "develop"]

[tasks.install-python-package-with-stubs]
description = "Install the Python package with up-to-date stubs (not needed for testing)."
dependencies = ["generate-stubs", "install-python-package"]

[tasks.pytest]
description = "Run Python tests."
dependencies = ["install-python-package"]
command = "poetry"
args = ["run", "pytest"]

[tasks.pytest-flow]
dependencies = [
    "pre-test",
    "install-python-package",
    "pytest",
    "post-test",
]

[tasks.stubtest]
description = "Check Python stubfiles."
dependencies = ["install-python-package-with-stubs"]
command = "poetry"
cwd = "python"
args = [
    "run",
    "stubtest",
    "--allowlist",
    "stubtest-allowlist",
    "--allowlist",
    "./qcs_sdk/_tracing_subscriber/.stubtest-allowlist",
    "--ignore-disjoint-bases",
    "--ignore-unused-allowlist",
    "qcs_sdk",
]
# TODO(#475): Enable error reporting once stubtest is happy with stubgen's output.
ignore_errors = true

[tasks.stubtest-flow]
dependencies = ["stubtest"]

[tasks.lint-python-package]
description = "Find errors in Python-related Rust code."
dependencies = ["install-python-package-with-stubs"]
command = "poetry"
args = ["run", "python", "./scripts/lint-bindings.py", "--base", "src", "--show-mistakes"]

[tasks.show-python-package-layout]
description = "Print the Python package layout as defined within Rust code."
dependencies = ["install-python-package-with-stubs"]
command = "poetry"
args = ["run", "python", "./scripts/lint-bindings.py", "--base", "src", "--show-package"]

[tasks.test-python-package]
description = "Run all Python-related tests."
dependencies = [
    "lint-python-package",
    "check-python-api",
    "stubtest-flow",
    "pytest-flow",
]

[tasks.test-all]
description = "Run all tests."
dependencies = ["test", "test-python-package"]

[tasks.default]
alias = "test-all"

[tasks.check-python-api]
description = "Check if Python API has breaking changes."
dependencies = ["install-python-package-with-stubs"]
script = { file = "./scripts/check-py-api.sh" }

[tasks.document-python-package]
description = "Generate Python package documentation."
dependencies = ["install-python-package-with-stubs"]
command = "poetry"
args = [
    "run",
    "pdoc",
    "-o", "build/docs",
    "qcs_sdk",
    "!qcs_sdk.qcs_sdk",
    "--logo", "https://qcs.rigetti.com/static/img/rigetti-logo.svg",
]

# ----

[tasks.format-tracing-subscriber]
dependencies = ["install-python-deps"]
command = "poetry"
args = ["run", "black", "python/qcs_sdk/_tracing_subscriber"]

[tasks.format]
dependencies = ["install-python-deps"]
command = "poetry"
args = ["run", "black", "python/qcs_sdk", "tests"]

[tasks.test-session]
dependencies = ["install-python-package-with-stubs"]
command = "poetry"
args = ["run", "pytest", "tests_py", "--with-qcs-session"]

[tasks.test-execution]
dependencies = ["install-python-package-with-stubs"]
command = "poetry"
args = ["run", "pytest", "tests_py", "--with-qcs-session", "--with-qcs-execution"]

[tasks.dev-flow]
dependencies = ["dev-test-flow", "pytest-flow", "stubtest-flow"]