Introduction

Supercharge your CircuitPython classes similar to CPython dataclasses

Dependencies

This driver depends on:

• Adafruit CircuitPython

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

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 circuitpython-nitroclass

To install system-wide (this may be required in some cases):

sudo pip3 install circuitpython-nitroclass

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-nitroclass

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install circuitpython_nitroclass

Or the following command to update an existing version:

circup update

Usage Example

from circuitpython_nitroclass import field, nitroclass

@nitroclass
class DataPacket:
    req = field(type=int)
    dyn = field(default_factory=list)
    cls_var = "a"


# NOTE: Due to CircuitPython implementation details, fields must be provided by keyword ONLY!

x = DataPacket(req=1)
y = DataPacket(req=2)

assert x != y

x.req = 2

assert x == y

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.