Skip to content

docs: Document @micropython.native usage policy. #406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nedseb merged 3 commits into from
Apr 17, 2026
Merged

docs: Document @micropython.native usage policy. #406

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8262532
docs: Document @micropython.native usage policy.
nedseb Apr 17, 2026
0864e70
perf: Add @micropython.native to rendering hot-paths in examples.
nedseb Apr 17, 2026
d011c58
perf(ssd1327): Add @micropython.native to draw_cube() in 3D cube exam…
nedseb Apr 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ lib/<component>/
- **Time**: use `from time import sleep_ms` (not `utime`, not `sleep()` with float seconds).
- **Exceptions**: use `except Exception:` instead of bare `except:`. Enforced by ruff (E722).
- **No debug `print()`** in production driver code. Enforced by ruff (T20, examples and tests excluded).
- **`@micropython.native`**: do **not** use in driver code (`device.py`) — methods are dominated by I2C/SPI bus time, so native compilation gains nothing and reduces debuggability. In **examples**, it may be used on rendering hot-paths (tight pixel loops, math-heavy drawing functions) where a measurable speedup is expected. Do not apply it to functions with only a few comparisons or I/O calls. Note: the native emitter does not support generators, closures, or `with` statements.

## Driver API conventions

Expand Down
2 changes: 0 additions & 2 deletions lib/vl53l1x/examples/radar_screen.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

from time import sleep_ms

import micropython
import ssd1327
from machine import I2C, SPI, Pin
from steami_screen import DARK, GRAY, LIGHT, RED, Screen, SSD1327Display
Expand All @@ -29,7 +28,6 @@
tof = VL53L1X(i2c)


@micropython.native
def compute_display(distance):
"""Compute proximity and color from distance value.

Expand Down
Loading