{ "id": "josverl/micropython-stubber", "name": "micropython-stubber", "prettyName": "micropython-stubber", "description": "Generate and maintain stubs for different MicroPython ports to use with VSCode and Pylance, PyRight, Thonny, PyCharm or MyPy", "version": "", "author": "josverl", "license": "NOASSERTION", "tags": [ "firmware-stubs", "micropython", "micropython-stubber", "micropython-stubs", "mypy", "mypy-stubs", "pylance", "pyright", "python", "static-typing", "typed", "vscode" ], "status": "VALID", "official": false, "source": "https://github.com/josverl/micropython-stubber", "updatedAt": "2025-06-28T07:00:20.686Z", "page": "https://checkmim.com/packages/josverl+micropython-stubber", "createdAt": "2025-05-27T04:35:51.746Z", "submittedBy": "oliverr", "install": { "mpremote": "mpremote mip install github:josverl/micropython-stubber", "mip": "import mip; mip.install(\"github:josverl/micropython-stubber\")" }, "readme": "# Boost MicroPython productivity in VSCode\n \n [![pypi version](https://badgen.net/pypi/v/micropython-stubber)](https://pypi.org/project/micropython-stubber/)\n [![python versions](https://badgen.net/pypi/python/micropython-stubber)](https://badgen.net/pypi/python/micropython-stubber)\n [![Ruff](https://img.shields.io/badge/code%20style-ruff-d7ff64.svg)](https://docs.astral.sh/ruff/ \"Ruff badge\")\n [![Star on GitHub](https://img.shields.io/github/stars/josverl/micropython-stubber.svg?style=social)](https://github.com/josverl/micropython-stubber/stargazers)\n [![All Contributors](https://img.shields.io/badge/all_contributors-19-green.svg?style=flat-square)](#Contributions)\n \n [![pytest stubber](https://github.com/Josverl/micropython-stubber/actions/workflows/pytest.yml/badge.svg)](https://github.com/Josverl/micropython-stubber/actions/workflows/pytest.yml)\n [![Documentation Status](https://readthedocs.org/projects/micropython-stubber/badge/?version=latest)](https://micropython-stubber.readthedocs.io/en/latest/?badge=latest \"Document build status badge\")\n \n [![Open in VSCode](https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc\n)](https://open.vscode.dev/josverl/micropython-stubber)\n \nThe IntelliSense and code linting that is so prevalent in modern editors, does not work out-of-the-gate for MicroPython projects.\nWhile the language is Python, the modules used are different from CPython, and also different ports have different modules and classes, or the same class with different parameters.\n\nWriting MicroPython code in a modern editor should not need to involve keeping a browser open to check for the exact parameters to read a sensor, light-up a LED or send a network request.\n\nFortunately with some additional configuration and data, it is possible to make the editors understand your flavor of MicroPython, whether you use one of the pre-compiled firmwares, but also if you run a one-off custom firmware version.\n\n\n![demo][]]\n\nIn order to achieve this a few things are needed:\n1) Stub files for the native / enabled modules in the firmware using PEP 484 Type Hints\n2) Specific configuration of the VS Code Python extensions \n3) Specific configuration of Pylint [ Optional ]\n4) Suppression of warnings that collide with the MicroPython principles or code optimization.\n\nPlease review the documentation on [https://micropython-stubber.readthedocs.io] \n\nWith that in place, VSCode will understand MicroPython for the most part, and help you to write code, and catch more errors before deploying it to your board. \n\nNote that the above is not limited to VSCode and pylint, but it happens to be the combination that I use. \n\nA lot of subs have already been generated and are shared on PyPi, github or pre-installed by a tool, so it is quite likely that you can just grab a copy be be productive in a few minutes.\n\n## To install pre-built stubs from PyPI\nThis section describes how to install the stubs from PyPI, and how to use them in your project.\nIf you want to create or maintain stub - please see the next section.\n\n- Install in a typings folder (recommended) \n `pip install -U micropython-[-]stubs --no-user --target ./typings`\n- Install in a venv (after activating) \n `pip install -U micropython-[-]stubs --no-user`\n\nExamples:\n``` bash\npip install -U micropython-stm32-stubs\n\n# Install stubs for a specific version.\npip install -U micropython-esp32-stubs==1.20.0.*\n\n# Install stubs for a specific board.\npip install -U micropython-rp2-pico_w-stubs\n```\n\nFor more details how to use the stubs please refer to [the documentation on RTD](https://micropython-stubs.readthedocs.io/en/latest/20_using.html)\n\n\n1. The sister-repo [**MicroPython-stubs**][stubs-repo] contains [all stubs][all-stubs] I have collected with the help of others, and which can be used directly.\nThat repo also contains examples configuration files that can be easily adopted to your setup.\n\n2. Micropython-stubber uses [MPFlash](https://github.com/Josverl/mpflash?tab=readme-ov-file) in some of its operations.\n mpflash was formerly hosted in this repo, but has been moved to its own repo.\n\n## Quick start to build stubs\n\n```bash\npip install micropython-stubber\n\ncd my_stub_workspace\nmkdir all-stubs\n\n# pick a firmware version (tag, stable, preview)\nstubber switch stable\n\n# generate doc-based stdlib stubs for the selected version\nstubber docstubs --enrich\n\n# capture frozen modules from reference firmware downloads\nstubber frozen --version stable --enrich\n\n# merge the pieces for one or more targets\nstubber merge --port esp32 --board ESP32_GENERIC --version stable\nstubber merge --port rp2 --board RPI_PICO_W --version stable\n\n# build final wheel-style outputs in all-stubs//\nstubber build --port esp32 --board ESP32_GENERIC --version stable\n```\n\n- `switch` locks the workspace to a MicroPython release before running other commands.\n- `docstubs` pulls documentation-based stubs; `frozen` adds board-specific frozen modules.\n- `merge` and `build` combine everything into installable stubs under `all-stubs/`.\n\n## Common commands\n\n- List available firmware tags: `stubber switch --list`\n- Create merged stubs for every board of a port: `stubber merge --port esp32 --board all --version stable`\n- Rebuild already downloaded artifacts: `stubber build --port esp32 --board ESP32_GENERIC --version stable`\n- Enrich an existing stub set with docstrings/parameter hints: `stubber docstubs --enrich`\n\n## Outputs and where to use them\n\n- Generated wheels and folders end up under `all-stubs///`.\n- Point your editor type checker (Pyright/Pylance/Mypy) to the `all-stubs` path or install the produced wheels into your project virtual environment.\n- For a full worked example, see the notebook [Manual stub build chain.ipynb](Manual%20stub%20build%20chain.ipynb) which mirrors the CLI workflow used above.\n\n### Working with Custom MicroPython Builds\n\nIf you're working with a fork, branch, or custom build of MicroPython (such as a custom RPi Pico W firmware), see the [Custom MicroPython Guide](docs/25_custom_micropython.md) for detailed instructions on how to generate stubs for your specific build.\n\n\n## Developing & testing \n\nThis is described in more detail in the [developing](docs/developing.md) and [testing](docs/testing.md) documents in the docs folder.\n\n## Branch Main\nThe name of the default branch has been changed to `main`.\nIf you have cloned this repo before you main need to adjust the local repro to be aware of this, or create a fresh clone.\n\nTo update run the below command: \n``` bash\ngit branch -m master main \ngit fetch origin\ngit branch -u origin/main main \ngit remote set-head origin -a\n```\n\nfor more info see [**Renaming a branch**](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch#updating-a-local-clone-after-a-branch-name-changes)\n\n## Licensing \n\n`MicroPython-Stubber` is licensed under the MIT license, and all contributions should follow this [LICENSE](LICENSE).\n\n\n# Contributions\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\"Jos
Jos Verlinde
πŸ’» πŸ”¬ πŸ€” πŸ–‹ πŸ–οΈ βœ…		\"Thonny,
Thonny, Python IDE for beginners
πŸ€” πŸ”¬		\"MicroPython\"/
MicroPython
πŸ”£ πŸ–οΈ		\"pyright\"/
pyright
πŸ”§		\"Boris
Boris Lovosevic
πŸ”£ πŸ–οΈ		\"Paul
Paul Sokolovsky
πŸ”£ πŸ–οΈ		\"pycopy\"/
pycopy
πŸ”£ πŸ–οΈ
\"Pycom\"/
Pycom
πŸš‡		\"Braden
Braden Mars
πŸ› πŸ’» πŸ–οΈ πŸ“¦		\"James
James Manners
πŸ’» πŸ›		\"Patrick\"/
Patrick
πŸ› πŸ’» πŸ–οΈ		\"Paul
Paul m. p. P.
πŸ€” πŸ”¬		\"Edward
Edward K. Ream
πŸ”Œ		\"Daryl
Daryl Stultz
πŸ–οΈ
\"Keeping
Keeping things together
πŸ›		\"vbolshakov\"/
vbolshakov
πŸ› πŸ–οΈ		\"Mauro
Mauro Riva
πŸ“ πŸ›		\"MathijsNL\"/
MathijsNL
πŸ›		\"Callum
Callum Jacob Hays
πŸ› βœ…		\"ZoltΓ‘n
ZoltΓ‘n VΓΆrΓΆs
πŸ”£		\"vincent-l-j\"/
vincent-l-j
πŸ“–
\"Egor
Egor Litvinov
πŸ›		\"Sam
Sam Duke
πŸ’»		\"Howard
Howard Lovatt
πŸ–οΈ πŸ”¬		\"VirtualWolf\"/
VirtualWolf
βœ…		\"Lukas
Lukas Kremla
βœ…
\n\n\n\n\n\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\n----------------------------\n\n--------------------------------\n\n\n\n[stubs-repo]: https://github.com/Josverl/micropython-stubs\n[stubs-repo2]: https://github.com/BradenM/micropy-stubs\n[micropython-stubber]: https://github.com/Josverl/micropython-stubber\n[micropython-stubs]: https://github.com/Josverl/micropython-stubs#micropython-stubs\n[micropy-cli]: https://github.com/BradenM/micropy-cli\n[using-the-stubs]: https://github.com/Josverl/micropython-stubs#using-the-stubs\n[demo]: https://github.com/Josverl/micropython-stubber/blob/main/docs/img/demo.gif?raw=true\t\"demo of writing code using the stubs\"\n[stub processing order]: https://github.com/Josverl/micropython-stubber/blob/main/docs/img/stuborder_pylance.png?raw=true\t\"recommended stub processing order\"\n[naming-convention]: #naming-convention-and-stub-folder-structure\n[all-stubs]: https://github.com/Josverl/micropython-stubs/blob/main/firmwares.md\n[micropython]: https://github.com/micropython/micropython\n[micropython-lib]: https://github.com/micropython/micropython-lib\n[pycopy]: https://github.com/pfalcon/pycopy\n[pycopy-lib]: https://github.com/pfalcon/pycopy-lib\n\n" }