Made most of the requested changes

This commit is contained in:
dherrada 2020-07-03 13:49:00 -04:00
parent 843ff5d302
commit 3df03a5650
48 changed files with 116 additions and 110 deletions

View File

@ -95,7 +95,7 @@ const mp_obj_property_t bleio_adapter_enabled_obj = {
(mp_obj_t)&mp_const_none_obj }, (mp_obj_t)&mp_const_none_obj },
}; };
//| address: str = ... //| address: Address = ...
//| """MAC address of the BLE adapter. (read-only)""" //| """MAC address of the BLE adapter. (read-only)"""
//| //|
STATIC mp_obj_t bleio_adapter_get_address(mp_obj_t self) { STATIC mp_obj_t bleio_adapter_get_address(mp_obj_t self) {
@ -350,7 +350,7 @@ const mp_obj_property_t bleio_adapter_connections_obj = {
(mp_obj_t)&mp_const_none_obj }, (mp_obj_t)&mp_const_none_obj },
}; };
//| def connect(self, address: Address, *, timeout: float/int) -> Adapter.connect: //| def connect(self, address: Address, *, timeout: float/int) -> Connection:
//| """Attempts a connection to the device with the given address. //| """Attempts a connection to the device with the given address.
//| //|
//| :param Address address: The address of the peripheral to connect to //| :param Address address: The address of the peripheral to connect to

View File

@ -128,7 +128,7 @@ const mp_obj_property_t bleio_address_type_obj = {
(mp_obj_t)&mp_const_none_obj}, (mp_obj_t)&mp_const_none_obj},
}; };
//| def __eq__(self, other: bytes) -> Optional[bool]: //| def __eq__(self, other: Any) -> bool:
//| """Two Address objects are equal if their addresses and address types are equal.""" //| """Two Address objects are equal if their addresses and address types are equal."""
//| ... //| ...
//| //|
@ -154,7 +154,7 @@ STATIC mp_obj_t bleio_address_binary_op(mp_binary_op_t op, mp_obj_t lhs_in, mp_o
} }
} }
//| def __hash__(self) -> Optional[int]: //| def __hash__(self) -> int:
//| """Returns a hash for the Address data.""" //| """Returns a hash for the Address data."""
//| ... //| ...
//| //|
@ -187,7 +187,7 @@ STATIC void bleio_address_print(const mp_print_t *print, mp_obj_t self_in, mp_pr
buf[5], buf[4], buf[3], buf[2], buf[1], buf[0]); buf[5], buf[4], buf[3], buf[2], buf[1], buf[0]);
} }
//| PUBLIC: bytes = ... //| PUBLIC: int = ...
//| """A publicly known address, with a company ID (high 24 bits)and company-assigned part (low 24 bits).""" //| """A publicly known address, with a company ID (high 24 bits)and company-assigned part (low 24 bits)."""
//| //|
//| RANDOM_STATIC: int = ... //| RANDOM_STATIC: int = ...

View File

@ -109,7 +109,7 @@ STATIC mp_obj_t bleio_connection_pair(mp_uint_t n_args, const mp_obj_t *pos_args
} }
STATIC MP_DEFINE_CONST_FUN_OBJ_KW(bleio_connection_pair_obj, 1, bleio_connection_pair); STATIC MP_DEFINE_CONST_FUN_OBJ_KW(bleio_connection_pair_obj, 1, bleio_connection_pair);
//| def discover_remote_services(self, service_uuids_whitelist: iterable = None) -> Tuple(_bleio.Service, ...): //| def discover_remote_services(self, service_uuids_whitelist: iterable = None) -> Service:
//| """Do BLE discovery for all services or for the given service UUIDS, //| """Do BLE discovery for all services or for the given service UUIDS,
//| to find their handles and characteristics, and return the discovered services. //| to find their handles and characteristics, and return the discovered services.
//| `Connection.connected` must be True. //| `Connection.connected` must be True.

View File

@ -117,7 +117,7 @@ STATIC mp_obj_t bleio_packet_buffer_readinto(mp_obj_t self_in, mp_obj_t buffer_o
} }
STATIC MP_DEFINE_CONST_FUN_OBJ_2(bleio_packet_buffer_readinto_obj, bleio_packet_buffer_readinto); STATIC MP_DEFINE_CONST_FUN_OBJ_2(bleio_packet_buffer_readinto_obj, bleio_packet_buffer_readinto);
//| def write(self, data: bytes, *, header: bytes = None) -> int: //| def write(self, data: bytes, *, header: Optional[bytes] = None) -> int:
//| """Writes all bytes from data into the same outgoing packet. The bytes from header are included //| """Writes all bytes from data into the same outgoing packet. The bytes from header are included
//| before data when the pending packet is currently empty. //| before data when the pending packet is currently empty.
//| //|

View File

@ -70,7 +70,7 @@ STATIC mp_obj_t bleio_scanentry_matches(mp_uint_t n_args, const mp_obj_t *pos_ar
} }
STATIC MP_DEFINE_CONST_FUN_OBJ_KW(bleio_scanentry_matches_obj, 2, bleio_scanentry_matches); STATIC MP_DEFINE_CONST_FUN_OBJ_KW(bleio_scanentry_matches_obj, 2, bleio_scanentry_matches);
//| address: _bleio.Address = ... //| address: Address = ...
//| """The address of the device (read-only), of type `_bleio.Address`.""" //| """The address of the device (read-only), of type `_bleio.Address`."""
//| //|
STATIC mp_obj_t bleio_scanentry_get_address(mp_obj_t self_in) { STATIC mp_obj_t bleio_scanentry_get_address(mp_obj_t self_in) {

View File

@ -50,11 +50,11 @@ STATIC mp_obj_t scanresults_iternext(mp_obj_t self_in) {
//| """Cannot be instantiated directly. Use `_bleio.Adapter.start_scan`.""" //| """Cannot be instantiated directly. Use `_bleio.Adapter.start_scan`."""
//| ... //| ...
//| //|
//| def __iter__(self) -> __iter__: //| def __iter__(self) -> Iterator[ScanEntry]:
//| """Returns itself since it is the iterator.""" //| """Returns itself since it is the iterator."""
//| ... //| ...
//| //|
//| def __next__(self) -> _bleio.ScanEntry: //| def __next__(self) -> ScanEntry:
//| """Returns the next `_bleio.ScanEntry`. Blocks if none have been received and scanning is still //| """Returns the next `_bleio.ScanEntry`. Blocks if none have been received and scanning is still
//| active. Raises `StopIteration` if scanning is finished and no other results are available.""" //| active. Raises `StopIteration` if scanning is finished and no other results are available."""
//| ... //| ...

View File

@ -73,7 +73,7 @@ STATIC mp_obj_t bleio_service_make_new(const mp_obj_type_t *type, size_t n_args,
return MP_OBJ_FROM_PTR(service); return MP_OBJ_FROM_PTR(service);
} }
//| characteristics: Tuple(Characteristic, ...) = ... //| characteristics: Tuple[Characteristic, ...] = ...
//| """A tuple of :py:class:`Characteristic` designating the characteristics that are offered by //| """A tuple of :py:class:`Characteristic` designating the characteristics that are offered by
//| this service. (read-only)""" //| this service. (read-only)"""
//| //|

View File

@ -36,7 +36,7 @@
//| class UUID: //| class UUID:
//| """A 16-bit or 128-bit UUID. Can be used for services, characteristics, descriptors and more.""" //| """A 16-bit or 128-bit UUID. Can be used for services, characteristics, descriptors and more."""
//| //|
//| def __init__(self, value: Union[int, typing.ByteString]): //| def __init__(self, value: Union[int, ReadableBuffer, str]):
//| """Create a new UUID or UUID object encapsulating the uuid value. //| """Create a new UUID or UUID object encapsulating the uuid value.
//| The value can be one of: //| The value can be one of:
//| //|
@ -248,7 +248,7 @@ STATIC mp_obj_t bleio_uuid_unary_op(mp_unary_op_t op, mp_obj_t self_in) {
} }
} }
//| def __eq__(self, other: UUID) -> Optional[bool]: //| def __eq__(self, other: Any) -> bool:
//| """Two UUID objects are equal if their values match and they are both 128-bit or both 16-bit.""" //| """Two UUID objects are equal if their values match and they are both 128-bit or both 16-bit."""
//| ... //| ...
//| //|

