Introduction¶
Definitions not in the standard typing
module that are
needed for type annotation of CircuitPython code.
This library is not needed at runtime for CircuitPython code, and does not need to be in the bundle.
Dependencies¶
Installing from PyPI¶
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:
pip3 install adafruit-circuitpython-typing
To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-typing
To install in a virtual environment in your current project:
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-typing
Documentation¶
API documentation for this library can be found on Read the Docs.
For information on building library documentation, please check out this guide.
Contributing¶
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
Table of Contents¶
circuitpython_typing
Alarm
AudioSample
BlockDevice
ByteStream
FrameBuffer
ReadableBuffer
WriteableBuffer
circuitpython_typing.socket
CircuitPythonSocketType
CommonCircuitPythonSocketType
CommonSocketType
InterfaceType
LegacyCircuitPythonSocketType
SocketpoolModuleType
StandardPythonSocketType
SupportsRecvInto
SupportsRecvWithFlags