Added inline pyi to audiobusio

Author: evaherrada

shared-bindings/audiobusio/I2SOut.c

@@ -35,65 +35,64 @@
 #include "shared-bindings/util.h"
 #include "supervisor/shared/translate.h"
 
-//| .. currentmodule:: audiobusio
-//|
-//| :class:`I2SOut` -- Output an I2S audio signal
-//| ========================================================
-//|
-//| I2S is used to output an audio signal on an I2S bus.
-//|
-//| .. class:: I2SOut(bit_clock, word_select, data, *, left_justified)
-//|
-//|   Create a I2SOut object associated with the given pins.
-//|
-//|   :param ~microcontroller.Pin bit_clock: The bit clock (or serial clock) pin
-//|   :param ~microcontroller.Pin word_select: The word select (or left/right clock) pin
-//|   :param ~microcontroller.Pin data: The data pin
-//|   :param bool left_justified: True when data bits are aligned with the word select clock. False
-//|     when they are shifted by one to match classic I2S protocol.
-//|
-//|   Simple 8ksps 440 Hz sine wave on `Metro M0 Express <https://www.adafruit.com/product/3505>`_
-//|   using `UDA1334 Breakout <https://www.adafruit.com/product/3678>`_::
-//|
-//|     import audiobusio
-//|     import audiocore
-//|     import board
-//|     import array
-//|     import time
-//|     import math
-//|
-//|     # Generate one period of sine wave.
-//|     length = 8000 // 440
-//|     sine_wave = array.array("H", [0] * length)
-//|     for i in range(length):
-//|         sine_wave[i] = int(math.sin(math.pi * 2 * i / 18) * (2 ** 15) + 2 ** 15)
-//|
-//|     sine_wave = audiocore.RawSample(sine_wave, sample_rate=8000)
-//|     i2s = audiobusio.I2SOut(board.D1, board.D0, board.D9)
-//|     i2s.play(sine_wave, loop=True)
-//|     time.sleep(1)
-//|     i2s.stop()
-//|
-//|   Playing a wave file from flash::
-//|
-//|     import board
-//|     import audioio
-//|     import audiocore
-//|     import audiobusio
-//|     import digitalio
-//|
-//|
-//|     f = open("cplay-5.1-16bit-16khz.wav", "rb")
-//|     wav = audiocore.WaveFile(f)
-//|
-//|     a = audiobusio.I2SOut(board.D1, board.D0, board.D9)
-//|
-//|     print("playing")
-//|     a.play(wav)
-//|     while a.playing:
-//|       pass
-//|     print("stopped")
-//|
+//|class I2SOut:
+//|    """.. currentmodule:: audiobusio
+//|
+//|    :class:`I2SOut` -- Output an I2S audio signal
+//|    ========================================================
+//|
+//|    I2S is used to output an audio signal on an I2S bus."""
+//|    def __init__(self, bit_clock: microcontroller.Pin, word_select: microcontroller.Pin, data: microcontroller.Pin, *, left_justified: bool):
+//|        """Create a I2SOut object associated with the given pins.
+//|
+//|        :param ~microcontroller.Pin bit_clock: The bit clock (or serial clock) pin
+//|        :param ~microcontroller.Pin word_select: The word select (or left/right clock) pin
+//|        :param ~microcontroller.Pin data: The data pin
+//|        :param bool left_justified: True when data bits are aligned with the word select clock. False
+//|        when they are shifted by one to match classic I2S protocol.
+//|
+//|        Simple 8ksps 440 Hz sine wave on `Metro M0 Express <https://www.adafruit.com/product/3505>`_
+//|        using `UDA1334 Breakout <https://www.adafruit.com/product/3678>`_::
+//|
+//|          import audiobusio
+//|          import audiocore
+//|          import board
+//|          import array
+//|          import time
+//|          import math
+//|
+//|          # Generate one period of sine wave.
+//|          length = 8000 // 440
+//|          sine_wave = array.array("H", [0] * length)
+//|          for i in range(length):
+//|              sine_wave[i] = int(math.sin(math.pi * 2 * i / 18) * (2 ** 15) + 2 ** 15)
+//|
+//|          sine_wave = audiocore.RawSample(sine_wave, sample_rate=8000)
+//|          i2s = audiobusio.I2SOut(board.D1, board.D0, board.D9)
+//|          i2s.play(sine_wave, loop=True)
+//|          time.sleep(1)
+//|          i2s.stop()
+//|
+//|        Playing a wave file from flash::
+//|
+//|          import board
+//|          import audioio
+//|          import audiocore
+//|          import audiobusio
+//|          import digitalio
+//|
+//|
+//|          f = open("cplay-5.1-16bit-16khz.wav", "rb")
+//|          wav = audiocore.WaveFile(f)
+//|
+//|          a = audiobusio.I2SOut(board.D1, board.D0, board.D9)
+//|
+//|          print("playing")
+//|          a.play(wav)
+//|          while a.playing:
+//|            pass
+//|          print("stopped")"""
+//|        ...
 STATIC mp_obj_t audiobusio_i2sout_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     enum { ARG_bit_clock, ARG_word_select, ARG_data, ARG_left_justified };
     static const mp_arg_t allowed_args[] = {
@@ -116,10 +115,9 @@ STATIC mp_obj_t audiobusio_i2sout_make_new(const mp_obj_type_t *type, size_t n_a
     return MP_OBJ_FROM_PTR(self);
 }
 
-//|   .. method:: deinit()
-//|
-//|      Deinitialises the I2SOut and releases any hardware resources for reuse.
-//|
+//|    def deinit(self, ) -> Any:
+//|        """Deinitialises the I2SOut and releases any hardware resources for reuse."""
+//|        ...
 STATIC mp_obj_t audiobusio_i2sout_deinit(mp_obj_t self_in) {
     audiobusio_i2sout_obj_t *self = MP_OBJ_TO_PTR(self_in);
     common_hal_audiobusio_i2sout_deinit(self);
@@ -132,17 +130,15 @@ STATIC void check_for_deinit(audiobusio_i2sout_obj_t *self) {
         raise_deinited_error();
     }
 }
-//|   .. method:: __enter__()
-//|
-//|      No-op used by Context Managers.
-//|
+//|    def __enter__(self, ) -> Any:
+//|        """No-op used by Context Managers."""
+//|        ...
 //  Provided by context manager helper.
 
-//|   .. method:: __exit__()
-//|
-//|      Automatically deinitializes the hardware when exiting a context. See
-//|      :ref:`lifetime-and-contextmanagers` for more info.
-//|
+//|    def __exit__(self, ) -> Any:
+//|        """Automatically deinitializes the hardware when exiting a context. See
+//|        :ref:`lifetime-and-contextmanagers` for more info."""
+//|        ...
 STATIC mp_obj_t audiobusio_i2sout_obj___exit__(size_t n_args, const mp_obj_t *args) {
     (void)n_args;
     common_hal_audiobusio_i2sout_deinit(args[0]);
@@ -151,15 +147,14 @@ 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__);
 
 
-//|   .. method:: play(sample, *, loop=False)
+//|    def play(self, sample: Any, *, loop: Any = False) -> Any:
+//|        """Plays the sample once when loop=False and continuously when loop=True.
+//|        Does not block. Use `playing` to block.
 //|
-//|     Plays the sample once when loop=False and continuously when loop=True.
-//|     Does not block. Use `playing` to block.
-//|
-//|     Sample must be an `audiocore.WaveFile`, `audiocore.RawSample`, or `audiomixer.Mixer`.
-//|
-//|     The sample itself should consist of 8 bit or 16 bit samples.
+//|        Sample must be an `audiocore.WaveFile`, `audiocore.RawSample`, or `audiomixer.Mixer`.
 //|
+//|        The sample itself should consist of 8 bit or 16 bit samples."""
+//|        ...
 STATIC mp_obj_t audiobusio_i2sout_obj_play(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     enum { ARG_sample, ARG_loop };
     static const mp_arg_t allowed_args[] = {
@@ -178,10 +173,9 @@ STATIC mp_obj_t audiobusio_i2sout_obj_play(size_t n_args, const mp_obj_t *pos_ar
 }
 MP_DEFINE_CONST_FUN_OBJ_KW(audiobusio_i2sout_play_obj, 1, audiobusio_i2sout_obj_play);
 
-//|   .. method:: stop()
-//|
-//|     Stops playback.
-//|
+//|    def stop(self, ) -> Any:
+//|        """Stops playback."""
+//|        ...
 STATIC mp_obj_t audiobusio_i2sout_obj_stop(mp_obj_t self_in) {
     audiobusio_i2sout_obj_t *self = MP_OBJ_TO_PTR(self_in);
     check_for_deinit(self);
@@ -190,10 +184,9 @@ STATIC mp_obj_t audiobusio_i2sout_obj_stop(mp_obj_t self_in) {
 }
 MP_DEFINE_CONST_FUN_OBJ_1(audiobusio_i2sout_stop_obj, audiobusio_i2sout_obj_stop);
 
-//|   .. attribute:: playing
-//|
-//|     True when the audio sample is being output. (read-only)
-//|
+//|    playing: Any =
+//|        """True when the audio sample is being output. (read-only)"""
+//|        ...
 STATIC mp_obj_t audiobusio_i2sout_obj_get_playing(mp_obj_t self_in) {
     audiobusio_i2sout_obj_t *self = MP_OBJ_TO_PTR(self_in);
     check_for_deinit(self);
@@ -208,10 +201,9 @@ const mp_obj_property_t audiobusio_i2sout_playing_obj = {
               (mp_obj_t)&mp_const_none_obj},
 };
 
-//|   .. method:: pause()
-//|
-//|     Stops playback temporarily while remembering the position. Use `resume` to resume playback.
-//|
+//|    def pause(self, ) -> Any:
+//|        """Stops playback temporarily while remembering the position. Use `resume` to resume playback."""
+//|        ...
 STATIC mp_obj_t audiobusio_i2sout_obj_pause(mp_obj_t self_in) {
     audiobusio_i2sout_obj_t *self = MP_OBJ_TO_PTR(self_in);
     check_for_deinit(self);
@@ -224,10 +216,9 @@ STATIC mp_obj_t audiobusio_i2sout_obj_pause(mp_obj_t self_in) {
 }
 MP_DEFINE_CONST_FUN_OBJ_1(audiobusio_i2sout_pause_obj, audiobusio_i2sout_obj_pause);
 
-//|   .. method:: resume()
-//|
-//|     Resumes sample playback after :py:func:`pause`.
-//|
+//|    def resume(self, ) -> Any:
+//|        """Resumes sample playback after :py:func:`pause`."""
+//|        ...
 STATIC mp_obj_t audiobusio_i2sout_obj_resume(mp_obj_t self_in) {
     audiobusio_i2sout_obj_t *self = MP_OBJ_TO_PTR(self_in);
     check_for_deinit(self);
@@ -240,10 +231,9 @@ STATIC mp_obj_t audiobusio_i2sout_obj_resume(mp_obj_t self_in) {
 }
 MP_DEFINE_CONST_FUN_OBJ_1(audiobusio_i2sout_resume_obj, audiobusio_i2sout_obj_resume);
 
-//|   .. attribute:: paused
-//|
-//|     True when playback is paused. (read-only)
-//|
+//|    paused: Any =
+//|        """True when playback is paused. (read-only)"""
+//|        ...
 STATIC mp_obj_t audiobusio_i2sout_obj_get_paused(mp_obj_t self_in) {
     audiobusio_i2sout_obj_t *self = MP_OBJ_TO_PTR(self_in);
     check_for_deinit(self);