View File

@ -59,10 +59,9 @@
//| //|
//| class BluetoothError: //| class BluetoothError(Exception):
//| def __init__(self, Exception: Exception): //| """Catch all exception for Bluetooth related errors."""
//| """Catch all exception for Bluetooth related errors.""" //| ...
//| ...
MP_DEFINE_BLEIO_EXCEPTION(BluetoothError, Exception) MP_DEFINE_BLEIO_EXCEPTION(BluetoothError, Exception)
NORETURN void mp_raise_bleio_BluetoothError(const compressed_string_t* fmt, ...) { NORETURN void mp_raise_bleio_BluetoothError(const compressed_string_t* fmt, ...) {
@ -72,10 +71,9 @@ NORETURN void mp_raise_bleio_BluetoothError(const compressed_string_t* fmt, ...)
va_end(argptr); va_end(argptr);
nlr_raise(exception); nlr_raise(exception);
} }
//| class ConnectionError: //| class ConnectionError(BluetoothError):
//| def __init__(self, BluetoothError: _bleio.BluetoothError): //| """Raised when a connection is unavailable."""
//| """Raised when a connection is unavailable.""" //| ...
//| ...
//| //|
MP_DEFINE_BLEIO_EXCEPTION(ConnectionError, bleio_BluetoothError) MP_DEFINE_BLEIO_EXCEPTION(ConnectionError, bleio_BluetoothError)
NORETURN void mp_raise_bleio_ConnectionError(const compressed_string_t* fmt, ...) { NORETURN void mp_raise_bleio_ConnectionError(const compressed_string_t* fmt, ...) {
@ -86,20 +84,18 @@ NORETURN void mp_raise_bleio_ConnectionError(const compressed_string_t* fmt, ...
nlr_raise(exception); nlr_raise(exception);
} }
//| class RoleError: //| class RoleError(BluetoothError):
//| def __init__(self, BluetoothError: _bleio.BluetoothError): //| """Raised when a resource is used as the mismatched role. For example, if a local CCCD is
//| """Raised when a resource is used as the mismatched role. For example, if a local CCCD is //| attempted to be set but they can only be set when remote."""
//| attempted to be set but they can only be set when remote.""" //| ...
//| ...
//| //|
MP_DEFINE_BLEIO_EXCEPTION(RoleError, bleio_BluetoothError) MP_DEFINE_BLEIO_EXCEPTION(RoleError, bleio_BluetoothError)
NORETURN void mp_raise_bleio_RoleError(const compressed_string_t* msg) { NORETURN void mp_raise_bleio_RoleError(const compressed_string_t* msg) {
mp_raise_msg(&mp_type_bleio_RoleError, msg); mp_raise_msg(&mp_type_bleio_RoleError, msg);
} }
//| class SecurityError: //| class SecurityError(BluetoothError):
//| def __init__(self, BluetoothError: _bleio.BluetoothError): //| """Raised when a security related error occurs."""
//| """Raised when a security related error occurs.""" //| ...
//| ...
//| //|
MP_DEFINE_BLEIO_EXCEPTION(SecurityError, bleio_BluetoothError) MP_DEFINE_BLEIO_EXCEPTION(SecurityError, bleio_BluetoothError)
NORETURN void mp_raise_bleio_SecurityError(const compressed_string_t* fmt, ...) { NORETURN void mp_raise_bleio_SecurityError(const compressed_string_t* fmt, ...) {

View File

@ -58,7 +58,7 @@ STATIC mp_obj_t _register(mp_obj_t self, mp_obj_t o) {
} }
STATIC MP_DEFINE_CONST_FUN_OBJ_2(register_obj, _register); STATIC MP_DEFINE_CONST_FUN_OBJ_2(register_obj, _register);
//| def flush(self) -> Any: //| def flush(self) -> None:
//| """Send any queued drawing commands directly to the hardware. //| """Send any queued drawing commands directly to the hardware.
//| //|
//| :param int width: The width of the grid in tiles, or 1 for sprites.""" //| :param int width: The width of the grid in tiles, or 1 for sprites."""
@ -559,9 +559,9 @@ STATIC mp_obj_t _colorrgb(size_t n_args, const mp_obj_t *args) {
} }
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(colorrgb_obj, 4, 4, _colorrgb); STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(colorrgb_obj, 4, 4, _colorrgb);
//| def Display(self) -> Any: ... //| def Display(self) -> None:
//| """End the display list""" //| """End the display list"""
//| //| ...
STATIC mp_obj_t _display(mp_obj_t self) { STATIC mp_obj_t _display(mp_obj_t self) {
@ -570,7 +570,7 @@ STATIC mp_obj_t _display(mp_obj_t self) {
} }
STATIC MP_DEFINE_CONST_FUN_OBJ_1(display_obj, _display); STATIC MP_DEFINE_CONST_FUN_OBJ_1(display_obj, _display);
//| def End(self) -> Any: //| def End(self) -> None:
//| """End drawing a graphics primitive //| """End drawing a graphics primitive
//| //|
//| :meth:`Vertex2ii` and :meth:`Vertex2f` calls are ignored until the next :meth:`Begin`.""" //| :meth:`Vertex2ii` and :meth:`Vertex2f` calls are ignored until the next :meth:`Begin`."""
@ -628,7 +628,7 @@ STATIC mp_obj_t _macro(mp_obj_t self, mp_obj_t a0) {
} }
STATIC MP_DEFINE_CONST_FUN_OBJ_2(macro_obj, _macro); STATIC MP_DEFINE_CONST_FUN_OBJ_2(macro_obj, _macro);
//| def Nop(self) -> Any: //| def Nop(self) -> None:
//| """No operation""" //| """No operation"""
//| ... //| ...
//| //|
@ -672,7 +672,7 @@ STATIC mp_obj_t _pointsize(mp_obj_t self, mp_obj_t a0) {
} }
STATIC MP_DEFINE_CONST_FUN_OBJ_2(pointsize_obj, _pointsize); STATIC MP_DEFINE_CONST_FUN_OBJ_2(pointsize_obj, _pointsize);
//| def RestoreContext(self) -> Any: //| def RestoreContext(self) -> None:
//| """Restore the current graphics context from the context stack""" //| """Restore the current graphics context from the context stack"""
//| ... //| ...
//| //|
@ -684,7 +684,7 @@ STATIC mp_obj_t _restorecontext(mp_obj_t self) {
} }
STATIC MP_DEFINE_CONST_FUN_OBJ_1(restorecontext_obj, _restorecontext); STATIC MP_DEFINE_CONST_FUN_OBJ_1(restorecontext_obj, _restorecontext);
//| def Return(self) -> Any: //| def Return(self) -> None:
//| """Return from a previous call command""" //| """Return from a previous call command"""
//| ... //| ...
//| //|
@ -696,7 +696,7 @@ STATIC mp_obj_t _return(mp_obj_t self) {
} }
STATIC MP_DEFINE_CONST_FUN_OBJ_1(return_obj, _return); STATIC MP_DEFINE_CONST_FUN_OBJ_1(return_obj, _return);
//| def SaveContext(self) -> Any: //| def SaveContext(self) -> None:
//| """Push the current graphics context on the context stack""" //| """Push the current graphics context on the context stack"""
//| ... //| ...
//| //|

View File

