src/circuitpython_typing.py

   1 # The MIT License (MIT)
   2 #
   3 # Copyright (c) 2017 cefn for adafruit industries
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining a copy
   6 # of this software and associated documentation files (the "Software"), to deal
   7 # in the Software without restriction, including without limitation the rights
   8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 # copies of the Software, and to permit persons to whom the Software is
  10 # furnished to do so, subject to the following conditions:
  11 #
  12 # The above copyright notice and this permission notice shall be included in
  13 # all copies or substantial portions of the Software.
  14 #
  15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21 # THE SOFTWARE.
  22 """
  23 `circuitpython_typing` - Define subset of types for C-level protocols
  24 ======================================================
  25
  26 See `CircuitPython:board` in CircuitPython for more details.
  27
  28 * Author(s): Alec Delaney
  29 """
  30
  31 from typing import Union
  32 from array import array
  33 from numpy import ndarray
  34
  35 ReadableBuffer = Union[
  36     bytes, bytearray, memoryview, array, ndarray
  37 ]
  38 """Classes that implement the readable buffer protocol
  39   - `bytes`
  40   - `bytearray`
  41   - `memoryview`
  42   - `array.array`
  43   - `numpy.ndarray`
  44 """
  45
  46 WriteableBuffer = Union[
  47     bytearray, memoryview, array, ndarray
  48 ]
  49 """Classes that implement the writeable buffer protocol
  50   - `bytearray`
  51   - `memoryview`
  52   - `array.array`
  53   - `numpy.ndarray`
  54 """