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

pimoroni_pico_stubs-1.21.0.tar.gz (23.7 kB view details)

Uploaded Source

Built Distribution

pimoroni_pico_stubs-1.21.0-py3-none-any.whl (43.3 kB view details)

Uploaded Python 3

File details

Details for the file pimoroni_pico_stubs-1.21.0.tar.gz.

File metadata

  • Download URL: pimoroni_pico_stubs-1.21.0.tar.gz
  • Upload date:
  • Size: 23.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for pimoroni_pico_stubs-1.21.0.tar.gz
Algorithm Hash digest
SHA256 27c6a066fc581dfca4948f216d872ea5fb8b6c31304eb5ba89f2f72232a0db1b
MD5 872458d7b395ee5b0e61308f19b570cd
BLAKE2b-256 88d6df4d25d8fe6b5153eb1057f3e4f6dc2c1f9ef3d7dd1733f68d3499c7b67e

See more details on using hashes here.

File details

Details for the file pimoroni_pico_stubs-1.21.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pimoroni_pico_stubs-1.21.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2ffb860c9f389b5003378df7f1e28a5a499a2a89368166ae64ada31505c0f488
MD5 f7d9ebdb870481f71c62ab94970ec4bf
BLAKE2b-256 5e5297b2de47eb2f602f3c2dca0118a399aa1be87d9c9dde438ca044aee7b21e

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