@ -46,7 +46,7 @@
//| that library.""" //| that library."""
//| //|
//| def __init__(self, buffer: ReadableBuffer, rows: List[DigitalInputOutput, DigitalInputOutput, DigitalInputOutput, DigitalInputOutput, DigitalInputOutput, DigitalInputOutput, DigitalInputOutput, DigitalInputOutput], cols: List[DigitalInputOutput, DigitalInputOutput, DigitalInputOutput, DigitalInputOutput, DigitalInputOutput, DigitalInputOutput, DigitalInputOutput, DigitalInputOutput], buttons: DigitalInputOutput): //| def __init__(self, buffer: ReadableBuffer, rows: List[DigitalInOut, DigitalInOut, DigitalInOut, DigitalInOut, DigitalInOut, DigitalInOut, DigitalInOut, DigitalInOut], cols: List[DigitalInOut, DigitalInOut, DigitalInOut, DigitalInOut, DigitalInOut, DigitalInOut, DigitalInOut, DigitalInOut], buttons: DigitalInOut):
//| """Initializes matrix scanning routines. //| """Initializes matrix scanning routines.
//| //|
//| The ``buffer`` is a 64 byte long ``bytearray`` that stores what should //| The ``buffer`` is a 64 byte long ``bytearray`` that stores what should

View File

@ -257,7 +257,7 @@ STATIC mp_obj_t pixelbuf_pixelbuf_show(mp_obj_t self_in) {
} }
STATIC MP_DEFINE_CONST_FUN_OBJ_1(pixelbuf_pixelbuf_show_obj, pixelbuf_pixelbuf_show); STATIC MP_DEFINE_CONST_FUN_OBJ_1(pixelbuf_pixelbuf_show_obj, pixelbuf_pixelbuf_show);
//| def fill(color: tuple[int, int, int]) -> None: //| def fill(color: Union[int, Tuple[int, int, int]]) -> None:
//| """Fills the given pixelbuf with the given color.""" //| """Fills the given pixelbuf with the given color."""
//| ... //| ...
//| //|

View File

@ -12,7 +12,7 @@
//| class AES: //| class AES:
//| """Encrypt and decrypt AES streams""" //| """Encrypt and decrypt AES streams"""
//| //|
//| def __init__(self, key: ReadableBuffer, mode: int=0, iv: ReadableBuffer=None, segment_size: int=8) -> AES: //| def __init__(self, key: Optional[ReadableBuffer], mode: int=0, iv: ReadableBuffer=None, segment_size: int=8) -> None:
//| """Create a new AES state with the given key. //| """Create a new AES state with the given key.
//| //|
//| :param bytearray key: A 16-, 24-, or 32-byte key //| :param bytearray key: A 16-, 24-, or 32-byte key
@ -152,7 +152,7 @@ STATIC void validate_length(aesio_aes_obj_t *self, size_t src_length,
} }
} }
//| def encrypt_into(src: WriteableBuffer, dest: WriteableBuffer) -> None: //| def encrypt_into(src: ReadableBuffer, dest: WriteableBuffer) -> None:
//| """Encrypt the buffer from ``src`` into ``dest``. //| """Encrypt the buffer from ``src`` into ``dest``.
//| //|
//| For ECB mode, the buffers must be 16 bytes long. For CBC mode, the //| For ECB mode, the buffers must be 16 bytes long. For CBC mode, the
@ -183,7 +183,7 @@ STATIC mp_obj_t aesio_aes_encrypt_into(mp_obj_t aesio_obj, mp_obj_t src,
STATIC MP_DEFINE_CONST_FUN_OBJ_3(aesio_aes_encrypt_into_obj, STATIC MP_DEFINE_CONST_FUN_OBJ_3(aesio_aes_encrypt_into_obj,
aesio_aes_encrypt_into); aesio_aes_encrypt_into);
//| def decrypt_into(src: WriteableBuffer, dest: WriteableBuffer) -> None: //| def decrypt_into(src: ReadableBuffer, dest: WriteableBuffer) -> None:
//| //|
//| """Decrypt the buffer from ``src`` into ``dest``. //| """Decrypt the buffer from ``src`` into ``dest``.
//| For ECB mode, the buffers must be 16 bytes long. For CBC mode, the //| For ECB mode, the buffers must be 16 bytes long. For CBC mode, the

View File

@ -147,7 +147,7 @@ STATIC mp_obj_t audiobusio_i2sout_obj___exit__(size_t n_args, const mp_obj_t *ar
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(audiobusio_i2sout___exit___obj, 4, 4, audiobusio_i2sout_obj___exit__); STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(audiobusio_i2sout___exit___obj, 4, 4, audiobusio_i2sout_obj___exit__);
//| def play(self, sample: Union[audiocore.WaveFile, audiocore.RawSample, audiomixe.Mixer], *, loop: bool = False) -> None: //| def play(self, sample: Union[audiocore.WaveFile, audiocore.RawSample, audiomixer.Mixer], *, loop: bool = False) -> None:
//| """Plays the sample once when loop=False and continuously when loop=True. //| """Plays the sample once when loop=False and continuously when loop=True.
//| Does not block. Use `playing` to block. //| Does not block. Use `playing` to block.
//| //|

View File

@ -125,7 +125,7 @@ STATIC mp_obj_t audioio_wavefile_obj___exit__(size_t n_args, const mp_obj_t *arg
} }
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(audioio_wavefile___exit___obj, 4, 4, audioio_wavefile_obj___exit__); STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(audioio_wavefile___exit___obj, 4, 4, audioio_wavefile_obj___exit__);
//| sample_rate: Optional[int] = ... //| sample_rate: int = ...
//| """32 bit value that dictates how quickly samples are loaded into the DAC //| """32 bit value that dictates how quickly samples are loaded into the DAC
//| in Hertz (cycles per second). When the sample is looped, this can change //| in Hertz (cycles per second). When the sample is looped, this can change
//| the pitch output without changing the underlying sample.""" //| the pitch output without changing the underlying sample."""

View File

@ -190,7 +190,7 @@ const mp_obj_property_t audiomixer_mixer_sample_rate_obj = {
(mp_obj_t)&mp_const_none_obj}, (mp_obj_t)&mp_const_none_obj},
}; };
//| voice: Tuple[audiomixer.MixerVoice, ...] = ... //| voice: Tuple[MixerVoice, ...] = ...
//| """A tuple of the mixer's `audiomixer.MixerVoice` object(s). //| """A tuple of the mixer's `audiomixer.MixerVoice` object(s).
//| //|
//| .. code-block:: python //| .. code-block:: python

View File

@ -56,7 +56,7 @@ STATIC mp_obj_t audiomixer_mixervoice_make_new(const mp_obj_type_t *type, size_t
return MP_OBJ_FROM_PTR(self); return MP_OBJ_FROM_PTR(self);
} }
//| def play(self, sample: Union[audiocore.WaveFile, audiomixer.Mixer, audiocore.RawSample], *, loop: bool = False) -> None: //| def play(self, sample: Union[audiocore.WaveFile, Mixer, audiocore.RawSample], *, loop: bool = False) -> None:
//| """Plays the sample once when ``loop=False``, and continuously when ``loop=True``. //| """Plays the sample once when ``loop=False``, and continuously when ``loop=True``.
//| Does not block. Use `playing` to block. //| Does not block. Use `playing` to block.
//| //|

View File

