Function rate_limit

examples/device_code_flow.py:172–197

(func, rate="1/5s")

# It is up to as the provider to decide how you want
# to rate limit the device during polling.
def rate_limit(func, rate="1/5s"):
    def wrapper():
        # some logic to ensure client device is rate limited by a minimum
        # of 1 request every 5 seconds during device polling
        # https://datatracker.ietf.org/doc/html/rfc8628#section-3.2

        # use device_code to retrieve device
        device = Device

        # get the time in seconds since the device polled the /token endpoint
        now = datetime.datetime.now(tz=datetime.UTC)
        diff = now - timedelta(device.last_checked)
        total_seconds_since_last_device_poll = diff.total_seconds()

        device.last_checked = now

        # for illustrative purposes. 1/5s means 1 request every 5 seconds.
        # so if `total_seconds_since_last_device_poll` is 4 seconds, this will
        # raise an error
        if total_seconds_since_last_device_poll < rate:
            raise device_flow_errors.SlowDownError()

        result = func()
        return result

    return wrapper


class ExampleRequestValidator(RequestValidator):