Add type stubs & minimal validation #110
Conversation
|
Great work!
That's kind of crazy that there is nothing to automate this stub creation. |
There's work ongoing it seems, but there didn't seem to be a default just-works solution. I didn't look too much into all the options, partly as some of them looked like they'd be fairly disruptive. https://github.com/mike-huls/cythonbuilder for example seems to be mentioned as being able to do it, but also seems to be a separate build process -- which I didn't want to force on the project just for annotations. I didn't look at all into how it actually works though, nor whether it can be used just for the stubs. |
|
It's mostly that I'll rebase this on I haven't looked at #106 in detail, though it seems that that adds quite a lot of stuff? If so, yeah it's probably simpler to get this PR in first. Hopefully extending the changes here to cover that will be fairly straightforward. |
|
I just merged #109, tell me when you are ready for review 👍 |
PeterJCLaw
force-pushed
the
type-stubs
branch
from
0944f36 to
f559920
Compare
This adds type stubs to the published package, so that consumers can benefit from type checking despite the Cython implementation of this package. The stubs are manually constructed as there does not appear to be a mature solution which produces good stubs from Cython code. (It is actually unclear if such a solution is possible without annotation of the Cython source) Validation of the stubs is achieved by annotating the tests and relying on the existing test coverage to explore all relevant members & operations. A new tox environment runs mypy against the tests. Fixes Ezibenroc#105
Mypy complains that this doesn't have a self/cls argument, however adding @staticmethod causes test failures on Python < 3.10 as the resulting object isn't callable (presumably because the class hasn't finished initiating when we call the method). Hoisting this to a function avoids the issue entirely, at the cost of this helper being slightly further from its usages.
PeterJCLaw
force-pushed
the
type-stubs
branch
from
f559920 to
7edfe6d
Compare
|
For clarity: this is ready for review now. |
| max_value: int | ||
| min_value: int | ||
| sum_value: int | ||
| cardinality: int |
There was a problem hiding this comment.
That made me think, it could be nicer to replace this dict by a proper dataclass. But this is out of scope of this PR of course.
This adds type stubs to the published package, so that consumers can benefit from type checking despite the Cython implementation of this package. The stubs are manually constructed as there does not appear to be a mature solution which produces good stubs from Cython code. (It is actually unclear if such a solution is possible without annotation of the Cython source)
Validation of the stubs is achieved by annotating the tests and relying on the existing test coverage to explore all relevant members & operations. A new tox environment runs mypy against the tests.
Fixes #105
Builds on #109.