Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-12 01:24:17 +00:00
Code Issues Releases Activity

micropython.opt_level: Clarify docstring.

Browse Source 
Just list what each level does instead of a complicated if-then bullet list. It's still shorter anyway.

Also add a note that this only applies to REPL code in case of Pybricks.
This commit is contained in:
Laurens Valk
2021-07-14 15:13:26 +02:00
parent 4c00c3209b
commit 3ed6e2dd7d
1 changed files with 18 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/micropython/__init__.py
+18 -15
View File
@@ -9,7 +9,7 @@
Access and control MicroPython internals.
"""
from typing import Any, Literal, overload
from typing import Any, overload
def const(value: int) -> int:
@@ -28,32 +28,35 @@ def const(value: int) -> int:
@overload
def opt_level() -> None:
def opt_level() -> int:
...
@overload
def opt_level(level: Literal[0, 1, 2, 3]) -> None:
def opt_level(level: int) -> None:
...
def opt_level(*args):
"""
If ``level`` is given then this function sets the optimization level for subsequent
compilation of scripts, and returns ``None``. Otherwise it returns the current
optimization level.
Sets the optimization level for code compiled on the hub:
The optimization level controls the following compilation features:
0. Assertion statements are enabled. The built-in ``__debug__`` variable
is ``True``. Script line numbers are saved, so they can be reported when
an Exception occurs.
1. Assertions are ignored and ``__debug__`` is ``False``.
Script line numbers are saved.
2. Assertions are ignored and ``__debug__`` is ``False``.
Script line numbers are saved.
3. Assertions are ignored and ``__debug__`` is ``False``.
Script line numbers are *not* saved.
- Assertions: at level 0 assertion statements are enabled and compiled into the
bytecode; at levels 1 and higher assertions are not compiled.
- Built-in ``__debug__`` variable: at level 0 this variable expands to ``True``;
at levels 1 and higher it expands to ``False``.
- Source-code line numbers: at levels 0, 1 and 2 source-code line number are
stored along with the bytecode so that exceptions can report the line number
they occurred at; at levels 3 and higher line numbers are not stored.
This applies only to code that you run in the REPL, because regular scripts
are already compiled before they are sent to the hub.
If no argument is given, this function returns the current optimization
level.
The default optimization level is usually level 0.
"""