Correct way to add stubs for umqtt.simple when using rp2 port?

[HendrikThePendric]

I'm working with the Raspberry Pi Pico 2 W and have successfully installed the umqtt.simple module using mpremote mip install umqtt.simple, but I was getting a "module unresolved error" in my editor from PyRight. I would have expected the module to be available in the stubs already (I installed these using pip install -U micropython-rp2-stubs --target typings --no-user), but this was not the case.

I spent a long time trying to find a good solution to this but couldn't really find anything useful. Doing pip install micropython-umqtt.simple seemed the most promising option, but that results in an error (not a python package).

In the end I did a search in this repo for umqtt.simple and found it for the esp32 port. So I just installed these stubs as well (pip install -U micropython-esp32-stubs --target typings --no-user) and this seems to have worked.

But I expect that the "solution" I went with also comes with some downsides and suspect/hope there is a better approach. What would that be?

Update: as expected I am encountering errors now, "country" is not a known attribute of module "rp2"" I've just added # type: ignore to that 🤷‍♂️

[Josverl]

Hi Hendrik, you are the first to report this , but I have been expecting this question, though I do not yet have a scalable solution for it.

I build the stub packages based on the frozen modules to be an exact match to the firmware. The PICO2_W standard firmware does not have the does not But the downside of that is that mpremote mip installed modules do not show up as mpremote mip is oblivious to type-stubs, and prefers the .mpy version to save on space.

I have considered creating separate stub packages for each individual module in stdlib-stubs, but that are more than a few ...
for now I see two short term options:

1. PICO_W stubs + manual copy

• pip install -U micropython-rp2-rpi_pico2_w-stubs --target typings --no-user
• then download & copy just the esp32 umqtt frozen stubs to typings/umqtt/simple.pyi

2. First ESP32 then PICO_W stubs ( last writer wins)

• pip install -U micropython-esp32-stubs --target typings --no-user
• pip install -U micropython-rp2-rpi_pico2_w-stubs --target typings --no-user
  you can also specify this in a pyproject.toml file

the first one is more precise , the 2nd one a bit simpler.

I have been thinking of adding the ability to download / create individual stubs to either mpflash or the stubber package.

[HendrikThePendric]

Thanks for the swift reply @Josverl. Your second approach is exactly what I did already. I did however find that this actually caused one of my pre-exiting import statement to start throwing an error:

Import statement:

from rp2 import country

Lint error:

"country" is unknown import symbol

I don't quite understand how this can happen given the "last writer wins" principle, but I am seeing the error in my editor nonetheless (PyRight is giving me the lint error).

I don't have time right now but I'm already working with a small bask script to install deps, so I'll just add a few lines later on to switch to the manual copy approach. That seems a bit cleaner anyway.

[HendrikThePendric]

@Josverl just to confirm I have had better luck with the manual copy approach. I now get type hints for the umqtt.simple module, without breaking the rp2.country import.

In case someone else wants to do something similar, I'll paste the bash script I use to install my "dev dependencies" below. The assumes to be in a folder 1 level below the project root (mine is in ./scripts/install_dev_deps.sh):

#!/bin/bash

# Quick and dirty way to ensure the script is being executed from the root dir
SCRIPTS_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
cd "$SCRIPTS_DIR" || return
cd ..

pip install -r requirements.txt
pip install -U micropython-rp2-pico_w-stubs --target typings --no-user --no-cache-dir

# Manually get typings for umqtt.simple because this is not included in the
# micropython-rp2-pico_w-stubs stubs. See this discussion for details:
# https://github.com/Josverl/micropython-stubs/discussions/821
mkdir typings/umqtt
curl -H 'Accept: application/vnd.github.v3.raw' -O -L \
  --output-dir typings/umqtt \
  https://api.github.com/repos/Josverl/micropython-stubs/contents/stubs/micropython-v1_25_0-frozen/esp32/GENERIC/umqtt/simple.pyi

[HendrikThePendric]

BTW, I am using the NeoVim / LazyVim editor with these stubs and this is working perfectly. I guess that's to be expected since it uses PyRight as my LSP source, so it's pretty much an identical setup to VSCode. Still wanted to mention it in case you wanted to expand the list of supported editors 😄

[Josverl]

Great to hear :-)
Adding an overview of editors and extensions / add-ins is actually something I have been meaning to add to the docs.
It would be great if you can create a .md page/ paragraph on your setup.
something like :

• https://github.com/Josverl/micropython-stubs/blob/main/docs/27_micropico.md
• https://micropython-stubs.readthedocs.io/en/main/27_micropico.html

[HendrikThePendric]

I was thinking about what to write about my "editor setup" and realised there isn't actually anything to write. The only thing I had to do was add a pyrightconfig.json with 1 field: "reportMissingModuleSource": "none". My editor happens to use PyRight as its default Python linter, so that worked out of the box. And apart from that I just use CLI tools like mpremote and a few bash scripts. I know that NeoVim plugins do exist that provide a proper integrated workflow, but I decided against using them so I could become a bit more familiar with what's actually going on.