From 0ecf536cda690320af062a335c238a5a7495b0fc Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Thu, 5 Aug 2021 10:41:18 +0200 Subject: [PATCH] ubuiltins: Add compatibility everywhere. This lets us sort everything by category or alphabetically without having to make special categories for Move Hub. --- doc/main/micropython/builtins.rst | 114 ++++++++++++++++++++++++++++++ src/ubuiltins/__init__.py | 14 +--- 2 files changed, 115 insertions(+), 13 deletions(-) diff --git a/doc/main/micropython/builtins.rst b/doc/main/micropython/builtins.rst index 394ca2d..259acf8 100644 --- a/doc/main/micropython/builtins.rst +++ b/doc/main/micropython/builtins.rst @@ -1,141 +1,255 @@ Built-in classes and functions ===================================================== +The classes and functions shown on this page can be used without +importing anything. Classes and types ---------------------- +.. pybricks-requirements:: + .. autoclass:: ubuiltins.bool +.. pybricks-requirements:: stm32-extra + .. autoclass:: ubuiltins.bytearray +.. pybricks-requirements:: + .. autoclass:: ubuiltins.bytes +.. pybricks-requirements:: stm32-float + .. autoclass:: ubuiltins.complex +.. pybricks-requirements:: + .. autoclass:: ubuiltins.dict +.. pybricks-requirements:: stm32-float + .. autoclass:: ubuiltins.float +.. pybricks-requirements:: + .. autoclass:: ubuiltins.int +.. pybricks-requirements:: + .. autoclass:: ubuiltins.list +.. pybricks-requirements:: + .. autoclass:: ubuiltins.object +.. pybricks-requirements:: + .. autoclass:: ubuiltins.range +.. pybricks-requirements:: stm32-extra + .. autoclass:: ubuiltins.slice +.. pybricks-requirements:: + .. autoclass:: ubuiltins.str +.. pybricks-requirements:: + .. autoclass:: ubuiltins.tuple +.. pybricks-requirements:: + .. autoclass:: ubuiltins.type Math-related functions ---------------------- +.. 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 Iterable-related functions -------------------------- +.. pybricks-requirements:: + .. autofunction:: ubuiltins.all +.. pybricks-requirements:: + .. autofunction:: ubuiltins.any +.. pybricks-requirements:: stm32-extra + .. autofunction:: ubuiltins.enumerate +.. pybricks-requirements:: + .. autofunction:: ubuiltins.iter +.. pybricks-requirements:: + .. autofunction:: ubuiltins.len +.. pybricks-requirements:: + .. autofunction:: ubuiltins.map +.. pybricks-requirements:: + .. autofunction:: ubuiltins.next +.. 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 Class-related 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 Input/output functions ------------------------ +.. pybricks-requirements:: stm32-extra + .. autofunction:: ubuiltins.input +.. pybricks-requirements:: + .. autofunction:: ubuiltins.print Runtime-related functions ------------------------- +.. pybricks-requirements:: + .. autofunction:: ubuiltins.locals +.. pybricks-requirements:: + .. autofunction:: ubuiltins.globals +.. pybricks-requirements:: + .. autofunction:: ubuiltins.eval +.. pybricks-requirements:: + .. autofunction:: ubuiltins.exec +.. pybricks-requirements:: + .. autofunction:: ubuiltins.hash +.. pybricks-requirements:: + .. autofunction:: ubuiltins.id +.. pybricks-requirements:: stm32-extra + .. autofunction:: ubuiltins.help Method decorators ----------------- +.. pybricks-requirements:: + .. autodecorator:: ubuiltins.classmethod +.. pybricks-requirements:: + .. autodecorator:: ubuiltins.staticmethod diff --git a/src/ubuiltins/__init__.py b/src/ubuiltins/__init__.py index 0399b74..e531c81 100644 --- a/src/ubuiltins/__init__.py +++ b/src/ubuiltins/__init__.py @@ -230,8 +230,6 @@ class complex: """ Returns a complex number with the value `real + imag*1j` or converts a string or number to a complex number. - - .. note:: This type is not available on the BOOST Move hub. """ @@ -305,8 +303,6 @@ def enumerate(*args) -> Iterable: for elem in sequence: yield n, elem n += 1 - - .. note:: This type is not available on the BOOST Move hub. """ @@ -429,8 +425,6 @@ def help(*args) -> None: """ Prints help for the ``object``. If no argument is given, prints general help. If object is ``'modules'``, prints available modules. - - .. note:: This function is not available on the BOOST Move hub. """ @@ -462,8 +456,6 @@ def input(*args) -> _str: If the prompt argument is present, it is written to standard output without a trailing newline. The function then reads a line from input, converts it to a string (stripping a trailing newline), and returns that. - - .. note:: This function is not available on the BOOST Move hub. """ @@ -656,7 +648,7 @@ def print(*objects, sep: _str = " ", end: _str = "\n", file: uio.FileIO = usys.s followed by ``end``. ``sep``, ``end`` and ``file``, if present, must be given as keyword arguments. - .. note:: The ``file`` argument is not supported on the BOOST Move hub. + The ``file`` argument is not supported on the BOOST Move hub. """ @@ -688,8 +680,6 @@ def repr(object: Any) -> _str: def reversed(seq: Sequence) -> Iterator: """ Returns a reverse iterator. - - .. note:: This function is not available on the BOOST Move hub. """ @@ -764,8 +754,6 @@ class slice: Slice objects are also generated when extended indexing syntax is used. For example: ``a[start:stop:step]`` or ``a[start:stop, i]``. - - .. note:: This type is not available on the BOOST Move hub. """