MicroPython Stubs: Enhance Your Development Experience

Overview:

• Introduction to MicroPython Stubs
  • What are type stubs?
  • Benefits of using MicroPython Stubs
• Install the micropython-stubs
  • Quick setup script (uv run)
  • 1: Install to typings folder
  • 2: Install in a Virtual Environment
• Static Type Checking of MicroPython code
  • What is Static Type Checking?
  • Alternative Method: Static Type Checking without a Typing Module
  • Positional and keyword parameter types
• Terms and Definitions

Configuration:

• Configuring VSCode, Pylance or Pyright
  • Pyright configuration using pyproject.toml
  • Install the stubs from PyPi.
  • vscode Configuration for Pylance.
  • vscode: Ignore ‘could not be resolved from source’.
  • vscode: Configure Pylance to read MicroPython stdlib stubs.
  • VSCode: Sample workspace configuration file.
  • pylance/pyright: Using pyproject.toml
  • Most Relevant settings
• Pylance/Pyright Advanced configuration
  • Multi-Root workspace.
  • Pyright configuration files.
• PyCharm Configuration
  • Configure PyCharm to use the selected stub folders
  • Install the stubs from PyPi.
  • Check library imports
• MicroPico Configuration [Pylance]
• Type Checking with MyPy
  • MyPy and stub-only packages installed in a typings folder
• Linting with Ruff
  • Why use Ruff with MicroPython stubs?
  • Installation
  • Configuration
  • Running Ruff
  • Integration with the test suite
  • IDE Integration
  • Comparison with other linters
  • Further reading
• Pylint Configuration
  • Pylint:Legacy configuration.
• How to use the Micro:bit v2 stubs
  • Create and navigate to the typings directory:
  • Add the remote repository:
  • Pull from the remote repository:
  • Start VScode
• Configuration using pyproject.toml
  • Configuration using pyproject.toml with stubs in a typings folder

Advanced:

• MicroPython’s typing.mpy module
  • Install the typing modules to your MCU
  • Add to your project source
  • Best portability
  • example code
  • About the modules
  • Cross Compiling
• Type check PIO code using the @rp2_asm decorator
  • enable type checking for RP2 PIO code
  • Disable typechecker warnings for RP2 PIO code
  • PyCharm specific Configuration
• Detailed Installation Guide
  • Install Stubs for a specific port
  • Install Stubs for a Specific Version
  • Install Stubs for a Specific Board
• Micropython-Stubs
  • MCU stubs:
  • Frozen stubs:
  • Doc stubs:
  • Merged stubs:
  • MicroPython core stubs:
  • MicroPython stdlib packages
• Stub Locations
  • Using / mixing different ports or boards
• DIY Stub file creation for MicroPython
  • Install micropython-stubber
  • Create a folder and a pyproject.toml file
  • Clone the micropython source repos and the micropython-stubs repos
• Run the mcu stubber
  • check results
  • Install the stubs to a typing folder to use in your IDE
  • Create a PR to the micropython-stubs repo
• Create a symbolic link
  • Windows 10 / 11
  • Linux/Macos/Unix
• Stub folder Naming Conventions.
  • Use
  • Versioning
  • Version Specifiers and Semantic Versioning
• Installing directy from the repository
• Stub QA testing (Validation Snippets)
  • Usage
  • Caching of packages

Stub index

• List of available packages
  • Packages on PyPi
    • MicroPython v1.28.0
    • MicroPython v1.27.0
    • MicroPython v1.26.1
    • MicroPython v1.26.0
    • MicroPython v1.25.0
    • MicroPython v1.24.1
    • MicroPython v1.23.0
    • MicroPython v1.22.2
    • MicroPython v1.22.1
    • MicroPython v1.22.0
    • MicroPython v1.21.0
    • MicroPython v1.20.0
    • MicroPython v1.19.1
    • MicroPython v1.18.0
    • MicroPython v1.17.0
  • Packages on GitHub
    • MicroPython v1.29.0-preview
  • List of current firmwares and all partial stubs
• Overview of all modules
• Stubs by family and version
  • Micropython
  • Loboris
  • Lvgl
  • M5stack
  • Pyb
  • Pycopy
  • Ulab
  • Metrics
• All stubs by type

Indices and reference

• Index

• Search Page