mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-12 09:37:25 +00:00
Laurens Valk
c656eae2f3
TConst does not exist, so adding it makes it a bit harder to read than needed. The const() "function" will take int or float, and the return value can be used as such, even if it is optimized out. This is described in the docstring, so we can leave out the additional type. Also adds autofunctions in place of one auto module so we can move things around as needed. Also fix cross links with usys to get the build to pass before we update that module.
132 lines
4.1 KiB
Python
132 lines
4.1 KiB
Python
# SPDX-License-Identifier: MIT
|
|
# Copyright (c) 2021 The Pybricks Authors
|
|
#
|
|
# Documentation copied from:
|
|
# https://raw.githubusercontent.com/micropython/micropython/master/docs/library/micropython.rst
|
|
# Copyright (c) 2014-2021, Damien P. George, Paul Sokolovsky, and contributors
|
|
|
|
"""
|
|
Access and control MicroPython internals.
|
|
"""
|
|
|
|
from typing import Any, Literal, Union, overload
|
|
|
|
|
|
def const(expression: Union[int, float]) -> Union[int, float]:
|
|
"""
|
|
Used to declare that the expression is a constant so that the compile can
|
|
optimise it. The use of this function should be as follows::
|
|
|
|
from micropython import const
|
|
|
|
CONST_X = const(123)
|
|
CONST_Y = const(2 * CONST_X + 1)
|
|
|
|
Constants declared this way are still accessible as global variables from
|
|
outside the module they are declared in. On the other hand, if a constant
|
|
begins with an underscore then it is hidden, it is not available as a global
|
|
variable, and does not take up any memory during execution.
|
|
|
|
This ``const`` function is recognized directly by the MicroPython parser and is
|
|
provided as part of the :mod:`micropython` module mainly so that scripts can be
|
|
written which run under both CPython and MicroPython, by following the above
|
|
pattern.
|
|
"""
|
|
...
|
|
|
|
|
|
@overload
|
|
def opt_level() -> None:
|
|
...
|
|
|
|
|
|
@overload
|
|
def opt_level(level: Literal[0, 1, 2, 3]) -> 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.
|
|
|
|
The optimization level controls the following compilation features:
|
|
|
|
- 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.
|
|
|
|
The default optimization level is usually level 0.
|
|
"""
|
|
|
|
|
|
@overload
|
|
def mem_info() -> None:
|
|
...
|
|
|
|
|
|
@overload
|
|
def mem_info(verbose: Any) -> None:
|
|
...
|
|
|
|
|
|
def mem_info(*args):
|
|
"""
|
|
Print information about currently used memory. If the ``verbose`` argument
|
|
is given then extra information is printed.
|
|
|
|
The information that is printed is implementation dependent, but currently
|
|
includes the amount of stack and heap used. In verbose mode it prints out
|
|
the entire heap indicating which blocks are used and which are free.
|
|
"""
|
|
|
|
|
|
@overload
|
|
def qstr_info() -> None:
|
|
...
|
|
|
|
|
|
@overload
|
|
def qstr_info(verbose: Any) -> None:
|
|
...
|
|
|
|
|
|
def qstr_info(*args):
|
|
"""
|
|
Print information about currently interned strings. If the ``verbose``
|
|
argument is given then extra information is printed.
|
|
|
|
The information that is printed is implementation dependent, but currently
|
|
includes the number of interned strings and the amount of RAM they use. In
|
|
verbose mode it prints out the names of all RAM-interned strings.
|
|
"""
|
|
|
|
|
|
def stack_use() -> None:
|
|
"""
|
|
Return an integer representing the current amount of stack that is being
|
|
used. The absolute value of this is not particularly useful, rather it
|
|
should be used to compute differences in stack usage at different points.
|
|
"""
|
|
|
|
|
|
# REVISIT: Skipping heap lock funcs for now
|
|
|
|
|
|
def kbd_intr(chr: int) -> None:
|
|
"""
|
|
Set the character that will raise a ``KeyboardInterrupt`` exception. By
|
|
default this is set to ``3`` during script execution, corresponding to
|
|
:kbd:`Ctrl-C`. Passing ``-1`` to this function will disable capture of
|
|
:kbd:`Ctrl-C`, and passing ``3`` will restore it.
|
|
|
|
This function can be used to prevent the capturing of :kbd:`Ctrl-C` on the
|
|
incoming stream of characters that is usually used for the REPL, in case
|
|
that stream is used for other purposes.
|
|
"""
|