Adding ty type checking (experimental) by cdbf1 · Pull Request #1371 · Infleqtion/client-superstaq

cdbf1 · 2026-04-08T08:05:02Z

No description provided.

vtomole · 2026-04-08T16:07:06Z

Sounds like we should introduce this gradually, so we can have it run on modules that pass for first pass and then be able to merge.

vtomole · 2026-04-15T16:21:11Z

To get this to pass, install something like types-requests.

richrines1 · 2026-04-18T19:44:18Z

+                error_content = {str(key): value for key, value in json_content.items()}
+                detail = error_content.get("detail")
+                alternative = detail if isinstance(detail, str) else ""
+                message_content = error_content.get("message")
+                message = message_content if isinstance(message_content, str) else alternative


if we change the annotation of _handle_response to pydantic.JsonValue (which is more precise anyway) we can revert these changes

I agree with updating annotation of _handle_response to pydantic.JsonValue and while this satisfies ty it introduces an error from mypy instead (since json_content.get("detail", "") is not garunteed to be a string.
Ultimately, either way some handling of non-string response values is required.

I've modified a little bit to now satisfy both

richrines1 · 2026-04-18T20:05:57Z

        return credentials

+    @staticmethod
+    def _normalize_job_ids(job_ids: Sequence[str] | Sequence[uuid.UUID]) -> list[uuid.UUID]:


pydantic is supposed to do this kind of type coercion for us, i don't think we should be adding these manual validations/conversions on top of it (for example the pydantic plugin for mypy tells it to treat model arguments as Any by default, but unfortunately it seems like ty's pydantic support is still a wip..)

not sure how to best circumvent this though.. one possible (but definitely suboptimal) workaround would be to add something like

[tool.ty.analysis] replace-imports-with-any = ["pydantic.main.**"]

to our pyproject.yaml?

Pydantic does the coercion for us, but ty is correct that we are technically passing in a value of the wrong type since pydantic doesnt have a way of annotating the coercion it does. For now my suggestion is targeted ignore lines.

hmm now i'm a little confused. shouldn't the type checker only care about the annotation of __init__ when checking the arguments passed to the class constructor? pydantic.BaseModel.__init__ has this annotation:

def __init__(self, /, **data: Any) -> None:

which should mean that all input arguments accept anything

dowusu-antwi · 2026-04-29T17:15:53Z

@@ -93,6 +93,27 @@ jobs:
        run: |
          checks/mypy_.py

+  ty:
+    name: Type check (ty)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Python 3.14
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.14
+      - uses: actions/cache@v5
+        with:
+          path: ${{ env.pythonLocation }}
+          key: ${{ env.pythonLocation }}-${{ hashFiles('**/pyproject.toml', '**/*requirements.txt', '.github/workflows/ci.yml') }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ./checks-superstaq -e ./general-superstaq[dev] -e ./qiskit-superstaq[dev] -e ./cirq-superstaq[dev] -e ./supermarq-benchmarks[dev]
+      - name: Type check
+        run: |
+          checks/ty_.py general-superstaq
+
  coverage:
    name: Pytest and Coverage check
    strategy:


Do we set a minimum supported Python version for client? We say 3.9 in the docs. Or, is the goal to bring all type-syntax up to date with 3.14?

Relevant: ty docs on inferring the Python version.

We may want to check explicitly setting this (like you can in mypy)

dowusu-antwi · 2026-04-29T17:28:04Z

+    parser.description = textwrap.dedent(
+        """
+        Runs ty on the repository (typing check).
+        Ignores files in the [repo_root]/examples directory.


Is this handled somewhere? Or are we ignoring it for now since gss has no examples?

Nope, that was because I copied it from somewhere else - thanks for catching!

dowusu-antwi · 2026-06-24T15:49:05Z

Dev discussion: Consider doing some kind of ty ignore (not sure about syntax) for the expected type errors, b/c ty is still in alpha and so this might change.

dowusu-antwi · 2026-07-29T16:32:41Z

Consider pyrefly: https://htmlpreview.github.io/?https://github.com/python/typing/blob/main/conformance/results/results.html

quantumlib/Cirq#8182

cdbf1 · 2026-07-30T06:45:05Z

Oh yeah, pyrefly looks interesting. I read a useful comparison blog which highlights some of the differences in approach nicely: https://blog.edward-li.com/tech/comparing-pyrefly-vs-ty/

Factors out the addition of `checks-superstaq/checks_superstaq/ty_.py` from #1371 for independent use. Closes #1437 (also includes a tangential type check fix with 59c42b7) --------- Signed-off-by: Bharath <bharath.thotakura@infleqtion.com>

cdbf1 added 2 commits April 8, 2026 09:04

Adding ty type checking

564a5ed

Reformatting

c439ffa

cdbf1 added 4 commits April 13, 2026 18:33

Fix typing issues in general superstaq

68fe5b4

Add tests for coverage of new code in gss

1f39a96

Merge remote-tracking branch 'origin/main' into feature/ty_type_checking

c6a7287

Update ci.yaml so that ty check only runs on general superstaq

ae7b3a4

cdbf1 added 3 commits April 16, 2026 08:26

Merge remote-tracking branch 'origin/main' into feature/ty_type_checking

1285569

Adding typing extensions to check-superstaq requirements

5b21288

Drop minimum version for py39

f3fe984

cdbf1 requested a review from richrines1 April 16, 2026 07:47

richrines1 reviewed Apr 18, 2026

View reviewed changes

cdbf1 added 7 commits April 20, 2026 08:10

Merge remote-tracking branch 'origin/main' into feature/ty_type_checking

3f7bc69

Fixing some things from RR

38cc108

Update requirements and client type checking

559ed4b

Fix tests

6e11754

Ignore strict tv typing on pydantic coercion

fc9eae8

Merge remote-tracking branch 'origin/main' into feature/ty_type_checking

9692234

Fixing compiler output typing

8665461

cdbf1 requested a review from richrines1 April 21, 2026 13:14

dowusu-antwi reviewed Apr 29, 2026

View reviewed changes

cdbf1 added 3 commits June 8, 2026 09:02

Merge branch 'main' into feature/ty_type_checking

3e57e34

Set minimum ty python version to check against

be2be31

Remove bad docs

44c8c46

This was referenced Aug 7, 2026

Adding ./checks/ty_.py? #1437

Closed

Add standalone ty check in checks-superstaq #1439

Merged

richrines1 marked this pull request as draft September 2, 2026 15:43

Uh oh!

Conversation

cdbf1 commented Apr 8, 2026

Uh oh!

vtomole commented Apr 8, 2026

Uh oh!

vtomole commented Apr 15, 2026

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bharat-thotakura May 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dowusu-antwi commented Jun 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dowusu-antwi commented Jul 29, 2026

Uh oh!

cdbf1 commented Jul 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

bharat-thotakura May 6, 2026 •

edited

Loading

dowusu-antwi commented Jun 24, 2026 •

edited

Loading