@ -124,7 +124,7 @@ STATIC mp_obj_t audiomp3_mp3file_obj___exit__(size_t n_args, const mp_obj_t *arg
} }
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(audiomp3_mp3file___exit___obj, 4, 4, audiomp3_mp3file_obj___exit__); STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(audiomp3_mp3file___exit___obj, 4, 4, audiomp3_mp3file_obj___exit__);
//| file: Optional[file] = ... //| file: file = ...
//| """File to play back.""" //| """File to play back."""
//| //|
STATIC mp_obj_t audiomp3_mp3file_obj_get_file(mp_obj_t self_in) { STATIC mp_obj_t audiomp3_mp3file_obj_get_file(mp_obj_t self_in) {
@ -154,7 +154,7 @@ const mp_obj_property_t audiomp3_mp3file_file_obj = {
//| sample_rate: Optional[int] = ... //| sample_rate: int = ...
//| """32 bit value that dictates how quickly samples are loaded into the DAC //| """32 bit value that dictates how quickly samples are loaded into the DAC
//| in Hertz (cycles per second). When the sample is looped, this can change //| in Hertz (cycles per second). When the sample is looped, this can change
//| the pitch output without changing the underlying sample.""" //| the pitch output without changing the underlying sample."""

View File

@ -228,7 +228,7 @@ STATIC mp_obj_t busio_spi_obj_unlock(mp_obj_t self_in) {
} }
MP_DEFINE_CONST_FUN_OBJ_1(busio_spi_unlock_obj, busio_spi_obj_unlock); MP_DEFINE_CONST_FUN_OBJ_1(busio_spi_unlock_obj, busio_spi_obj_unlock);
//| def write(self, buffer: ReadableBuffer, *, start: int = 0, end: int = None) -> None: //| def write(self, buffer: ReadableBuffer, *, start: int = 0, end: Optional[int] = None) -> None:
//| """Write the data contained in ``buffer``. The SPI object must be locked. //| """Write the data contained in ``buffer``. The SPI object must be locked.
//| If the buffer is empty, nothing happens. //| If the buffer is empty, nothing happens.
//| //|
@ -270,7 +270,7 @@ STATIC mp_obj_t busio_spi_write(size_t n_args, const mp_obj_t *pos_args, mp_map_
MP_DEFINE_CONST_FUN_OBJ_KW(busio_spi_write_obj, 2, busio_spi_write); MP_DEFINE_CONST_FUN_OBJ_KW(busio_spi_write_obj, 2, busio_spi_write);
//| def readinto(self, buffer: bytearray, *, start: int = 0, end: int = None, write_value: int = 0) -> None: //| def readinto(self, buffer: bytearray, *, start: int = 0, end: Optional[int] = None, write_value: int = 0) -> None:
//| """Read into ``buffer`` while writing ``write_value`` for each byte read. //| """Read into ``buffer`` while writing ``write_value`` for each byte read.
//| The SPI object must be locked. //| The SPI object must be locked.
//| If the number of bytes to read is 0, nothing happens. //| If the number of bytes to read is 0, nothing happens.
@ -314,7 +314,7 @@ STATIC mp_obj_t busio_spi_readinto(size_t n_args, const mp_obj_t *pos_args, mp_m
} }
MP_DEFINE_CONST_FUN_OBJ_KW(busio_spi_readinto_obj, 2, busio_spi_readinto); MP_DEFINE_CONST_FUN_OBJ_KW(busio_spi_readinto_obj, 2, busio_spi_readinto);
//| def write_readinto(self, buffer_out: ReadableBuffer, buffer_in: ReadableBuffer, *, out_start: int = 0, out_end: int = None, in_start: int = 0, in_end: int = None) -> None: //| def write_readinto(self, buffer_out: ReadableBuffer, buffer_in: ReadableBuffer, *, out_start: int = 0, out_end: Optional[int] = None, in_start: int = 0, in_end: Optional[int] = None) -> None:
//| """Write out the data in ``buffer_out`` while simultaneously reading data into ``buffer_in``. //| """Write out the data in ``buffer_out`` while simultaneously reading data into ``buffer_in``.
//| The SPI object must be locked. //| The SPI object must be locked.
//| The lengths of the slices defined by ``buffer_out[out_start:out_end]`` and ``buffer_in[in_start:in_end]`` //| The lengths of the slices defined by ``buffer_out[out_start:out_end]`` and ``buffer_in[in_start:in_end]``

View File

@ -179,7 +179,7 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(busio_uart___exit___obj, 4, 4, busio_
// These are standard stream methods. Code is in py/stream.c. // These are standard stream methods. Code is in py/stream.c.
// //
//| def read(self, nbytes: int = None) -> Optional[bytes]: //| def read(self, nbytes: Optional[int] = None) -> Optional[bytes]:
//| """Read characters. If ``nbytes`` is specified then read at most that many //| """Read characters. If ``nbytes`` is specified then read at most that many
//| bytes. Otherwise, read everything that arrives until the connection //| bytes. Otherwise, read everything that arrives until the connection
//| times out. Providing the number of bytes expected is highly recommended //| times out. Providing the number of bytes expected is highly recommended

View File

@ -49,7 +49,7 @@
//| Most people should not use this class directly. Use a specific display driver instead that will //| Most people should not use this class directly. Use a specific display driver instead that will
//| contain the initialization sequence at minimum.""" //| contain the initialization sequence at minimum."""
//| //|
//| def __init__(self, display_bus: displayio, init_sequence: buffer, *, width: int, height: int, colstart: int = 0, rowstart: int = 0, rotation: int = 0, color_depth: int = 16, grayscale: bool = False, pixels_in_byte_share_row: bool = True, bytes_per_cell: int = 1, reverse_pixels_in_byte: bool = False, set_column_command: int = 0x2a, set_row_command: int = 0x2b, write_ram_command: int = 0x2c, set_vertical_scroll: int = 0, backlight_pin: microcontroller.Pin = None, brightness_command: int = None, brightness: bool = 1.0, auto_brightness: bool = False, single_byte_bounds: bool = False, data_as_commands: bool = False, auto_refresh: bool = True, native_frames_per_second: int = 60): //| def __init__(self, display_bus: displayio, init_sequence: buffer, *, width: int, height: int, colstart: int = 0, rowstart: int = 0, rotation: int = 0, color_depth: int = 16, grayscale: bool = False, pixels_in_byte_share_row: bool = True, bytes_per_cell: int = 1, reverse_pixels_in_byte: bool = False, set_column_command: int = 0x2a, set_row_command: int = 0x2b, write_ram_command: int = 0x2c, set_vertical_scroll: int = 0, backlight_pin: Optional[microcontroller.Pin] = None, brightness_command: int = None, brightness: bool = 1.0, auto_brightness: bool = False, single_byte_bounds: bool = False, data_as_commands: bool = False, auto_refresh: bool = True, native_frames_per_second: int = 60):
//| r"""Create a Display object on the given display bus (`displayio.FourWire` or `displayio.ParallelBus`). //| r"""Create a Display object on the given display bus (`displayio.FourWire` or `displayio.ParallelBus`).
//| //|
//| The ``init_sequence`` is bitpacked to minimize the ram impact. Every command begins with a //| The ``init_sequence`` is bitpacked to minimize the ram impact. Every command begins with a
@ -372,7 +372,7 @@ const mp_obj_property_t displayio_display_height_obj = {
(mp_obj_t)&mp_const_none_obj}, (mp_obj_t)&mp_const_none_obj},
}; };
//| rotation: Optional[int] = ... //| rotation: int = ...
//| """The rotation of the display as an int in degrees.""" //| """The rotation of the display as an int in degrees."""
//| //|
STATIC mp_obj_t displayio_display_obj_get_rotation(mp_obj_t self_in) { STATIC mp_obj_t displayio_display_obj_get_rotation(mp_obj_t self_in) {

View File

@ -49,7 +49,7 @@
//| Most people should not use this class directly. Use a specific display driver instead that will //| Most people should not use this class directly. Use a specific display driver instead that will
//| contain the startup and shutdown sequences at minimum.""" //| contain the startup and shutdown sequences at minimum."""
//| //|
//| def __init__(self, display_bus: displayio, start_sequence: buffer, stop_sequence: buffer, *, width: int, height: int, ram_width: int, ram_height: int, colstart: int = 0, rowstart: int = 0, rotation: int = 0, set_column_window_command: int = None, set_row_window_command: int = None, single_byte_bounds: bool = False, write_black_ram_command: int, black_bits_inverted: bool = False, write_color_ram_command: int = None, color_bits_inverted: bool = False, highlight_color: int = 0x000000, refresh_display_command: int, refresh_time: float = 40, busy_pin: microcontroller.Pin = None, busy_state: bool = True, seconds_per_frame: float = 180, always_toggle_chip_select: bool = False): //| def __init__(self, display_bus: displayio, start_sequence: buffer, stop_sequence: buffer, *, width: int, height: int, ram_width: int, ram_height: int, colstart: int = 0, rowstart: int = 0, rotation: int = 0, set_column_window_command: Optional[int] = None, set_row_window_command: Optional[int] = None, single_byte_bounds: bool = False, write_black_ram_command: int, black_bits_inverted: bool = False, write_color_ram_command: Optional[int] = None, color_bits_inverted: bool = False, highlight_color: int = 0x000000, refresh_display_command: int, refresh_time: float = 40, busy_pin: Optional[microcontroller.Pin] = None, busy_state: bool = True, seconds_per_frame: float = 180, always_toggle_chip_select: bool = False):
//| """Create a EPaperDisplay object on the given display bus (`displayio.FourWire` or `displayio.ParallelBus`). //| """Create a EPaperDisplay object on the given display bus (`displayio.FourWire` or `displayio.ParallelBus`).
//| //|
//| The ``start_sequence`` and ``stop_sequence`` are bitpacked to minimize the ram impact. Every //| The ``start_sequence`` and ``stop_sequence`` are bitpacked to minimize the ram impact. Every

View File

@ -86,7 +86,7 @@ displayio_group_t* native_group(mp_obj_t group_obj) {
return MP_OBJ_TO_PTR(native_group); return MP_OBJ_TO_PTR(native_group);
} }
//| hidden: Optional[bool] = ... //| hidden: bool = ...
//| """True when the Group and all of it's layers are not visible. When False, the Group's layers //| """True when the Group and all of it's layers are not visible. When False, the Group's layers
//| are visible if they haven't been hidden.""" //| are visible if they haven't been hidden."""
//| //|
@ -111,7 +111,7 @@ const mp_obj_property_t displayio_group_hidden_obj = {
(mp_obj_t)&mp_const_none_obj}, (mp_obj_t)&mp_const_none_obj},
}; };
//| scale: Optional[int] = ... //| scale: int = ...
//| """Scales each pixel within the Group in both directions. For example, when scale=2 each pixel //| """Scales each pixel within the Group in both directions. For example, when scale=2 each pixel
//| will be represented by 2x2 pixels.""" //| will be represented by 2x2 pixels."""
//| //|
@ -140,7 +140,7 @@ const mp_obj_property_t displayio_group_scale_obj = {
(mp_obj_t)&mp_const_none_obj}, (mp_obj_t)&mp_const_none_obj},
}; };
//| x: Optional[int] = ... //| x: int = ...
//| """X position of the Group in the parent.""" //| """X position of the Group in the parent."""
//| //|
STATIC mp_obj_t displayio_group_obj_get_x(mp_obj_t self_in) { STATIC mp_obj_t displayio_group_obj_get_x(mp_obj_t self_in) {
@ -165,7 +165,7 @@ const mp_obj_property_t displayio_group_x_obj = {
(mp_obj_t)&mp_const_none_obj}, (mp_obj_t)&mp_const_none_obj},
}; };
//| y: Optional[int] = ... //| y: int = ...
//| """Y position of the Group in the parent.""" //| """Y position of the Group in the parent."""
//| //|
STATIC mp_obj_t displayio_group_obj_get_y(mp_obj_t self_in) { STATIC mp_obj_t displayio_group_obj_get_y(mp_obj_t self_in) {
@ -264,7 +264,9 @@ STATIC mp_obj_t displayio_group_obj_remove(mp_obj_t self_in, mp_obj_t layer) {
} }
MP_DEFINE_CONST_FUN_OBJ_2(displayio_group_remove_obj, displayio_group_obj_remove); MP_DEFINE_CONST_FUN_OBJ_2(displayio_group_remove_obj, displayio_group_obj_remove);
//| def __len__(self) -> Union[bool, int, None]: //| def __bool__(self) -> bool: ...
//|
//| def __len__(self) -> int:
//| """Returns the number of layers in a Group""" //| """Returns the number of layers in a Group"""
//| ... //| ...
//| //|

View File

@ -91,7 +91,7 @@ STATIC mp_obj_t displayio_i2cdisplay_obj_reset(mp_obj_t self_in) {
} }
MP_DEFINE_CONST_FUN_OBJ_1(displayio_i2cdisplay_reset_obj, displayio_i2cdisplay_obj_reset); MP_DEFINE_CONST_FUN_OBJ_1(displayio_i2cdisplay_reset_obj, displayio_i2cdisplay_obj_reset);
//| def send(self, command: int, data: displayio) -> None: //| def send(self, command: int, data: ReadableBuffer) -> None:
//| """Sends the given command value followed by the full set of data. Display state, such as //| """Sends the given command value followed by the full set of data. Display state, such as
//| vertical scroll, set via ``send`` may or may not be reset once the code is done.""" //| vertical scroll, set via ``send`` may or may not be reset once the code is done."""
//| ... //| ...

