mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-07-27 19:57:02 +00:00
David Lechner
821a3e4455
Many blocking functions now return Awaitable[T] when the async run loop is running. The static analysis tools don't have a way of knowing this, so the best we can do is return both types so that x = method() and x = await method() both work mostly as expected.
Pybricks end-user API & Documentation ===================================== This repository documents the Pybricks end-user MicroPython API. Each `Pybricks firmware`_ comes with the `Pybricks package`_. All modules, classes, methods, and functions in that package have optimized implementations in C for high performance and reduced memory footprint. This repository provides an empty, pure Python blueprint of that package. It is used to generate the `official documentation`_. See the `contributor's guide <CONTRIBUTING.md>`_ for acceptable changes and instructions to build the documentation locally. You can use the API stubs in this repository for syntax highlighting and code completion when programming the EV3 with VS Code. To enable, remove the ``"python.languageServer"="None"`` line in the ``.vscode/settings.json`` file generated by the *LEGO® MINDSTORMS® EV3 MicroPython* extension. For general discussion, please visit the `support`_ issue tracker. .. _Pybricks package: pybricks .. _Pybricks firmware: https://github.com/pybricks/pybricks-micropython .. _official documentation: https://docs.pybricks.com/ .. _support: https://github.com/pybricks/support/issues