mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-12 09:37:25 +00:00
Laurens Valk
dd2e6e8603
Sphinx fails to show the docsting for class methods. Since we have very few of them, it is easier to just document this one manually Fixes https://github.com/pybricks/pybricks-api/issues/86
282 lines
4.9 KiB
ReStructuredText
282 lines
4.9 KiB
ReStructuredText
Built-in classes and functions
|
|
=====================================================
|
|
|
|
The classes and functions shown on this page can be used without
|
|
importing anything.
|
|
|
|
Input and output
|
|
------------------------
|
|
|
|
.. pybricks-requirements:: stm32-extra
|
|
|
|
.. autofunction:: ubuiltins.input
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.print
|
|
|
|
Basic types
|
|
---------------------------
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autoclass:: ubuiltins.bool
|
|
|
|
.. pybricks-requirements:: stm32-float
|
|
|
|
.. autoclass:: ubuiltins.complex
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autoclass:: ubuiltins.dict
|
|
|
|
.. pybricks-requirements:: stm32-float
|
|
|
|
.. autoclass:: ubuiltins.float
|
|
|
|
.. pybricks-requirements::
|
|
|
|
..
|
|
_comment: The int class is defined manually because otherwise the classmethod is hidden, see https://github.com/pybricks/pybricks-api/issues/86
|
|
|
|
.. autoclass:: ubuiltins.int
|
|
:no-members:
|
|
|
|
.. automethod:: ubuiltins.int.to_bytes
|
|
|
|
.. classmethod:: from_bytes(bytes: Union[bytes, bytearray], byteorder: Literal["little", "big"]) -> int
|
|
|
|
Returns the integer represented by the given bytes.
|
|
|
|
:param bytes: The bytes to convert.
|
|
:param byteorder: Determines the byte order used to represent the
|
|
integer. If byteorder is ``"big"``, the most significant byte is at
|
|
the beginning of the byte sequence. If byteorder is ``"little"``,
|
|
the most significant byte is at the end of the byte sequence.
|
|
|
|
:returns: The integer represented by the bytes.
|
|
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autoclass:: ubuiltins.object
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autoclass:: ubuiltins.type
|
|
|
|
Sequences
|
|
---------------------------
|
|
|
|
.. pybricks-requirements:: stm32-extra
|
|
|
|
.. autoclass:: ubuiltins.bytearray
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autoclass:: ubuiltins.bytes
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.len
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autoclass:: ubuiltins.list
|
|
|
|
.. pybricks-requirements:: stm32-extra
|
|
|
|
.. autoclass:: ubuiltins.slice
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autoclass:: ubuiltins.str
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autoclass:: ubuiltins.tuple
|
|
|
|
Iterators
|
|
--------------------------
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.all
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.any
|
|
|
|
.. pybricks-requirements:: stm32-extra
|
|
|
|
.. autoclass:: ubuiltins.enumerate
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.iter
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.map
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.next
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autoclass:: ubuiltins.range
|
|
|
|
.. pybricks-requirements:: stm32-extra
|
|
|
|
.. autofunction:: ubuiltins.reversed
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.sorted
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.zip
|
|
|
|
Conversion functions
|
|
------------------------
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.bin
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.chr
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.hex
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.oct
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.ord
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.repr
|
|
|
|
.. _builtinmath:
|
|
|
|
Math functions
|
|
----------------------
|
|
|
|
See also :mod:`umath` for floating point math operations.
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.abs
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.divmod
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.max
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.min
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.pow
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.round
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.sum
|
|
|
|
Runtime functions
|
|
-------------------------
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.eval
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.exec
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.globals
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.hash
|
|
|
|
.. pybricks-requirements:: stm32-extra
|
|
|
|
.. autofunction:: ubuiltins.help
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.id
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.locals
|
|
|
|
|
|
Class functions
|
|
------------------------
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.callable
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.dir
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.getattr
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.hasattr
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.isinstance
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.issubclass
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.setattr
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autofunction:: ubuiltins.super
|
|
|
|
|
|
Method decorators
|
|
-----------------
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autodecorator:: ubuiltins.classmethod
|
|
|
|
.. pybricks-requirements::
|
|
|
|
.. autodecorator:: ubuiltins.staticmethod
|