View File

@ -70,7 +70,9 @@ STATIC mp_obj_t displayio_palette_make_new(const mp_obj_type_t *type, size_t n_a
return MP_OBJ_FROM_PTR(self); return MP_OBJ_FROM_PTR(self);
} }
//| def __len__(self) -> Union[bool, int, None]: //| def __bool__(self) -> bool: ...
//|
//| def __len__(self) -> int:
//| """Returns the number of colors in a Palette""" //| """Returns the number of colors in a Palette"""
//| ... //| ...
//| //|

View File

@ -102,7 +102,7 @@ STATIC mp_obj_t displayio_parallelbus_obj_reset(mp_obj_t self_in) {
} }
MP_DEFINE_CONST_FUN_OBJ_1(displayio_parallelbus_reset_obj, displayio_parallelbus_obj_reset); MP_DEFINE_CONST_FUN_OBJ_1(displayio_parallelbus_reset_obj, displayio_parallelbus_obj_reset);
//| def send(self, command: int, data: displayio) -> None: //| def send(self, command: int, data: ReadableBuffer) -> None:
//| """Sends the given command value followed by the full set of data. Display state, such as //| """Sends the given command value followed by the full set of data. Display state, such as
//| vertical scroll, set via ``send`` may or may not be reset once the code is done.""" //| vertical scroll, set via ``send`` may or may not be reset once the code is done."""
//| ... //| ...

View File

