Adding micropython.const to stubs

[dunkmann00]

I'm not sure if this is the right place for this so forgive me if it isn't.

I was trying to import from micropython import const into my code.py and am getting Import "micropython" could not be resolved. I have circuitpython-stubs installed and other circuitpython specific libraries are all getting typed correctly so I believe I have everything setup correct.

Would it be possible to add micropython.const to this typing library to get the type hint? I'd be happy to open a PR myself if it would help.

Thanks!

[FoamyGuy]

@dunkmann00 Are you trying this on a CircuitPython device? Or under CPython on Linux like a Raspberry Pi or similar?

If CircuitPython, which device and version of CircuitPython?

Also are you able to share the code in use that is trying to import and use micropython.const? I think in some cases that is used vor actual values rather than just type annotations I'm not sure that having a typing definition for it would allow it to work in cases where it's used to hold a value.

[Neradoc]

Import "micropython" could not be resolved that's a pylance error right ?
Looking at an install of circuitpython-stubs, there is no micropython-stubs installed with it.
So I think that's the issue. (Having blinka installed could be a temporary workaround).

[dunkmann00]

Hey thanks for the quick responses!

So yes, this is an error being presented by the type checker (pyright) from my editor. It runs fine on the CircuitPython board I am using (which is a QTPy2040).

I also saw that there is no micropython-stubs, in the circuitpython-stubs library. AFAICT that is because it does not live in shared-bindings.

I tried installing this library, and since it depends on blinka, blinka also got installed. But it still wasn't working, so I looked into it a little further.

I seems that while blinka does have a type stub for the micropython module, it is not named in a way for pyright to find it. The structure for the stub file is micropython-stubs --> micropython.pyi. In order to get the desired type checking behavior it should be micropython-stubs --> __init__.pyi. I made this change locally to test it out and after doing so, from micropython import const is correctly handled by pyright.

It would be nice if it was in circuitpython-stubs as it would avoid needing to import several additional libraries that are dependencies of either this library or blinka, but I'm not sure if that is really that big of a deal or if adding it is even feasible given how circuitpython-stubs is generated.

[FoamyGuy]

I think maybe we could add some static sections to the stubs for micropython and perhaps some other things. We already do this for docs with the files here: https://github.com/adafruit/circuitpython/tree/main/docs/library including for micropython module. The stubs are essentially a form of documentation, so a similar solution seems fine to me.

[dunkmann00]

Okay, that sounds cool! Is there something you would like me to do, like open an issue over in the circuitpython repo? Or would you prefer to take care of it?

[dunkmann00]

Putting this here to not forget. Wherever this ends up going, it should be a generic type because const now supports any object (see micropython#8548) not just int. In blinka, the argument and return type are still int.

[Neradoc]

Oh I didn't know it was extended to all constants, nice. You can do a PR to Blinka for micropython-stubs.
We could also just move this issue to the Circuitpython repo (and rename it) to track the stubs issue there.

[dunkmann00]

Okay, I opened up a PR in Blinka!

[dunkmann00]

@Neradoc Is moving this issue to the Circuitpython repo something you can do?

[FoamyGuy]

@dunkmann00 moved to core repo now. I also raised the question about static stubs in the weeds during this weeks meeting and we are good with moving forward on that idea. In the top level of the repo in a new stubs folder was the suggested place to put them.

Along with adding static .pyi files there, I think we'll need to update the make stubs command to pull in those files during the stubs build.

I will try to test the process out.