circuitpython/shared-bindings/_typing/__init__.pyi

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

70 lines
1.5 KiB
Python
Raw Normal View History

2020-08-03 00:35:43 -04:00
"""Types for the C-level protocols"""
from typing import Union
2020-11-27 23:27:15 -05:00
import alarm
import alarm.pin
import alarm.time
2020-08-03 00:35:43 -04:00
import array
import audiocore
import audiomixer
import audiomp3
import rgbmatrix
import ulab
ReadableBuffer = Union[
2021-04-01 16:43:40 -04:00
bytes, bytearray, memoryview, array.array, ulab.ndarray, rgbmatrix.RGBMatrix
2020-08-03 00:35:43 -04:00
]
"""Classes that implement the readable buffer protocol
- `bytes`
- `bytearray`
- `memoryview`
- `array.array`
2021-04-01 16:43:40 -04:00
- `ulab.ndarray`
2020-08-03 00:35:43 -04:00
- `rgbmatrix.RGBMatrix`
"""
WriteableBuffer = Union[
2021-04-01 16:43:40 -04:00
bytearray, memoryview, array.array, ulab.ndarray, rgbmatrix.RGBMatrix
2020-08-03 00:35:43 -04:00
]
"""Classes that implement the writeable buffer protocol
- `bytearray`
- `memoryview`
- `array.array`
2021-04-01 16:43:40 -04:00
- `ulab.ndarray`
2020-08-03 00:35:43 -04:00
- `rgbmatrix.RGBMatrix`
"""
AudioSample = Union[
audiocore.WaveFile, audiocore.RawSample, audiomixer.Mixer, audiomp3.MP3Decoder, synthio.MidiTrack
2020-08-03 00:35:43 -04:00
]
"""Classes that implement the audiosample protocol
- `audiocore.WaveFile`
- `audiocore.RawSample`
- `audiomixer.Mixer`
- `audiomp3.MP3Decoder`
- `synthio.MidiTrack`
2020-08-03 00:35:43 -04:00
You can play these back with `audioio.AudioOut`, `audiobusio.I2SOut` or `audiopwmio.PWMAudioOut`.
"""
FrameBuffer = Union[rgbmatrix.RGBMatrix]
"""Classes that implement the framebuffer protocol
- `rgbmatrix.RGBMatrix`
"""
2020-10-15 19:59:29 -04:00
Alarm = Union[
alarm.pin.PinAlarm, alarm.time.TimeAlarm
2020-10-15 19:59:29 -04:00
]
"""Classes that implement alarms for sleeping and asynchronous notification.
2020-10-15 19:59:29 -04:00
- `alarm.pin.PinAlarm`
- `alarm.time.TimeAlarm`
2020-10-15 19:59:29 -04:00
2020-11-27 23:27:15 -05:00
You can use these alarms to wake up from light or deep sleep.
2020-10-15 19:59:29 -04:00
"""