@ -141,7 +141,7 @@ static displayio_tilegrid_t* native_tilegrid(mp_obj_t tilegrid_obj) {
mp_obj_assert_native_inited(native_tilegrid); mp_obj_assert_native_inited(native_tilegrid);
return MP_OBJ_TO_PTR(native_tilegrid); return MP_OBJ_TO_PTR(native_tilegrid);
} }
//| hidden: Optional[bool] = ... //| hidden: bool = ...
//| """True when the TileGrid is hidden. This may be False even when a part of a hidden Group.""" //| """True when the TileGrid is hidden. This may be False even when a part of a hidden Group."""
//| //|
STATIC mp_obj_t displayio_tilegrid_obj_get_hidden(mp_obj_t self_in) { STATIC mp_obj_t displayio_tilegrid_obj_get_hidden(mp_obj_t self_in) {
@ -165,7 +165,7 @@ const mp_obj_property_t displayio_tilegrid_hidden_obj = {
(mp_obj_t)&mp_const_none_obj}, (mp_obj_t)&mp_const_none_obj},
}; };
//| x: Optional[int] = ... //| x: int = ...
//| """X position of the left edge in the parent.""" //| """X position of the left edge in the parent."""
//| //|
STATIC mp_obj_t displayio_tilegrid_obj_get_x(mp_obj_t self_in) { STATIC mp_obj_t displayio_tilegrid_obj_get_x(mp_obj_t self_in) {
@ -190,7 +190,7 @@ const mp_obj_property_t displayio_tilegrid_x_obj = {
(mp_obj_t)&mp_const_none_obj}, (mp_obj_t)&mp_const_none_obj},
}; };
//| y: Optional[int] = ... //| y: int = ...
//| """Y position of the top edge in the parent.""" //| """Y position of the top edge in the parent."""
//| //|
STATIC mp_obj_t displayio_tilegrid_obj_get_y(mp_obj_t self_in) { STATIC mp_obj_t displayio_tilegrid_obj_get_y(mp_obj_t self_in) {
@ -215,7 +215,7 @@ const mp_obj_property_t displayio_tilegrid_y_obj = {
(mp_obj_t)&mp_const_none_obj}, (mp_obj_t)&mp_const_none_obj},
}; };
//| flip_x: Optional[bool] = ... //| flip_x: bool = ...
//| """If true, the left edge rendered will be the right edge of the right-most tile.""" //| """If true, the left edge rendered will be the right edge of the right-most tile."""
//| //|
STATIC mp_obj_t displayio_tilegrid_obj_get_flip_x(mp_obj_t self_in) { STATIC mp_obj_t displayio_tilegrid_obj_get_flip_x(mp_obj_t self_in) {
@ -239,7 +239,7 @@ const mp_obj_property_t displayio_tilegrid_flip_x_obj = {
(mp_obj_t)&mp_const_none_obj}, (mp_obj_t)&mp_const_none_obj},
}; };
//| flip_y: Optional[bool] = ... //| flip_y: bool = ...
//| """If true, the top edge rendered will be the bottom edge of the bottom-most tile.""" //| """If true, the top edge rendered will be the bottom edge of the bottom-most tile."""
//| //|
STATIC mp_obj_t displayio_tilegrid_obj_get_flip_y(mp_obj_t self_in) { STATIC mp_obj_t displayio_tilegrid_obj_get_flip_y(mp_obj_t self_in) {
@ -264,7 +264,7 @@ const mp_obj_property_t displayio_tilegrid_flip_y_obj = {
}; };
//| transpose_xy: Optional[bool] = ... //| transpose_xy: bool = ...
//| """If true, the TileGrid's axis will be swapped. When combined with mirroring, any 90 degree //| """If true, the TileGrid's axis will be swapped. When combined with mirroring, any 90 degree
//| rotation can be achieved along with the corresponding mirrored version.""" //| rotation can be achieved along with the corresponding mirrored version."""
//| //|

View File

@ -76,7 +76,7 @@ STATIC mp_obj_t fontio_builtinfont_obj_get_bounding_box(mp_obj_t self_in) {
MP_DEFINE_CONST_FUN_OBJ_1(fontio_builtinfont_get_bounding_box_obj, fontio_builtinfont_obj_get_bounding_box); MP_DEFINE_CONST_FUN_OBJ_1(fontio_builtinfont_get_bounding_box_obj, fontio_builtinfont_obj_get_bounding_box);
//| def get_glyph(self, codepoint: int) -> fontio.Glyph: //| def get_glyph(self, codepoint: int) -> Glyph:
//| """Returns a `fontio.Glyph` for the given codepoint or None if no glyph is available.""" //| """Returns a `fontio.Glyph` for the given codepoint or None if no glyph is available."""
//| ... //| ...
//| //|

View File

@ -151,7 +151,7 @@ STATIC mp_obj_t framebufferio_framebufferdisplay_obj_refresh(size_t n_args, cons
} }
MP_DEFINE_CONST_FUN_OBJ_KW(framebufferio_framebufferdisplay_refresh_obj, 1, framebufferio_framebufferdisplay_obj_refresh); MP_DEFINE_CONST_FUN_OBJ_KW(framebufferio_framebufferdisplay_refresh_obj, 1, framebufferio_framebufferdisplay_obj_refresh);
//| auto_refresh: Optional[bool] = ... //| auto_refresh: bool = ...
//| """True when the display is refreshed automatically.""" //| """True when the display is refreshed automatically."""
//| //|
STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_auto_refresh(mp_obj_t self_in) { STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_auto_refresh(mp_obj_t self_in) {
@ -176,7 +176,7 @@ const mp_obj_property_t framebufferio_framebufferdisplay_auto_refresh_obj = {
(mp_obj_t)&mp_const_none_obj}, (mp_obj_t)&mp_const_none_obj},
}; };
//| brightness: Optional[float] = ... //| brightness: float = ...
//| """The brightness of the display as a float. 0.0 is off and 1.0 is full brightness. When //| """The brightness of the display as a float. 0.0 is off and 1.0 is full brightness. When
//| `auto_brightness` is True, the value of `brightness` will change automatically. //| `auto_brightness` is True, the value of `brightness` will change automatically.
//| If `brightness` is set, `auto_brightness` will be disabled and will be set to False.""" //| If `brightness` is set, `auto_brightness` will be disabled and will be set to False."""
@ -213,7 +213,7 @@ const mp_obj_property_t framebufferio_framebufferdisplay_brightness_obj = {
(mp_obj_t)&mp_const_none_obj}, (mp_obj_t)&mp_const_none_obj},
}; };
//| auto_brightness: Optional[bool] = ... //| auto_brightness: bool = ...
//| """True when the display brightness is adjusted automatically, based on an ambient //| """True when the display brightness is adjusted automatically, based on an ambient
//| light sensor or other method. Note that some displays may have this set to True by default, //| light sensor or other method. Note that some displays may have this set to True by default,
//| but not actually implement automatic brightness adjustment. `auto_brightness` is set to False //| but not actually implement automatic brightness adjustment. `auto_brightness` is set to False
@ -276,7 +276,7 @@ const mp_obj_property_t framebufferio_framebufferdisplay_height_obj = {
(mp_obj_t)&mp_const_none_obj}, (mp_obj_t)&mp_const_none_obj},
}; };
//| rotation: Optional[int] = ... //| rotation: int = ...
//| """The rotation of the display as an int in degrees.""" //| """The rotation of the display as an int in degrees."""
//| //|
STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_rotation(mp_obj_t self_in) { STATIC mp_obj_t framebufferio_framebufferdisplay_obj_get_rotation(mp_obj_t self_in) {
@ -317,7 +317,7 @@ const mp_obj_property_t framebufferio_framebufferframebuffer_obj = {
}; };
//| def fill_row(self, y: int, buffer: ReadableBuffer) -> displayio: //| def fill_row(self, y: int, buffer: WriteableBuffer) -> displayio:
//| """Extract the pixels from a single row //| """Extract the pixels from a single row
//| //|
//| :param int y: The top edge of the area //| :param int y: The top edge of the area

View File

@ -169,7 +169,7 @@ STATIC mp_obj_t frequencyio_frequencyin_obj_clear(mp_obj_t self_in) {
} }
MP_DEFINE_CONST_FUN_OBJ_1(frequencyio_frequencyin_clear_obj, frequencyio_frequencyin_obj_clear); MP_DEFINE_CONST_FUN_OBJ_1(frequencyio_frequencyin_clear_obj, frequencyio_frequencyin_obj_clear);
//| capture_period: Optional[int] = ... //| capture_period: int = ...
//| """The capture measurement period. Lower incoming frequencies will be measured //| """The capture measurement period. Lower incoming frequencies will be measured
//| more accurately with longer capture periods. Higher frequencies are more //| more accurately with longer capture periods. Higher frequencies are more
//| accurate with shorter capture periods. //| accurate with shorter capture periods.

View File

