search

dwavesystems / dimod

A shared API for QUBO/Ising samplers.
https://docs.ocean.dwavesys.com/en/stable/docs_dimod/
Apache License 2.0
124 stars 81 forks source link

Mypy stub files for Cython files #1221

Open arcondello opened 2 years ago

arcondello commented 2 years ago

It would be good to add stub files for some of the most commonly used cython packages because cython current does not support type annotations.

Especially dimod.cyvariables and dimod.cyutilities would benefit because the Variables object is used in many places.

Should be as simple as adding a dimod/cyvariables.pyi file etc.

arcondello commented 2 years ago

As a downside, it does not seem like those type annotations are picked up by sphinx (see https://github.com/sphinx-doc/sphinx/issues/7630).