IoT Edge Validator Library for Python
Project description
iot-edge-validator
This package is a wrapper around the azure-iot-device SDK to provide standardized exception handling and direct method request validation.
Official Documentation | Source code | Package PyPI
Table of Contents
Versioning
This repository adheres to Semantic Versioning. It will be maintained through the CHANGELOG.md
and in GitHub Releases. It's important to note that you must maintain the version with your releases in iot/edge/validator/_version.py
, otherwise a new package version will fail to get published.
Getting Started
This section provides basic examples with the iot-edge-validator
.
Prerequisites
-
Python 3.7 or later is required to use this package.
-
You must have an Azure subscription and Azure IoT Edge Device to use this package.
Basic Examples
-
Install via pip:
pip install iot-edge-validator
-
Import and say hello:
from iot.edge.validator import __version__ print(f"hello world from iot-edge-validator version: {__version__}")
-
Basic usage:
from typing import Any, Dict, Union from azure.iot.device.iothub.models.methods import MethodRequest, MethodResponse from iot.edge.validator import ( format_exception_error, generate_error_response, compare_dictionary, ) EXPECTED_METHOD_NAME: str = "some_method_name" EXPECTED_METHOD_PAYLOAD: Dict[str, Any] = { "some": {}, "expected": {}, "payload": {}, } def validate_method_requests(method_request: MethodRequest) -> Union[MethodResponse, None]: """validation handler for some_method_name listener""" if method_request.name == EXPECTED_METHOD_NAME: pass else: return generate_error_response(method_request, f"received unknown method request for {method_request.name}", 400, ) def validate_some_method_name_request(method_request: MethodRequest) -> Union[MethodResponse, None]: """validation for expected payload of some_method_name direct method request""" # top level basic format validation error_msg = compare_dictionary( d1=method_request.payload, d2=EXPECTED_METHOD_PAYLOAD, value_match=False, recurse=False, ) if error_msg: return generate_error_response( method_request, f"error parsing payload: {error_msg}", 400 ) return None
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for iot_edge_validator-1.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ffc14c14c6b5a86eef792fb287f1fb8db5e372208bd502d685af95459603916 |
|
MD5 | 59f2bcf5bb3c0fd38364ad4c099c93fa |
|
BLAKE2b-256 | 069a9eed5aa6781e66c4a08b11670a237485e0791502d0c5b8b3c9a13128012a |