@ -70,7 +70,7 @@
//| time.sleep(0.1)""" //| time.sleep(0.1)"""
//| //|
//| def __init__(self, b1: DigialInOut, b2: DigialInOut, b3: DigialInOut, b4: DigialInOut, b5: DigialInOut, b6: DigialInOut, b7: DigialInOut, b8: DigialInOut): //| def __init__(self, b1: DigitalInOut, b2: DigitalInOut, b3: DigitalInOut, b4: DigitalInOut, b5: DigitalInOut, b6: DigitalInOut, b7: DigitalInOut, b8: DigitalInOut):
//| """Initializes button scanning routines. //| """Initializes button scanning routines.
//| //|
//| The ``b1``-``b8`` parameters are ``DigitalInOut`` objects, which //| The ``b1``-``b8`` parameters are ``DigitalInOut`` objects, which

View File

@ -171,7 +171,7 @@ const mp_obj_property_t gnss_altitude_obj = {
(mp_obj_t)&mp_const_none_obj}, (mp_obj_t)&mp_const_none_obj},
}; };
//| timestamp: string = ... //| timestamp: time.struct_time = ...
//| """Time when the position data was updated.""" //| """Time when the position data was updated."""
//| //|
STATIC mp_obj_t gnss_obj_get_timestamp(mp_obj_t self_in) { STATIC mp_obj_t gnss_obj_get_timestamp(mp_obj_t self_in) {

View File

@ -32,17 +32,17 @@
//| def __init__(self): //| def __init__(self):
//| """Enum-like class to define the position fix mode.""" //| """Enum-like class to define the position fix mode."""
//| //|
//| INVALID: gnss.PositionFix = ... //| INVALID: PositionFix = ...
//| """No measurement. //| """No measurement.
//| //|
//| :type gnss.PositionFix:""" //| :type PositionFix:"""
//| //|
//| FIX_2D: gnss.PositionFix = ... //| FIX_2D: PositionFix = ...
//| """2D fix. //| """2D fix.
//| //|
//| :type gnss.PositionFix:""" //| :type PositionFix:"""
//| //|
//| FIX_3D: gnss.PositionFix = ... //| FIX_3D: PositionFix = ...
//| """3D fix. //| """3D fix.
//| //|
//| :type gnss.PositionFix:""" //| :type gnss.PositionFix:"""

View File

@ -32,27 +32,27 @@
//| def __init__(self): //| def __init__(self):
//| """Enum-like class to define the satellite system type.""" //| """Enum-like class to define the satellite system type."""
//| //|
//| GPS: gnss.SatelliteSystem = ... //| GPS: SatelliteSystem = ...
//| """Global Positioning System. //| """Global Positioning System.
//| //|
//| :type gnss.SatelliteSystem:""" //| :type gnss.SatelliteSystem:"""
//| //|
//| GLONASS: gnss.SatelliteSystem = ... //| GLONASS: SatelliteSystem = ...
//| """GLObal NAvigation Satellite System. //| """GLObal NAvigation Satellite System.
//| //|
//| :type gnss.SatelliteSystem:""" //| :type gnss.SatelliteSystem:"""
//| //|
//| SBAS: gnss.SatelliteSystem = ... //| SBAS: SatelliteSystem = ...
//| """Satellite Based Augmentation System. //| """Satellite Based Augmentation System.
//| //|
//| :type gnss.SatelliteSystem:""" //| :type gnss.SatelliteSystem:"""
//| //|
//| QZSS_L1CA: gnss.SatelliteSystem = ... //| QZSS_L1CA: SatelliteSystem = ...
//| """Quasi-Zenith Satellite System L1C/A. //| """Quasi-Zenith Satellite System L1C/A.
//| //|
//| :type gnss.SatelliteSystem:""" //| :type gnss.SatelliteSystem:"""
//| //|
//| QZSS_L1S: gnss.SatelliteSystem = ... //| QZSS_L1S: SatelliteSystem = ...
//| """Quasi-Zenith Satellite System L1S. //| """Quasi-Zenith Satellite System L1S.
//| //|
//| :type gnss.SatelliteSystem:""" //| :type gnss.SatelliteSystem:"""

View File

@ -133,7 +133,7 @@ STATIC mp_obj_t i2cperipheral_i2c_peripheral_obj___exit__(size_t n_args, const m
} }
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(i2cperipheral_i2c_peripheral___exit___obj, 4, 4, i2cperipheral_i2c_peripheral_obj___exit__); STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(i2cperipheral_i2c_peripheral___exit___obj, 4, 4, i2cperipheral_i2c_peripheral_obj___exit__);
//| def request(self, timeout: float = -1) -> i2cperipheral.I2CPeripheralRequest: //| def request(self, timeout: float = -1) -> I2CPeripheralRequest:
//| """Wait for an I2C request. //| """Wait for an I2C request.
//| //|
//| :param float timeout: Timeout in seconds. Zero means wait forever, a negative value means check once //| :param float timeout: Timeout in seconds. Zero means wait forever, a negative value means check once

View File

@ -33,18 +33,18 @@
//| """Enum-like class to define the run mode of the microcontroller and //| """Enum-like class to define the run mode of the microcontroller and
//| CircuitPython.""" //| CircuitPython."""
//| //|
//| NORMAL: microcontroller.RunMode = ... //| NORMAL: RunMode = ...
//| """Run CircuitPython as normal. //| """Run CircuitPython as normal.
//| //|
//| :type microcontroller.RunMode:""" //| :type microcontroller.RunMode:"""
//| //|
//| SAFE_MODE: microcontroller.RunMode = ... //| SAFE_MODE: RunMode = ...
//| """Run CircuitPython in safe mode. User code will not be run and the //| """Run CircuitPython in safe mode. User code will not be run and the
//| file system will be writeable over USB. //| file system will be writeable over USB.
//| //|
//| :type microcontroller.RunMode:""" //| :type microcontroller.RunMode:"""
//| //|
//| BOOTLOADER: microcontroller.RunMode = ... //| BOOTLOADER: RunMode = ...
//| """Run the bootloader. //| """Run the bootloader.
//| //|
//| :type microcontroller.RunMode:""" //| :type microcontroller.RunMode:"""

View File

@ -49,7 +49,9 @@
//| ... //| ...
//| //|
//| def __len__(self) -> Union[bool, int, None]: //| def __bool__(self) -> bool: ...
//|
//| def __len__(self) -> int:
//| """Return the length. This is used by (`len`)""" //| """Return the length. This is used by (`len`)"""
//| ... //| ...
//| //|

View File

@ -122,7 +122,7 @@ STATIC mp_obj_t ps2io_ps2_obj___exit__(size_t n_args, const mp_obj_t *args) {
} }
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(ps2io_ps2___exit___obj, 4, 4, ps2io_ps2_obj___exit__); STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(ps2io_ps2___exit___obj, 4, 4, ps2io_ps2_obj___exit__);
//| def popleft(self) -> byte: //| def popleft(self) -> int:
//| """Removes and returns the oldest received byte. When buffer //| """Removes and returns the oldest received byte. When buffer
//| is empty, raises an IndexError exception.""" //| is empty, raises an IndexError exception."""
//| ... //| ...
@ -164,7 +164,7 @@ STATIC mp_obj_t ps2io_ps2_obj_sendcmd(mp_obj_t self_in, mp_obj_t ob) {
} }
MP_DEFINE_CONST_FUN_OBJ_2(ps2io_ps2_sendcmd_obj, ps2io_ps2_obj_sendcmd); MP_DEFINE_CONST_FUN_OBJ_2(ps2io_ps2_sendcmd_obj, ps2io_ps2_obj_sendcmd);
//| def clear_errors(self) -> int: //| def clear_errors(self) -> None:
//| """Returns and clears a bitmap with latest recorded communication errors. //| """Returns and clears a bitmap with latest recorded communication errors.
//| //|
//| Reception errors (arise asynchronously, as data is received): //| Reception errors (arise asynchronously, as data is received):
@ -202,7 +202,9 @@ STATIC mp_obj_t ps2io_ps2_obj_clear_errors(mp_obj_t self_in) {
} }
MP_DEFINE_CONST_FUN_OBJ_1(ps2io_ps2_clear_errors_obj, ps2io_ps2_obj_clear_errors); MP_DEFINE_CONST_FUN_OBJ_1(ps2io_ps2_clear_errors_obj, ps2io_ps2_obj_clear_errors);
//| def __len__(self) -> Union[bool, int, None]: //| def __bool__(self) -> bool: ...
//|
//| def __len__(self) -> int:
//| """Returns the number of received bytes in buffer, available //| """Returns the number of received bytes in buffer, available
//| to :py:func:`popleft()`.""" //| to :py:func:`popleft()`."""
//| ... //| ...

