Skip to main content

Micropython Stubs for Pimoroni MicroPython libraries for RP2040-based boards

Project description

Pimoroni Pico MicroPython Stubs

This repository contains type stubs that help you write code for Pimoroni Pico MicroPython's many built-in modules.

Type stubs include details about the constants, functions, classes and methods available in each module, and what arguments they accept.

VSCode Setup

Required Extensions

You must install the VSCode Python extension and additionally Pylance to support type hints.

To install extensions, press Ctrl+Shift+P or Cmd+Shift+P and in the pop-up box type "Extensions" and select "Extensions: Install Extensions".

A search box should open on the left-hand side of your editor, find and install the following:

VSCode Settings

To open VSCode settings press Ctrl+Shift+P or Cmd+Shift+P and in the pop-up box type "Settings" and choose "Preferences: Open Workspace Settings (JSON)".

If the file is empty you can go right ahead and add the lines below:

{
    "python.languageServer": "Pylance",
    "python.analysis.typeCheckingMode": "basic",
    "python.analysis.diagnosticSeverityOverrides": {
        "reportMissingModuleSource": "none"
    },
    "python.analysis.typeshedPaths": [
        "./typings/",
    ],
}

MicroPython stubs

To get MicroPython type hints you'll need to install the following package into the ./typings directory of your project.

If the terminal is not open press Ctrl+Shift+P or Cmd+Shift+P and in the pop-up box type "Terminal" and select "Terminal: Create New Terminal (In Active Workspace)".

Finally in the terminal run the following command:

pip install pimoroni-pico-stubs --target ./typings --no-user

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file north101_pimoroni_pico_stubs-1.21.0.post1.tar.gz.

File metadata

File hashes

Hashes for north101_pimoroni_pico_stubs-1.21.0.post1.tar.gz
Algorithm Hash digest
SHA256 2ee0f6348ade915d8ba3131d63137a85a68085bbf7d20a32e96a5369e5eff261
MD5 e49c6338767c525b147d63aa7eb5bf2a
BLAKE2b-256 8dcaf36c25796adfa4b2c9b335cc4e86337526b52f74b22efc7cb886e20534e5

See more details on using hashes here.

File details

Details for the file north101_pimoroni_pico_stubs-1.21.0.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for north101_pimoroni_pico_stubs-1.21.0.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 a5be00552f965996cb5ab425be2df0f61f2041cc81eda288016a0b8d2f9ca5c2
MD5 56c8c981c0e15d023b52149dd57355b9
BLAKE2b-256 20b4c8db9b0c9f7f40d09dc91e6c623f3f281ee39470e8d74e15c10b4a1cbd01

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page