View File

@ -150,7 +150,7 @@ STATIC mp_obj_t pulseio_pwmout_obj___exit__(size_t n_args, const mp_obj_t *args)
} }
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(pulseio_pwmout___exit___obj, 4, 4, pulseio_pwmout_obj___exit__); STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(pulseio_pwmout___exit___obj, 4, 4, pulseio_pwmout_obj___exit__);
//| duty_cycle: Optional[int] = ... //| duty_cycle: int = ...
//| """16 bit value that dictates how much of one cycle is high (1) versus low //| """16 bit value that dictates how much of one cycle is high (1) versus low
//| (0). 0xffff will always be high, 0 will always be low and 0x7fff will //| (0). 0xffff will always be high, 0 will always be low and 0x7fff will
//| be half high and then half low. //| be half high and then half low.
@ -186,7 +186,7 @@ const mp_obj_property_t pulseio_pwmout_duty_cycle_obj = {
(mp_obj_t)&mp_const_none_obj}, (mp_obj_t)&mp_const_none_obj},
}; };
//| frequency: Optional[int] = ... //| frequency: int = ...
//| """32 bit value that dictates the PWM frequency in Hertz (cycles per //| """32 bit value that dictates the PWM frequency in Hertz (cycles per
//| second). Only writeable when constructed with ``variable_frequency=True``. //| second). Only writeable when constructed with ``variable_frequency=True``.
//| //|

View File

@ -234,7 +234,9 @@ const mp_obj_property_t pulseio_pulsein_paused_obj = {
(mp_obj_t)&mp_const_none_obj}, (mp_obj_t)&mp_const_none_obj},
}; };
//| def __len__(self) -> Union[bool, int, None]: //| def __bool__(self) -> bool: ...
//|
//| def __len__(self) -> int:
//| """Returns the current pulse length //| """Returns the current pulse length
//| //|
//| This allows you to:: //| This allows you to::

View File

@ -128,7 +128,7 @@ STATIC void preflight_pins_or_throw(uint8_t clock_pin, uint8_t *rgb_pins, uint8_
} }
} }
//| def __init__(self, *, width: int, bit_depth: List[digitalio.DigitalInOut], rgb_pins: List[digitalio.DigitalInOut], addr_pins: List[digitalio.DigitalInOut], clock_pin: digitalio.DigitalInOut, latch_pin: digitalio.DigitalInOut, output_enable_pin: digitalio.DigitalInOut, doublebuffer: bool = True, framebuffer: WriteableBuffer = None, height: int = 0): //| def __init__(self, *, width: int, bit_depth: List[digitalio.DigitalInOut], rgb_pins: List[digitalio.DigitalInOut], addr_pins: List[digitalio.DigitalInOut], clock_pin: digitalio.DigitalInOut, latch_pin: digitalio.DigitalInOut, output_enable_pin: digitalio.DigitalInOut, doublebuffer: bool = True, framebuffer: Optional[WriteableBuffer] = None, height: int = 0):
//| """Create a RGBMatrix object with the given attributes. The height of //| """Create a RGBMatrix object with the given attributes. The height of
//| the display is determined by the number of rgb and address pins: //| the display is determined by the number of rgb and address pins:
//| len(rgb_pins) // 3 * 2 ** len(address_pins). With 6 RGB pins and 4 //| len(rgb_pins) // 3 * 2 ** len(address_pins). With 6 RGB pins and 4
@ -257,7 +257,7 @@ static void check_for_deinit(rgbmatrix_rgbmatrix_obj_t *self) {
} }
} }
//| brightness: Optional[float] = ... //| brightness: float = ...
//| """In the current implementation, 0.0 turns the display off entirely //| """In the current implementation, 0.0 turns the display off entirely
//| and any other value up to 1.0 turns the display on fully.""" //| and any other value up to 1.0 turns the display on fully."""
//| //|

View File

@ -116,7 +116,7 @@ STATIC mp_obj_t rotaryio_incrementalencoder_obj___exit__(size_t n_args, const mp
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(rotaryio_incrementalencoder___exit___obj, 4, 4, rotaryio_incrementalencoder_obj___exit__); STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(rotaryio_incrementalencoder___exit___obj, 4, 4, rotaryio_incrementalencoder_obj___exit__);
//| position: Optional[int] = ... //| position: int = ...
//| """The current position in terms of pulses. The number of pulses per rotation is defined by the //| """The current position in terms of pulses. The number of pulses per rotation is defined by the
//| specific hardware.""" //| specific hardware."""
//| //|

View File

@ -39,7 +39,7 @@
//| print("Hello World!")""" //| print("Hello World!")"""
//| //|
//| def __init__(self): //| def __init__(self): -> None
//| """You cannot create an instance of `supervisor.Runtime`. //| """You cannot create an instance of `supervisor.Runtime`.
//| Use `supervisor.runtime` to access the sole instance available.""" //| Use `supervisor.runtime` to access the sole instance available."""
//| ... //| ...

View File

@ -39,7 +39,7 @@
//| mouse.send_report()""" //| mouse.send_report()"""
//| //|
//| def __init__(self): //| def __init__(self): -> None
//| """Not currently dynamically supported.""" //| """Not currently dynamically supported."""
//| ... //| ...
//| //|

View File

@ -58,7 +58,7 @@
//| :rtype: bytes or None""" //| :rtype: bytes or None"""
//| ... //| ...
//| //|
//| def readinto(self, buf: WriteableBuffer, nbytes: int = None) -> Optional[bytes]: //| def readinto(self, buf: WriteableBuffer, nbytes: Optional[int] = None) -> Optional[bytes]:
//| """Read bytes into the ``buf``. If ``nbytes`` is specified then read at most //| """Read bytes into the ``buf``. If ``nbytes`` is specified then read at most
//| that many bytes. Otherwise, read at most ``len(buf)`` bytes. //| that many bytes. Otherwise, read at most ``len(buf)`` bytes.
//| //|

View File

@ -38,7 +38,7 @@
//| class PortOut: //| class PortOut:
//| """Sends midi messages to a computer over USB""" //| """Sends midi messages to a computer over USB"""
//| //|
//| def __init__(self): //| def __init__(self): -> None
//| """You cannot create an instance of `usb_midi.PortOut`. //| """You cannot create an instance of `usb_midi.PortOut`.
//| //|
//| PortOut objects are constructed for every corresponding entry in the USB //| PortOut objects are constructed for every corresponding entry in the USB

View File

@ -29,7 +29,7 @@
//| class WatchDogMode: //| class WatchDogMode:
//| """run state of the watchdog timer""" //| """run state of the watchdog timer"""
//| //|
//| def __init__(self): //| def __init__(self): -> None
//| """Enum-like class to define the run mode of the watchdog timer.""" //| """Enum-like class to define the run mode of the watchdog timer."""
//| //|
//| RAISE: watchdog.WatchDogMode = ... //| RAISE: watchdog.WatchDogMode = ...

View File

@ -49,7 +49,7 @@
//| """ //| """
//| //|
//| def __init__(self): //| def __init__(self): -> None
//| """Not currently dynamically supported. Access the sole instance through `microcontroller.watchdog`.""" //| """Not currently dynamically supported. Access the sole instance through `microcontroller.watchdog`."""
//| ... //| ...
//| //|